| blob | aa173441c27d8d70de500f9c3365e9178cd394cd |
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."
255 "Hook that is run after an Org log buffer is created."
264 "Load all extensions listed in `org-modules'."
269 org-modules)
273 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
282 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
283 "Modules that should always be loaded together with org.el.
284 If a description starts with <C>, the file is not part of Emacs
285 and loading it will require that you have downloaded and properly installed
286 the org-mode distribution.
288 You can also use this system to load external packages (i.e. neither Org
289 core modules, nor modules from the CONTRIB directory). Just add symbols
290 to the end of the list. If the package is called org-xyz.el, then you need
291 to add the symbol `xyz', and the package must have a call to
293 (provide 'org-xyz)"
296 :type
327 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
336 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
345 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
362 "Non-nil means make shift-cursor commands select text when possible.
364 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
365 selecting a region, or enlarge regions started in this way.
366 In Org-mode, in special contexts, these same keys are used for other
367 purposes, important enough to compete with shift selection. Org tries
368 to balance these needs by supporting `shift-select-mode' outside these
369 special contexts, under control of this variable.
371 The default of this variable is nil, to avoid confusing behavior. Shifted
372 cursor keys will then execute Org commands in the following contexts:
373 - on a headline, changing TODO state (left/right) and priority (up/down)
374 - on a time stamp, changing the time
375 - in a plain list item, changing the bullet type
376 - in a property definition line, switching between allowed values
377 - in the BEGIN line of a clock table (changing the time block).
378 Outside these contexts, the commands will throw an error.
380 When this variable is t and the cursor is not in a special context,
381 Org-mode will support shift-selection for making and enlarging regions.
382 To make this more effective, the bullet cycling will no longer happen
383 anywhere in an item line, but only if the cursor is exactly on the bullet.
385 If you set this variable to the symbol `always', then the keys
386 will not be special in headlines, property lines, and item lines, to make
387 shift selection work there as well. If this is what you want, you can
388 use the following alternative commands: `C-c C-t' and `C-c ,' to
389 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
390 TODO sets, `C-c -' to cycle item bullet types, and properties can be
391 edited by hand or in column view.
393 However, when the cursor is on a timestamp, shift-cursor commands
394 will still edit the time stamp - this is just too good to give up.
396 XEmacs user should have this variable set to nil, because shift-select-mode
397 is Emacs 23 only."
405 "Options concerning startup of Org-mode."
410 "Non-nil means entering Org-mode will switch to OVERVIEW.
411 This can also be configured on a per-file basis by adding one of
412 the following lines anywhere in the buffer:
414 #+STARTUP: fold (or `overview', this is equivalent)
415 #+STARTUP: nofold (or `showall', this is equivalent)
416 #+STARTUP: content
417 #+STARTUP: showeverything"
426 "Non-nil means entering Org-mode will set `truncate-lines'.
427 This is useful since some lines containing links can be very long and
428 uninteresting. Also tables look terrible when wrapped."
433 "Non-nil means turn on `org-indent-mode' on startup.
434 This can also be configured on a per-file basis by adding one of
435 the following lines anywhere in the buffer:
437 #+STARTUP: indent
438 #+STARTUP: noindent"
446 When this option is turned on, you can use TeX-like syntax for sub- and
448 considered as a single item - so grouping with {} is normally not
449 needed. For example, the following things will be parsed as single
450 sub- or superscripts.
452 10^24 or 10^tau several digits will be considered 1 item.
453 10^-12 or 10^-tau a leading sign with digits or a word
454 x^2-y^3 will be read as x^2 - y^3, because items are
455 terminated by almost any nonword/nondigit char.
456 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
458 Still, ambiguity is possible - so when in doubt use {} to enclose the
459 sub/superscript. If you set this variable to the symbol `{}',
460 the braces are *required* in order to trigger interpretations as
462 frequently in plain text.
464 Not all export backends support this, but HTML does.
479 "Non-nil means turn on `org-beamer-mode' on startup.
480 This can also be configured on a per-file basis by adding one of
481 the following lines anywhere in the buffer:
483 #+STARTUP: beamer"
488 "Non-nil means align all tables when visiting a file.
489 This is useful when the column width in tables is forced with <N> cookies
490 in table fields. Such tables will look correct only after the first re-align.
491 This can also be configured on a per-file basis by adding one of
492 the following lines anywhere in the buffer:
493 #+STARTUP: align
494 #+STARTUP: noalign"
499 "Non-nil means show inline images when loading a new Org file.
500 This can also be configured on a per-file basis by adding one of
501 the following lines anywhere in the buffer:
502 #+STARTUP: inlineimages
503 #+STARTUP: noinlineimages"
508 "Non-nil means insert the first line setting Org-mode in empty files.
509 When the function `org-mode' is called interactively in an empty file, this
510 normally means that the file name does not automatically trigger Org-mode.
511 To ensure that the file will always be in Org-mode in the future, a
512 line enforcing Org-mode will be inserted into the buffer, if this option
513 has been set."
518 "Non-nil means use alternative key bindings for some keys.
519 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
520 These keys are also used by other packages like shift-selection-mode'
521 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
522 If you want to use Org-mode together with one of these other modes,
523 or more generally if you would like to move some Org-mode commands to
524 other keys, set this variable and configure the keys with the variable
525 `org-disputed-keys'.
527 This option is only relevant at load-time of Org-mode, and must be set
528 *before* org.el is loaded. Changing it requires a restart of Emacs to
529 become effective."
534 "Non-nil means use extra key sequence definitions for certain commands.
535 This happens automatically if you run XEmacs or if `window-system'
536 is nil. This variable lets you do the same manually. You must
537 set it before loading org.
539 Example: on Carbon Emacs 22 running graphically, with an external
540 keyboard on a Powerbook, the default way of setting M-left might
541 not work for either Alt or ESC. Setting this variable will make
542 it work for ESC."
556 "Keys for which Org-mode and other modes compete.
557 This is an alist, cars are the default keys, second element specifies
558 the alternative to use when `org-replace-disputed-keys' is t.
560 Keys can be specified in any syntax supported by `define-key'.
561 The value of this option takes effect only at Org-mode's startup,
562 therefore you'll have to restart Emacs to apply it after changing."
567 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
568 Or return the original if not disputed.
569 Also apply the translations defined in `org-xemacs-key-equivalents'."
574 org-disputed-keys)))
578 key)
588 "Define a key, possibly translated, as returned by `org-key'."
592 "The ellipsis to use in the Org-mode outline.
593 When nil, just use the standard three dots. When a string, use that instead,
594 When a face, use the standard 3 dots, but with the specified face.
595 The change affects only Org-mode (which will then use its own display table).
596 Changing this requires executing `M-x org-mode' in a buffer to become
597 effective."
607 "Keywords in Org-mode."
612 "String to mark deadline entries.
613 A deadline is this string, followed by a time stamp. Should be a word,
614 terminated by a colon. You can insert a schedule keyword and
616 Changes become only effective after restarting Emacs."
621 "String to mark scheduled TODO entries.
622 A schedule is this string, followed by a time stamp. Should be a word,
623 terminated by a colon. You can insert a schedule keyword and
625 Changes become only effective after restarting Emacs."
630 "String used as the prefix for timestamps logging closing a TODO entry."
635 "String used as prefix for timestamps clocking work hours on an item."
640 "Entries starting with this keyword will never be exported.
641 An entry can be toggled between COMMENT and normal with
643 Changes become only effective after restarting Emacs."
648 "Entries starting with this keyword will be exported in fixed-width font.
649 Quoting applies only to the text in the entry following the headline, and does
650 not extend beyond the next headline, even if that is lower level.
651 An entry can be toggled between QUOTE and normal with
658 "Regular expression for specifying repeated events.
662 "Options concerning the general structure of Org-mode files."
667 "Options about how to make context of a location visible."
691 "Non-nil means show full hierarchy when revealing a location.
692 Org-mode often shows locations in an org-mode file which might have
693 been invisible before. When this is set, the hierarchy of headings
694 above the exposed location is shown.
695 Turning this off for example for sparse trees makes them very compact.
696 Instead of t, this can also be an alist specifying this option for different
697 contexts. Valid contexts are
698 agenda when exposing an entry from the agenda
699 org-goto when using the command `org-goto' on key C-c C-j
700 occur-tree when using the command `org-occur' on key C-c /
701 tags-tree when constructing a sparse tree based on tags matches
702 link-search when exposing search matches associated with a link
703 mark-goto when exposing the jump goal of a mark
704 bookmark-jump when exposing a bookmark location
705 isearch when exiting from an incremental search
706 default default for all contexts not set explicitly"
711 "Non-nil means show following heading when revealing a location.
712 Org-mode often shows locations in an org-mode file which might have
713 been invisible before. When this is set, the heading following the
714 match is shown.
715 Turning this off for example for sparse trees makes them very compact,
716 but makes it harder to edit the location of the match. In such a case,
718 Instead of t, this can also be an alist specifying this option for different
719 contexts. See `org-show-hierarchy-above' for valid contexts."
724 "Non-nil means show all sibling heading when revealing a location.
725 Org-mode often shows locations in an org-mode file which might have
726 been invisible before. When this is set, the sibling of the current entry
727 heading are all made visible. If `org-show-hierarchy-above' is t,
728 the same happens on each level of the hierarchy above the current entry.
730 By default this is on for the isearch context, off for all other contexts.
731 Turning this off for example for sparse trees makes them very compact,
732 but makes it harder to edit the location of the match. In such a case,
734 Instead of t, this can also be an alist specifying this option for different
735 contexts. See `org-show-hierarchy-above' for valid contexts."
740 "Non-nil means show the entry below a headline when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before. When this is set, the text below the headline that is
743 exposed is also shown.
745 By default this is off for all contexts.
746 Instead of t, this can also be an alist specifying this option for different
747 contexts. See `org-show-hierarchy-above' for valid contexts."
752 "How should indirect tree buffers be displayed?
753 This applies to indirect buffers created with the commands
755 Valid values are:
756 current-window Display in the current window
757 other-window Just display in another window.
758 dedicated-frame Create one new frame, and re-use it each time.
759 new-frame Make a new frame each time. Note that in this case
760 previously-made indirect buffers are kept, and you need to
761 kill these buffers yourself."
771 "Non-nil means activate single letter commands at beginning of a headline.
772 This may also be a function to test for appropriate locations where speed
773 commands should be active."
781 "Alist of additional speed commands.
782 This list will be checked before `org-speed-commands-default'
783 when the variable `org-use-speed-commands' is non-nil
784 and when the cursor is at the beginning of a headline.
785 The car if each entry is a string with a single letter, which must
786 be assigned to `self-insert-command' in the global map.
787 The cdr is either a command to be called interactively, a function
788 to be called, or a form to be evaluated.
789 An entry that is just a list with a single string will be interpreted
790 as a descriptive headline that will be added when listing the speed
791 commands in the Help buffer using the `?' speed command."
803 "Options concerning visibility cycling in Org-mode."
808 "Non-nil means skip CHILDREN state in entries that don't have any."
813 "Maximum level which should still be subject to visibility cycling.
814 Levels higher than this will, for cycling, be treated as text, not a headline.
815 When `org-odd-levels-only' is set, a value of N in this variable actually
816 means 2N-1 stars as the limiting headline.
817 When nil, cycle all levels.
818 Note that the limiting level of cycling is also influenced by
819 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
820 `org-inlinetask-min-level' is, cycling will be limited to levels one less
821 than its value."
828 "Names of drawers. Drawers are not opened by cycling on the headline above.
829 Drawers only open with a TAB on the drawer line itself. A drawer looks like
830 this:
831 :DRAWERNAME:
832 .....
833 :END:
835 the property API.
837 Drawers can be defined on the per-file basis with a line like:
839 #+DRAWERS: HIDDEN STATE PROPERTIES"
845 "Non-nil means entering Org-mode will fold all blocks.
846 This can also be set in on a per-file basis with
848 #+STARTUP: hideblocks
849 #+STARTUP: showblocks"
855 "Cycle globally if cursor is at beginning of buffer and not at a headline.
856 This makes it possible to do global cycling without having to use S-TAB or
858 of the buffer
859 must not be a headline - it may be empty or some other text. When used in
860 this way, `org-cycle-hook' is disables temporarily, to make sure the
861 cursor stays at the beginning of the buffer.
862 When this option is nil, don't do anything special at the beginning
863 of the buffer."
868 "Non-nil means cycle entry level or item indentation in new empty entries.
870 When the cursor is at the end of an empty headline, i.e with only stars
871 and maybe a TODO keyword, TAB will then switch the entry to become a child,
872 and then all possible ancestor states, before returning to the original state.
873 This makes data entry extremely fast: M-RET to create a new headline,
874 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
876 When the cursor is at the end of an empty plain list item, one TAB will
877 make it a subitem, two or more tabs will back up to make this an item
878 higher up in the item hierarchy."
883 "Where should `org-cycle' emulate TAB.
884 nil Never
885 white Only in completely white lines
886 whitestart Only at the beginning of lines, before the first non-white char
887 t Everywhere except in headlines
888 exc-hl-bol Everywhere except at the start of a headline
889 If TAB is used in a place where it does not emulate TAB, the current subtree
890 visibility is cycled."
897 ))
900 "Number of empty lines needed to keep an empty line between collapsed trees.
901 If you leave an empty line between the end of a subtree and the following
902 headline, this empty line is hidden when the subtree is folded.
903 Org-mode will leave (exactly) one empty line visible if the number of
904 empty lines is equal or larger to the number given in this variable.
905 So the default 2 means at least 2 empty lines after the end of a subtree
906 are needed to produce free space between a collapsed subtree and the
907 following headline.
909 If the number is negative, and the number of empty lines is at least -N,
910 all empty lines are shown.
912 Special case: when 0, never leave empty lines in collapsed view."
918 "Hook that is run before visibility cycling is happening.
919 The function(s) in this hook must accept a single argument which indicates
920 the new state that will be set right after running this hook. The
921 argument is a symbol. Before a global state change, it can have the values
922 `overview', `content', or `all'. Before a local state change, it can have
923 the values `folded', `children', or `subtree'."
928 org-cycle-hide-drawers
929 org-cycle-show-empty-lines
930 org-optimize-window-after-visibility-change)
931 "Hook that is run after `org-cycle' has changed the buffer visibility.
932 The function(s) in this hook must accept a single argument which indicates
933 the new state that was set by the most recent `org-cycle' command. The
934 argument is a symbol. After a global state change, it can have the values
935 `overview', `content', or `all'. After a local state change, it can have
936 the values `folded', `children', or `subtree'."
941 "Options concerning structure editing in Org-mode."
946 "Non-nil means skip even levels and only use odd levels for the outline.
947 This has the effect that two stars are being added/taken away in
948 promotion/demotion commands. It also influences how levels are
949 handled by the exporters.
950 Changing it requires restart of `font-lock-mode' to become effective
951 for fontification also in regions already fontified.
952 You may also set this on a per-file basis by adding one of the following
953 lines to the buffer:
955 #+STARTUP: odd
956 #+STARTUP: oddeven"
962 "Non-nil means adapt indentation to outline node level.
964 When this variable is set, Org assumes that you write outlines by
965 indenting text in each node to align with the headline (after the stars).
966 The following issues are influenced by this variable:
968 - When this is set and the *entire* text in an entry is indented, the
969 indentation is increased by one space in a demotion command, and
970 decreased by one in a promotion command. If any line in the entry
971 body starts with text at column 0, indentation is not changed at all.
973 - Property drawers and planning information is inserted indented when
974 this variable s set. When nil, they will not be indented.
976 - TAB indents a line relative to context. The lines below a headline
977 will be indented when this variable is set.
979 Note that this is all about true indentation, by adding and removing
980 space characters. See also `org-indent.el' which does level-dependent
981 indentation in a virtual way, i.e. at display time in Emacs."
986 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
988 When t, `C-a' will bring back the cursor to the beginning of the
989 headline text, i.e. after the stars and after a possible TODO keyword.
990 In an item, this will be the position after the bullet.
991 When the cursor is already at that position, another `C-a' will bring
992 it to the beginning of the line.
994 `C-e' will jump to the end of the headline, ignoring the presence of tags
995 in the headline. A second `C-e' will then jump to the true end of the
996 line, after any tags. This also means that, when this variable is
997 non-nil, `C-e' also will never jump beyond the end of the heading of a
998 folded section, i.e. not after the ellipses.
1000 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1001 going to the true line boundary first. Only a directly following, identical
1002 keypress will bring the cursor to the special positions.
1004 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1005 set separately."
1024 "Non-nil means `C-k' will behave specially in headlines.
1025 When nil, `C-k' will call the default `kill-line' command.
1026 When t, the following will happen while the cursor is in the headline:
1028 - When the cursor is at the beginning of a headline, kill the entire
1029 line and possible the folded subtree below the line.
1030 - When in the middle of the headline text, kill the headline up to the tags.
1031 - When after the headline text, kill the tags."
1036 "Non-nil means, do not delete a hidden subtree with C-k.
1037 When set to the symbol `error', simply throw an error when C-k is
1038 used to kill (part-of) a headline that has hidden text behind it.
1039 Any other non-nil value will result in a query to the user, if it is
1040 OK to kill that hidden subtree. When nil, kill without remorse."
1048 "Non-nil means when yanking subtrees, fold them.
1049 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1050 it starts with a heading and all other headings in it are either children
1051 or siblings, then fold all the subtrees. However, do this only if no
1052 text after the yank would be swallowed into a folded tree by this action."
1057 "Non-nil means when yanking subtrees, adjust the level.
1058 With this setting, `org-paste-subtree' is used to insert the subtree, see
1059 this function for details."
1064 "Non-nil means M-RET will split the line at the cursor position.
1065 When nil, it will go to the end of the line before making a
1066 new line.
1067 You may also set this option in a different way for different
1068 contexts. Valid contexts are:
1070 headline when creating a new headline
1071 item when creating a new item
1072 table in a table field
1073 default the value to be used for all contexts not explicitly
1074 customized"
1091 "Non-nil means insert new headings after the current subtree.
1092 When nil, the new heading is created directly after the current line.
1095 for the duration of the command."
1101 "Should `org-insert-heading' leave a blank line before new heading/item?
1102 The value is an alist, with `heading' and `plain-list-item' as CAR,
1103 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1104 which case Org will look at the surrounding headings/items and try to
1105 make an intelligent decision whether to insert a blank line or not.
1107 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1108 set, the setting here is ignored and no empty line is inserted, to avoid
1109 breaking the list structure."
1122 "Hook being run after inserting a new heading."
1128 This currently only means they are never auto-wrapped.
1129 When nil, such lines will be treated like ordinary lines.
1130 See also the QUOTE keyword."
1135 "Non-nil means typing characters in `org-goto' starts incremental search."
1140 "Options concerning sparse trees in Org-mode."
1145 "Non-nil means highlight all matches that define a sparse tree.
1146 The highlights will automatically disappear the next time the buffer is
1147 changed by an edit command."
1152 "Non-nil means any change to the buffer will remove temporary highlights.
1153 Such highlights are created by `org-occur' and `org-clock-display'.
1154 When nil, `C-c C-c needs to be used to get rid of the highlights.
1155 The highlights created by `org-preview-latex-fragment' always need
1156 `C-c C-c' to be removed."
1163 "Hook that is run after `org-occur' has constructed a sparse tree.
1164 This can be used to recenter the window to show as much of the structure
1165 as possible."
1170 "Options concerning imenu and speedbar in Org-mode."
1175 "The maximum level for Imenu access to Org-mode headlines.
1176 This also applied for speedbar access."
1181 "Options concerning tables in Org-mode."
1187 When nil, such lines will be treated like ordinary lines.
1189 When equal to the symbol `optimized', the table editor will be optimized to
1190 do the following:
1191 - Automatic overwrite mode in front of whitespace in table fields.
1192 This makes the structure of the table stay in tact as long as the edited
1193 field does not exceed the column width.
1194 - Minimize the number of realigns. Normally, the table is aligned each time
1195 TAB or RET are pressed to move to another field. With optimization this
1196 happens only if changes to a field might have changed the column width.
1197 Optimization requires replacing the functions `self-insert-command',
1198 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1199 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1200 very good at guessing when a re-align will be necessary, but you can always
1203 If you would like to use the optimized version in Org-mode, but the
1204 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1206 This variable can be used to turn on and off the table editor during a session,
1207 but in order to toggle optimization, a restart is required.
1209 See also the variable `org-table-auto-blank-field'."
1217 "Non-nil means cluster self-insert commands for undo when possible.
1218 If this is set, then, like in the Emacs command loop, 20 consecutive
1219 characters will be undone together.
1220 This is configurable, because there is some impact on typing performance."
1225 "Non-nil means TAB will automatically notice a table.el table.
1226 When it sees such a table, it moves point into it and - if necessary -
1227 calls `table-recognize-table'."
1232 "Options concerning links in Org-mode."
1237 "Buffer-local version of `org-link-abbrev-alist', which see.
1242 "Alist of link abbreviations.
1243 The car of each element is a string, to be replaced at the start of a link.
1245 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1247 [[linkkey:tag][description]]
1249 The 'linkkey' must be a word word, starting with a letter, followed
1250 by letters, numbers, '-' or '_'.
1252 If REPLACE is a string, the tag will simply be appended to create the link.
1255 be inserted at that point (see the function `url-hexify-string').
1257 REPLACE may also be a function that will be called with the tag as the
1258 only argument to create the link, which should be returned as a string.
1260 See the manual for examples."
1270 "Non-nil means hide link part and only show description of bracket links.
1271 Bracket links are like [[link][description]]. This variable sets the initial
1272 state in new org-mode buffers. The setting can then be toggled on a
1273 per-buffer basis from the Org->Hyperlinks menu."
1278 "How the path name in file links should be stored.
1279 Valid values are:
1281 relative Relative to the current directory, i.e. the directory of the file
1282 into which the link is being inserted.
1283 absolute Absolute path, if possible with ~ for home directory.
1284 noabbrev Absolute path, no abbreviation of home directory.
1285 adaptive Use relative path for files in the current directory and sub-
1286 directories of it. For other files, use an absolute path."
1295 "Types of links that should be activated in Org-mode files.
1296 This is a list of symbols, each leading to the activation of a certain link
1297 type. In principle, it does not hurt to turn on most link types - there may
1298 be a small gain when turning off unused link types. The types are:
1300 bracket The recommended [[link][description]] or [[link]] links with hiding.
1301 angle Links in angular brackets that may contain whitespace like
1302 <bbdb:Carsten Dominik>.
1303 plain Plain links in normal text, no whitespace, like http://google.com.
1304 radio Text that is matched by a radio target, see manual for details.
1305 tag Tag settings in a headline (link to tag search).
1306 date Time stamps (link to calendar).
1307 footnote Footnote labels.
1309 Changing this variable requires a restart of Emacs to become effective."
1321 "Function to use to generate link descriptions from links.
1322 If nil the link location will be used. This function must take
1323 two parameters; the first is the link and the second the
1324 description `org-insert-link' has generated, and should return the
1325 description to use."
1330 "Options concerning storing links in Org-mode."
1335 "Format of the description part of a link to an email or usenet message.
1336 The following %-escapes will be replaced by corresponding information:
1344 %s subject
1345 %d date
1346 %m message-id.
1348 You may use normal field width specification between the % and the letter.
1349 This is for example useful to limit the length of the subject.
1363 It should match if the message is from the user him/herself."
1368 "Non-nil means storing a link to an Org file will use entry IDs.
1370 Note that before this variable is even considered, org-id must be loaded,
1371 so please customize `org-modules' and turn it on.
1373 The variable can have the following values:
1375 t Create an ID if needed to make a link to the current entry.
1377 create-if-interactive
1378 If `org-store-link' is called directly (interactively, as a user
1379 command), do create an ID to support the link. But when doing the
1380 job for remember, only use the ID if it already exists. The
1381 purpose of this setting is to avoid proliferation of unwanted
1382 IDs, just because you happen to be in an Org file when you
1383 call `org-remember' that automatically and preemptively
1384 creates a link. If you do want to get an ID link in a remember
1385 template to an entry not having an ID, create it first by
1386 explicitly creating a link to it, using `C-c C-l' first.
1388 create-if-interactive-and-no-custom-id
1389 Like create-if-interactive, but do not create an ID if there is
1390 a CUSTOM_ID property defined in the entry. This is the default.
1392 use-existing
1393 Use existing ID, do not create one.
1395 nil Never use an ID to make a link, instead link using a text search for
1396 the headline text."
1401 create-if-interactive)
1403 create-if-interactive-and-no-custom-id)
1408 "Non-nil means file links from `org-store-link' contain context.
1409 A search string will be added to the file name with :: as separator and
1410 used to find the context when the link is activated by the command
1411 `org-open-at-point'. When this option is t, the entire active region
1412 will be placed in the search string of the file link. If set to a
1413 positive integer, only the first n lines of context will be stored.
1416 negates this setting for the duration of the command."
1421 "Non-nil means keep link in list for entire session.
1423 The command `org-store-link' adds a link pointing to the current
1424 location to an internal list. These links accumulate during a session.
1425 The command `org-insert-link' can be used to insert links into any
1426 Org-mode file (offering completion for all stored links). When this
1428 will be removed from the list, to make completing the unused links
1429 more efficient."
1434 "Options concerning following links in Org-mode."
1439 "Function to translate links with different syntax to Org syntax.
1440 This can be used to translate links created for example by the Planner
1441 or emacs-wiki packages to Org syntax.
1442 The function must accept two parameters, a TYPE containing the link
1444 which is everything after the link protocol. It should return a cons
1445 with possibly modified values of type and path.
1446 Org contains a function for this, so if you set this variable to
1447 `org-translate-link-from-planner', you should be able follow many
1448 links created by planner."
1453 "Hook that is run after a link has been followed."
1458 "Non-nil means on links TAB will follow the link.
1459 Needs to be set before org.el is loaded.
1460 This really should not be used, it does not make sense, and the
1461 implementation is bad."
1466 "Non-nil means on links RET will follow the link."
1472 "Non-nil means mouse-1 on a link will follow the link.
1473 A longer mouse click will still set point. Does not work on XEmacs.
1474 Needs to be set before org.el is loaded."
1479 "Number of different positions to be recorded in the ring.
1480 Changing this requires a restart of Emacs to work correctly."
1485 "Non-nil means internal links in Org files must exactly match a headline.
1486 When nil, the link search tries to match a phrase with all words
1487 in the search text."
1493 query-to-create)))
1500 "Setup the frame configuration for following links.
1501 When following a link with Emacs, it may often be useful to display
1502 this link in another window or frame. This variable can be used to
1503 set this up for the different types of links.
1504 For VM, use any of
1505 `vm-visit-folder'
1506 `vm-visit-folder-other-window'
1507 `vm-visit-folder-other-frame'
1508 For Gnus, use any of
1509 `gnus'
1510 `gnus-other-frame'
1511 `org-gnus-no-new-news'
1512 For FILE, use any of
1513 `find-file'
1514 `find-file-other-window'
1515 `find-file-other-frame'
1516 For Wanderlust use any of
1517 `wl'
1518 `wl-other-frame'
1519 For the calendar, use the variable `calendar-setup'.
1520 For BBDB, it is currently only possible to display the matches in
1521 another window."
1545 "Non-nil means use indirect buffer to display infile links.
1546 Activating internal links (from one location in a file to another location
1547 in the same file) normally just jumps to the location. When the link is
1549 is displayed in
1550 another window. When this option is set, the other window actually displays
1551 an indirect buffer clone of the current buffer, to avoid any visibility
1552 changes to the current buffer."
1557 "Non-nil means `org-open-file' will open non-existing files.
1558 When nil, an error will be generated.
1559 This variable applies only to external applications because they
1560 might choke on non-existing files. If the link is to a file that
1561 will be opened in Emacs, the variable is ignored."
1566 "Non-nil means a link to a directory really means to index.org.
1567 When nil, following a directory link will run dired or open a finder/explorer
1568 window on that directory."
1573 "Function and arguments to call for following mailto links.
1574 This is a list with the first element being a Lisp function, and the
1575 remaining elements being arguments to the function. In string arguments,
1576 %a will be replaced by the address, and %s will be replaced by the subject
1577 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1586 "Non-nil means ask for confirmation before executing shell links.
1587 Shell links can be dangerous: just think about a link
1589 [[shell:rm -rf ~/*][Google Search]]
1592 but really it would remove your entire home directory.
1593 Therefore we advise against setting this variable to nil.
1594 Just change it to `y-or-n-p' if you want to confirm with a
1602 'safe-local-variable
1606 "A regexp to skip confirmation for shell links."
1611 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1612 Elisp links can be dangerous: just think about a link
1617 but really it would remove your entire home directory.
1618 Therefore we advise against setting this variable to nil.
1619 Just change it to `y-or-n-p' if you want to confirm with a
1627 'safe-local-variable
1631 "A regexp to skip confirmation for Elisp links."
1639 "Default file applications on a UNIX or GNU/Linux system.
1650 "Default file applications on a MacOS X system.
1652 for some files for which the OS does not have a good default.
1660 'mswindows-shell-execute
1665 'mswindows-shell-execute
1668 "Default file applications on a Windows NT system.
1673 '(
1678 )
1679 "External applications for opening `file:path' items in a document.
1680 Org-mode uses system defaults for different file types, but
1681 you can use this variable to set the application for a given file
1682 extension. The entries in this list are cons cells where the car identifies
1683 files and the cdr the corresponding command. Possible values for the
1684 file identifier are
1686 ways, depending on its contents:
1688 - Alphanumeric characters only:
1689 Match links with this file extension.
1691 to open PDFs with evince.
1693 - Regular expression: Match links where the
1694 filename matches the regexp. If you want to
1695 use groups here, use shy groups.
1699 to open *.html and *.xhtml with firefox.
1701 - Regular expression which contains (non-shy) groups:
1703 anything after that, matches the regexp.
1704 In a custom command string, %1, %2, etc. are replaced with
1705 the parts of the link that were matched by the groups.
1706 For backwards compatibility, if a command string is given
1707 that does not use any of the group matches, this case is
1708 handled identically to the second one (i.e. match against
1709 file name only).
1710 In a custom lisp form, you can access the group matches with
1711 (match-string n link).
1714 to open [[file:document.pdf::5]] with evince at page 5.
1716 `directory' Matches a directory
1717 `remote' Matches a remote file, accessible through tramp or efs.
1718 Remote files most likely should be visited through Emacs
1719 because external applications cannot handle such paths.
1720 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1721 so all files Emacs knows how to handle. Using this with
1722 command `emacs' will open most files in Emacs. Beware that this
1723 will also open html files inside Emacs, unless you add
1725 t Default for files not matched by any of the other options.
1726 `system' The system command to open files, like `open' on Windows
1727 and Mac OS X, and mailcap under GNU/Linux. This is the command
1728 that will be selected if you call `C-c C-o' with a double
1731 Possible values for the command are:
1732 `emacs' The file will be visited by the current Emacs process.
1733 `default' Use the default application for this file type, which is the
1734 association for t in the list, most likely in the system-specific
1735 part.
1736 This can be used to overrule an unwanted setting in the
1737 system-specific variable.
1739 This command is specified by the entry whose car is `system'.
1740 Most likely, the system-specific version of this variable
1741 does define this command, but you can overrule/replace it
1742 here.
1743 string A command to be executed by a shell; %s will be replaced
1744 by the path to the file.
1745 sexp A Lisp form which will be evaluated. The file path will
1746 be available in the Lisp variable `file'.
1747 For more examples, see the system specific constants
1748 `org-file-apps-defaults-macosx'
1749 `org-file-apps-defaults-windowsnt'
1750 `org-file-apps-defaults-gnu'."
1760 auto-mode))
1771 "Options concerning refiling entries in Org-mode."
1776 "Directory with org files.
1777 This is just a default location to look for Org files. There is no need
1778 at all to put your files into this directory. It is only used in the
1779 following situations:
1781 1. When a remember template specifies a target file that is not an
1782 absolute path. The path will then be interpreted relative to
1783 `org-directory'
1784 2. When a remember note is filed away in an interactive way (when exiting the
1785 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1786 with `org-directory' as the default path."
1792 "Default target for storing notes.
1793 Used as a fall back file for org-remember.el and org-capture.el, for
1794 templates that do not specify a target file."
1799 file))
1802 "The default interface to be used for `org-goto'.
1803 Allowed values are:
1804 outline The interface shows an outline of the relevant file
1805 and the correct heading is found by moving through
1806 the outline or by searching with incremental search.
1807 outline-path-completion Headlines in the current buffer are offered via
1808 completion. This is the interface also used by
1809 the refile command."
1816 "Maximum target level when running `org-goto' with refile interface."
1821 "Non-nil means store new notes at the beginning of a file or entry.
1822 When nil, new notes will be filed to the end of a file or entry.
1823 This can also be a list with cons cells of regular expressions that
1824 are matched against file names, and values."
1834 "Information to record when a task is refiled.
1836 Possible values are:
1838 nil Don't add anything
1839 time Add a time stamp to the task
1840 note Prompt for a note and add it with template `org-log-note-headings'
1842 This option can also be set with on a per-file-basis with
1844 #+STARTUP: nologrefile
1845 #+STARTUP: logrefile
1846 #+STARTUP: lognoterefile
1848 You can have local logging settings for a subtree by setting the LOGGING
1849 property to one or more of these keywords.
1851 When bulk-refiling from the agenda, the value `note' is forbidden and
1852 will temporarily be changed to `time'."
1862 This is list of cons cells. Each cell contains:
1863 - a specification of the files to be considered, either a list of files,
1864 or a symbol whose function or variable value will be used to retrieve
1865 a file name or a list of file names. If you use `org-agenda-files' for
1866 that, all agenda files will be scanned for targets. Nil means consider
1867 headings in the current buffer.
1868 - A specification of how to find candidate refile targets. This may be
1869 any of:
1871 This tag has to be present in all target headlines, inheritance will
1872 not be considered.
1874 todo keyword.
1876 headlines that are refiling targets.
1877 - a cons cell (:level . N). Any headline of level N is considered a target.
1878 Note that, when `org-odd-levels-only' is set, level corresponds to
1879 order in hierarchy, not to the number of stars.
1880 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1881 Note that, when `org-odd-levels-only' is set, level corresponds to
1882 order in hierarchy, not to the number of stars.
1884 You can set the variable `org-refile-target-verify-function' to a function
1885 to verify each headline found by the simple criteria above.
1887 When this variable is nil, all top-level headlines in the current buffer
1888 are used, equivalent to the value `((nil . (:level . 1))'."
1904 "Function to verify if the headline at point should be a refile target.
1905 The function will be called without arguments, with point at the
1906 beginning of the headline. It should return t and leave point
1907 where it is if the headline is a valid target for refiling.
1909 If the target should not be selected, the function must return nil.
1910 In addition to this, it may move point to a place from where the search
1911 should be continued. For example, the function may decide that the entire
1912 subtree of the current entry should be excluded and move point to the end
1913 of the subtree."
1918 "Non-nil means cache refile targets to speed up the process.
1919 The cache for a particular file will be updated automatically when
1920 the buffer has been killed, or when any of the marker used for flagging
1921 refile targets no longer points at a live buffer.
1922 If you have added new entries to a buffer that might themselves be targets,
1923 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1924 find that easier, `C-u C-u C-u C-c C-w'."
1929 "Non-nil means provide refile targets as paths.
1930 So a level 3 headline will be available as level1/level2/level3.
1932 When the value is `file', also include the file name (without directory)
1933 into the path. In this case, you can also stop the completion after
1934 the file name, to get entries inserted as top level in the file.
1936 When `full-file-path', include the full file path."
1945 "Non-nil means complete the outline path in hierarchical steps.
1946 When Org-mode uses the refile interface to select an outline path
1947 \(see variable `org-refile-use-outline-path'), the completion of
1948 the path can be done is a single go, or if can be done in steps down
1949 the headline hierarchy. Going in steps is probably the best if you
1950 do not use a special completion package like `ido' or `icicles'.
1951 However, when using these packages, going in one step can be very
1952 fast, while still showing the whole path to the entry."
1957 "Non-nil means allow to create new nodes as refile targets.
1959 of an existing node. When the value of this variable is `confirm',
1960 new node creation must be confirmed by the user (recommended)
1961 When nil, the completion must match an existing entry.
1963 Note that, if the new heading is not seen by the criteria
1964 listed in `org-refile-targets', multiple instances of the same
1965 heading would be created by trying again to file under the new
1966 heading."
1974 "Options concerning TODO items in Org-mode."
1979 "Options concerning Progress logging in Org-mode."
1986 "The available interpretation symbols for customizing `org-todo-keywords'.
1990 "List of TODO entry keyword sequences and their interpretation.
1993 Each sequence starts with a symbol, either `sequence' or `type',
1994 indicating if the keywords should be interpreted as a sequence of
1995 action steps, or as different types of TODO items. The first
1996 keywords are states requiring action - these states will select a headline
1997 for inclusion into the global TODO list Org-mode produces. If one of
2000 the last keyword is treated as the only DONE state of the sequence.
2003 additional state where no keyword is present. For details about this
2004 cycling, see the manual.
2006 TODO keywords and interpretation can also be set on a per-file basis with
2007 the special #+SEQ_TODO and #+TYP_TODO lines.
2009 Each keyword can optionally specify a character for fast state selection
2010 \(in combination with the variable `org-use-fast-todo-selection')
2011 and specifiers for state change logging, using the same syntax
2014 indicates to record a time stamp each time this state is selected.
2016 Each keyword may also specify if a timestamp or a note should be
2017 recorded when entering or leaving the state, by adding additional
2018 characters in the parenthesis after the keyword. This looks like this:
2020 record only the time of the state change. With X and Y being either
2022 Y when leaving the state if and only if the *target* state does not
2023 define X. You may omit any of the fast-selection key or X or /Y,
2024 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2026 For backward compatibility, this variable may also be just a list
2027 of keywords - in this case the interpretation (sequence or type) will be
2028 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2038 ;;Quick and dirty way to see
2039 ;;`org-todo-interpretations'. This takes the
2040 ;;place of item arguments
2041 :convert-widget
2048 org-todo-interpretation-widgets))
2049 widget))
2080 "Controls how TODO keywords are interpreted.
2081 This variable is in principle obsolete and is only used for
2082 backward compatibility, if the interpretation of todo keywords is
2083 not given already in `org-todo-keywords'. See that variable for
2084 more information."
2091 "Non-nil means use the fast todo selection scheme with C-c C-t.
2092 This variable describes if and under what circumstances the cycling
2093 mechanism for TODO keywords will be replaced by a single-key, direct
2094 selection scheme.
2096 When nil, fast selection is never used.
2098 When the symbol `prefix', it will be used when `org-todo' is called with
2099 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2100 in an agenda buffer.
2102 When t, fast selection is used by default. In this case, the prefix
2103 argument forces cycling instead.
2105 In all cases, the special interface is only used if access keys have actually
2106 been assigned by the user, i.e. if keywords in the configuration are followed
2107 by a letter in parenthesis, like TODO(t)."
2115 "Non-nil means update todo statistics after insert and toggle.
2116 ALL-HEADLINES means update todo statistics by including headlines
2117 with no TODO keyword as well, counting them as not done.
2118 A list of TODO keywords means the same, but skip keywords that are
2119 not in this list.
2121 When this is set, todo statistics is updated in the parent of the
2122 current entry each time a todo state is changed."
2132 "Non-nil means TODO statistics covers just direct children.
2133 When nil, all entries in the subtree are considered.
2134 This has only an effect if `org-provide-todo-statistics' is set.
2135 To set this to nil for only a single subtree, use a COOKIE_DATA
2141 "Hook which is run after the state of a TODO item was changed.
2142 The new state (a string with a TODO keyword, or nil) is available in the
2143 Lisp variable `state'."
2148 "Hook for functions that are allowed to block a state change.
2150 Each function gets as its single argument a property list, see
2151 `org-trigger-hook' for more information about this list.
2153 If any of the functions in this hook returns nil, the state change
2157 "Hook for functions that are triggered by a state change.
2159 Each function gets as its single argument a property list with at least
2160 the following elements:
2162 (:type type-of-change :position pos-at-entry-start
2163 :from old-state :to new-state)
2165 Depending on the type, more properties may be present.
2167 This mechanism is currently implemented for:
2169 TODO state changes
2170 ------------------
2171 :type todo-state-change
2172 :from previous state (keyword as a string), or nil, or a symbol
2173 'todo' or 'done', to indicate the general type of state.
2177 "Non-nil means undone TODO entries will block switching the parent to DONE.
2178 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2179 be blocked if any prior sibling is not yet done.
2180 Finally, if the parent is blocked because of ordered siblings of its own,
2181 the child will also be blocked.
2182 This variable needs to be set before org.el is loaded, and you need to
2183 restart Emacs after a change to make the change effective. The only way
2184 to change is while Emacs is running is through the customize interface."
2196 "Non-nil means unchecked boxes will block switching the parent to DONE.
2197 When this is nil, checkboxes have no influence on switching TODO states.
2198 When non-nil, you first need to check off all check boxes before the TODO
2199 entry can be switched to DONE.
2200 This variable needs to be set before org.el is loaded, and you need to
2201 restart Emacs after a change to make the change effective. The only way
2202 to change is while Emacs is running is through the customize interface."
2214 "Non-nil means inserting a TODO heading is treated as state change.
2216 logging will apply if appropriate. When nil, the new TODO item will
2217 be inserted directly, and no logging will take place."
2222 "Non-nil means switching TODO states with S-cursor counts as state change.
2223 This is the default behavior. However, setting this to nil allows a
2224 convenient way to select a TODO state and bypass any logging associated
2225 with that."
2230 "Tag changes that should be triggered by TODO state changes.
2231 This is a list. Each entry is
2233 (state-change (tag . flag) .......)
2235 State-change can be a string with a state, and empty string to indicate the
2236 state that has no TODO keyword, or it can be one of the symbols `todo'
2237 or `done', meaning any not-done or done state, respectively."
2251 "Information to record when a task moves to the DONE state.
2253 Possible values are:
2255 nil Don't add anything, just change the keyword
2256 time Add a time stamp to the task
2257 note Prompt for a note and add it with template `org-log-note-headings'
2259 This option can also be set with on a per-file-basis with
2261 #+STARTUP: nologdone
2262 #+STARTUP: logdone
2263 #+STARTUP: lognotedone
2265 You can have local logging settings for a subtree by setting the LOGGING
2266 property to one or more of these keywords."
2274 ;; Normalize old uses of org-log-done.
2281 "Information to record when the scheduling date of a tasks is modified.
2283 Possible values are:
2285 nil Don't add anything, just change the date
2286 time Add a time stamp to the task
2287 note Prompt for a note and add it with template `org-log-note-headings'
2289 This option can also be set with on a per-file-basis with
2291 #+STARTUP: nologreschedule
2292 #+STARTUP: logreschedule
2293 #+STARTUP: lognotereschedule"
2302 "Information to record when the deadline date of a tasks is modified.
2304 Possible values are:
2306 nil Don't add anything, just change the date
2307 time Add a time stamp to the task
2308 note Prompt for a note and add it with template `org-log-note-headings'
2310 This option can also be set with on a per-file-basis with
2312 #+STARTUP: nologredeadline
2313 #+STARTUP: logredeadline
2314 #+STARTUP: lognoteredeadline
2316 You can have local logging settings for a subtree by setting the LOGGING
2317 property to one or more of these keywords."
2326 "Non-nil means record a note when clocking out of an item.
2327 This can also be configured on a per-file basis by adding one of
2328 the following lines anywhere in the buffer:
2330 #+STARTUP: lognoteclock-out
2331 #+STARTUP: nolognoteclock-out"
2337 "Non-nil means the CLOSED time stamp will contain date and time.
2338 When nil, only the date will be recorded."
2352 "Headings for notes added to entries.
2353 The value is an alist, with the car being a symbol indicating the note
2354 context, and the cdr is the heading to be used. The heading may also be the
2355 empty string.
2356 %t in the heading will be replaced by a time stamp.
2357 %T will be an active time stamp instead the default inactive one
2358 %s will be replaced by the new TODO state, in double quotes.
2359 %S will be replaced by the old TODO state, in double quotes.
2360 %u will be replaced by the user name.
2361 %U will be replaced by the full user name.
2363 In fact, it is not a good idea to change the `state' entry, because
2364 agenda log mode depends on the format of these entries."
2370 "Heading when changing todo state (todo sequence only)"
2384 "Non-nil means insert state change notes and time stamps into a drawer.
2385 When nil, state changes notes will be inserted after the headline and
2386 any scheduling and clock lines, but not inside a drawer.
2388 The value of this variable should be the name of the drawer to use.
2389 LOGBOOK is proposed as the default drawer for this purpose, you can
2390 also set this to a string to define the drawer of your choice.
2394 If this variable is set, `org-log-state-notes-insert-after-drawers'
2395 will be ignored.
2397 You can set the property LOG_INTO_DRAWER to overrule this setting for
2398 a subtree."
2410 "Return the value of `org-log-into-drawer', but let properties overrule.
2411 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2412 used instead of the default value."
2420 "Non-nil means insert state change notes after any drawers in entry.
2421 Only the drawers that *immediately* follow the headline and the
2422 deadline/scheduled line are skipped.
2423 When nil, insert notes right after the heading and perhaps the line
2424 with deadline/scheduling if present.
2426 This variable will have no effect if `org-log-into-drawer' is
2427 set."
2433 "Non-nil means the latest state note will be directly after heading.
2434 When nil, the state change notes will be ordered according to time."
2440 "The TODO state to which a repeater should return the repeating task.
2441 By default this is the first task in a TODO sequence, or the previous state
2442 in a TODO_TYP set. But you can specify another task here.
2443 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2449 "Non-nil means record moving through the DONE state when triggering repeat.
2450 An auto-repeating task is immediately switched back to TODO when
2453 record a closing note, there will be no record of the task moving
2454 through DONE. This variable forces taking a note anyway.
2456 nil Don't force a record
2457 time Record a time stamp
2458 note Record a note
2460 This option can also be set with on a per-file-basis with
2462 #+STARTUP: logrepeat
2463 #+STARTUP: lognoterepeat
2464 #+STARTUP: nologrepeat
2466 You can have local logging settings for a subtree by setting the LOGGING
2467 property to one or more of these keywords."
2477 "Priorities in Org-mode."
2482 "Non-nil means priority commands are active.
2483 When nil, these commands will be disabled, so that you never accidentally
2484 set a priority."
2489 "The highest priority of TODO items. A character like ?A, ?B etc.
2490 Must have a smaller ASCII number than `org-lowest-priority'."
2495 "The lowest priority of TODO items. A character like ?A, ?B etc.
2496 Must have a larger ASCII number than `org-highest-priority'."
2501 "The default priority of TODO items.
2502 This is the priority an item gets if no explicit priority is given.
2503 When starting to cycle on an empty priority the first step in the cycle
2504 depends on `org-priority-start-cycle-with-default'. The resulting first
2505 step priority must not exceed the range from `org-highest-priority' to
2506 `org-lowest-priority' which means that `org-default-priority' has to be
2507 in this range exclusive or inclusive the range boundaries. Else the
2508 first step refuses to set the default and the second will fall back
2509 to (depending on the command used) the highest or lowest priority."
2514 "Non-nil means start with default priority when starting to cycle.
2515 When this is nil, the first step in the cycle will be (depending on the
2516 command used) one higher or lower than the default priority.
2517 See also `org-default-priority'."
2522 "Function to extract the priority from a string.
2523 The string is normally the headline. If this is nil Org computes the
2524 priority from the priority cookie like [#A] in the headline. It returns
2525 an integer, increasing by 1000 for each priority level.
2526 The user can set a different function here, which should take a string
2527 as an argument and return the numeric priority."
2532 "Options concerning time stamps and deadlines in Org-mode."
2537 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2538 When nil, these labeled time stamps are forces into the second line of an
2539 entry, just after the headline. When scheduling from the global TODO list,
2540 the time stamp will always be forced into the second line."
2545 "Formats for `format-time-string' which are used for time stamps.
2549 "Number of minutes to round time stamps to.
2550 These are two values, the first applies when first creating a time stamp.
2551 The second applies when changing it with the commands `S-up' and `S-down'.
2552 When changing the time stamp, this means that it will change in steps
2553 of N minutes, as given by the second value.
2555 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2556 numbers should be factors of 60, so for example 5, 10, 15.
2558 When this is larger than 1, you can still force an exact time stamp by using
2559 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2560 and by using a prefix arg to `S-up/down' to specify the exact number
2561 of minutes to shift."
2571 ;; Normalize old customizations of this variable.
2575 org-time-stamp-rounding-minutes)))
2578 "Non-nil means overlay custom formats over all time stamps.
2579 The formats are defined through the variable `org-time-stamp-custom-formats'.
2580 To turn this on on a per-file basis, insert anywhere in the file:
2581 #+STARTUP: customtime"
2589 "Custom formats for time stamps. See `format-time-string' for the syntax.
2590 These are overlayed over the default ISO format if the variable
2591 `org-display-custom-times' is set. Time like %H:%M should be at the
2592 end of the second format. The custom formats are also honored by export
2593 commands, if custom time display is turned on at the time of export."
2598 "Get the right format for a time string."
2603 f)))
2606 "The format string used when creating CLOCKSUM lines.
2607 This is also used when org-mode generates a time duration."
2613 org-mode generates a time duration."
2618 "The format string used when creating CLOCKSUM lines, or when
2619 org-mode generates a time duration."
2624 "No. of days before expiration during which a deadline becomes active.
2625 This variable governs the display in sparse trees and in the agenda.
2626 When 0 or negative, it means use this number (the absolute value of it)
2627 even if a deadline has a different individual lead time specified.
2629 Custom commands can set this variable in the options section."
2635 "Non-nil means assume future for incomplete date input from user.
2636 This affects the following situations:
2637 1. The user gives a month but not a year.
2640 2. The user gives a day, but no month.
2643 it will be considered as *this* month.
2645 If you set this variable to the symbol `time', then also the following
2646 will work:
2648 3. If the user gives a time, but no day. If the time is before now,
2649 to will be interpreted as tomorrow.
2651 Currently none of this works for ISO week specifications.
2653 When this option is nil, the current day, month and year will always be
2654 used as defaults.
2656 See also `org-agenda-jump-prefer-future'."
2664 "Should the agenda jump command prefer the future for incomplete dates?
2665 The default is to do the same as configured in `org-read-date-prefer-future'.
2666 But you can also set a deviating value here.
2667 This may t or nil, or the symbol `org-read-date-prefer-future'."
2672 org-read-date-prefer-future)
2677 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2679 Depending on the system Emacs is running on, certain dates cannot
2680 be represented with the type used internally to represent time.
2681 Dates between 1970-1-1 and 2038-1-1 can always be represented
2682 correctly. Some systems allow for earlier dates, some for later,
2683 some for both. One way to find out it to insert any date into an
2684 Org buffer, putting the cursor on the year and hitting S-up and
2685 S-down to test the range.
2687 When this variable is set to t, the date/time prompt will not let
2688 you specify dates outside the 1970-2037 range, so it is certain that
2689 these dates will work in whatever version of Emacs you are
2690 running, and also that you can move a file from one Emacs implementation
2691 to another. WHenever Org is forcing the year for you, it will display
2692 a message and beep.
2694 When this variable is nil, Org will check if the date is
2695 representable in the specific Emacs implementation you are using.
2696 If not, it will force a year, usually the current year, and beep
2697 to remind you. Currently this setting is not recommended because
2698 the likelihood that you will open your Org files in an Emacs that
2699 has limited date range is not negligible.
2701 A workaround for this problem is to use diary sexp dates for time
2702 stamps outside of this range."
2707 "Non-nil means display current interpretation of date prompt live.
2708 This display will be in an overlay, in the minibuffer."
2713 "Non-nil means pop up a calendar when prompting for a date.
2714 In the calendar, the date can be selected with mouse-1. However, the
2715 minibuffer will also be active, and you can simply enter the date as well.
2716 When nil, only the minibuffer will be available."
2724 "Hook to be used to set up keys for the date/time interface.
2725 Add key definitions to `minibuffer-local-map', which will be a temporary
2726 copy."
2731 "The hour when your day really ends. Must be an integer.
2732 This has influence for the following applications:
2734 the time given here, the day recognized as TODAY is actually yesterday.
2735 - When a date is read from the user and it is still before the time given
2736 here, the current date and time will be assumed to be yesterday, 23:59.
2737 Also, timestamps inserted in remember templates follow this rule.
2739 IMPORTANT: This is a feature whose implementation is and likely will
2740 remain incomplete. Really, it is only here because past midnight seems to
2741 be the favorite working time of John Wiegley :-)"
2746 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2747 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2749 23:59 of the previous day."
2754 "Non-nil means S-down will increase the time in a time stamp.
2755 When nil, S-up will increase."
2760 "Non-nil means make the calendar window follow timestamp changes.
2761 When a timestamp is modified and the calendar window is visible, it will be
2762 moved to the new date."
2767 "Options concerning tags in Org-mode."
2772 "List of tags allowed in Org-mode files.
2773 When this list is nil, Org-mode will base TAG input on what is already in the
2774 buffer.
2775 The value of this variable is an alist, the car of each entry must be a
2776 keyword as a string, the cdr may be a character that is used to select
2777 that tag through the fast-tag-selection interface.
2778 See the manual for details."
2793 "List of tags that will always appear in all Org-mode files.
2794 This is in addition to any in buffer settings or customizations
2795 of `org-tag-alist'.
2796 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2797 The value of this variable is an alist, the car of each entry must be a
2798 keyword as a string, the cdr may be a character that is used to select
2799 that tag through the fast-tag-selection interface.
2800 See the manual for details.
2801 To disable these tags on a per-file basis, insert anywhere in the file:
2802 #+STARTUP: noptag"
2813 "If non-nil, always offer completion for all tags of all agenda files.
2814 Instead of customizing this variable directly, you might want to
2815 set it locally for capture buffers, because there no list of
2816 tags in that file can be created dynamically (there are none).
2818 (add-hook 'org-capture-mode-hook
2819 (lambda ()
2820 (set (make-local-variable
2821 'org-complete-tags-always-offer-all-agenda-tags)
2822 t)))"
2827 "List of tags that can be inherited by all entries in the file.
2828 The tags will be inherited if the variable `org-use-tag-inheritance'
2829 says they should be.
2833 "Non-nil means use fast tag selection scheme.
2834 This is a special interface to select and deselect tags with single keys.
2835 When nil, fast selection is never used.
2836 When the symbol `auto', fast selection is used if and only if selection
2837 characters for tags have been configured, either through the variable
2838 `org-tag-alist' or through a #+TAGS line in the buffer.
2839 When t, fast selection is always used and selection keys are assigned
2840 automatically if necessary."
2848 "Non-nil means fast tag selection exits after first change.
2849 When nil, you have to press RET to exit it.
2850 During fast tag selection, you can toggle this flag with `C-c'.
2851 This variable can also have the value `expert'. In this case, the window
2852 displaying the tags menu is not even shown, until you press C-c again."
2860 "Non-nil means fast tags selection interface will also offer TODO states.
2864 "The column to which tags should be indented in a headline.
2865 If this number is positive, it specifies the column. If it is negative,
2866 it means that the tags should be flushright to that column. For example,
2867 -80 works well for a normal 80 character screen."
2872 "Non-nil keeps tags aligned when modifying headlines.
2873 Some operations (i.e. demoting) change the length of a headline and
2874 therefore shift the tags around. With this option turned on, after
2875 each such operation the tags are again aligned to `org-tags-column'."
2880 "Non-nil means tags in levels apply also for sublevels.
2881 When nil, only the tags directly given in a specific line apply there.
2882 This may also be a list of tags that should be inherited, or a regexp that
2883 matches tags that should be inherited. Additional control is possible
2884 with the variable `org-tags-exclude-from-inheritance' which gives an
2885 explicit list of tags to be excluded from inheritance., even if the value of
2886 `org-use-tag-inheritance' would select it for inheritance.
2888 If this option is t, a match early-on in a tree can lead to a large
2889 number of matches in the subtree when constructing the agenda or creating
2890 a sparse tree. If you only want to see the first match in a tree during
2891 a search, check out the variable `org-tags-match-list-sublevels'."
2900 "List of tags that should never be inherited.
2901 This is a way to exclude a few tags from inheritance. For way to do
2902 the opposite, to actively allow inheritance for selected tags,
2903 see the variable `org-use-tag-inheritance'."
2908 "Check if TAG is one that should be inherited."
2920 "Non-nil means list also sublevels of headlines matching a search.
2921 This variable applies to tags/property searches, and also to stuck
2922 projects because this search is based on a tags match as well.
2924 When set to the symbol `indented', sublevels are indented with
2925 leading dots.
2927 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2928 the sublevels of a headline matching a tag search often also match
2929 the same search. Listing all of them can create very long lists.
2930 Setting this variable to nil causes subtrees of a match to be skipped.
2932 This variable is semi-obsolete and probably should always be true. It
2933 is better to limit inheritance to certain tags using the variables
2934 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2942 "When set, tags are sorted using this function as a comparator."
2958 "Options concerning properties in Org-mode."
2963 "How property key/value pairs should be formatted by `indent-line'.
2964 When `indent-line' hits a property definition, it will format the line
2965 according to this format, mainly to make sure that the values are
2966 lined-up with respect to each other."
2971 "Non-nil means properties apply also for sublevels.
2973 This setting is chiefly used during property searches. Turning it on can
2974 cause significant overhead when doing a search, which is why it is not
2975 on by default.
2977 When nil, only the properties directly given in the current entry count.
2978 When t, every property is inherited. The value may also be a list of
2979 properties that should have inheritance, or a regular expression matching
2980 properties that should be inherited.
2982 However, note that some special properties use inheritance under special
2983 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2985 for valid values of a property.
2987 Note for programmers:
2988 When querying an entry with `org-entry-get', you can control if inheritance
2989 should be used. By default, `org-entry-get' looks only at the local
2990 properties. You can request inheritance by setting the inherit argument
2991 to t (to force inheritance) or to `selective' (to respect the setting
2992 in this variable)."
3001 "Check if PROPERTY is one that should be inherited."
3012 "The default column format, if no other format has been defined.
3013 This variable can be set on the per-file basis by inserting a line
3015 #+COLUMNS: %25ITEM ....."
3020 "The ellipses to be used when a field in column view is truncated.
3021 When this is the empty string, as many characters as possible are shown,
3022 but then there will be no visual indication that the field has been truncated.
3023 When this is a string of length N, the last N characters of a truncated
3024 field are replaced by this string. If the column is narrower than the
3025 ellipses string, only part of the ellipses string will be shown."
3030 "Function that modifies values for display in column view.
3031 For example, it can be used to cut out a certain part from a time stamp.
3032 The function must take 2 arguments:
3034 column-title The title of the column (*not* the property name)
3035 value The value that should be modified.
3037 The function should return the value that should be displayed,
3038 or nil if the normal value should be used."
3043 "The property that is being used to keep track of effort estimates.
3044 Effort estimates given in this property need to have the format H:MM."
3052 "List of property/value pairs that can be inherited by any entry.
3054 These are fixed values, for the preset properties. The user variable
3055 that can be used to add to this list is `org-global-properties'.
3057 The entries in this list are cons cells where the car is a property
3058 name and cdr is a string with the value. If the value represents
3063 "List of property/value pairs that can be inherited by any entry.
3065 This list will be combined with the constant `org-global-properties-fixed'.
3067 The entries in this list are cons cells where the car is a property
3068 name and cdr is a string with the value.
3070 You can set buffer-local values for the same purpose in the variable
3071 `org-file-properties' this by adding lines like
3073 #+PROPERTY: NAME VALUE"
3080 "List of property/value pairs that can be inherited by any entry.
3081 Valid for the current buffer.
3086 "Options concerning agenda views in Org-mode."
3091 "Variable used by org files to set a category for agenda display.
3092 Such files should use a file variable to set it, for example
3096 or contain a special line
3098 #+CATEGORY: ELisp
3100 If the file does not specify a category, then file's base name
3106 "The files to be used for agenda display.
3110 If an entry is a directory, all files in that directory that are matched by
3111 `org-agenda-file-regexp' will be part of the file list.
3113 If the value of the variable is not a list but a single file name, then
3114 the list of agenda files is actually stored and maintained in that file, one
3115 agenda file per line. In this file paths can be given relative to
3116 `org-directory'. Tilde expansion and environment variable substitution
3117 are also made."
3124 "Regular expression to match files for `org-agenda-files'.
3125 If any element in the list in that variable contains a directory instead
3126 of a normal file, all files in that directory that are matched by this
3127 regular expression will be included."
3132 "List of extra files to be searched by text search commands.
3133 These files will be search in addition to the agenda files by the
3134 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3135 Note that these files will only be searched for text search commands,
3136 not for the other agenda views like todo lists, tag searches or the weekly
3137 agenda. This variable is intended to list notes and possibly archive files
3138 that should also be searched by these two commands.
3139 In fact, if the first element in the list is the symbol `agenda-archives',
3140 than all archive files of all agenda files will be added to the search
3141 scope."
3152 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3153 A nil value means to remove them, after a query, from the list."
3158 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3159 The command `org-calendar-goto-agenda' will be bound to this key. The
3160 default is the character `c' because then `c' can be used to switch back and
3161 forth between agenda and calendar."
3166 "The key to be installed in `calendar-mode-map' for agenda-action.
3167 The command `org-agenda-action' will be bound to this key. The
3168 default is the character `k' because we use the same key in the agenda."
3173 "The key to be installed in `calendar-mode-map' for adding diary entries.
3174 This option is irrelevant until `org-agenda-diary-file' has been configured
3175 to point to an Org-mode file. When that is the case, the command
3176 `org-agenda-diary-entry' will be bound to the key given here, by default
3177 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3178 if you want to continue doing this, you need to change this to a different
3179 key."
3184 "File to which to add new entries with the `i' key in agenda and calendar.
3185 When this is the symbol `diary-file', the functionality in the Emacs
3186 calendar will be used to add entries to the `diary-file'. But when this
3187 points to a file, `org-agenda-diary-entry' will be used instead."
3203 org-calendar-insert-diary-entry-key
3207 "Options for embedding LaTeX code into Org-mode."
3215 "Options for creating images from LaTeX fragments.
3216 This is a property list with the following properties:
3218 `default' means use the foreground of the default face.
3220 `default' means use the background of the default face.
3221 :scale a scaling factor for the size of the images, to get more pixels
3222 :html-foreground, :html-background, :html-scale
3223 the same numbers for HTML export.
3224 :matchers a list indicating which matchers should be used to
3225 find LaTeX fragments. Valid members of this list are:
3236 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3237 When nil, just push out a message."
3246 \[PACKAGES]
3247 \[DEFAULT-PACKAGES]
3248 % The settings below are copied from fullpage.sty
3261 "The document header used for processing LaTeX fragments.
3262 It is imperative that this header make sure that no page number
3263 appears on the page. The package defined in the variables
3264 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3266 will be appended."
3273 "Set the packages alist and make sure it has 3 elements per entry."
3277 x))
3278 val)))
3282 "Get the packages alist and make sure it has 3 elements per entry."
3286 x))
3289 ;; The following variables are defined here because is it also used
3290 ;; when formatting latex fragments. Originally it was part of the
3291 ;; LaTeX exporter, which is why the name includes "export".
3308 )
3309 "Alist of default packages to be inserted in the header.
3310 Change this only if one of the packages here causes an incompatibility
3311 with another package you are using.
3312 The packages in this list are needed by one part or another of Org-mode
3313 to function properly.
3315 - inputenc, fontenc: for basic font and character selection
3316 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3317 for interpreting the entities in `org-entities'. You can skip some of these
3318 packages if you don't use any of the symbols in it.
3319 - graphicx: for including images
3320 - float, wrapfig: for figure placement
3321 - longtable: for long tables
3322 - hyperref: for cross references
3324 Therefore you should not modify this variable unless you know what you
3325 are doing. The one reason to change it anyway is that you might be loading
3326 some other package that conflicts with one of the default packages.
3328 If SNIPPET-FLAG is t, the package also needs to be included when
3329 compiling LaTeX snippets into images for inclusion into HTML."
3342 "Alist of packages to be inserted in every LaTeX header.
3343 These will be inserted after `org-export-latex-default-packages-alist'.
3345 SNIPPET-FLAG, when t, indicates that this package is also needed when
3346 turning LaTeX snippets into images for inclusion into HTML.
3347 Make sure that you only list packages here which:
3348 - you want in every file
3349 - do not conflict with the default packages in
3350 `org-export-latex-default-packages-alist'
3351 - do not conflict with the setup in `org-format-latex-header'."
3365 "Settings for Org-mode appearance."
3370 "Non-nil means fontify only the stars in each headline.
3371 When nil, the entire headline is fontified.
3372 Changing it requires restart of `font-lock-mode' to become effective
3373 also in regions already fontified."
3378 "Non-nil means hide the first N-1 stars in a headline.
3379 This works by using the face `org-hide' for these stars. This
3380 face is white for a light background, and black for a dark
3381 background. You may have to customize the face `org-hide' to
3382 make this work.
3383 Changing it requires restart of `font-lock-mode' to become effective
3384 also in regions already fontified.
3385 You may also set this on a per-file basis by adding one of the following
3386 lines to the buffer:
3388 #+STARTUP: hidestars
3389 #+STARTUP: showstars"
3394 "List of symbols corresponding to keywords to be hidden the org buffer.
3395 For example, a value '(title) for this list will make the document's title
3396 appear in the buffer without the initial #+TITLE: keyword."
3404 "Non-nil means change the face of a headline if it is marked DONE.
3405 Normally, only the TODO/DONE keyword indicates the state of a headline.
3406 When this is non-nil, the headline after the keyword is set to the
3407 `org-headline-done' as an additional indication."
3412 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3413 Changing this variable requires a restart of Emacs to take effect."
3418 "Non-nil means fontify the whole line for headings.
3419 This is useful when setting a background color for the
3420 org-level-* faces."
3425 "Non-nil means fontify what is treated specially by the exporters."
3430 "Non-nil mean font-lock should hide the emphasis marker characters."
3435 "Non-nil means show entities as UTF8 characters.
3441 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3446 "Regular expression for matching emphasis.
3447 After a match, the match groups contain these elements:
3448 0 The match of the full regular expression, including the characters
3449 before and after the proper match
3450 1 The character before the proper match, or empty at beginning of line
3451 2 The proper match, including the leading and trailing markers
3452 3 The leading marker like * or /, indicating the type of highlighting
3453 4 The text between the emphasis markers, not including the markers
3460 "Set variable and compute the emphasis regular expression."
3464 org-emphasis-alist org-emphasis-regexp-components)
3476 ;; make sure special characters appear at the right position in the class
3488 ;; Make the regexp
3496 body1
3508 body1
3516 "Components used to build the regular expression for emphasis.
3517 This is a list with five entries. Terminology: In an emphasis string
3521 specify what is allowed/forbidden in each part:
3523 pre Chars allowed as prematch. Beginning of line will be allowed too.
3524 post Chars allowed as postmatch. End of line will be allowed too.
3525 border The chars *forbidden* as border characters.
3527 non-shy groups here, and don't allow newline here.
3528 newline The maximum number of newlines allowed in an emphasis exp.
3530 Use customize to modify this, or restart Emacs after changing it."
3549 )
3550 "Special syntax for emphasized text.
3551 Text starting and ending with a special character will be emphasized, for
3552 example *bold*, _underlined_ and /italic/. This variable sets the marker
3553 characters, the face to be used by font-lock for highlighting in Org-mode
3554 Emacs buffers, and the HTML tags to be used for this.
3555 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3556 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3557 Use customize to modify this, or restart Emacs after changing it."
3572 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3575 ;;; Miscellaneous options
3578 "Completion in Org-mode."
3583 "Non-nil means use ido completion wherever possible.
3584 Note that `ido-mode' must be active for this variable to be relevant.
3585 If you decide to turn this variable on, you might well want to turn off
3586 `org-outline-path-complete-in-steps'.
3587 See also `org-completion-use-iswitchb'."
3592 "Non-nil means use iswitchb completion wherever possible.
3593 Note that `iswitchb-mode' must be active for this variable to be relevant.
3594 If you decide to turn this variable on, you might well want to turn off
3595 `org-outline-path-complete-in-steps'.
3596 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3602 Normal means, no org-mode-specific context."
3606 ;;; Functions and variables from their packages
3607 ;; Declared here to avoid compiler warnings
3609 ;; XEmacs only
3615 ;; Emacs only
3618 ;; Various packages
3636 org-format-agenda-item "org-agenda"
3667 ;;; Autoload and prepare some org modules
3669 ;; Some table stuff that needs to be defined here, because it is used
3670 ;; by the functions setting up org-mode or checking for table context.
3683 "Detect the first line outside a table when searching from within it.
3686 ;; Autoload the functions in org-table.el that are needed by functions here.
3691 org-table-convert org-table-convert-region org-table-copy-down
3692 org-table-copy-region org-table-create
3693 org-table-create-or-convert-from-region
3694 org-table-create-with-table.el org-table-current-dline
3695 org-table-cut-region org-table-delete-column org-table-edit-field
3696 org-table-edit-formulas org-table-end org-table-eval-formula
3697 org-table-export org-table-field-info
3698 org-table-get-stored-formulas org-table-goto-column
3699 org-table-hline-and-move org-table-import org-table-insert-column
3700 org-table-insert-hline org-table-insert-row org-table-iterate
3701 org-table-justify-field-maybe org-table-kill-row
3702 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3703 org-table-move-column org-table-move-column-left
3704 org-table-move-column-right org-table-move-row
3705 org-table-move-row-down org-table-move-row-up
3706 org-table-next-field org-table-next-row org-table-paste-rectangle
3707 org-table-previous-field org-table-recalculate
3708 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3709 org-table-toggle-coordinate-overlays
3710 org-table-toggle-formula-debugger org-table-wrap-region
3711 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3712 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3713 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3716 "Return t if the cursor is inside an org-type table.
3717 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3722 org-table-line-regexp)))
3723 nil))
3727 "Return t if and only if we are at a table.el table."
3733 "If there is a table.el table nearby, recognize it and move into it."
3739 nil
3749 t
3754 t)
3755 nil)
3756 nil))
3759 "Return t if the cursor is inside a hline in a table."
3764 nil))
3769 "Apply FUNCTION to the start of all tables in the buffer."
3785 ;; Declare and autoload functions from org-exp.el & Co
3793 org-insert-export-options-template
3794 org-table-clean-before-export))
3797 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3798 org-export-region-as-ascii))
3801 org-replace-region-by-latex org-export-region-as-latex
3802 org-export-as-latex org-export-as-pdf
3803 org-export-as-pdf-and-open))
3806 org-export-as-html-batch org-export-as-html-to-buffer
3807 org-replace-region-by-html org-export-region-as-html
3808 org-export-as-html))
3811 org-replace-region-by-docbook org-export-region-as-docbook
3812 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3813 org-export-as-docbook))
3816 org-export-icalendar-all-agenda-files
3817 org-export-icalendar-combine-agenda-files))
3821 ;; Declare and autoload functions from org-agenda.el
3826 org-todo-list org-tags-view org-agenda-list-stuck-projects
3827 org-diary org-agenda-to-appt
3828 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3830 ;; Autoload org-remember
3835 org-remember-apply-template org-remember org-remember-handler)))
3840 org-capture-import-remember-templates)))
3842 ;; Autoload org-clock.el
3857 "Return non-nil if clock is currently running.
3858 The return value is actually the clock marker."
3863 "org-clock"
3865 org-clock-goto org-clock-sum org-clock-display
3866 org-clock-remove-overlays org-clock-report
3867 org-clocktable-shift org-dblock-write:clocktable
3868 org-get-clocktable org-resolve-clocks)))
3871 "If this is a CLOCK line, update it and return t.
3872 Otherwise, return nil."
3881 ts te h m s neg)
3884 nil)
3889 ;; The clock is running here
3910 t))))))
3913 "Check if the current buffer contains the running clock.
3914 If yes, offer to stop it and to save the buffer with the changes."
3923 "Check if this line starts a clock table, if yes, shift the time block."
3927 ;; Autoload org-timer.el
3931 "org-timer"
3933 org-timer-change-times-in-region
3934 org-timer-set-timer
3935 org-timer-reset-timers
3936 org-timer-show-remaining-time)))
3938 ;; Autoload org-feed.el
3942 "org-feed"
3946 ;; Autoload org-indent.el
3948 ;; Define the variable already here, to make sure we have it.
3950 "Non-nil if Org-Indent mode is enabled.
3955 "org-indent"
3958 ;; Autoload org-mobile.el
3962 "org-mobile"
3965 ;; Autoload archiving code
3966 ;; The stuff that is needed for cycling and tags has to be defined here.
3969 "Options concerning archiving in Org-mode."
3974 "The location where subtrees should be archived.
3976 The value of this variable is a string, consisting of two parts,
3977 separated by a double-colon. The first part is a filename and
3978 the second part is a headline.
3980 When the filename is omitted, archiving happens in the same file.
3981 %s in the filename will be replaced by the current file
3982 name (without the directory part). Archiving to a different file
3983 is useful to keep archived entries from contributing to the
3984 Org-mode Agenda.
3986 The archived entries will be filed as subtrees of the specified
3987 headline. When the headline is omitted, the subtrees are simply
3988 filed away at the end of the file, as top-level entries. Also in
3989 the heading you can use %s to represent the file name, this can be
3990 useful when using the same archive for a number of different files.
3992 Here are a few examples:
3994 If the current file is Projects.org, archive in file
3995 Projects.org_archive, as top-level trees. This is the default.
3998 Archive in the current file, under the top-level headline
4002 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4005 Archive in file ~/org/archive.org (absolute path), under headlines
4009 Archive in file ./basement (relative path), as level 3 trees
4012 You may set this option on a per-file basis by adding to the buffer a
4013 line like
4015 #+ARCHIVE: basement::** Finished Tasks
4017 You may also define it locally for a subtree by setting an ARCHIVE property
4018 in the entry. If such a property is found in an entry, or anywhere up
4019 the hierarchy, it will be used."
4024 "The tag that marks a subtree as archived.
4025 An archived subtree does not open during visibility cycling, and does
4026 not contribute to the agenda listings.
4027 After changing this, font-lock must be restarted in the relevant buffers to
4028 get the proper fontification."
4034 "Non-nil means the agenda will skip any items located in archived trees.
4035 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4036 variable is no longer recommended, you should leave it at the value t.
4037 Instead, use the key `v' to cycle the archives-mode in the agenda."
4043 "Non-nil means ignore archived trees when creating column view."
4049 "Non-nil means `org-cycle' will open archived trees.
4050 An archived tree is a tree marked with the tag ARCHIVE.
4051 When nil, archived trees will stay folded. You can still open them with
4052 normal outline commands like `show-all', but not with the cycling commands."
4058 "Non-nil means sparse tree construction shows matches in archived trees.
4059 When nil, matches in these trees are highlighted, but the trees are kept in
4060 collapsed state."
4066 "Re-hide all archived subtrees after a visibility state change."
4077 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4080 "Cycle subtree even if it is archived."
4087 "Re-hide all archived subtrees after a visibility state change."
4102 flag)))
4109 org-archive-to-archive-sibling org-toggle-archive-tag
4110 org-archive-subtree-default
4111 org-archive-subtree-default-with-confirmation)))
4113 ;; Autoload Column View Code
4121 org-columns-compute org-agenda-columns org-columns-remove-overlays
4124 ;; Autoload ID code
4132 org-id-get-with-outline-path-completion
4133 org-id-get-with-outline-drilling org-id-store-link
4134 org-id-goto org-id-find org-id-store-link))
4136 ;; Autoload Plotting Code
4141 ;;; Variables for pre-computed regular expressions, all buffer local
4159 "Matches a headline and puts everything into groups:
4160 group 1: the stars
4161 group 2: The todo keyword, maybe
4162 group 3: Priority cookie
4163 group 4: True headline
4167 "Printf format to make regexp to match an exact headline.
4168 This regexp will match the headline of any node which hase the exact
4169 headline text that is put into the format, but may have any TODO state,
4173 "Matches a headline and puts TODO state into group 2 if present.
4228 "Regular expression to match a plain time or time range.
4229 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4230 groups carry important information:
4231 0 the full match
4232 1 the first time, range or not
4240 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4241 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4242 groups carry important information:
4243 0 the full match
4244 7 hours of duration
4253 "Regular expression to match a timestamp time or time range.
4254 After a match, the following groups carry important information:
4255 0 the full match
4256 1 date plus weekday, for back referencing to make sure both times are on the same day
4257 2 the first time, range or not
4312 "Variable associated with STARTUP options for org-mode.
4313 Each element is a list of three items: The startup options as written
4314 in the #+STARTUP line, the corresponding variable, and the value to
4315 set this variable to if the option is found. An optional forth element PUSH
4319 "Precompute regular expressions for current buffer."
4339 kwds kws0 kwsa key log value cat arch tags const links hw dws
4340 tail sep kws1 prio props ftags drawers beamer-p
4362 ;; general TODO-like setup
4374 links)))
4380 props)))
4385 ftags
4395 l var val)
4425 ))))
4442 ;; Process the TODO keywords
4444 ;; Use the global values as if they had been given locally.
4456 kws)))
4459 kwsa nil
4462 ;; 1 2
4470 kw)
4472 kws0)
4489 ;; Process the constants
4497 ;; Process the tags.
4508 tgs))
4516 ;; Compute the regular expressions and other local variables
4524 org-drawer-regexp
4528 org-not-done-keywords
4530 org-todo-regexp
4533 org-not-done-regexp
4537 org-not-done-heading-regexp
4541 org-todo-line-regexp
4545 org-complex-heading-regexp
4550 org-complex-heading-regexp-format
4559 org-nl-done-regexp
4563 org-todo-line-tags-regexp
4568 org-looking-at-done-regexp
4573 org-deadline-time-regexp
4575 org-deadline-line-regexp
4577 org-scheduled-regexp
4579 org-scheduled-time-regexp
4581 org-closed-time-regexp
4583 org-keyword-time-regexp
4589 org-keyword-time-not-clock-regexp
4595 org-maybe-keyword-time-regexp
4601 org-planning-or-clock-line-re
4606 org-all-time-keywords
4609 org-clock-string org-closed-string))
4610 )
4615 "Return the contents of FILE, as a string."
4629 "Extract the log state setting from a TODO keyword string.
4643 "Remove a pair of parenthesis at the end of each string in LIST."
4647 x))
4648 list))
4651 "Assign fast keys to a keyword-key alist.
4652 Respect keys that are already there."
4670 ;;; Some variables used in various places
4677 "Function to be called when `C-c C-c' is used.
4681 ;; FIXME: Occasionally check by commenting these, to make sure
4682 ;; no other functions uses these, forgetting to let-bind them.
4687 ;; Defined somewhere in this file, but used before definition.
4693 ;;;; Define the Org-mode
4696 (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"))
4699 ;; We use a before-change function to check if a table might need
4700 ;; an update.
4702 "Indicates that a table might need an update.
4703 This variable is set by `org-before-change-function'.
4706 "Every change indicates that a table might need an update."
4716 ;; org-outline-regexp ought to be a defconst but is let-binding
4717 ;; in some places -- e.g. see the macro org-with-limited-levels
4721 ;;;###autoload
4723 "Outline-based notes management and organizer, alias
4726 Org-mode develops organizational tasks around a NOTES file which
4727 contains information about projects as plain text. Org-mode is
4728 implemented on top of outline-mode, which is ideal to keep the content
4729 of large files well structured. It supports ToDo items, deadlines and
4730 time stamps, which magically appear in the diary listing of the Emacs
4731 calendar. Tables are easily created with a built-in table editor.
4732 Plain text URL-like links connect to websites, emails (VM), Usenet
4733 messages (Gnus), BBDB entries, and any files related to the project.
4734 For printing and sharing of notes, an Org-mode file (or a part of it)
4735 can be exported as a structured ASCII or HTML file.
4737 The following commands are available:
4741 ;; Get rid of Outline menus, they are not needed
4742 ;; Need to do this here because define-derived-mode sets up
4743 ;; the keymap so late. Still, it is a waste to call this each time
4744 ;; we switch another buffer into org-mode.
4747 ;; Assume this is Greg's port, it uses easymenu
4772 org-display-table 4
4775 org-ellipsis)))
4780 ;; tag faces set outside customize.... force initialization.
4782 ;; Calc embedded
4788 ;; Activate before-change-function
4792 ;; Check for running clock before killing a buffer
4794 ;; Paragraphs and auto-filling
4798 ;; Beginning/end of defun
4801 ;; Next error for sparse trees
4803 ;; Make sure dependence stuff works reliably, even for users who set it
4804 ;; too late :-(
4816 ;; Comment characters
4820 ;; Align options lines
4822 'align-mode-rules-list
4827 ;; Imenu
4831 ;; Make isearch reveal context
4834 ;; Emacs 21 and XEmacs make use of the hook
4836 ;; Emacs 22 deals with this through a special variable
4840 ;; Turn on org-beamer-mode?
4843 ;; Setup the pcomplete hooks
4856 ;; If empty file that did not turn on org-mode automatically, make it to.
4881 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4891 "Return today date, considering `org-extend-today-until'."
4896 ;;;; Font-Lock stuff, including the activators
4927 "Regular expression used to analyze links.
4928 Here is what the match groups contain after a match:
4929 1: http:
4930 2: http
4931 3: path
4932 4: [desc]
4940 "Number of stacked braces for sub/superscript matching.
4941 This has to be set before loading org.el to be effective."
4946 "Create a regular expression which will match a balanced sexp.
4947 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4948 as single character strings.
4949 The regexp returned will match the entire expression including the
4950 delimiters. It will also define a single group which contains the
4951 match except for the outermost delimiters. The maximum depth of
4952 stacked delimiters is N. Escaping delimiters is not possible."
4981 "Update the link regular expressions.
4982 This should be called after the variable `org-link-types' has changed."
4986 org-link-re-with-space
4992 org-link-re-with-space2
4998 org-link-re-with-space3
5003 org-angle-link-re
5009 org-plain-link-re
5013 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5014 org-bracket-link-regexp
5016 org-bracket-link-analytic-regexp
5024 org-bracket-link-analytic-regexp++
5032 org-any-link-re
5041 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5043 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5044 "Regular expression matching time strings for analysis.
5045 This one does not require the space after the date, so it can be used
5047 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5063 "Regular expression matching a time stamp or time stamp range.
5069 "Run through the buffer and add overlays to emphasised strings."
5078 'face
5091 rtn))
5094 "Insert or change an emphasis, i.e. a font like bold or italic.
5095 If there is an active region, change that region to a new emphasis.
5096 If there is no region, just insert the marker characters and position
5097 the cursor between them.
5098 CHAR should be either the marker character, or the first character of the
5099 HTML tag associated with that emphasis. If CHAR is a space, the means
5100 to remove the emphasis of the selected region.
5101 If char is not given (for example in an interactive call) it
5102 will be prompted for."
5153 "Run through the buffer and add overlays to links."
5162 nil
5168 t)))))
5176 t)))
5179 "When non-nil, fontify code in code blocks."
5190 "Fontify #+ lines and blocks, in the correct ways."
5193 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5194 limit t)
5202 end end1 quoting block-type ovl)
5205 ;; a single line of backend-specific content
5213 ; for backend-specific code
5214 t)
5216 ;; Truly a block
5228 beg end
5236 ;; remove old background overlays
5241 ;; add a background overlay
5255 t))
5268 ;; just any other in-buffer setting, but not indented
5272 t)
5281 t)
5289 "Run through the buffer and add overlays to links."
5297 t)))
5300 "Run through the buffer and add overlays to footnotes."
5307 'keymap org-mouse-map
5308 'help-echo
5310 "Footnote definition"
5312 'font-lock-fontified t
5313 'font-lock-multiline t
5317 "Run through the buffer and add overlays to bracketed links."
5321 ;; FIXME: above we should remove the escapes.
5322 ;; but that requires another match, protecting match data,
5323 ;; a lot of overhead for font-lock.
5330 ;; We need to remove the invisible property here. Table narrowing
5331 ;; may have made some of this invisible.
5349 t)))
5352 "Run through the buffer and add overlays to dates."
5364 t)))
5373 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5377 "Run through the buffer and add overlays to target matches."
5385 'keymap org-mouse-map
5389 t)))))
5392 "Find all radio targets in this file and update the regular expression."
5407 t)))
5414 ;; This should be with the exporter code, but we also use if for font-locking
5424 "Compute regular expression for stuff treated specially by exporters."
5431 org-latex-regexps)))
5459 org-entities)))
5463 org-latex-entities)
5464 nil))
5466 ))
5467 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5470 org-export-html-special-string-regexps)))
5475 ))))
5477 'org-latex-and-specials-regexp
5482 "Run through the buffer and add overlays to links."
5486 limit t))
5500 rtn)))
5503 "Restart `font-lock-mode', to force refontification."
5509 "Return a list of all targets in this file.
5510 With optional argument RADIO, only find radio targets."
5512 rtn)
5517 rtn)))
5520 "Make regular expression matching all strings in TARGETS.
5521 The regular expression finds the targets also if there is a line break
5522 between words."
5531 x)
5532 targets
5544 t)))
5547 "Compute the outline level of the heading at point.
5548 This function assumes that the cursor is at the beginning of a line matched
5549 by `outline-regexp'. Otherwise it returns garbage.
5550 If this is called at a normal headline, the level is the number of stars.
5551 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5558 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5565 "Functions that can manipulate `org-font-lock-extra-keywords'.
5566 This is calles after `org-font-lock-extra-keywords' is defined, but before
5567 it is installed to be used by font lock. This can be useful if something
5578 ;; Call the hook
5580 ;; Headlines
5587 ;; Table lines
5590 ;; Table internals
5595 ;; Drawers
5598 ;; Properties
5602 ;; Links
5612 ;; TODO lines
5615 ;; DONE
5621 nil)
5622 ;; Priorities
5624 ;; Tags
5626 ;; Special keywords
5631 ;; Emphasis
5636 ;; Checkboxes
5637 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5642 ;; Description list items
5645 ;; ARCHIVEd headings
5647 org-outline-regexp-bol
5650 ;; Specials
5654 ;; Code
5656 ;; COMMENT
5661 ;; Blocks and meta lines
5663 )))
5666 ;; Now set the full font-lock-keywords
5673 "Toggle the composition display of entities as UTF8 characters."
5685 "Find an entity to fontify."
5691 limit t)
5703 nil))))
5706 "Fontify string S like in Org-mode."
5718 "Get the right face for match N in font-lock matching of headlines."
5731 "Get the right face for a TODO keyword KWD.
5732 If KWD is a number, get the corresponding match group."
5740 "Create a face list that inherits INHERIT, but sets the foreground color.
5741 When FACE-OR-COLOR is not a string, just return it."
5745 face-or-color)
5746 face-or-color))
5749 "Add the special tag faces."
5758 "Add the special priority faces."
5765 org-priority-faces)))
5770 "Get the right face for a TODO keyword KWD.
5771 If KWD is a number, get the corresponding match group."
5778 "Remove fontification and activation overlays from links."
5783 deactivate-mark buffer-file-name buffer-file-truename)
5786 beg end
5788 ;; also remove line-prefix and wrap-prefix properties
5790 invisible t intangible t
5791 line-prefix t wrap-prefix t
5792 org-no-flyspell t org-emphasis t)
5794 invisible t intangible t
5795 org-no-flyspell t org-emphasis t)))
5805 "Remove specific display properties that have been added by font lock.
5806 The will remove the raise properties that are used to show superscripts
5807 and subscripts."
5817 "Add raise properties to sub/superscripts."
5821 org-match-substring-regexp
5822 org-match-substring-with-braces-regexp)
5823 limit t)
5833 ;; FIXME: Should we go back one character here, for a_b^c
5834 ;; (goto-char (1- pos)) ;????????????????????
5836 t
5838 'display
5854 t)))))
5856 ;;;; Visibility cycling, including org-goto and indirect buffer
5858 ;;; Cycling
5865 ;;;###autoload
5870 "TAB-action and visibility cycling for Org-mode.
5872 This is the command invoked in Org-mode by the TAB key. Its main purpose
5873 is outline visibility cycling, but it also invokes other actions
5874 in special contexts.
5876 - When this function is called with a prefix argument, rotate the entire
5877 buffer through 3 states (global cycling)
5878 1. OVERVIEW: Show only top-level headlines.
5879 2. CONTENTS: Show all headlines of all levels, but no body text.
5880 3. SHOW ALL: Show everything.
5881 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5882 determined by the variable `org-startup-folded', and by any VISIBILITY
5883 properties in the buffer.
5884 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5885 including any drawers.
5887 - When inside a table, re-align the table and move to the next field.
5889 - When point is at the beginning of a headline, rotate the subtree started
5890 by this line through 3 different states (local cycling)
5891 1. FOLDED: Only the main headline is shown.
5892 2. CHILDREN: The main headline and the direct children are shown.
5893 From this state, you can move to one of the children
5894 and zoom in further.
5895 3. SUBTREE: Show the entire subtree, including body text.
5896 If there is no subtree, switch directly from CHILDREN to FOLDED.
5898 - When point is at the beginning of an empty headline and the variable
5899 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5900 of the headline by demoting and promoting it to likely levels. This
5901 speeds up creation document structure by pressing TAB once or several
5902 times right after creating a new headline.
5904 - When there is a numeric prefix, go up to a heading with level ARG, do
5905 a `show-subtree' and return to the previous cursor position. If ARG
5906 is negative, go up that many levels.
5908 - When point is not at the beginning of a headline, execute the global
5909 binding for TAB, which is re-indenting the line. See the option
5910 `org-cycle-emulate-tab' for details.
5912 - Special case: if point is at the beginning of the buffer and there is
5913 no headline in line 1, this function will act as if called with prefix arg
5914 (C-u TAB, same as S-TAB) also when called without prefix arg.
5915 But only if also the variable `org-cycle-global-at-bob' is t."
5925 org-inlinetask-min-level
5930 limit-level)))
5933 outline-regexp
5941 org-cycle-hook))
5945 ;; special case: use global cycling
5959 ;; Table: enter it or move to the next field.
5970 ;; Global cycling: delegate to `org-cycle-internal-global'.
5973 ;; Drawers: delegate to `org-flag-drawer'.
5981 ;; Show-subtree, ARG levels up from here.
5989 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5995 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6002 ;; From there: TAB emulation and template completion.
6026 t
6035 "Do the global cycling action."
6039 ;; We just created the overview - now do table of contents
6040 ;; This can be slow in very large buffers, so indicate action
6050 ;; We just showed the table of contents - now show everything
6058 ;; Default action: go to overview
6066 "Do the local cycling action."
6068 ;; First, determine end of headline (EOH), end of subtree or item
6069 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6093 ;; Determine end invisible part of buffer (EOL)
6095 ;; XEmacs doesn't have `next-single-char-property-change'
6105 ;; Find out what to do next and set `this-command'
6108 ;; Nothing is hidden behind this heading
6120 org-cycle-skip-children-state-if-no-children))))
6121 ;; Entire subtree is hidden in one line: children view
6127 ;; Fold every list in subtree to top-level items.
6149 ;; We just showed the children, or no children are there,
6150 ;; now show everything.
6157 ;; Default action: hide the subtree.
6164 ;;;###autoload
6166 "Cycle the global visibility. For details see `org-cycle'.
6168 With a numeric prefix, show all headlines up to that level."
6184 "Set the visibility required by startup options and properties."
6199 "Switch subtree visibilities according to :VISIBILITY: property."
6206 nil t)
6231 "Switch to overview mode, showing only top-level headlines.
6232 Really, this shows all headlines with level equal or greater than the level
6233 of the first headline in the buffer. This is important, because if the
6234 first headline is not level one, then (hide-sublevels 1) gives confusing
6235 results."
6246 "Show all headlines in the buffer, like a table of contents.
6247 With numerical argument N, show content up to level N."
6250 ;; Visit all headings and show their offspring
6257 t)
6266 "Adjust the window after a change in outline visibility.
6267 This function is the default value of the hook `org-cycle-hook'."
6277 "Remove outline overlays that do not contain non-white stuff."
6287 "Fix visibility issues after moving a subtree."
6288 ;; First, find a reasonable region to look at:
6289 ;; Start two siblings above, end three below
6307 ;; Properly fold already folded siblings
6318 "Show empty lines above all visible headlines.
6319 The region to be covered depends on STATE when called through
6320 `org-cycle-hook'. Lisp program can use t for STATE to get the
6321 entire buffer covered. Note that an empty line is only shown if there
6322 are at least `org-cycle-separator-lines' empty lines before the headline."
6332 beg end b e)
6356 ;; Never hide empty lines at the end of the file.
6366 "Move to the parent and re-show empty lines before visible headlines."
6372 "Return `org-agenda-files' list, plus all open org-mode files.
6373 This is useful for operations that need to scan all of a user's
6374 open and agenda-wise Org files."
6382 files))
6385 "Return the beginning position of the current entry."
6389 "Return the end position of the current entry."
6393 "Re-hide all drawers after a visibility state change."
6419 "Is the end of the current subtree visible?"
6424 "Move cursor to the first headline and recenter the headline.
6425 Optional argument N means put the headline into the Nth line of the window."
6431 ;;; Saving and restoring visibility
6434 "Return a list of the locations of all outline overlays.
6435 These are overlays with the `invisible' property value `outline'.
6436 The return value is a list of cons cells, with start and stop
6437 positions for each overlay.
6438 If USE-MARKERS is set, return the positions as markers."
6456 "Create visibility overlays for all positions in DATA.
6457 DATA should have been made by `org-outline-overlay-data'."
6466 data)))))
6468 ;;; Folding of blocks
6479 "Call FUNCTION at the head of all source blocks in the current buffer.
6480 Optional arguments START and END can be used to limit the range."
6492 "Toggle the visibility of all blocks in the current buffer."
6496 "Fold all blocks in the current buffer."
6502 "Unfold all blocks in the current buffer."
6508 "Toggle visibility of block at point."
6519 "Toggle the visibility of the current block."
6526 ov)
6542 ;; make the block accessible to isearch
6544 ov 'isearch-open-invisible
6555 ;; org-tab-after-check-for-cycling-hook
6557 ;; Remove overlays when changing major mode
6562 ;;; Org-goto
6568 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6584 nil)
6585 (org-defkey map "q" 'org-goto-quit)
6586 (org-defkey map "n" 'outline-next-visible-heading)
6587 (org-defkey map "p" 'outline-previous-visible-heading)
6588 (org-defkey map "f" 'outline-forward-same-level)
6589 (org-defkey map "b" 'outline-backward-same-level)
6590 (org-defkey map "u" 'outline-up-heading))
6591 (org-defkey map "/" 'org-occur)
6592 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6593 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6594 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6595 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6596 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6597 map))
6599 (defconst org-goto-help
6600 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6601 RET=jump to location [Q]uit and return to previous location
6602 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6604 (defvar org-goto-start-pos) ; dynamically scoped parameter
6606 ;; FIXME: Docstring does not mention both interfaces
6607 (defun org-goto (&optional alternative-interface)
6608 "Look up a different location in the current file, keeping current visibility.
6610 When you want look-up or go to a different location in a document, the
6611 fastest way is often to fold the entire buffer and then dive into the tree.
6612 This method has the disadvantage, that the previous location will be folded,
6613 which may not be what you want.
6615 This command works around this by showing a copy of the current buffer
6616 in an indirect buffer, in overview mode. You can dive into the tree in
6617 that copy, use org-occur and incremental search to find a location.
6618 When pressing RET or `Q', the command returns to the original buffer in
6619 which the visibility is still unchanged. After RET is will also jump to
6620 the location selected in the indirect buffer and expose the headline
6621 hierarchy above."
6622 (interactive "P")
6623 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6624 (org-refile-use-outline-path t)
6625 (org-refile-target-verify-function nil)
6626 (interface
6627 (if (not alternative-interface)
6628 org-goto-interface
6629 (if (eq org-goto-interface 'outline)
6630 'outline-path-completion
6631 'outline)))
6632 (org-goto-start-pos (point))
6633 (selected-point
6634 (if (eq interface 'outline)
6635 (car (org-get-location (current-buffer) org-goto-help))
6636 (let ((pa (org-refile-get-location "Goto")))
6637 (org-refile-check-position pa)
6638 (nth 3 pa)))))
6639 (if selected-point
6640 (progn
6641 (org-mark-ring-push org-goto-start-pos)
6642 (goto-char selected-point)
6643 (if (or (outline-invisible-p) (org-invisible-p2))
6644 (org-show-context 'org-goto)))
6645 (message "Quit"))))
6647 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6648 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6649 (defvar org-goto-local-auto-isearch-map) ; defined below
6651 (defun org-get-location (buf help)
6652 "Let the user select a location in the Org-mode buffer BUF.
6653 This function uses a recursive edit. It returns the selected position
6654 or nil."
6655 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6656 (isearch-hide-immediately nil)
6657 (isearch-search-fun-function
6658 (lambda () 'org-goto-local-search-headings))
6659 (org-goto-selected-point org-goto-exit-command)
6660 (pop-up-frames nil)
6661 (special-display-buffer-names nil)
6662 (special-display-regexps nil)
6663 (special-display-function nil))
6664 (save-excursion
6665 (save-window-excursion
6666 (delete-other-windows)
6667 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6668 (org-pop-to-buffer-same-window
6669 (condition-case nil
6670 (make-indirect-buffer (current-buffer) "*org-goto*")
6671 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6672 (with-output-to-temp-buffer "*Help*"
6673 (princ help))
6674 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6675 (setq buffer-read-only nil)
6676 (let ((org-startup-truncated t)
6677 (org-startup-folded nil)
6678 (org-startup-align-all-tables nil))
6679 (org-mode)
6680 (org-overview))
6681 (setq buffer-read-only t)
6682 (if (and (boundp 'org-goto-start-pos)
6683 (integer-or-marker-p org-goto-start-pos))
6684 (let ((org-show-hierarchy-above t)
6685 (org-show-siblings t)
6686 (org-show-following-heading t))
6687 (goto-char org-goto-start-pos)
6688 (and (outline-invisible-p) (org-show-context)))
6689 (goto-char (point-min)))
6690 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6691 (message "Select location and press RET")
6692 (use-local-map org-goto-map)
6693 (recursive-edit)
6694 ))
6695 (kill-buffer "*org-goto*")
6696 (cons org-goto-selected-point org-goto-exit-command)))
6698 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6699 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6700 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6701 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6703 (defun org-goto-local-search-headings (string bound noerror)
6704 "Search and make sure that any matches are in headlines."
6705 (catch 'return
6706 (while (if isearch-forward
6707 (search-forward string bound noerror)
6708 (search-backward string bound noerror))
6709 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6710 (and (member :headline context)
6711 (not (member :tags context))))
6712 (throw 'return (point))))))
6714 (defun org-goto-local-auto-isearch ()
6715 "Start isearch."
6716 (interactive)
6717 (goto-char (point-min))
6718 (let ((keys (this-command-keys)))
6719 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6720 (isearch-mode t)
6721 (isearch-process-search-char (string-to-char keys)))))
6723 (defun org-goto-ret (&optional arg)
6724 "Finish `org-goto' by going to the new location."
6725 (interactive "P")
6726 (setq org-goto-selected-point (point)
6727 org-goto-exit-command 'return)
6728 (throw 'exit nil))
6730 (defun org-goto-left ()
6731 "Finish `org-goto' by going to the new location."
6732 (interactive)
6733 (if (org-on-heading-p)
6734 (progn
6735 (beginning-of-line 1)
6736 (setq org-goto-selected-point (point)
6737 org-goto-exit-command 'left)
6738 (throw 'exit nil))
6739 (error "Not on a heading")))
6741 (defun org-goto-right ()
6742 "Finish `org-goto' by going to the new location."
6743 (interactive)
6744 (if (org-on-heading-p)
6745 (progn
6746 (setq org-goto-selected-point (point)
6747 org-goto-exit-command 'right)
6748 (throw 'exit nil))
6749 (error "Not on a heading")))
6751 (defun org-goto-quit ()
6752 "Finish `org-goto' without cursor motion."
6753 (interactive)
6754 (setq org-goto-selected-point nil)
6755 (setq org-goto-exit-command 'quit)
6756 (throw 'exit nil))
6758 ;;; Indirect buffer display of subtrees
6760 (defvar org-indirect-dedicated-frame nil
6761 "This is the frame being used for indirect tree display.")
6762 (defvar org-last-indirect-buffer nil)
6764 (defun org-tree-to-indirect-buffer (&optional arg)
6765 "Create indirect buffer and narrow it to current subtree.
6766 With numerical prefix ARG, go up to this level and then take that tree.
6767 If ARG is negative, go up that many levels.
6768 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6769 indirect buffer previously made with this command, to avoid proliferation of
6770 indirect buffers. However, when you call the command with a \
6772 when `org-indirect-buffer-display' is `new-frame', the last buffer
6773 is kept so that you can work with several indirect buffers at the same time.
6774 If `org-indirect-buffer-display' is `dedicated-frame', the \
6776 requests that a new frame be made for the new buffer, so that the dedicated
6777 frame is not changed."
6778 (interactive "P")
6779 (let ((cbuf (current-buffer))
6780 (cwin (selected-window))
6781 (pos (point))
6782 beg end level heading ibuf)
6783 (save-excursion
6784 (org-back-to-heading t)
6785 (when (numberp arg)
6786 (setq level (org-outline-level))
6787 (if (< arg 0) (setq arg (+ level arg)))
6788 (while (> (setq level (org-outline-level)) arg)
6789 (outline-up-heading 1 t)))
6790 (setq beg (point)
6791 heading (org-get-heading))
6792 (org-end-of-subtree t t)
6793 (if (org-on-heading-p) (backward-char 1))
6794 (setq end (point)))
6795 (if (and (buffer-live-p org-last-indirect-buffer)
6796 (not (eq org-indirect-buffer-display 'new-frame))
6797 (not arg))
6798 (kill-buffer org-last-indirect-buffer))
6799 (setq ibuf (org-get-indirect-buffer cbuf)
6800 org-last-indirect-buffer ibuf)
6801 (cond
6802 ((or (eq org-indirect-buffer-display 'new-frame)
6803 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6804 (select-frame (make-frame))
6805 (delete-other-windows)
6806 (org-pop-to-buffer-same-window ibuf)
6807 (org-set-frame-title heading))
6808 ((eq org-indirect-buffer-display 'dedicated-frame)
6809 (raise-frame
6810 (select-frame (or (and org-indirect-dedicated-frame
6811 (frame-live-p org-indirect-dedicated-frame)
6812 org-indirect-dedicated-frame)
6813 (setq org-indirect-dedicated-frame (make-frame)))))
6814 (delete-other-windows)
6815 (org-pop-to-buffer-same-window ibuf)
6816 (org-set-frame-title (concat "Indirect: " heading)))
6817 ((eq org-indirect-buffer-display 'current-window)
6818 (org-pop-to-buffer-same-window ibuf))
6819 ((eq org-indirect-buffer-display 'other-window)
6820 (pop-to-buffer ibuf))
6821 (t (error "Invalid value")))
6822 (if (featurep 'xemacs)
6823 (save-excursion (org-mode) (turn-on-font-lock)))
6824 (narrow-to-region beg end)
6825 (show-all)
6826 (goto-char pos)
6827 (and (window-live-p cwin) (select-window cwin))))
6829 (defun org-get-indirect-buffer (&optional buffer)
6830 (setq buffer (or buffer (current-buffer)))
6831 (let ((n 1) (base (buffer-name buffer)) bname)
6832 (while (buffer-live-p
6833 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6834 (setq n (1+ n)))
6835 (condition-case nil
6836 (make-indirect-buffer buffer bname 'clone)
6837 (error (make-indirect-buffer buffer bname)))))
6839 (defun org-set-frame-title (title)
6840 "Set the title of the current frame to the string TITLE."
6841 ;; FIXME: how to name a single frame in XEmacs???
6842 (unless (featurep 'xemacs)
6843 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6845 ;;;; Structure editing
6847 ;;; Inserting headlines
6849 (defun org-previous-line-empty-p ()
6850 (save-excursion
6851 (and (not (bobp))
6852 (or (beginning-of-line 0) t)
6853 (save-match-data
6856 (defun org-insert-heading (&optional force-heading invisible-ok)
6857 "Insert a new heading or item with same depth at point.
6858 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6859 If point is at the beginning of a headline, insert a sibling before the
6860 current headline. If point is not at the beginning, split the line,
6861 create the new headline with the text in the current line after point
6862 \(but see also the variable `org-M-RET-may-split-line').
6864 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6865 This is important for non-interactive uses of the command."
6866 (interactive "P")
6867 (if (or (= (buffer-size) 0)
6868 (and (not (save-excursion
6869 (and (ignore-errors (org-back-to-heading invisible-ok))
6870 (org-on-heading-p))))
6871 (or force-heading (not (org-in-item-p)))))
6872 (progn
6874 (run-hooks 'org-insert-heading-hook))
6875 (when (or force-heading (not (org-insert-item)))
6876 (let* ((empty-line-p nil)
6877 (level nil)
6878 (on-heading (org-on-heading-p))
6879 (head (save-excursion
6880 (condition-case nil
6881 (progn
6882 (org-back-to-heading invisible-ok)
6883 (when (and (not on-heading)
6884 (featurep 'org-inlinetask)
6885 (integerp org-inlinetask-min-level)
6886 (>= (length (match-string 0))
6887 org-inlinetask-min-level))
6888 ;; Find a heading level before the inline task
6889 (while (and (setq level (org-up-heading-safe))
6890 (>= level org-inlinetask-min-level)))
6891 (if (org-on-heading-p)
6892 (org-back-to-heading invisible-ok)
6893 (error "This should not happen")))
6894 (setq empty-line-p (org-previous-line-empty-p))
6895 (match-string 0))
6896 (error "*"))))
6897 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6898 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6899 pos hide-previous previous-pos)
6900 (cond
6901 ((and (org-on-heading-p) (bolp)
6902 (or (bobp)
6903 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6904 ;; insert before the current line
6905 (open-line (if blank 2 1)))
6906 ((and (bolp)
6907 (not org-insert-heading-respect-content)
6908 (or (bobp)
6909 (save-excursion
6910 (backward-char 1) (not (outline-invisible-p)))))
6911 ;; insert right here
6912 nil)
6913 (t
6914 ;; somewhere in the line
6915 (save-excursion
6916 (setq previous-pos (point-at-bol))
6917 (end-of-line)
6918 (setq hide-previous (outline-invisible-p)))
6919 (and org-insert-heading-respect-content (org-show-subtree))
6920 (let ((split
6921 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6922 (save-excursion
6923 (let ((p (point)))
6924 (goto-char (point-at-bol))
6925 (and (looking-at org-complex-heading-regexp)
6926 (> p (match-beginning 4)))))))
6927 tags pos)
6928 (cond
6929 (org-insert-heading-respect-content
6930 (org-end-of-subtree nil t)
6931 (when (featurep 'org-inlinetask)
6932 (while (and (not (eobp))
6934 (>= (length (match-string 1))
6935 org-inlinetask-min-level))
6936 (org-end-of-subtree nil t)))
6937 (or (bolp) (newline))
6938 (or (org-previous-line-empty-p)
6939 (and blank (newline)))
6940 (open-line 1))
6941 ((org-on-heading-p)
6942 (when hide-previous
6943 (show-children)
6944 (org-show-entry))
6946 (setq tags (and (match-end 2) (match-string 2)))
6947 (and (match-end 1)
6948 (delete-region (match-beginning 1) (match-end 1)))
6949 (setq pos (point-at-bol))
6950 (or split (end-of-line 1))
6951 (delete-horizontal-space)
6953 (buffer-substring (point-at-bol) (point)))
6954 (insert " "))
6955 (newline (if blank 2 1))
6956 (when tags
6957 (save-excursion
6958 (goto-char pos)
6959 (end-of-line 1)
6960 (insert " " tags)
6961 (org-set-tags nil 'align))))
6962 (t
6963 (or split (end-of-line 1))
6964 (newline (if blank 2 1)))))))
6965 (insert head) (just-one-space)
6966 (setq pos (point))
6967 (end-of-line 1)
6968 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6969 (when (and org-insert-heading-respect-content hide-previous)
6970 (save-excursion
6971 (goto-char previous-pos)
6972 (hide-subtree)))
6973 (run-hooks 'org-insert-heading-hook)))))
6975 (defun org-get-heading (&optional no-tags no-todo)
6976 "Return the heading of the current entry, without the stars.
6977 When NO-TAGS is non-nil, don't include tags.
6978 When NO-TODO is non-nil, don't include TODO keywords."
6979 (save-excursion
6980 (org-back-to-heading t)
6981 (cond
6982 ((and no-tags no-todo)
6983 (looking-at org-complex-heading-regexp)
6984 (match-string 4))
6985 (no-tags
6987 (match-string 1))
6988 (no-todo
6991 (match-string 2))
6993 (match-string 1)))))
6995 (defun org-heading-components ()
6996 "Return the components of the current heading.
6997 This is a list with the following elements:
6998 - the level as an integer
6999 - the reduced level, different if `org-odd-levels-only' is set.
7000 - the TODO keyword, or nil
7001 - the priority character, like ?A, or nil if no priority is given
7002 - the headline text itself, or the tags string if no headline text
7003 - the tags string, or nil."
7004 (save-excursion
7005 (org-back-to-heading t)
7006 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7007 (list (length (match-string 1))
7008 (org-reduced-level (length (match-string 1)))
7009 (org-match-string-no-properties 2)
7010 (and (match-end 3) (aref (match-string 3) 2))
7011 (org-match-string-no-properties 4)
7012 (org-match-string-no-properties 5)))))
7014 (defun org-get-entry ()
7015 "Get the entry text, after heading, entire subtree."
7016 (save-excursion
7017 (org-back-to-heading t)
7018 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7020 (defun org-insert-heading-after-current ()
7021 "Insert a new heading with same level as current, after current subtree."
7022 (interactive)
7023 (org-back-to-heading)
7024 (org-insert-heading)
7025 (org-move-subtree-down)
7026 (end-of-line 1))
7028 (defun org-insert-heading-respect-content ()
7029 (interactive)
7030 (let ((org-insert-heading-respect-content t))
7031 (org-insert-heading t)))
7033 (defun org-insert-todo-heading-respect-content (&optional force-state)
7034 (interactive "P")
7035 (let ((org-insert-heading-respect-content t))
7036 (org-insert-todo-heading force-state t)))
7038 (defun org-insert-todo-heading (arg &optional force-heading)
7039 "Insert a new heading with the same level and TODO state as current heading.
7040 If the heading has no TODO state, or if the state is DONE, use the first
7041 state (TODO by default). Also with prefix arg, force first state."
7042 (interactive "P")
7043 (when (or force-heading (not (org-insert-item 'checkbox)))
7044 (org-insert-heading force-heading)
7045 (save-excursion
7046 (org-back-to-heading)
7047 (outline-previous-heading)
7048 (looking-at org-todo-line-regexp))
7049 (let*
7050 ((new-mark-x
7051 (if (or arg
7052 (not (match-beginning 2))
7053 (member (match-string 2) org-done-keywords))
7054 (car org-todo-keywords-1)
7055 (match-string 2)))
7056 (new-mark
7057 (or
7058 (run-hook-with-args-until-success
7059 'org-todo-get-default-hook new-mark-x nil)
7060 new-mark-x)))
7061 (beginning-of-line 1)
7062 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7063 (if org-treat-insert-todo-heading-as-state-change
7064 (org-todo new-mark)
7065 (insert new-mark " "))))
7066 (when org-provide-todo-statistics
7067 (org-update-parent-todo-statistics))))
7069 (defun org-insert-subheading (arg)
7070 "Insert a new subheading and demote it.
7071 Works for outline headings and for plain lists alike."
7072 (interactive "P")
7073 (org-insert-heading arg)
7074 (cond
7075 ((org-on-heading-p) (org-do-demote))
7076 ((org-at-item-p) (org-indent-item))))
7078 (defun org-insert-todo-subheading (arg)
7079 "Insert a new subheading with TODO keyword or checkbox and demote it.
7080 Works for outline headings and for plain lists alike."
7081 (interactive "P")
7082 (org-insert-todo-heading arg)
7083 (cond
7084 ((org-on-heading-p) (org-do-demote))
7085 ((org-at-item-p) (org-indent-item))))
7087 ;;; Promotion and Demotion
7089 (defvar org-after-demote-entry-hook nil
7090 "Hook run after an entry has been demoted.
7091 The cursor will be at the beginning of the entry.
7092 When a subtree is being demoted, the hook will be called for each node.")
7094 (defvar org-after-promote-entry-hook nil
7095 "Hook run after an entry has been promoted.
7096 The cursor will be at the beginning of the entry.
7097 When a subtree is being promoted, the hook will be called for each node.")
7099 (defun org-promote-subtree ()
7100 "Promote the entire subtree.
7101 See also `org-promote'."
7102 (interactive)
7103 (save-excursion
7104 (org-with-limited-levels (org-map-tree 'org-promote)))
7105 (org-fix-position-after-promote))
7107 (defun org-demote-subtree ()
7108 "Demote the entire subtree. See `org-demote'.
7109 See also `org-promote'."
7110 (interactive)
7111 (save-excursion
7112 (org-with-limited-levels (org-map-tree 'org-demote)))
7113 (org-fix-position-after-promote))
7116 (defun org-do-promote ()
7117 "Promote the current heading higher up the tree.
7118 If the region is active in `transient-mark-mode', promote all headings
7119 in the region."
7120 (interactive)
7121 (save-excursion
7122 (if (org-region-active-p)
7123 (org-map-region 'org-promote (region-beginning) (region-end))
7124 (org-promote)))
7125 (org-fix-position-after-promote))
7127 (defun org-do-demote ()
7128 "Demote the current heading lower down the tree.
7129 If the region is active in `transient-mark-mode', demote all headings
7130 in the region."
7131 (interactive)
7132 (save-excursion
7133 (if (org-region-active-p)
7134 (org-map-region 'org-demote (region-beginning) (region-end))
7135 (org-demote)))
7136 (org-fix-position-after-promote))
7138 (defun org-fix-position-after-promote ()
7139 "Make sure that after pro/demotion cursor position is right."
7140 (let ((pos (point)))
7141 (when (save-excursion
7142 (beginning-of-line 1)
7143 (looking-at org-todo-line-regexp)
7144 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7145 (cond ((eobp) (insert " "))
7146 ((eolp) (insert " "))
7147 ((equal (char-after) ?\ ) (forward-char 1))))))
7149 (defun org-current-level ()
7150 "Return the level of the current entry, or nil if before the first headline.
7151 The level is the number of stars at the beginning of the headline."
7152 (save-excursion
7153 (org-with-limited-levels
7154 (ignore-errors
7155 (org-back-to-heading t)
7156 (funcall outline-level)))))
7158 (defun org-get-previous-line-level ()
7159 "Return the outline depth of the last headline before the current line.
7160 Returns 0 for the first headline in the buffer, and nil if before the
7161 first headline."
7162 (let ((current-level (org-current-level))
7163 (prev-level (when (> (line-number-at-pos) 1)
7164 (save-excursion
7165 (beginning-of-line 0)
7166 (org-current-level)))))
7167 (cond ((null current-level) nil) ; Before first headline
7168 ((null prev-level) 0) ; At first headline
7169 (prev-level))))
7171 (defun org-reduced-level (l)
7172 "Compute the effective level of a heading.
7173 This takes into account the setting of `org-odd-levels-only'."
7174 (cond
7175 ((zerop l) 0)
7176 (org-odd-levels-only (1+ (floor (/ l 2))))
7177 (t l)))
7179 (defun org-level-increment ()
7180 "Return the number of stars that will be added or removed at a
7181 time to headlines when structure editing, based on the value of
7182 `org-odd-levels-only'."
7183 (if org-odd-levels-only 2 1))
7185 (defun org-get-valid-level (level &optional change)
7186 "Rectify a level change under the influence of `org-odd-levels-only'
7187 LEVEL is a current level, CHANGE is by how much the level should be
7188 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7189 even level numbers will become the next higher odd number."
7190 (if org-odd-levels-only
7191 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7192 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7193 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7194 (max 1 (+ level (or change 0)))))
7196 (if (boundp 'define-obsolete-function-alias)
7197 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7198 (define-obsolete-function-alias 'org-get-legal-level
7199 'org-get-valid-level)
7200 (define-obsolete-function-alias 'org-get-legal-level
7201 'org-get-valid-level "23.1")))
7203 (defun org-promote ()
7204 "Promote the current heading higher up the tree.
7205 If the region is active in `transient-mark-mode', promote all headings
7206 in the region."
7207 (org-back-to-heading t)
7208 (let* ((level (save-match-data (funcall outline-level)))
7209 (after-change-functions (remove 'flyspell-after-change-function
7210 after-change-functions))
7211 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7212 (diff (abs (- level (length up-head) -1))))
7213 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7214 (replace-match up-head nil t)
7215 ;; Fixup tag positioning
7216 (and org-auto-align-tags (org-set-tags nil t))
7217 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7218 (run-hooks 'org-after-promote-entry-hook)))
7220 (defun org-demote ()
7221 "Demote the current heading lower down the tree.
7222 If the region is active in `transient-mark-mode', demote all headings
7223 in the region."
7224 (org-back-to-heading t)
7225 (let* ((level (save-match-data (funcall outline-level)))
7226 (after-change-functions (remove 'flyspell-after-change-function
7227 after-change-functions))
7228 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7229 (diff (abs (- level (length down-head) -1))))
7230 (replace-match down-head nil t)
7231 ;; Fixup tag positioning
7232 (and org-auto-align-tags (org-set-tags nil t))
7233 (if org-adapt-indentation (org-fixup-indentation diff))
7234 (run-hooks 'org-after-demote-entry-hook)))
7236 (defun org-cycle-level ()
7237 "Cycle the level of an empty headline through possible states.
7238 This goes first to child, then to parent, level, then up the hierarchy.
7239 After top level, it switches back to sibling level."
7240 (interactive)
7241 (let ((org-adapt-indentation nil))
7242 (when (org-point-at-end-of-empty-headline)
7243 (setq this-command 'org-cycle-level) ; Only needed for caching
7244 (let ((cur-level (org-current-level))
7245 (prev-level (org-get-previous-line-level)))
7246 (cond
7247 ;; If first headline in file, promote to top-level.
7248 ((= prev-level 0)
7249 (loop repeat (/ (- cur-level 1) (org-level-increment))
7250 do (org-do-promote)))
7251 ;; If same level as prev, demote one.
7252 ((= prev-level cur-level)
7253 (org-do-demote))
7254 ;; If parent is top-level, promote to top level if not already.
7255 ((= prev-level 1)
7256 (loop repeat (/ (- cur-level 1) (org-level-increment))
7257 do (org-do-promote)))
7258 ;; If top-level, return to prev-level.
7259 ((= cur-level 1)
7260 (loop repeat (/ (- prev-level 1) (org-level-increment))
7261 do (org-do-demote)))
7262 ;; If less than prev-level, promote one.
7263 ((< cur-level prev-level)
7264 (org-do-promote))
7265 ;; If deeper than prev-level, promote until higher than
7266 ;; prev-level.
7267 ((> cur-level prev-level)
7268 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7269 do (org-do-promote))))
7270 t))))
7272 (defun org-map-tree (fun)
7273 "Call FUN for every heading underneath the current one."
7274 (org-back-to-heading)
7275 (let ((level (funcall outline-level)))
7276 (save-excursion
7277 (funcall fun)
7278 (while (and (progn
7279 (outline-next-heading)
7280 (> (funcall outline-level) level))
7281 (not (eobp)))
7282 (funcall fun)))))
7284 (defun org-map-region (fun beg end)
7285 "Call FUN for every heading between BEG and END."
7286 (let ((org-ignore-region t))
7287 (save-excursion
7288 (setq end (copy-marker end))
7289 (goto-char beg)
7290 (if (and (re-search-forward org-outline-regexp-bol nil t)
7291 (< (point) end))
7292 (funcall fun))
7293 (while (and (progn
7294 (outline-next-heading)
7295 (< (point) end))
7296 (not (eobp)))
7297 (funcall fun)))))
7299 (defun org-fixup-indentation (diff)
7300 "Change the indentation in the current entry by DIFF.
7301 However, if any line in the current entry has no indentation, or if it
7302 would end up with no indentation after the change, nothing at all is done."
7303 (save-excursion
7304 (let ((end (save-excursion (outline-next-heading)
7305 (point-marker)))
7306 (prohibit (if (> diff 0)
7309 col)
7310 (unless (save-excursion (end-of-line 1)
7311 (re-search-forward prohibit end t))
7312 (while (and (< (point) end)
7314 (goto-char (match-end 0))
7315 (setq col (current-column))
7316 (if (< diff 0) (replace-match ""))
7317 (org-indent-to-column (+ diff col))))
7318 (move-marker end nil))))
7320 (defun org-convert-to-odd-levels ()
7321 "Convert an org-mode file with all levels allowed to one with odd levels.
7322 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7323 level 5 etc."
7324 (interactive)
7325 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7326 (let ((outline-level 'org-outline-level)
7327 (org-odd-levels-only nil) n)
7328 (save-excursion
7329 (goto-char (point-min))
7331 (setq n (- (length (match-string 0)) 2))
7332 (while (>= (setq n (1- n)) 0)
7333 (org-demote))
7334 (end-of-line 1))))))
7336 (defun org-convert-to-oddeven-levels ()
7337 "Convert an org-mode file with only odd levels to one with odd/even levels.
7338 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7339 file contains a section with an even level, conversion would
7340 destroy the structure of the file. An error is signaled in this
7341 case."
7342 (interactive)
7343 (goto-char (point-min))
7344 ;; First check if there are no even levels
7346 (org-show-context t)
7347 (error "Not all levels are odd in this file. Conversion not possible"))
7348 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7349 (let ((outline-regexp org-outline-regexp)
7350 (outline-level 'org-outline-level)
7351 (org-odd-levels-only nil) n)
7352 (save-excursion
7353 (goto-char (point-min))
7355 (setq n (/ (1- (length (match-string 0))) 2))
7356 (while (>= (setq n (1- n)) 0)
7357 (org-promote))
7358 (end-of-line 1))))))
7360 (defun org-tr-level (n)
7361 "Make N odd if required."
7362 (if org-odd-levels-only (1+ (/ n 2)) n))
7364 ;;; Vertical tree motion, cutting and pasting of subtrees
7366 (defun org-move-subtree-up (&optional arg)
7367 "Move the current subtree up past ARG headlines of the same level."
7368 (interactive "p")
7369 (org-move-subtree-down (- (prefix-numeric-value arg))))
7371 (defun org-move-subtree-down (&optional arg)
7372 "Move the current subtree down past ARG headlines of the same level."
7373 (interactive "p")
7374 (setq arg (prefix-numeric-value arg))
7375 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7376 'org-get-last-sibling))
7377 (ins-point (make-marker))
7378 (cnt (abs arg))
7379 (col (current-column))
7380 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7381 ;; Select the tree
7382 (org-back-to-heading)
7383 (setq beg0 (point))
7384 (save-excursion
7385 (setq ne-beg (org-back-over-empty-lines))
7386 (setq beg (point)))
7387 (save-match-data
7388 (save-excursion (outline-end-of-heading)
7389 (setq folded (outline-invisible-p)))
7390 (outline-end-of-subtree))
7391 (outline-next-heading)
7392 (setq ne-end (org-back-over-empty-lines))
7393 (setq end (point))
7394 (goto-char beg0)
7395 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7396 ;; include less whitespace
7397 (save-excursion
7398 (goto-char beg)
7399 (forward-line (- ne-beg ne-end))
7400 (setq beg (point))))
7401 ;; Find insertion point, with error handling
7402 (while (> cnt 0)
7403 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7404 (progn (goto-char beg0)
7405 (error "Cannot move past superior level or buffer limit")))
7406 (setq cnt (1- cnt)))
7407 (if (> arg 0)
7408 ;; Moving forward - still need to move over subtree
7409 (progn (org-end-of-subtree t t)
7410 (save-excursion
7411 (org-back-over-empty-lines)
7412 (or (bolp) (newline)))))
7413 (setq ne-ins (org-back-over-empty-lines))
7414 (move-marker ins-point (point))
7415 (setq txt (buffer-substring beg end))
7416 (org-save-markers-in-region beg end)
7417 (delete-region beg end)
7418 (org-remove-empty-overlays-at beg)
7419 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7420 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7422 (let ((bbb (point)))
7423 (insert-before-markers txt)
7424 (org-reinstall-markers-in-region bbb)
7425 (move-marker ins-point bbb))
7427 (setq ins-end (point))
7428 (goto-char ins-point)
7429 (org-skip-whitespace)
7430 (when (and (< arg 0)
7431 (org-first-sibling-p)
7432 (> ne-ins ne-beg))
7433 ;; Move whitespace back to beginning
7434 (save-excursion
7435 (goto-char ins-end)
7436 (let ((kill-whole-line t))
7437 (kill-line (- ne-ins ne-beg)) (point)))
7439 (move-marker ins-point nil)
7440 (if folded
7441 (hide-subtree)
7442 (org-show-entry)
7443 (show-children)
7444 (org-cycle-hide-drawers 'children))
7445 (org-clean-visibility-after-subtree-move)
7446 ;; move back to the initial column we were at
7447 (move-to-column col)))
7449 (defvar org-subtree-clip ""
7450 "Clipboard for cut and paste of subtrees.
7451 This is actually only a copy of the kill, because we use the normal kill
7452 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7454 (defvar org-subtree-clip-folded nil
7455 "Was the last copied subtree folded?
7456 This is used to fold the tree back after pasting.")
7458 (defun org-cut-subtree (&optional n)
7459 "Cut the current subtree into the clipboard.
7460 With prefix arg N, cut this many sequential subtrees.
7461 This is a short-hand for marking the subtree and then cutting it."
7462 (interactive "p")
7463 (org-copy-subtree n 'cut))
7465 (defun org-copy-subtree (&optional n cut force-store-markers)
7466 "Cut the current subtree into the clipboard.
7467 With prefix arg N, cut this many sequential subtrees.
7468 This is a short-hand for marking the subtree and then copying it.
7469 If CUT is non-nil, actually cut the subtree.
7470 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7471 of some markers in the region, even if CUT is non-nil. This is
7472 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7473 (interactive "p")
7474 (let (beg end folded (beg0 (point)))
7475 (if (org-called-interactively-p 'any)
7476 (org-back-to-heading nil) ; take what looks like a subtree
7477 (org-back-to-heading t)) ; take what is really there
7478 (org-back-over-empty-lines)
7479 (setq beg (point))
7481 (save-match-data
7482 (save-excursion (outline-end-of-heading)
7483 (setq folded (outline-invisible-p)))
7484 (condition-case nil
7485 (org-forward-same-level (1- n) t)
7486 (error nil))
7487 (org-end-of-subtree t t))
7488 (org-back-over-empty-lines)
7489 (setq end (point))
7490 (goto-char beg0)
7491 (when (> end beg)
7492 (setq org-subtree-clip-folded folded)
7493 (when (or cut force-store-markers)
7494 (org-save-markers-in-region beg end))
7495 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7496 (setq org-subtree-clip (current-kill 0))
7497 (message "%s: Subtree(s) with %d characters"
7498 (if cut "Cut" "Copied")
7499 (length org-subtree-clip)))))
7501 (defun org-paste-subtree (&optional level tree for-yank)
7502 "Paste the clipboard as a subtree, with modification of headline level.
7503 The entire subtree is promoted or demoted in order to match a new headline
7504 level.
7506 If the cursor is at the beginning of a headline, the same level as
7507 that headline is used to paste the tree
7509 If not, the new level is derived from the *visible* headings
7510 before and after the insertion point, and taken to be the inferior headline
7511 level of the two. So if the previous visible heading is level 3 and the
7512 next is level 4 (or vice versa), level 4 will be used for insertion.
7513 This makes sure that the subtree remains an independent subtree and does
7514 not swallow low level entries.
7516 You can also force a different level, either by using a numeric prefix
7517 argument, or by inserting the heading marker by hand. For example, if the
7520 If optional TREE is given, use this text instead of the kill ring.
7522 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7523 move back over whitespace before inserting, and move point to the end of
7524 the inserted text when done."
7525 (interactive "P")
7526 (setq tree (or tree (and kill-ring (current-kill 0))))
7527 (unless (org-kill-is-subtree-p tree)
7528 (error "%s"
7529 (substitute-command-keys
7531 (org-with-limited-levels
7532 (let* ((visp (not (outline-invisible-p)))
7533 (txt tree)
7535 (old-level (if (string-match org-outline-regexp-bol txt)
7536 (- (match-end 0) (match-beginning 0) 1)
7537 -1))
7538 (force-level (cond (level (prefix-numeric-value level))
7540 (string-match
7542 (point-at-bol) (point))))
7543 (- (match-end 1) (match-beginning 1)))
7544 ((and (bolp)
7545 (looking-at org-outline-regexp))
7546 (- (match-end 0) (point) 1))
7547 (t nil)))
7548 (previous-level (save-excursion
7549 (condition-case nil
7550 (progn
7551 (outline-previous-visible-heading 1)
7552 (if (looking-at ^re_)
7553 (- (match-end 0) (match-beginning 0) 1)
7554 1))
7555 (error 1))))
7556 (next-level (save-excursion
7557 (condition-case nil
7558 (progn
7559 (or (looking-at org-outline-regexp)
7560 (outline-next-visible-heading 1))
7561 (if (looking-at ^re_)
7562 (- (match-end 0) (match-beginning 0) 1)
7563 1))
7564 (error 1))))
7565 (new-level (or force-level (max previous-level next-level)))
7566 (shift (if (or (= old-level -1)
7567 (= new-level -1)
7568 (= old-level new-level))
7569 0
7570 (- new-level old-level)))
7571 (delta (if (> shift 0) -1 1))
7572 (func (if (> shift 0) 'org-demote 'org-promote))
7573 (org-odd-levels-only nil)
7574 beg end newend)
7575 ;; Remove the forced level indicator
7576 (if force-level
7577 (delete-region (point-at-bol) (point)))
7578 ;; Paste
7579 (beginning-of-line (if (bolp) 1 2))
7580 (unless for-yank (org-back-over-empty-lines))
7581 (setq beg (point))
7582 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7583 (insert-before-markers txt)
7585 (setq newend (point))
7586 (org-reinstall-markers-in-region beg)
7587 (setq end (point))
7588 (goto-char beg)
7590 (setq beg (point))
7591 (if (and (outline-invisible-p) visp)
7592 (save-excursion (outline-show-heading)))
7593 ;; Shift if necessary
7594 (unless (= shift 0)
7595 (save-restriction
7596 (narrow-to-region beg end)
7597 (while (not (= shift 0))
7598 (org-map-region func (point-min) (point-max))
7599 (setq shift (+ delta shift)))
7600 (goto-char (point-min))
7601 (setq newend (point-max))))
7602 (when (or (org-called-interactively-p 'interactive) for-yank)
7603 (message "Clipboard pasted as level %d subtree" new-level))
7604 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7605 kill-ring
7606 (eq org-subtree-clip (current-kill 0))
7607 org-subtree-clip-folded)
7608 ;; The tree was folded before it was killed/copied
7609 (hide-subtree))
7610 (and for-yank (goto-char newend)))))
7612 (defun org-kill-is-subtree-p (&optional txt)
7613 "Check if the current kill is an outline subtree, or a set of trees.
7614 Returns nil if kill does not start with a headline, or if the first
7615 headline level is not the largest headline level in the tree.
7616 So this will actually accept several entries of equal levels as well,
7617 which is OK for `org-paste-subtree'.
7618 If optional TXT is given, check this string instead of the current kill."
7619 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7620 (re (org-get-limited-outline-regexp))
7621 (^re (concat "^" re))
7622 (start-level (and kill
7623 (string-match
7625 kill)
7626 (- (match-end 2) (match-beginning 2) 1)))
7627 (start (1+ (or (match-beginning 2) -1))))
7628 (if (not start-level)
7629 (progn
7630 nil) ;; does not even start with a heading
7631 (catch 'exit
7632 (while (setq start (string-match ^re kill (1+ start)))
7633 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7634 (throw 'exit nil)))
7635 t))))
7637 (defvar org-markers-to-move nil
7638 "Markers that should be moved with a cut-and-paste operation.
7639 Those markers are stored together with their positions relative to
7640 the start of the region.")
7642 (defun org-save-markers-in-region (beg end)
7643 "Check markers in region.
7644 If these markers are between BEG and END, record their position relative
7645 to BEG, so that after moving the block of text, we can put the markers back
7646 into place.
7647 This function gets called just before an entry or tree gets cut from the
7648 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7649 called immediately, to move the markers with the entries."
7650 (setq org-markers-to-move nil)
7651 (when (featurep 'org-clock)
7652 (org-clock-save-markers-for-cut-and-paste beg end))
7653 (when (featurep 'org-agenda)
7654 (org-agenda-save-markers-for-cut-and-paste beg end)))
7656 (defun org-check-and-save-marker (marker beg end)
7657 "Check if MARKER is between BEG and END.
7658 If yes, remember the marker and the distance to BEG."
7659 (when (and (marker-buffer marker)
7660 (equal (marker-buffer marker) (current-buffer)))
7661 (if (and (>= marker beg) (< marker end))
7662 (push (cons marker (- marker beg)) org-markers-to-move))))
7664 (defun org-reinstall-markers-in-region (beg)
7665 "Move all remembered markers to their position relative to BEG."
7666 (mapc (lambda (x)
7667 (move-marker (car x) (+ beg (cdr x))))
7668 org-markers-to-move)
7669 (setq org-markers-to-move nil))
7671 (defun org-narrow-to-subtree ()
7672 "Narrow buffer to the current subtree."
7673 (interactive)
7674 (save-excursion
7675 (save-match-data
7676 (org-with-limited-levels
7677 (narrow-to-region
7678 (progn (org-back-to-heading t) (point))
7679 (progn (org-end-of-subtree t t)
7680 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7681 (point)))))))
7683 (defun org-narrow-to-block ()
7684 "Narrow buffer to the current block."
7685 (interactive)
7686 (let* ((case-fold-search t)
7689 (if blockp
7690 (narrow-to-region (car blockp) (cdr blockp))
7691 (error "Not in a block"))))
7693 (eval-when-compile
7694 (defvar org-property-drawer-re))
7696 (defvar org-property-start-re) ;; defined below
7697 (defun org-clone-subtree-with-time-shift (n &optional shift)
7698 "Clone the task (subtree) at point N times.
7699 The clones will be inserted as siblings.
7701 In interactive use, the user will be prompted for the number of
7702 clones to be produced, and for a time SHIFT, which may be a
7703 repeater as used in time stamps, for example `+3d'.
7705 When a valid repeater is given and the entry contains any time
7706 stamps, the clones will become a sequence in time, with time
7707 stamps in the subtree shifted for each clone produced. If SHIFT
7708 is nil or the empty string, time stamps will be left alone. The
7709 ID property of the original subtree is removed.
7711 If the original subtree did contain time stamps with a repeater,
7712 the following will happen:
7713 - the repeater will be removed in each clone
7714 - an additional clone will be produced, with the current, unshifted
7715 date(s) in the entry.
7716 - the original entry will be placed *after* all the clones, with
7717 repeater intact.
7718 - the start days in the repeater in the original entry will be shifted
7719 to past the last clone.
7720 I this way you can spell out a number of instances of a repeating task,
7721 and still retain the repeater to cover future instances of the task."
7722 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7723 (let (beg end template task idprop
7724 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7725 (if (not (and (integerp n) (> n 0)))
7726 (error "Invalid number of replications %s" n))
7729 shift)))
7730 (error "Invalid shift specification %s" shift))
7731 (when doshift
7732 (setq shift-n (string-to-number (match-string 1 shift))
7733 shift-what (cdr (assoc (match-string 2 shift)
7734 '(("d" . day) ("w" . week)
7735 ("m" . month) ("y" . year))))))
7736 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7737 (setq nmin 1 nmax n)
7738 (org-back-to-heading t)
7739 (setq beg (point))
7740 (setq idprop (org-entry-get nil "ID"))
7741 (org-end-of-subtree t t)
7743 (setq end (point))
7744 (setq template (buffer-substring beg end))
7745 ;; Remove clocks and empty drawers
7746 (with-temp-buffer
7747 (insert template)
7748 (goto-char (point-min))
7749 (while (re-search-forward
7751 (replace-match "")
7752 (kill-whole-line))
7753 (goto-char (point-min))
7754 (while (re-search-forward
7756 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7757 (setq template (buffer-substring (point-min) (point-max))))
7758 (when (and doshift
7760 (delete-region beg end)
7761 (setq end beg)
7762 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7763 (goto-char end)
7764 (loop for n from nmin to nmax do
7765 ;; prepare clone
7766 (with-temp-buffer
7767 (insert template)
7768 (org-mode)
7769 (goto-char (point-min))
7770 (and idprop (if org-clone-delete-id
7771 (org-entry-delete nil "ID")
7772 (org-id-get-create t)))
7773 (while (re-search-forward org-property-start-re nil t)
7774 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7775 (goto-char (point-min))
7776 (when doshift
7777 (while (re-search-forward org-ts-regexp-both nil t)
7778 (org-timestamp-change (* n shift-n) shift-what))
7779 (unless (= n n-no-remove)
7780 (goto-char (point-min))
7781 (while (re-search-forward org-ts-regexp nil t)
7782 (save-excursion
7783 (goto-char (match-beginning 0))
7785 (delete-region (match-beginning 1) (match-end 1)))))))
7786 (setq task (buffer-string)))
7787 (insert task))
7788 (goto-char beg)))
7790 ;;; Outline Sorting
7792 (defun org-sort (with-case)
7793 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7794 Optional argument WITH-CASE means sort case-sensitively.
7795 With a double prefix argument, also remove duplicate entries."
7796 (interactive "P")
7797 (cond
7798 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7799 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7800 (t
7801 (org-call-with-arg 'org-sort-entries with-case))))
7803 (defun org-sort-remove-invisible (s)
7804 (remove-text-properties 0 (length s) org-rm-props s)
7805 (while (string-match org-bracket-link-regexp s)
7806 (setq s (replace-match (if (match-end 2)
7807 (match-string 3 s)
7808 (match-string 1 s)) t t s)))
7809 s)
7811 (defvar org-priority-regexp) ; defined later in the file
7813 (defvar org-after-sorting-entries-or-items-hook nil
7814 "Hook that is run after a bunch of entries or items have been sorted.
7815 When children are sorted, the cursor is in the parent line when this
7816 hook gets called. When a region or a plain list is sorted, the cursor
7817 will be in the first entry of the sorted region/list.")
7819 (defun org-sort-entries
7820 (&optional with-case sorting-type getkey-func compare-func property)
7821 "Sort entries on a certain level of an outline tree.
7822 If there is an active region, the entries in the region are sorted.
7823 Else, if the cursor is before the first entry, sort the top-level items.
7824 Else, the children of the entry at point are sorted.
7826 Sorting can be alphabetically, numerically, by date/time as given by
7827 a time stamp, by a property or by priority.
7829 The command prompts for the sorting type unless it has been given to the
7830 function through the SORTING-TYPE argument, which needs to be a character,
7831 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7832 precise meaning of each character:
7834 n Numerically, by converting the beginning of the entry/item to a number.
7835 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7836 t By date/time, either the first active time stamp in the entry, or, if
7837 none exist, by the first inactive one.
7838 s By the scheduled date/time.
7839 d By deadline date/time.
7840 c By creation time, which is assumed to be the first inactive time stamp
7841 at the beginning of a line.
7842 p By priority according to the cookie.
7843 r By the value of a property.
7845 Capital letters will reverse the sort order.
7847 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7848 called with point at the beginning of the record. It must return either
7849 a string or a number that should serve as the sorting key for that record.
7851 Comparing entries ignores case by default. However, with an optional argument
7852 WITH-CASE, the sorting considers case as well."
7853 (interactive "P")
7854 (let ((case-func (if with-case 'identity 'downcase))
7855 start beg end stars re re2
7856 txt what tmp)
7857 ;; Find beginning and end of region to sort
7858 (cond
7859 ((org-region-active-p)
7860 ;; we will sort the region
7861 (setq end (region-end)
7862 what "region")
7863 (goto-char (region-beginning))
7864 (if (not (org-on-heading-p)) (outline-next-heading))
7865 (setq start (point)))
7866 ((or (org-on-heading-p)
7867 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7868 ;; we will sort the children of the current headline
7869 (org-back-to-heading)
7870 (setq start (point)
7871 end (progn (org-end-of-subtree t t)
7873 (org-back-over-empty-lines)
7874 (point))
7875 what "children")
7876 (goto-char start)
7877 (show-subtree)
7878 (outline-next-heading))
7879 (t
7880 ;; we will sort the top-level entries in this file
7881 (goto-char (point-min))
7882 (or (org-on-heading-p) (outline-next-heading))
7883 (setq start (point))
7884 (goto-char (point-max))
7885 (beginning-of-line 1)
7887 ;; File ends in a non-white line
7888 (end-of-line 1)
7890 (setq end (point-max))
7891 (setq what "top-level")
7892 (goto-char start)
7893 (show-all)))
7895 (setq beg (point))
7896 (if (>= beg end) (error "Nothing to sort"))
7899 (setq stars (match-string 1)
7900 re (concat "^" (regexp-quote stars) " +")
7902 txt (buffer-substring beg end))
7904 (if (and (not (equal stars "*")) (string-match re2 txt))
7905 (error "Region to sort contains a level above the first entry"))
7907 (unless sorting-type
7908 (message
7909 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7911 A/N/T/S/D/C/P/O/F means reversed:"
7912 what)
7913 (setq sorting-type (read-char-exclusive))
7915 (and (= (downcase sorting-type) ?f)
7916 (setq getkey-func
7917 (org-icompleting-read "Sort using function: "
7918 obarray 'fboundp t nil nil))
7919 (setq getkey-func (intern getkey-func)))
7921 (and (= (downcase sorting-type) ?r)
7922 (setq property
7923 (org-icompleting-read "Property: "
7924 (mapcar 'list (org-buffer-property-keys t))
7925 nil t))))
7927 (message "Sorting entries...")
7929 (save-restriction
7930 (narrow-to-region start end)
7931 (let ((dcst (downcase sorting-type))
7932 (case-fold-search nil)
7933 (now (current-time)))
7934 (sort-subr
7935 (/= dcst sorting-type)
7936 ;; This function moves to the beginning character of the "record" to
7937 ;; be sorted.
7938 (lambda nil
7939 (if (re-search-forward re nil t)
7940 (goto-char (match-beginning 0))
7941 (goto-char (point-max))))
7942 ;; This function moves to the last character of the "record" being
7943 ;; sorted.
7944 (lambda nil
7945 (save-match-data
7946 (condition-case nil
7947 (outline-forward-same-level 1)
7948 (error
7949 (goto-char (point-max))))))
7950 ;; This function returns the value that gets sorted against.
7951 (lambda nil
7952 (cond
7953 ((= dcst ?n)
7954 (if (looking-at org-complex-heading-regexp)
7955 (string-to-number (match-string 4))
7956 nil))
7957 ((= dcst ?a)
7958 (if (looking-at org-complex-heading-regexp)
7959 (funcall case-func (match-string 4))
7960 nil))
7961 ((= dcst ?t)
7962 (let ((end (save-excursion (outline-next-heading) (point))))
7963 (if (or (re-search-forward org-ts-regexp end t)
7964 (re-search-forward org-ts-regexp-both end t))
7965 (org-time-string-to-seconds (match-string 0))
7966 (org-float-time now))))
7967 ((= dcst ?c)
7968 (let ((end (save-excursion (outline-next-heading) (point))))
7969 (if (re-search-forward
7971 end t)
7972 (org-time-string-to-seconds (match-string 0))
7973 (org-float-time now))))
7974 ((= dcst ?s)
7975 (let ((end (save-excursion (outline-next-heading) (point))))
7976 (if (re-search-forward org-scheduled-time-regexp end t)
7977 (org-time-string-to-seconds (match-string 1))
7978 (org-float-time now))))
7979 ((= dcst ?d)
7980 (let ((end (save-excursion (outline-next-heading) (point))))
7981 (if (re-search-forward org-deadline-time-regexp end t)
7982 (org-time-string-to-seconds (match-string 1))
7983 (org-float-time now))))
7984 ((= dcst ?p)
7985 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7986 (string-to-char (match-string 2))
7987 org-default-priority))
7988 ((= dcst ?r)
7989 (or (org-entry-get nil property) ""))
7990 ((= dcst ?o)
7991 (if (looking-at org-complex-heading-regexp)
7992 (- 9999 (length (member (match-string 2)
7993 org-todo-keywords-1)))))
7994 ((= dcst ?f)
7995 (if getkey-func
7996 (progn
7997 (setq tmp (funcall getkey-func))
7998 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7999 tmp)
8000 (error "Invalid key function `%s'" getkey-func)))
8001 (t (error "Invalid sorting type `%c'" sorting-type))))
8002 nil
8003 (cond
8004 ((= dcst ?a) 'string<)
8005 ((= dcst ?f) compare-func)
8006 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8007 (t nil)))))
8008 (run-hooks 'org-after-sorting-entries-or-items-hook)
8009 (message "Sorting entries...done")))
8011 (defun org-do-sort (table what &optional with-case sorting-type)
8012 "Sort TABLE of WHAT according to SORTING-TYPE.
8013 The user will be prompted for the SORTING-TYPE if the call to this
8014 function does not specify it. WHAT is only for the prompt, to indicate
8015 what is being sorted. The sorting key will be extracted from
8016 the car of the elements of the table.
8017 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8018 (unless sorting-type
8019 (message
8020 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8021 what)
8022 (setq sorting-type (read-char-exclusive)))
8023 (let ((dcst (downcase sorting-type))
8024 extractfun comparefun)
8025 ;; Define the appropriate functions
8026 (cond
8027 ((= dcst ?n)
8028 (setq extractfun 'string-to-number
8029 comparefun (if (= dcst sorting-type) '< '>)))
8030 ((= dcst ?a)
8031 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8032 (lambda(x) (downcase (org-sort-remove-invisible x))))
8033 comparefun (if (= dcst sorting-type)
8034 'string<
8035 (lambda (a b) (and (not (string< a b))
8036 (not (string= a b)))))))
8037 ((= dcst ?t)
8038 (setq extractfun
8039 (lambda (x)
8040 (if (or (string-match org-ts-regexp x)
8041 (string-match org-ts-regexp-both x))
8042 (org-float-time
8043 (org-time-string-to-time (match-string 0 x)))
8044 0))
8045 comparefun (if (= dcst sorting-type) '< '>)))
8046 (t (error "Invalid sorting type `%c'" sorting-type)))
8048 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8049 table)
8050 (lambda (a b) (funcall comparefun (car a) (car b))))))
8053 ;;; The orgstruct minor mode
8055 ;; Define a minor mode which can be used in other modes in order to
8056 ;; integrate the org-mode structure editing commands.
8058 ;; This is really a hack, because the org-mode structure commands use
8059 ;; keys which normally belong to the major mode. Here is how it
8060 ;; works: The minor mode defines all the keys necessary to operate the
8061 ;; structure commands, but wraps the commands into a function which
8062 ;; tests if the cursor is currently at a headline or a plain list
8063 ;; item. If that is the case, the structure command is used,
8064 ;; temporarily setting many Org-mode variables like regular
8065 ;; expressions for filling etc. However, when any of those keys is
8066 ;; used at a different location, function uses `key-binding' to look
8067 ;; up if the key has an associated command in another currently active
8068 ;; keymap (minor modes, major mode, global), and executes that
8069 ;; command. There might be problems if any of the keys is otherwise
8070 ;; used as a prefix key.
8072 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8073 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8074 ;; addresses this by checking explicitly for both bindings.
8076 (defvar orgstruct-mode-map (make-sparse-keymap)
8077 "Keymap for the minor `orgstruct-mode'.")
8079 (defvar org-local-vars nil
8080 "List of local variables, for use by `orgstruct-mode'.")
8082 ;;;###autoload
8083 (define-minor-mode orgstruct-mode
8084 "Toggle the minor mode `orgstruct-mode'.
8085 This mode is for using Org-mode structure commands in other
8086 modes. The following keys behave as if Org-mode were active, if
8087 the cursor is on a headline, or on a plain list item (both as
8088 defined by Org-mode).
8090 M-up Move entry/item up
8091 M-down Move entry/item down
8092 M-left Promote
8093 M-right Demote
8094 M-S-up Move entry/item up
8095 M-S-down Move entry/item down
8096 M-S-left Promote subtree
8097 M-S-right Demote subtree
8098 M-q Fill paragraph and items like in Org-mode
8099 C-c ^ Sort entries
8100 C-c - Cycle list bullet
8101 TAB Cycle item visibility
8102 M-RET Insert new heading/item
8103 S-M-RET Insert new TODO heading / Checkbox item
8104 C-c C-c Set tags / toggle checkbox"
8105 nil " OrgStruct" nil
8106 (org-load-modules-maybe)
8107 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8109 ;;;###autoload
8110 (defun turn-on-orgstruct ()
8111 "Unconditionally turn on `orgstruct-mode'."
8112 (orgstruct-mode 1))
8114 (defun orgstruct++-mode (&optional arg)
8115 "Toggle `orgstruct-mode', the enhanced version of it.
8116 In addition to setting orgstruct-mode, this also exports all indentation
8117 and autofilling variables from org-mode into the buffer. It will also
8118 recognize item context in multiline items.
8119 Note that turning off orgstruct-mode will *not* remove the
8120 indentation/paragraph settings. This can only be done by refreshing the
8122 (interactive "P")
8123 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8124 (if (< arg 1)
8125 (orgstruct-mode -1)
8126 (orgstruct-mode 1)
8127 (let (var val)
8128 (mapc
8129 (lambda (x)
8130 (when (string-match
8132 (symbol-name (car x)))
8133 (setq var (car x) val (nth 1 x))
8134 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8135 org-local-vars)
8136 (org-set-local 'orgstruct-is-++ t))))
8138 (defvar orgstruct-is-++ nil
8139 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8140 (make-variable-buffer-local 'orgstruct-is-++)
8142 ;;;###autoload
8143 (defun turn-on-orgstruct++ ()
8144 "Unconditionally turn on `orgstruct++-mode'."
8145 (orgstruct++-mode 1))
8147 (defun orgstruct-error ()
8148 "Error when there is no default binding for a structure key."
8149 (interactive)
8150 (error "This key has no function outside structure elements"))
8152 (defun orgstruct-setup ()
8153 "Setup orgstruct keymaps."
8154 (let ((nfunc 0)
8155 (bindings
8156 (list
8157 '([(meta up)] org-metaup)
8158 '([(meta down)] org-metadown)
8159 '([(meta left)] org-metaleft)
8160 '([(meta right)] org-metaright)
8161 '([(meta shift up)] org-shiftmetaup)
8162 '([(meta shift down)] org-shiftmetadown)
8163 '([(meta shift left)] org-shiftmetaleft)
8164 '([(meta shift right)] org-shiftmetaright)
8165 '([?\e (up)] org-metaup)
8166 '([?\e (down)] org-metadown)
8167 '([?\e (left)] org-metaleft)
8168 '([?\e (right)] org-metaright)
8169 '([?\e (shift up)] org-shiftmetaup)
8170 '([?\e (shift down)] org-shiftmetadown)
8171 '([?\e (shift left)] org-shiftmetaleft)
8172 '([?\e (shift right)] org-shiftmetaright)
8173 '([(shift up)] org-shiftup)
8174 '([(shift down)] org-shiftdown)
8175 '([(shift left)] org-shiftleft)
8176 '([(shift right)] org-shiftright)
8177 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8178 '("\M-q" fill-paragraph)
8179 '("\C-c^" org-sort)
8180 '("\C-c-" org-cycle-list-bullet)))
8181 elt key fun cmd)
8182 (while (setq elt (pop bindings))
8183 (setq nfunc (1+ nfunc))
8184 (setq key (org-key (car elt))
8185 fun (nth 1 elt)
8186 cmd (orgstruct-make-binding fun nfunc key))
8187 (org-defkey orgstruct-mode-map key cmd))
8189 ;; Special treatment needed for TAB and RET
8190 (org-defkey orgstruct-mode-map [(tab)]
8191 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8192 (org-defkey orgstruct-mode-map "\C-i"
8193 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8195 (org-defkey orgstruct-mode-map "\M-\C-m"
8196 (orgstruct-make-binding 'org-insert-heading 105
8197 "\M-\C-m" [(meta return)]))
8198 (org-defkey orgstruct-mode-map [(meta return)]
8199 (orgstruct-make-binding 'org-insert-heading 106
8200 [(meta return)] "\M-\C-m"))
8202 (org-defkey orgstruct-mode-map [(shift meta return)]
8203 (orgstruct-make-binding 'org-insert-todo-heading 107
8204 [(meta return)] "\M-\C-m"))
8206 (org-defkey orgstruct-mode-map "\e\C-m"
8207 (orgstruct-make-binding 'org-insert-heading 108
8208 "\e\C-m" [?\e (return)]))
8209 (org-defkey orgstruct-mode-map [?\e (return)]
8210 (orgstruct-make-binding 'org-insert-heading 109
8211 [?\e (return)] "\e\C-m"))
8212 (org-defkey orgstruct-mode-map [?\e (shift return)]
8213 (orgstruct-make-binding 'org-insert-todo-heading 110
8214 [?\e (return)] "\e\C-m"))
8216 (unless org-local-vars
8217 (setq org-local-vars (org-get-local-variables)))
8219 t))
8221 (defun orgstruct-make-binding (fun n &rest keys)
8222 "Create a function for binding in the structure minor mode.
8223 FUN is the command to call inside a table. N is used to create a unique
8224 command name. KEYS are keys that should be checked in for a command
8225 to execute outside of tables."
8226 (eval
8227 (list 'defun
8228 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8229 '(arg)
8231 "Outside of structure, run the binding of `"
8232 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8233 "'.")
8234 '(interactive "p")
8235 (list 'if
8236 `(org-context-p 'headline 'item
8237 (and orgstruct-is-++
8238 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8239 'item-body))
8240 (list 'org-run-like-in-org-mode (list 'quote fun))
8241 (list 'let '(orgstruct-mode)
8242 (list 'call-interactively
8243 (append '(or)
8244 (mapcar (lambda (k)
8245 (list 'key-binding k))
8246 keys)
8247 '('orgstruct-error))))))))
8249 (defun org-context-p (&rest contexts)
8250 "Check if local context is any of CONTEXTS.
8251 Possible values in the list of contexts are `table', `headline', and `item'."
8252 (let ((pos (point)))
8253 (goto-char (point-at-bol))
8254 (prog1 (or (and (memq 'table contexts)
8256 (and (memq 'headline contexts)
8257 (looking-at org-outline-regexp))
8258 (and (memq 'item contexts)
8260 (and (memq 'item-body contexts)
8261 (org-in-item-p)))
8262 (goto-char pos))))
8264 (defun org-get-local-variables ()
8265 "Return a list of all local variables in an org-mode buffer."
8266 (let (varlist)
8267 (with-current-buffer (get-buffer-create "*Org tmp*")
8268 (erase-buffer)
8269 (org-mode)
8270 (setq varlist (buffer-local-variables)))
8271 (kill-buffer "*Org tmp*")
8272 (delq nil
8273 (mapcar
8274 (lambda (x)
8275 (setq x
8276 (if (symbolp x)
8277 (list x)
8278 (list (car x) (list 'quote (cdr x)))))
8279 (if (string-match
8280 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8281 (symbol-name (car x)))
8282 x nil))
8283 varlist))))
8285 (defun org-clone-local-variables (from-buffer &optional regexp)
8286 "Clone local variables from FROM-BUFFER.
8287 Optional argument REGEXP selects variables to clone."
8288 (mapc
8289 (lambda (pair)
8290 (and (symbolp (car pair))
8291 (or (null regexp)
8292 (string-match regexp (symbol-name (car pair))))
8293 (set (make-local-variable (car pair))
8294 (cdr pair))))
8295 (buffer-local-variables from-buffer)))
8297 ;;;###autoload
8298 (defun org-run-like-in-org-mode (cmd)
8299 "Run a command, pretending that the current buffer is in Org-mode.
8300 This will temporarily bind local variables that are typically bound in
8301 Org-mode to the values they have in Org-mode, and then interactively
8302 call CMD."
8303 (org-load-modules-maybe)
8304 (unless org-local-vars
8305 (setq org-local-vars (org-get-local-variables)))
8306 (eval (list 'let org-local-vars
8307 (list 'call-interactively (list 'quote cmd)))))
8309 ;;;; Archiving
8311 (defun org-get-category (&optional pos force-refresh)
8312 "Get the category applying to position POS."
8313 (if force-refresh (org-refresh-category-properties))
8314 (let ((pos (or pos (point))))
8315 (or (get-text-property pos 'org-category)
8316 (progn (org-refresh-category-properties)
8317 (get-text-property pos 'org-category)))))
8319 (defun org-refresh-category-properties ()
8320 "Refresh category text properties in the buffer."
8321 (let ((def-cat (cond
8322 ((null org-category)
8323 (if buffer-file-name
8324 (file-name-sans-extension
8325 (file-name-nondirectory buffer-file-name))
8326 "???"))
8327 ((symbolp org-category) (symbol-name org-category))
8328 (t org-category)))
8329 beg end cat pos optionp)
8330 (org-unmodified
8331 (save-excursion
8332 (save-restriction
8333 (widen)
8334 (goto-char (point-min))
8335 (put-text-property (point) (point-max) 'org-category def-cat)
8336 (while (re-search-forward
8338 (setq pos (match-end 0)
8339 optionp (equal (char-after (match-beginning 0)) ?#)
8340 cat (org-trim (match-string 2)))
8341 (if optionp
8342 (setq beg (point-at-bol) end (point-max))
8343 (org-back-to-heading t)
8344 (setq beg (point) end (org-end-of-subtree t t)))
8345 (put-text-property beg end 'org-category cat)
8346 (goto-char pos)))))))
8349 ;;;; Link Stuff
8351 ;;; Link abbreviations
8353 (defun org-link-expand-abbrev (link)
8354 "Apply replacements as defined in `org-link-abbrev-alist."
8356 (let* ((key (match-string 1 link))
8357 (as (or (assoc key org-link-abbrev-alist-local)
8358 (assoc key org-link-abbrev-alist)))
8359 (tag (and (match-end 2) (match-string 3 link)))
8360 rpl)
8361 (if (not as)
8362 link
8363 (setq rpl (cdr as))
8364 (cond
8365 ((symbolp rpl) (funcall rpl tag))
8366 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8367 ((string-match "%h" rpl)
8368 (replace-match (url-hexify-string (or tag "")) t t rpl))
8369 (t (concat rpl tag)))))
8370 link))
8372 ;;; Storing and inserting links
8374 (defvar org-insert-link-history nil
8375 "Minibuffer history for links inserted with `org-insert-link'.")
8377 (defvar org-stored-links nil
8378 "Contains the links stored with `org-store-link'.")
8380 (defvar org-store-link-plist nil
8381 "Plist with info about the most recently link created with `org-store-link'.")
8383 (defvar org-link-protocols nil
8384 "Link protocols added to Org-mode using `org-add-link-type'.")
8386 (defvar org-store-link-functions nil
8387 "List of functions that are called to create and store a link.
8388 Each function will be called in turn until one returns a non-nil
8389 value. Each function should check if it is responsible for creating
8390 this link (for example by looking at the major mode).
8391 If not, it must exit and return nil.
8392 If yes, it should return a non-nil value after a calling
8393 `org-store-link-props' with a list of properties and values.
8394 Special properties are:
8398 This is obligatory as well.
8399 :description Optional default description for the second pair
8400 of brackets in an Org-mode link. The user can still change
8401 this when inserting this link into an Org-mode buffer.
8403 In addition to these, any additional properties can be specified
8404 and then used in remember templates.")
8406 (defun org-add-link-type (type &optional follow export)
8407 "Add TYPE to the list of `org-link-types'.
8408 Re-compute all regular expressions depending on `org-link-types'
8410 FOLLOW and EXPORT are two functions.
8412 FOLLOW should take the link path as the single argument and do whatever
8413 is necessary to follow the link, for example find a file or display
8414 a mail message.
8416 EXPORT should format the link path for export to one of the export formats.
8417 It should be a function accepting three arguments:
8420 desc the description of the link, if any, or a description added by
8421 org-export-normalize-links if there is none
8422 format the export format, a symbol like `html' or `latex' or `ascii'..
8424 The function may use the FORMAT information to return different values
8425 depending on the format. The return value will be put literally into
8426 the exported file. If the return value is nil, this means Org should
8427 do what it normally does with links which do not have EXPORT defined.
8429 Org-mode has a built-in default for exporting links. If you are happy with
8430 this default, there is no need to define an export function for the link
8431 type. For a simple example of an export function, see `org-bbdb.el'."
8432 (add-to-list 'org-link-types type t)
8433 (org-make-link-regexps)
8434 (if (assoc type org-link-protocols)
8435 (setcdr (assoc type org-link-protocols) (list follow export))
8436 (push (list type follow export) org-link-protocols)))
8438 (defvar org-agenda-buffer-name)
8440 ;;;###autoload
8441 (defun org-store-link (arg)
8443 This link is added to `org-stored-links' and can later be inserted
8446 For some link types, a prefix arg is interpreted:
8447 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8448 For file links, arg negates `org-context-in-file-links'."
8449 (interactive "P")
8450 (org-load-modules-maybe)
8451 (setq org-store-link-plist nil) ; reset
8452 (org-with-limited-levels
8453 (let (link cpltxt desc description search txt custom-id agenda-link)
8454 (cond
8456 ((run-hook-with-args-until-success 'org-store-link-functions)
8457 (setq link (plist-get org-store-link-plist :link)
8458 desc (or (plist-get org-store-link-plist :description) link)))
8460 ((equal (buffer-name) "*Org Edit Src Example*")
8461 (let (label gc)
8462 (while (or (not label)
8463 (save-excursion
8464 (save-restriction
8465 (widen)
8466 (goto-char (point-min))
8467 (re-search-forward
8468 (regexp-quote (format org-coderef-label-format label))
8469 nil t))))
8470 (when label (message "Label exists already") (sit-for 2))
8471 (setq label (read-string "Code line label: " label)))
8472 (end-of-line 1)
8473 (setq link (format org-coderef-label-format label))
8474 (setq gc (- 79 (length link)))
8475 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8476 (insert link)
8477 (setq link (concat "(" label ")") desc nil)))
8479 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8480 ;; We are in the agenda, link to referenced location
8481 (let ((m (or (get-text-property (point) 'org-hd-marker)
8482 (get-text-property (point) 'org-marker))))
8483 (when m
8484 (org-with-point-at m
8485 (setq agenda-link
8486 (if (org-called-interactively-p 'any)
8487 (call-interactively 'org-store-link)
8488 (org-store-link nil)))))))
8490 ((eq major-mode 'calendar-mode)
8491 (let ((cd (calendar-cursor-to-date)))
8492 (setq link
8493 (format-time-string
8494 (car org-time-stamp-formats)
8495 (apply 'encode-time
8496 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8497 nil nil nil))))
8498 (org-store-link-props :type "calendar" :date cd)))
8500 ((eq major-mode 'w3-mode)
8501 (setq cpltxt (if (and (buffer-name)
8502 (not (string-match "Untitled" (buffer-name))))
8503 (buffer-name)
8504 (url-view-url t))
8505 link (org-make-link (url-view-url t)))
8506 (org-store-link-props :type "w3" :url (url-view-url t)))
8508 ((eq major-mode 'w3m-mode)
8509 (setq cpltxt (or w3m-current-title w3m-current-url)
8510 link (org-make-link w3m-current-url))
8511 (org-store-link-props :type "w3m" :url (url-view-url t)))
8513 ((setq search (run-hook-with-args-until-success
8514 'org-create-file-search-functions))
8515 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8516 "::" search))
8517 (setq cpltxt (or description link)))
8519 ((eq major-mode 'image-mode)
8520 (setq cpltxt (concat "file:"
8521 (abbreviate-file-name buffer-file-name))
8522 link (org-make-link cpltxt))
8523 (org-store-link-props :type "image" :file buffer-file-name))
8525 ((eq major-mode 'dired-mode)
8526 ;; link to the file in the current line
8527 (let ((file (dired-get-filename nil t)))
8528 (setq file (if file
8529 (abbreviate-file-name
8530 (expand-file-name (dired-get-filename nil t)))
8531 ;; otherwise, no file so use current directory.
8532 default-directory))
8533 (setq cpltxt (concat "file:" file)
8534 link (org-make-link cpltxt))))
8536 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8537 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8538 (cond
8540 (setq cpltxt
8541 (concat "file:"
8542 (abbreviate-file-name
8543 (buffer-file-name (buffer-base-buffer)))
8544 "::" (match-string 1))
8545 link (org-make-link cpltxt)))
8546 ((and (featurep 'org-id)
8547 (or (eq org-link-to-org-use-id t)
8548 (and (eq org-link-to-org-use-id 'create-if-interactive)
8549 (org-called-interactively-p 'any))
8550 (and (eq org-link-to-org-use-id
8551 'create-if-interactive-and-no-custom-id)
8552 (org-called-interactively-p 'any)
8553 (not custom-id))
8554 (and org-link-to-org-use-id
8555 (org-entry-get nil "ID"))))
8556 ;; We can make a link using the ID.
8557 (setq link (condition-case nil
8558 (prog1 (org-id-store-link)
8559 (setq desc (plist-get org-store-link-plist
8560 :description)))
8561 (error
8562 ;; probably before first headline, link to file only
8563 (concat "file:"
8564 (abbreviate-file-name
8565 (buffer-file-name (buffer-base-buffer))))))))
8566 (t
8567 ;; Just link to current headline
8568 (setq cpltxt (concat "file:"
8569 (abbreviate-file-name
8570 (buffer-file-name (buffer-base-buffer)))))
8571 ;; Add a context search string
8572 (when (org-xor org-context-in-file-links arg)
8573 (setq txt (cond
8574 ((org-on-heading-p) nil)
8575 ((org-region-active-p)
8576 (buffer-substring (region-beginning) (region-end)))
8577 (t nil)))
8579 (setq cpltxt
8580 (concat cpltxt "::"
8581 (condition-case nil
8582 (org-make-org-heading-search-string txt)
8583 (error "")))
8584 desc (or (nth 4 (ignore-errors
8585 (org-heading-components))) "NONE"))))
8587 (setq cpltxt (substring cpltxt 0 -2)))
8588 (setq link (org-make-link cpltxt)))))
8590 ((buffer-file-name (buffer-base-buffer))
8591 ;; Just link to this file here.
8592 (setq cpltxt (concat "file:"
8593 (abbreviate-file-name
8594 (buffer-file-name (buffer-base-buffer)))))
8595 ;; Add a context string
8596 (when (org-xor org-context-in-file-links arg)
8597 (setq txt (if (org-region-active-p)
8598 (buffer-substring (region-beginning) (region-end))
8599 (buffer-substring (point-at-bol) (point-at-eol))))
8600 ;; Only use search option if there is some text.
8602 (setq cpltxt
8603 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8604 desc "NONE")))
8605 (setq link (org-make-link cpltxt)))
8607 ((org-called-interactively-p 'interactive)
8608 (error "Cannot link to a buffer which is not visiting a file"))
8610 (t (setq link nil)))
8612 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8613 (setq link (or link cpltxt)
8614 desc (or desc cpltxt))
8615 (if (equal desc "NONE") (setq desc nil))
8617 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8618 (progn
8619 (setq org-stored-links
8620 (cons (list link desc) org-stored-links))
8621 (message "Stored: %s" (or desc link))
8622 (when custom-id
8623 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8624 "::#" custom-id))
8625 (setq org-stored-links
8626 (cons (list link desc) org-stored-links))))
8627 (or agenda-link (and link (org-make-link-string link desc)))))))
8629 (defun org-store-link-props (&rest plist)
8630 "Store link properties, extract names and addresses."
8631 (let (x adr)
8632 (when (setq x (plist-get plist :from))
8633 (setq adr (mail-extract-address-components x))
8634 (setq plist (plist-put plist :fromname (car adr)))
8635 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8636 (when (setq x (plist-get plist :to))
8637 (setq adr (mail-extract-address-components x))
8638 (setq plist (plist-put plist :toname (car adr)))
8639 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8640 (let ((from (plist-get plist :from))
8641 (to (plist-get plist :to)))
8642 (when (and from to org-from-is-user-regexp)
8643 (setq plist
8644 (plist-put plist :fromto
8645 (if (string-match org-from-is-user-regexp from)
8646 (concat "to %t")
8647 (concat "from %f"))))))
8648 (setq org-store-link-plist plist))
8650 (defun org-add-link-props (&rest plist)
8651 "Add these properties to the link property list."
8652 (let (key value)
8653 (while plist
8654 (setq key (pop plist) value (pop plist))
8655 (setq org-store-link-plist
8656 (plist-put org-store-link-plist key value)))))
8658 (defun org-email-link-description (&optional fmt)
8659 "Return the description part of an email link.
8660 This takes information from `org-store-link-plist' and formats it
8661 according to FMT (default from `org-email-link-description-format')."
8662 (setq fmt (or fmt org-email-link-description-format))
8663 (let* ((p org-store-link-plist)
8664 (to (plist-get p :toaddress))
8665 (from (plist-get p :fromaddress))
8666 (table
8667 (list
8668 (cons "%c" (plist-get p :fromto))
8669 (cons "%F" (plist-get p :from))
8670 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8671 (cons "%T" (plist-get p :to))
8672 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8673 (cons "%s" (plist-get p :subject))
8674 (cons "%d" (plist-get p :date))
8675 (cons "%m" (plist-get p :message-id)))))
8676 (when (string-match "%c" fmt)
8677 ;; Check if the user wrote this message
8678 (if (and org-from-is-user-regexp from to
8679 (save-match-data (string-match org-from-is-user-regexp from)))
8680 (setq fmt (replace-match "to %t" t t fmt))
8681 (setq fmt (replace-match "from %f" t t fmt))))
8682 (org-replace-escapes fmt table)))
8684 (defun org-make-org-heading-search-string (&optional string heading)
8685 "Make search string for STRING or current headline."
8686 (interactive)
8687 (let ((s (or string (org-get-heading)))
8688 (lines org-context-in-file-links))
8689 (unless (and string (not heading))
8690 ;; We are using a headline, clean up garbage in there.
8691 (if (string-match org-todo-regexp s)
8692 (setq s (replace-match "" t t s)))
8694 (setq s (replace-match "" t t s)))
8695 (setq s (org-trim s))
8698 (setq s (replace-match "" t t s)))
8699 (while (string-match org-ts-regexp s)
8700 (setq s (replace-match "" t t s))))
8701 (or string (setq s (concat "*" s))) ; Add * for headlines
8702 (when (and string (integerp lines) (> lines 0))
8704 (when (< lines (length slines))
8705 (setq s (mapconcat
8706 'identity
8707 (reverse (nthcdr (- (length slines) lines)
8711 (defun org-make-link (&rest strings)
8712 "Concatenate STRINGS."
8713 (apply 'concat strings))
8715 (defun org-make-link-string (link &optional description)
8716 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8718 (error "Empty link"))
8719 (when (and description
8720 (stringp description)
8722 (setq description nil))
8723 (when (stringp description)
8724 ;; Remove brackets from the description, they are fatal.
8726 (setq description (replace-match "{" t t description)))
8728 (setq description (replace-match "}" t t description))))
8729 (when (equal link description)
8730 ;; No description needed, it is identical
8731 (setq description nil))
8732 (when (and (not description)
8733 (not (string-match (org-image-file-name-regexp) link))
8734 (not (equal link (org-link-escape link))))
8735 (setq description (org-extract-attributes link)))
8736 (setq link
8737 (cond ((string-match (org-image-file-name-regexp) link) link)
8738 ((string-match org-link-types-re link)
8739 (concat (match-string 1 link)
8740 (org-link-escape (substring link (match-end 1)))))
8741 (t (org-link-escape link))))
8742 (concat "[[" link "]"
8743 (if description (concat "[" description "]") "")
8744 "]"))
8746 (defconst org-link-escape-chars
8747 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8748 "List of characters that should be escaped in link.
8749 This is the list that is used for internal purposes.")
8751 (defvar org-url-encoding-use-url-hexify nil)
8753 (defconst org-link-escape-chars-browser
8754 '(?\ )
8755 "List of escapes for characters that are problematic in links.
8756 This is the list that is used before handing over to the browser.")
8758 (defun org-link-escape (text &optional table merge)
8759 "Return percent escaped representation of TEXT.
8760 TEXT is a string with the text to escape.
8761 Optional argument TABLE is a list with characters that should be
8762 escaped. When nil, `org-link-escape-chars' is used.
8763 If optional argument MERGE is set, merge TABLE into
8764 `org-link-escape-chars'."
8765 (if (and org-url-encoding-use-url-hexify (not table))
8766 (url-hexify-string text)
8767 (cond
8768 ((and table merge)
8769 (mapc (lambda (defchr)
8770 (unless (member defchr table)
8771 (setq table (cons defchr table)))) org-link-escape-chars))
8772 ((null table)
8773 (setq table org-link-escape-chars)))
8774 (mapconcat
8775 (lambda (char)
8776 (if (or (member char table)
8777 (< char 32) (= char 37) (> char 126))
8778 (mapconcat (lambda (sequence-element)
8779 (format "%%%.2X" sequence-element))
8780 (or (encode-coding-char char 'utf-8)
8781 (error "Unable to percent escape character: %s"
8782 (char-to-string char))) "")
8783 (char-to-string char))) text "")))
8785 (defun org-link-unescape (str)
8786 "Unhex hexified unicode strings as returned from the JavaScript function
8787 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8788 (unless (and (null str) (string= "" str))
8789 (let ((pos 0) (case-fold-search t) unhexed)
8791 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8792 (setq str (replace-match unhexed t t str))
8793 (setq pos (+ pos (length unhexed))))))
8794 str)
8796 (defun org-link-unescape-compound (hex)
8797 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8798 Note: this function also decodes single byte encodings like
8800 (save-match-data
8801 (let* ((bytes (cdr (split-string hex "%")))
8802 (ret "")
8803 (eat 0)
8804 (sum 0))
8805 (while bytes
8806 (let* ((val (string-to-number (pop bytes) 16))
8807 (shift-xor
8808 (if (= 0 eat)
8809 (cond
8810 ((>= val 252) (cons 6 252))
8811 ((>= val 248) (cons 5 248))
8812 ((>= val 240) (cons 4 240))
8813 ((>= val 224) (cons 3 224))
8814 ((>= val 192) (cons 2 192))
8815 (t (cons 0 0)))
8816 (cons 6 128))))
8817 (if (>= val 192) (setq eat (car shift-xor)))
8818 (setq val (logxor val (cdr shift-xor)))
8819 (setq sum (+ (lsh sum (car shift-xor)) val))
8820 (if (> eat 0) (setq eat (- eat 1)))
8821 (cond
8822 ((= 0 eat) ;multi byte
8823 (setq ret (concat ret (org-char-to-string sum)))
8824 (setq sum 0))
8825 ((not bytes) ; single byte(s)
8826 (setq ret (org-link-unescape-single-byte-sequence hex))))
8827 )) ;; end (while bytes
8828 ret )))
8830 (defun org-link-unescape-single-byte-sequence (hex)
8831 "Unhexify hex-encoded single byte character sequences."
8832 (mapconcat (lambda (byte)
8833 (char-to-string (string-to-number byte 16)))
8834 (cdr (split-string hex "%")) ""))
8836 (defun org-xor (a b)
8837 "Exclusive or."
8838 (if a (not b) b))
8840 (defun org-fixup-message-id-for-http (s)
8841 "Replace special characters in a message id, so it can be used in an http query."
8842 (when (string-match "%" s)
8843 (setq s (mapconcat (lambda (c)
8844 (if (eq c ?%)
8845 "%25"
8846 (char-to-string c)))
8847 s "")))
8848 (while (string-match "<" s)
8849 (setq s (replace-match "%3C" t t s)))
8850 (while (string-match ">" s)
8851 (setq s (replace-match "%3E" t t s)))
8852 (while (string-match "@" s)
8853 (setq s (replace-match "%40" t t s)))
8854 s)
8856 ;;;###autoload
8857 (defun org-insert-link-global ()
8858 "Insert a link like Org-mode does.
8859 This command can be called in any mode to insert a link in Org-mode syntax."
8860 (interactive)
8861 (org-load-modules-maybe)
8862 (org-run-like-in-org-mode 'org-insert-link))
8864 (defun org-insert-link (&optional complete-file link-location)
8865 "Insert a link. At the prompt, enter the link.
8867 Completion can be used to insert any of the link protocol prefixes like
8868 http or ftp in use.
8870 The history can be used to select a link previously stored with
8871 `org-store-link'. When the empty string is entered (i.e. if you just
8872 press RET at the prompt), the link defaults to the most recently
8873 stored link. As SPC triggers completion in the minibuffer, you need to
8874 use M-SPC or C-q SPC to force the insertion of a space character.
8876 You will also be prompted for a description, and if one is given, it will
8877 be displayed in the buffer instead of the link.
8879 If there is already a link at point, this command will allow you to edit link
8880 and description parts.
8883 be selected using completion. The path to the file will be relative to the
8884 current directory if the file is in the current directory or a subdirectory.
8885 Otherwise, the link will be the absolute path as completed in the minibuffer
8886 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8887 option `org-link-file-path-type'.
8890 the current directory or below.
8893 `org-keep-stored-link-after-insertion'.
8895 If `org-make-link-description-function' is non-nil, this function will be
8896 called with the link target, and the result will be the default
8897 link description.
8899 If the LINK-LOCATION parameter is non-nil, this value will be
8900 used as the link location instead of reading one interactively."
8901 (interactive "P")
8902 (let* ((wcf (current-window-configuration))
8903 (region (if (org-region-active-p)
8904 (buffer-substring (region-beginning) (region-end))))
8905 (remove (and region (list (region-beginning) (region-end))))
8906 (desc region)
8907 tmphist ; byte-compile incorrectly complains about this
8908 (link link-location)
8909 entry file all-prefixes)
8910 (cond
8911 (link-location) ; specified by arg, just use it.
8912 ((org-in-regexp org-bracket-link-regexp 1)
8913 ;; We do have a link at point, and we are going to edit it.
8914 (setq remove (list (match-beginning 0) (match-end 0)))
8915 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8916 (setq link (read-string "Link: "
8917 (org-link-unescape
8918 (org-match-string-no-properties 1)))))
8919 ((or (org-in-regexp org-angle-link-re)
8920 (org-in-regexp org-plain-link-re))
8921 ;; Convert to bracket link
8922 (setq remove (list (match-beginning 0) (match-end 0))
8923 link (read-string "Link: "
8924 (org-remove-angle-brackets (match-string 0)))))
8925 ((member complete-file '((4) (16)))
8926 ;; Completing read for file names.
8927 (setq link (org-file-complete-link complete-file)))
8928 (t
8929 ;; Read link, with completion for stored links.
8930 (with-output-to-temp-buffer "*Org Links*"
8931 (princ "Insert a link.
8933 (when org-stored-links
8935 (princ (mapconcat
8936 (lambda (x)
8937 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8939 (let ((cw (selected-window)))
8940 (select-window (get-buffer-window "*Org Links*" 'visible))
8941 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8942 (unless (pos-visible-in-window-p (point-max))
8943 (org-fit-window-to-buffer))
8944 (and (window-live-p cw) (select-window cw)))
8945 ;; Fake a link history, containing the stored links.
8946 (setq tmphist (append (mapcar 'car org-stored-links)
8947 org-insert-link-history))
8948 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8949 (mapcar 'car org-link-abbrev-alist)
8950 org-link-types))
8951 (unwind-protect
8952 (progn
8953 (setq link
8954 (let ((org-completion-use-ido nil)
8955 (org-completion-use-iswitchb nil))
8956 (org-completing-read
8957 "Link: "
8958 (append
8959 (mapcar (lambda (x) (list (concat x ":")))
8960 all-prefixes)
8961 (mapcar 'car org-stored-links))
8962 nil nil nil
8963 'tmphist
8964 (car (car org-stored-links)))))
8966 (error "No link selected"))
8967 (if (or (member link all-prefixes)
8968 (and (equal ":" (substring link -1))
8969 (member (substring link 0 -1) all-prefixes)
8970 (setq link (substring link 0 -1))))
8971 (setq link (org-link-try-special-completion link))))
8972 (set-window-configuration wcf)
8973 (kill-buffer "*Org Links*"))
8974 (setq entry (assoc link org-stored-links))
8975 (or entry (push link org-insert-link-history))
8976 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8977 (not org-keep-stored-link-after-insertion))
8978 (setq org-stored-links (delq (assoc link org-stored-links)
8979 org-stored-links)))
8980 (setq desc (or desc (nth 1 entry)))))
8982 (if (string-match org-plain-link-re link)
8983 ;; URL-like link, normalize the use of angular brackets.
8984 (setq link (org-make-link (org-remove-angle-brackets link))))
8986 ;; Check if we are linking to the current file with a search option
8987 ;; If yes, simplify the link by using only the search option.
8988 (when (and buffer-file-name
8990 (let* ((path (match-string 1 link))
8991 (case-fold-search nil)
8992 (search (match-string 2 link)))
8993 (save-match-data
8994 (if (equal (file-truename buffer-file-name) (file-truename path))
8995 ;; We are linking to this same file, with a search option
8996 (setq link search)))))
8998 ;; Check if we can/should use a relative path. If yes, simplify the link
9000 (let* ((type (match-string 1 link))
9001 (path (match-string 2 link))
9002 (origpath path)
9003 (case-fold-search nil))
9004 (cond
9005 ((or (eq org-link-file-path-type 'absolute)
9006 (equal complete-file '(16)))
9007 (setq path (abbreviate-file-name (expand-file-name path))))
9008 ((eq org-link-file-path-type 'noabbrev)
9009 (setq path (expand-file-name path)))
9010 ((eq org-link-file-path-type 'relative)
9011 (setq path (file-relative-name path)))
9012 (t
9013 (save-match-data
9014 (if (string-match (concat "^" (regexp-quote
9015 (expand-file-name
9016 (file-name-as-directory
9017 default-directory))))
9018 (expand-file-name path))
9019 ;; We are linking a file with relative path name.
9020 (setq path (substring (expand-file-name path)
9021 (match-end 0)))
9022 (setq path (abbreviate-file-name (expand-file-name path)))))))
9023 (setq link (concat type path))
9024 (if (equal desc origpath)
9025 (setq desc path))))
9027 (if org-make-link-description-function
9028 (setq desc (funcall org-make-link-description-function link desc)))
9030 (setq desc (read-string "Description: " desc))
9032 (if remove (apply 'delete-region remove))
9033 (insert (org-make-link-string link desc))))
9035 (defun org-link-try-special-completion (type)
9036 "If there is completion support for link type TYPE, offer it."
9037 (let ((fun (intern (concat "org-" type "-complete-link"))))
9038 (if (functionp fun)
9039 (funcall fun)
9040 (read-string "Link (no completion support): " (concat type ":")))))
9042 (defun org-file-complete-link (&optional arg)
9043 "Create a file link using completion."
9044 (let (file link)
9045 (setq file (read-file-name "File: "))
9046 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9047 (pwd1 (file-name-as-directory (abbreviate-file-name
9048 (expand-file-name ".")))))
9049 (cond
9050 ((equal arg '(16))
9051 (setq link (org-make-link
9052 "file:"
9053 (abbreviate-file-name (expand-file-name file)))))
9055 (setq link (org-make-link "file:" (match-string 1 file))))
9057 (expand-file-name file))
9058 (setq link (org-make-link
9059 "file:" (match-string 1 (expand-file-name file)))))
9060 (t (setq link (org-make-link "file:" file)))))
9061 link))
9063 (defun org-completing-read (&rest args)
9064 "Completing-read with SPACE being a normal character."
9065 (let ((minibuffer-local-completion-map
9066 (copy-keymap minibuffer-local-completion-map)))
9067 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9068 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9069 (apply 'org-icompleting-read args)))
9071 (defun org-completing-read-no-i (&rest args)
9072 (let (org-completion-use-ido org-completion-use-iswitchb)
9073 (apply 'org-completing-read args)))
9075 (defun org-iswitchb-completing-read (prompt choices &rest args)
9076 "Use iswitch as a completing-read replacement to choose from choices.
9077 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9078 from."
9079 (let* ((iswitchb-use-virtual-buffers nil)
9080 (iswitchb-make-buflist-hook
9081 (lambda ()
9082 (setq iswitchb-temp-buflist choices))))
9083 (iswitchb-read-buffer prompt)))
9085 (defun org-icompleting-read (&rest args)
9086 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9087 (org-without-partial-completion
9088 (if (and org-completion-use-ido
9089 (fboundp 'ido-completing-read)
9090 (boundp 'ido-mode) ido-mode
9091 (listp (second args)))
9092 (let ((ido-enter-matching-directory nil))
9093 (apply 'ido-completing-read (concat (car args))
9094 (if (consp (car (nth 1 args)))
9095 (mapcar 'car (nth 1 args))
9096 (nth 1 args))
9097 (cddr args)))
9098 (if (and org-completion-use-iswitchb
9099 (boundp 'iswitchb-mode) iswitchb-mode
9100 (listp (second args)))
9101 (apply 'org-iswitchb-completing-read (concat (car args))
9102 (if (consp (car (nth 1 args)))
9103 (mapcar 'car (nth 1 args))
9104 (nth 1 args))
9105 (cddr args))
9106 (apply 'completing-read args)))))
9108 (defun org-extract-attributes (s)
9109 "Extract the attributes cookie from a string and set as text property."
9110 (let (a attr (start 0) key value)
9111 (save-match-data
9113 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9115 (setq key (match-string 1 a) value (match-string 2 a)
9116 start (match-end 0)
9117 attr (plist-put attr (intern key) value))))
9118 (org-add-props s nil 'org-attr attr))
9119 s))
9121 (defun org-extract-attributes-from-string (tag)
9122 (let (key value attr)
9124 (setq key (match-string 1 tag) value (match-string 2 tag)
9125 tag (replace-match "" t t tag)
9126 attr (plist-put attr (intern key) value)))
9127 (cons tag attr)))
9129 (defun org-attributes-to-string (plist)
9130 "Format a property list into an HTML attribute list."
9131 (let ((s "") key value)
9132 (while plist
9133 (setq key (pop plist) value (pop plist))
9134 (and value
9136 s))
9138 ;;; Opening/following a link
9140 (defvar org-link-search-failed nil)
9142 (defvar org-open-link-functions nil
9143 "Hook for functions finding a plain text link.
9144 These functions must take a single argument, the link content.
9145 They will be called for links that look like [[link text][description]]
9149 These functions will be called *before* Org attempts to resolve the
9150 link by doing text searches in the current buffer - so if you want a
9152 handle this as a special case.
9154 When the function does handle the link, it must return a non-nil value.
9155 If it decides that it is not responsible for this link, it must return
9156 nil to indicate that that Org-mode can continue with other options
9157 like exact and fuzzy text search.")
9159 (defun org-next-link ()
9160 "Move forward to the next link.
9161 If the link is in hidden text, expose it."
9162 (interactive)
9163 (when (and org-link-search-failed (eq this-command last-command))
9164 (goto-char (point-min))
9165 (message "Link search wrapped back to beginning of buffer"))
9166 (setq org-link-search-failed nil)
9167 (let* ((pos (point))
9168 (ct (org-context))
9169 (a (assoc :link ct)))
9170 (if a (goto-char (nth 2 a)))
9171 (if (re-search-forward org-any-link-re nil t)
9172 (progn
9173 (goto-char (match-beginning 0))
9174 (if (outline-invisible-p) (org-show-context)))
9175 (goto-char pos)
9176 (setq org-link-search-failed t)
9177 (error "No further link found"))))
9179 (defun org-previous-link ()
9180 "Move backward to the previous link.
9181 If the link is in hidden text, expose it."
9182 (interactive)
9183 (when (and org-link-search-failed (eq this-command last-command))
9184 (goto-char (point-max))
9185 (message "Link search wrapped back to end of buffer"))
9186 (setq org-link-search-failed nil)
9187 (let* ((pos (point))
9188 (ct (org-context))
9189 (a (assoc :link ct)))
9190 (if a (goto-char (nth 1 a)))
9191 (if (re-search-backward org-any-link-re nil t)
9192 (progn
9193 (goto-char (match-beginning 0))
9194 (if (outline-invisible-p) (org-show-context)))
9195 (goto-char pos)
9196 (setq org-link-search-failed t)
9197 (error "No further link found"))))
9199 (defun org-translate-link (s)
9200 "Translate a link string if a translation function has been defined."
9201 (if (and org-link-translation-function
9202 (fboundp org-link-translation-function)
9204 (progn
9205 (setq s (funcall org-link-translation-function
9206 (match-string 1) (match-string 2)))
9207 (concat (car s) ":" (cdr s)))
9208 s))
9210 (defun org-translate-link-from-planner (type path)
9211 "Translate a link from Emacs Planner syntax so that Org can follow it.
9212 This is still an experimental function, your mileage may vary."
9213 (cond
9214 ((member type '("http" "https" "news" "ftp"))
9215 ;; standard Internet links are the same.
9216 nil)
9217 ((and (equal type "irc") (string-match "^//" path))
9218 ;; Planner has two / at the beginning of an irc link, we have 1.
9219 ;; We should have zero, actually....
9220 (setq path (substring path 1)))
9221 ((and (equal type "lisp") (string-match "^/" path))
9222 ;; Planner has a slash, we do not.
9223 (setq type "elisp" path (substring path 1)))
9225 ;; A typical message link. Planner has the id after the final slash,
9226 ;; we separate it with a hash mark
9227 (setq path (concat (match-string 1 path) "#"
9228 (org-remove-angle-brackets (match-string 2 path)))))
9229 )
9230 (cons type path))
9232 (defun org-find-file-at-mouse (ev)
9233 "Open file link or URL at mouse."
9234 (interactive "e")
9235 (mouse-set-point ev)
9236 (org-open-at-point 'in-emacs))
9238 (defun org-open-at-mouse (ev)
9239 "Open file link or URL at mouse."
9240 (interactive "e")
9241 (mouse-set-point ev)
9242 (if (eq major-mode 'org-agenda-mode)
9243 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9244 (org-open-at-point))
9246 (defvar org-window-config-before-follow-link nil
9247 "The window configuration before following a link.
9248 This is saved in case the need arises to restore it.")
9250 (defvar org-open-link-marker (make-marker)
9251 "Marker pointing to the location where `org-open-at-point; was called.")
9253 ;;;###autoload
9254 (defun org-open-at-point-global ()
9255 "Follow a link like Org-mode does.
9256 This command can be called in any mode to follow a link that has
9257 Org-mode syntax."
9258 (interactive)
9259 (org-run-like-in-org-mode 'org-open-at-point))
9261 ;;;###autoload
9262 (defun org-open-link-from-string (s &optional arg reference-buffer)
9263 "Open a link in the string S, as if it was in Org-mode."
9265 (let ((reference-buffer (or reference-buffer (current-buffer))))
9266 (with-temp-buffer
9267 (let ((org-inhibit-startup t))
9268 (org-mode)
9269 (insert s)
9270 (goto-char (point-min))
9271 (when reference-buffer
9272 (setq org-link-abbrev-alist-local
9273 (with-current-buffer reference-buffer
9274 org-link-abbrev-alist-local)))
9275 (org-open-at-point arg reference-buffer)))))
9277 (defvar org-open-at-point-functions nil
9278 "Hook that is run when following a link at point.
9280 Functions in this hook must return t if they identify and follow
9281 a link at point. If they don't find anything interesting at point,
9282 they must return nil.")
9284 (defun org-open-at-point (&optional arg reference-buffer)
9285 "Open link at or after point.
9286 If there is no link at point, this function will search forward up to
9287 the end of the current line.
9288 Normally, files will be opened by an appropriate application. If the
9289 optional prefix argument ARG is non-nil, Emacs will visit the file.
9290 With a double prefix argument, try to open outside of Emacs, in the
9291 application the system uses for this file type."
9292 (interactive "P")
9293 ;; if in a code block, then open the block's results
9294 (unless (call-interactively #'org-babel-open-src-block-result)
9295 (org-load-modules-maybe)
9296 (move-marker org-open-link-marker (point))
9297 (setq org-window-config-before-follow-link (current-window-configuration))
9298 (org-remove-occur-highlights nil nil t)
9299 (cond
9300 ((and (org-on-heading-p)
9301 (not (org-in-regexp
9306 (not (get-text-property (point) 'org-linked-text)))
9307 (or (org-offer-links-in-entry arg)
9308 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9309 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9310 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9311 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9312 (not (org-in-regexp org-bracket-link-regexp)))
9313 (org-footnote-action))
9314 (t
9315 (let (type path link line search (pos (point)))
9316 (catch 'match
9317 (save-excursion
9319 (when (org-in-regexp org-bracket-link-regexp 1)
9320 (setq link (org-extract-attributes
9321 (org-link-unescape (org-match-string-no-properties 1))))
9323 (setq link (replace-match " " t t link)))
9324 (setq link (org-link-expand-abbrev link))
9325 (cond
9326 ((or (file-name-absolute-p link)
9328 (setq type "file" path link))
9329 ((string-match org-link-re-with-space3 link)
9330 (setq type (match-string 1 link) path (match-string 2 link)))
9331 (t (setq type "thisfile" path link)))
9332 (throw 'match t)))
9334 (when (get-text-property (point) 'org-linked-text)
9335 (setq type "thisfile"
9336 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9337 (1+ (point)) (point))
9338 path (buffer-substring
9339 (or (previous-single-property-change pos 'org-linked-text)
9340 (point-min))
9341 (or (next-single-property-change pos 'org-linked-text)
9342 (point-max))))
9343 (throw 'match t))
9345 (save-excursion
9346 (when (or (org-in-regexp org-angle-link-re)
9347 (org-in-regexp org-plain-link-re))
9348 (setq type (match-string 1) path (match-string 2))
9349 (throw 'match t)))
9350 (save-excursion
9352 (setq type "tags"
9353 path (match-string 1))
9354 (while (string-match ":" path)
9355 (setq path (replace-match "+" t t path)))
9356 (throw 'match t)))
9358 (setq type "tree-match"
9359 path (match-string 1))
9360 (throw 'match t)))
9361 (unless path
9362 (error "No link found"))
9364 ;; switch back to reference buffer
9365 ;; needed when if called in a temporary buffer through
9366 ;; org-open-link-from-string
9367 (with-current-buffer (or reference-buffer (current-buffer))
9369 ;; Remove any trailing spaces in path
9371 (setq path (replace-match "" t t path)))
9372 (if (and org-link-translation-function
9373 (fboundp org-link-translation-function))
9374 ;; Check if we need to translate the link
9375 (let ((tmp (funcall org-link-translation-function type path)))
9376 (setq type (car tmp) path (cdr tmp))))
9378 (cond
9380 ((assoc type org-link-protocols)
9381 (funcall (nth 1 (assoc type org-link-protocols)) path))
9383 ((equal type "mailto")
9384 (let ((cmd (car org-link-mailto-program))
9385 (args (cdr org-link-mailto-program)) args1
9386 (address path) (subject "") a)
9388 (setq address (match-string 1 path)
9389 subject (org-link-escape (match-string 2 path))))
9390 (while args
9391 (cond
9392 ((not (stringp (car args))) (push (pop args) args1))
9393 (t (setq a (pop args))
9394 (if (string-match "%a" a)
9395 (setq a (replace-match address t t a)))
9396 (if (string-match "%s" a)
9397 (setq a (replace-match subject t t a)))
9398 (push a args1))))
9399 (apply cmd (nreverse args1))))
9401 ((member type '("http" "https" "ftp" "news"))
9402 (browse-url (concat type ":" (org-link-escape
9403 path org-link-escape-chars-browser))))
9405 ((string= type "doi")
9406 (browse-url (concat "http://dx.doi.org/"
9407 (org-link-escape
9408 path org-link-escape-chars-browser))))
9410 ((member type '("message"))
9411 (browse-url (concat type ":" path)))
9413 ((string= type "tags")
9414 (org-tags-view arg path))
9416 ((string= type "tree-match")
9419 ((string= type "file")
9421 (setq line (string-to-number (match-string 1 path))
9422 path (substring path 0 (match-beginning 0)))
9424 (setq search (match-string 1 path)
9425 path (substring path 0 (match-beginning 0)))))
9426 (if (string-match "[*?{]" (file-name-nondirectory path))
9427 (dired path)
9428 (org-open-file path arg line search)))
9430 ((string= type "shell")
9431 (let ((cmd path))
9432 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9433 (string-match org-confirm-shell-link-not-regexp cmd))
9434 (not org-confirm-shell-link-function)
9435 (funcall org-confirm-shell-link-function
9437 (org-add-props cmd nil
9438 'face 'org-warning))))
9439 (progn
9440 (message "Executing %s" cmd)
9441 (shell-command cmd))
9442 (error "Abort"))))
9444 ((string= type "elisp")
9445 (let ((cmd path))
9446 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9447 (string-match org-confirm-elisp-link-not-regexp cmd))
9448 (not org-confirm-elisp-link-function)
9449 (funcall org-confirm-elisp-link-function
9451 (org-add-props cmd nil
9452 'face 'org-warning))))
9453 (message "%s => %s" cmd
9454 (if (equal (string-to-char cmd) ?\()
9455 (eval (read cmd))
9456 (call-interactively (read cmd))))
9457 (error "Abort"))))
9459 ((and (string= type "thisfile")
9460 (run-hook-with-args-until-success
9461 'org-open-link-functions path)))
9463 ((string= type "thisfile")
9464 (if arg
9465 (switch-to-buffer-other-window
9466 (org-get-buffer-for-internal-link (current-buffer)))
9467 (org-mark-ring-push))
9468 (let ((cmd `(org-link-search
9469 ,path
9470 ,(cond ((equal arg '(4)) ''occur)
9471 ((equal arg '(16)) ''org-occur)
9472 (t nil))
9473 ,pos)))
9474 (condition-case nil (eval cmd)
9475 (error (progn (widen) (eval cmd))))))
9477 (t
9478 (browse-url-at-point)))))))
9479 (move-marker org-open-link-marker nil)
9480 (run-hook-with-args 'org-follow-link-hook)))
9482 (defun org-offer-links-in-entry (&optional nth zero)
9483 "Offer links in the current entry and follow the selected link.
9484 If there is only one link, follow it immediately as well.
9485 If NTH is an integer, immediately pick the NTH link found.
9486 If ZERO is a string, check also this string for a link, and if
9487 there is one, offer it as link number zero."
9491 (cnt ?0)
9492 (in-emacs (if (integerp nth) nil nth))
9493 have-zero end links link c)
9494 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9495 (push (match-string 0 zero) links)
9496 (setq cnt (1- cnt) have-zero t))
9497 (save-excursion
9498 (org-back-to-heading t)
9499 (setq end (save-excursion (outline-next-heading) (point)))
9500 (while (re-search-forward re end t)
9501 (push (match-string 0) links))
9502 (setq links (org-uniquify (reverse links))))
9504 (cond
9505 ((null links)
9506 (message "No links"))
9507 ((equal (length links) 1)
9508 (setq link (list (car links))))
9509 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9510 (setq link (nth (if have-zero nth (1- nth)) links)))
9511 (t ; we have to select a link
9512 (save-excursion
9513 (save-window-excursion
9514 (delete-other-windows)
9515 (with-output-to-temp-buffer "*Select Link*"
9516 (mapc (lambda (l)
9517 (if (not (string-match org-bracket-link-regexp l))
9519 (org-remove-angle-brackets l)))
9520 (if (match-end 3)
9522 (match-string 3 l) (match-string 1 l)))
9524 (match-string 1 l))))))
9525 links))
9526 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9527 (message "Select link to open, RET to open all:")
9528 (setq c (read-char-exclusive))
9529 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9530 (when (equal c ?q) (error "Abort"))
9531 (if (equal c ?\C-m)
9532 (setq link links)
9533 (setq nth (- c ?0))
9534 (if have-zero (setq nth (1+ nth)))
9535 (unless (and (integerp nth) (>= (length links) nth))
9536 (error "Invalid link selection"))
9537 (setq link (list (nth (1- nth) links))))))
9538 (if link
9539 (let ((buf (current-buffer)))
9540 (dolist (l link)
9541 (org-open-link-from-string l in-emacs buf))
9542 t)
9543 nil)))
9545 ;; Add special file links that specify the way of opening
9547 (org-add-link-type "file+sys" 'org-open-file-with-system)
9548 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9549 (defun org-open-file-with-system (path)
9550 "Open file at PATH using the system way of opening it."
9551 (org-open-file path 'system))
9552 (defun org-open-file-with-emacs (path)
9553 "Open file at PATH in Emacs."
9554 (org-open-file path 'emacs))
9555 (defun org-remove-file-link-modifiers ()
9556 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9557 (goto-char (point-min))
9559 (org-if-unprotected
9560 (replace-match "file:" t t))))
9561 (eval-after-load "org-exp"
9562 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9563 'org-remove-file-link-modifiers))
9565 ;;;; Time estimates
9567 (defun org-get-effort (&optional pom)
9568 "Get the effort estimate for the current entry."
9569 (org-entry-get pom org-effort-property))
9571 ;;; File search
9573 (defvar org-create-file-search-functions nil
9574 "List of functions to construct the right search string for a file link.
9575 These functions are called in turn with point at the location to
9576 which the link should point.
9578 A function in the hook should first test if it would like to
9579 handle this file type, for example by checking the `major-mode'
9580 or the file extension. If it decides not to handle this file, it
9581 should just return nil to give other functions a chance. If it
9582 does handle the file, it must return the search string to be used
9583 when following the link. The search string will be part of the
9584 file link, given after a double colon, and `org-open-at-point'
9585 will automatically search for it. If special measures must be
9586 taken to make the search successful, another function should be
9587 added to the companion hook `org-execute-file-search-functions',
9588 which see.
9590 A function in this hook may also use `setq' to set the variable
9591 `description' to provide a suggestion for the descriptive text to
9592 be used for this link when it gets inserted into an Org-mode
9595 (defvar org-execute-file-search-functions nil
9596 "List of functions to execute a file search triggered by a link.
9598 Functions added to this hook must accept a single argument, the
9599 search string that was part of the file link, the part after the
9600 double colon. The function must first check if it would like to
9601 handle this search, for example by checking the `major-mode' or
9602 the file extension. If it decides not to handle this search, it
9603 should just return nil to give other functions a chance. If it
9604 does handle the search, it must return a non-nil value to keep
9605 other functions from trying.
9607 Each function can access the current prefix argument through the
9608 variable `current-prefix-argument'. Note that a single prefix is
9609 used to force opening a link in Emacs, so it may be good to only
9610 use a numeric or double prefix to guide the search function.
9612 In case this is needed, a function in this hook can also restore
9613 the window configuration before `org-open-at-point' was called using:
9615 (set-window-configuration org-window-config-before-follow-link)")
9617 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9618 (defun org-link-search (s &optional type avoid-pos)
9619 "Search for a link search option.
9620 If S is surrounded by forward slashes, it is interpreted as a
9621 regular expression. In org-mode files, this will create an `org-occur'
9622 sparse tree. In ordinary files, `occur' will be used to list matches.
9623 If the current buffer is in `dired-mode', grep will be used to search
9624 in all files. If AVOID-POS is given, ignore matches near that position."
9625 (let ((case-fold-search t)
9629 org-emphasis-alist)
9631 (pos (point))
9632 (pre nil) (post nil)
9633 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9634 (cond
9635 ;; First check if there are any special search functions
9636 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9637 ;; Now try the builtin stuff
9638 ((and (equal (string-to-char s0) ?#)
9639 (> (length s0) 1)
9640 (save-excursion
9641 (goto-char (point-min))
9642 (and
9643 (re-search-forward
9645 (setq type 'dedicated
9646 pos (match-beginning 0))))
9647 ;; There is an exact target for this
9648 (goto-char pos)
9649 (org-back-to-heading t)))
9650 ((save-excursion
9651 (goto-char (point-min))
9652 (and
9653 (re-search-forward
9654 (concat "<<" (regexp-quote s0) ">>") nil t)
9655 (setq type 'dedicated
9656 pos (match-beginning 0))))
9657 ;; There is an exact target for this
9658 (goto-char pos))
9660 (save-excursion
9661 (goto-char (point-min))
9662 (and
9663 (re-search-forward
9664 (concat "[^[]" (regexp-quote
9665 (format org-coderef-label-format
9666 (match-string 1 s0))))
9667 nil t)
9668 (setq type 'dedicated
9669 pos (1+ (match-beginning 0))))))
9670 ;; There is a coderef target for this
9671 (goto-char pos))
9673 ;; A regular expression
9674 (cond
9675 ((org-mode-p)
9676 (org-occur (match-string 1 s)))
9677 ;;((eq major-mode 'dired-mode)
9678 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9679 (t (org-do-occur (match-string 1 s)))))
9680 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9681 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9682 (goto-char (point-min))
9683 (cond
9684 ((let (case-fold-search)
9685 (re-search-forward (format org-complex-heading-regexp-format
9686 (regexp-quote s))
9687 nil t))
9688 ;; OK, found a match
9689 (setq type 'dedicated)
9690 (goto-char (match-beginning 0)))
9691 ((and (not org-link-search-inhibit-query)
9692 (eq org-link-search-must-match-exact-headline 'query-to-create)
9693 (y-or-n-p "No match - create this as a new heading? "))
9694 (goto-char (point-max))
9695 (or (bolp) (newline))
9697 (beginning-of-line 0))
9698 (t
9699 (goto-char pos)
9700 (error "No match"))))
9701 (t
9702 ;; A normal search string
9703 (when (equal (string-to-char s) ?*)
9704 ;; Anchor on headlines, post may include tags.
9707 s (substring s 1)))
9708 (remove-text-properties
9709 0 (length s)
9710 '(face nil mouse-face nil keymap nil fontified nil) s)
9711 ;; Make a series of regular expressions to find a match
9720 re4 (concat "[^a-zA-Z_]" re4_)
9722 re1 (concat pre re2 post)
9723 re3 (concat pre (if pre re4_ re4) post)
9724 re5 (concat pre ".*" re4)
9725 re2 (concat pre re2)
9726 re2a (concat pre (if pre re2a_ re2a))
9727 re4 (concat pre (if pre re4_ re4))
9731 ))
9732 (cond
9733 ((eq type 'org-occur) (org-occur reall))
9734 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9735 (t (goto-char (point-min))
9736 (setq type 'fuzzy)
9737 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9738 (org-search-not-self 1 re1 nil t)
9739 (org-search-not-self 1 re2 nil t)
9740 (org-search-not-self 1 re2a nil t)
9741 (org-search-not-self 1 re3 nil t)
9742 (org-search-not-self 1 re4 nil t)
9743 (org-search-not-self 1 re5 nil t)
9744 )
9745 (goto-char (match-beginning 1))
9746 (goto-char pos)
9747 (error "No match"))))))
9748 (and (org-mode-p) (org-show-context 'link-search))
9749 type))
9751 (defun org-search-not-self (group &rest args)
9752 "Execute `re-search-forward', but only accept matches that do not
9753 enclose the position of `org-open-link-marker'."
9754 (let ((m org-open-link-marker))
9755 (catch 'exit
9756 (while (apply 're-search-forward args)
9757 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9758 (goto-char (match-end group))
9759 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9760 (> (match-beginning 0) (marker-position m))
9761 (< (match-end 0) (marker-position m)))
9762 (save-match-data
9763 (or (not (org-in-regexp
9764 org-bracket-link-analytic-regexp 1))
9765 (not (match-end 4)) ; no description
9766 (and (<= (match-beginning 4) (point))
9767 (>= (match-end 4) (point))))))
9768 (throw 'exit (point))))))))
9770 (defun org-get-buffer-for-internal-link (buffer)
9771 "Return a buffer to be used for displaying the link target of internal links."
9772 (cond
9773 ((not org-display-internal-link-with-indirect-buffer)
9774 buffer)
9775 ((string-match "(Clone)$" (buffer-name buffer))
9776 (message "Buffer is already a clone, not making another one")
9777 ;; we also do not modify visibility in this case
9778 buffer)
9779 (t ; make a new indirect buffer for displaying the link
9780 (let* ((bn (buffer-name buffer))
9781 (ibn (concat bn "(Clone)"))
9782 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9783 (with-current-buffer ib (org-overview))
9784 ib))))
9786 (defun org-do-occur (regexp &optional cleanup)
9787 "Call the Emacs command `occur'.
9788 If CLEANUP is non-nil, remove the printout of the regular expression
9789 in the *Occur* buffer. This is useful if the regex is long and not useful
9790 to read."
9791 (occur regexp)
9792 (when cleanup
9793 (let ((cwin (selected-window)) win beg end)
9794 (when (setq win (get-buffer-window "*Occur*"))
9795 (select-window win))
9796 (goto-char (point-min))
9797 (when (re-search-forward "match[a-z]+" nil t)
9798 (setq beg (match-end 0))
9800 (setq end (1- (match-beginning 0)))))
9801 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9802 (goto-char (point-min))
9803 (select-window cwin))))
9805 ;;; The mark ring for links jumps
9807 (defvar org-mark-ring nil
9808 "Mark ring for positions before jumps in Org-mode.")
9809 (defvar org-mark-ring-last-goto nil
9810 "Last position in the mark ring used to go back.")
9811 ;; Fill and close the ring
9812 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9813 (loop for i from 1 to org-mark-ring-length do
9814 (push (make-marker) org-mark-ring))
9815 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9816 org-mark-ring)
9818 (defun org-mark-ring-push (&optional pos buffer)
9819 "Put the current position or POS into the mark ring and rotate it."
9820 (interactive)
9821 (setq pos (or pos (point)))
9822 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9823 (move-marker (car org-mark-ring)
9824 (or pos (point))
9825 (or buffer (current-buffer)))
9826 (message "%s"
9827 (substitute-command-keys
9830 (defun org-mark-ring-goto (&optional n)
9831 "Jump to the previous position in the mark ring.
9832 With prefix arg N, jump back that many stored positions. When
9833 called several times in succession, walk through the entire ring.
9834 Org-mode commands jumping to a different position in the current file,
9835 or to another Org-mode file, automatically push the old position
9836 onto the ring."
9837 (interactive "p")
9838 (let (p m)
9839 (if (eq last-command this-command)
9840 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9841 (setq p org-mark-ring))
9842 (setq org-mark-ring-last-goto p)
9843 (setq m (car p))
9844 (org-pop-to-buffer-same-window (marker-buffer m))
9845 (goto-char m)
9846 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9848 (defun org-remove-angle-brackets (s)
9849 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9850 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9851 s)
9852 (defun org-add-angle-brackets (s)
9853 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9854 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9855 s)
9856 (defun org-remove-double-quotes (s)
9859 s)
9861 ;;; Following specific links
9863 (defun org-follow-timestamp-link ()
9864 (cond
9865 ((org-at-date-range-p t)
9866 (let ((org-agenda-start-on-weekday)
9867 (t1 (match-string 1))
9868 (t2 (match-string 2)))
9869 (setq t1 (time-to-days (org-time-string-to-time t1))
9870 t2 (time-to-days (org-time-string-to-time t2)))
9871 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9872 ((org-at-timestamp-p t)
9873 (org-agenda-list nil (time-to-days (org-time-string-to-time
9874 (substring (match-string 1) 0 10)))
9875 1))
9876 (t (error "This should not happen"))))
9879 ;;; Following file links
9880 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9881 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9882 (declare-function mailcap-mime-info
9883 "mailcap" (string &optional request no-decode))
9884 (defvar org-wait nil)
9885 (defun org-open-file (path &optional in-emacs line search)
9886 "Open the file at PATH.
9887 First, this expands any special file name abbreviations. Then the
9888 configuration variable `org-file-apps' is checked if it contains an
9889 entry for this file type, and if yes, the corresponding command is launched.
9891 If no application is found, Emacs simply visits the file.
9893 With optional prefix argument IN-EMACS, Emacs will visit the file.
9895 prefix arg, Org tries to avoid opening in Emacs
9896 and to use an external application to visit the file.
9898 Optional LINE specifies a line to go to, optional SEARCH a string
9899 to search for. If LINE or SEARCH is given, the file will be
9900 opened in Emacs, unless an entry from org-file-apps that makes
9901 use of groups in a regexp matches.
9902 If the file does not exist, an error is thrown."
9903 (let* ((file (if (equal path "")
9904 buffer-file-name
9905 (substitute-in-file-name (expand-file-name path))))
9906 (file-apps (append org-file-apps (org-default-apps)))
9907 (apps (org-remove-if
9908 'org-file-apps-entry-match-against-dlink-p file-apps))
9909 (apps-dlink (org-remove-if-not
9910 'org-file-apps-entry-match-against-dlink-p file-apps))
9911 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9912 (dirp (if remp nil (file-directory-p file)))
9913 (file (if (and dirp org-open-directory-means-index-dot-org)
9914 (concat (file-name-as-directory file) "index.org")
9915 file))
9916 (a-m-a-p (assq 'auto-mode apps))
9917 (dfile (downcase file))
9918 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9919 (link (cond ((and (eq line nil)
9920 (eq search nil))
9921 file)
9922 (line
9923 (concat file "::" (number-to-string line)))
9924 (search
9925 (concat file "::" search))))
9926 (dlink (downcase link))
9927 (old-buffer (current-buffer))
9928 (old-pos (point))
9929 (old-mode major-mode)
9930 ext cmd link-match-data)
9932 (setq ext (match-string 1 dfile))
9934 (setq ext (match-string 1 dfile))))
9935 (cond
9936 ((member in-emacs '((16) system))
9937 (setq cmd (cdr (assoc 'system apps))))
9938 (in-emacs (setq cmd 'emacs))
9939 (t
9940 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9941 (and dirp (cdr (assoc 'directory apps)))
9942 ; first, try matching against apps-dlink
9943 ; if we get a match here, store the match data for later
9944 (let ((match (assoc-default dlink apps-dlink
9945 'string-match)))
9946 (if match
9947 (progn (setq link-match-data (match-data))
9948 match)
9949 (progn (setq in-emacs (or in-emacs line search))
9950 nil))) ; if we have no match in apps-dlink,
9951 ; always open the file in emacs if line or search
9952 ; is given (for backwards compatibility)
9953 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9954 'string-match)
9955 (cdr (assoc ext apps))
9956 (cdr (assoc t apps))))))
9957 (when (eq cmd 'system)
9958 (setq cmd (cdr (assoc 'system apps))))
9959 (when (eq cmd 'default)
9960 (setq cmd (cdr (assoc t apps))))
9961 (when (eq cmd 'mailcap)
9962 (require 'mailcap)
9963 (mailcap-parse-mailcaps)
9964 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9965 (command (mailcap-mime-info mime-type)))
9966 (if (stringp command)
9967 (setq cmd command)
9968 (setq cmd 'emacs))))
9969 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9970 (not (file-exists-p file))
9971 (not org-open-non-existing-files))
9972 (error "No such file: %s" file))
9973 (cond
9975 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9977 (setq cmd (replace-match "%s" t t cmd)))
9978 (while (string-match "%s" cmd)
9979 (setq cmd (replace-match
9980 (save-match-data
9981 (shell-quote-argument
9982 (convert-standard-filename file)))
9983 t t cmd)))
9985 ;; Replace "%1", "%2" etc. in command with group matches from regex
9986 (save-match-data
9987 (let ((match-index 1)
9988 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9989 (set-match-data link-match-data)
9990 (while (<= match-index number-of-groups)
9991 (let ((regex (concat "%" (number-to-string match-index)))
9992 (replace-with (match-string match-index dlink)))
9993 (while (string-match regex cmd)
9994 (setq cmd (replace-match replace-with t t cmd))))
9995 (setq match-index (+ match-index 1)))))
9997 (save-window-excursion
9998 (start-process-shell-command cmd nil cmd)
9999 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10000 ))
10001 ((or (stringp cmd)
10002 (eq cmd 'emacs))
10003 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10004 (widen)
10005 (if line (org-goto-line line)
10006 (if search (org-link-search search))))
10007 ((consp cmd)
10008 (let ((file (convert-standard-filename file)))
10009 (save-match-data
10010 (set-match-data link-match-data)
10011 (eval cmd))))
10012 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10013 (and (org-mode-p) (eq old-mode 'org-mode)
10014 (or (not (equal old-buffer (current-buffer)))
10015 (not (equal old-pos (point))))
10016 (org-mark-ring-push old-pos old-buffer))))
10018 (defun org-file-apps-entry-match-against-dlink-p (entry)
10019 "This function returns non-nil if `entry' uses a regular
10020 expression which should be matched against the whole link by
10021 org-open-file.
10023 It assumes that is the case when the entry uses a regular
10024 expression which has at least one grouping construct and the
10025 action is either a lisp form or a command string containing
10026 '%1', i.e. using at least one subexpression match as a
10027 parameter."
10028 (let ((selector (car entry))
10029 (action (cdr entry)))
10030 (if (stringp selector)
10031 (and (> (regexp-opt-depth selector) 0)
10032 (or (and (stringp action)
10033 (string-match "%[0-9]" action))
10034 (consp action)))
10035 nil)))
10037 (defun org-default-apps ()
10038 "Return the default applications for this operating system."
10039 (cond
10040 ((eq system-type 'darwin)
10041 org-file-apps-defaults-macosx)
10042 ((eq system-type 'windows-nt)
10043 org-file-apps-defaults-windowsnt)
10044 (t org-file-apps-defaults-gnu)))
10046 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10047 "Convert extensions to regular expressions in the cars of LIST.
10048 Also, weed out any non-string entries, because the return value is used
10049 only for regexp matching.
10050 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10051 point to the symbol `emacs', indicating that the file should
10052 be opened in Emacs."
10053 (append
10054 (delq nil
10055 (mapcar (lambda (x)
10056 (if (not (stringp (car x)))
10057 nil
10059 x
10061 list))
10062 (if add-auto-mode
10063 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10065 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10066 (defun org-file-remote-p (file)
10067 "Test whether FILE specifies a location on a remote system.
10068 Return non-nil if the location is indeed remote.
10072 (cond ((fboundp 'file-remote-p)
10073 (file-remote-p file))
10074 ((fboundp 'tramp-handle-file-remote-p)
10075 (tramp-handle-file-remote-p file))
10076 ((and (boundp 'ange-ftp-name-format)
10077 (string-match (car ange-ftp-name-format) file))
10078 t)
10079 (t nil)))
10082 ;;;; Refiling
10084 (defun org-get-org-file ()
10085 "Read a filename, with default directory `org-directory'."
10086 (let ((default (or org-default-notes-file remember-data-file)))
10087 (read-file-name (format "File name [%s]: " default)
10088 (file-name-as-directory org-directory)
10089 default)))
10091 (defun org-notes-order-reversed-p ()
10092 "Check if the current file should receive notes in reversed order."
10093 (cond
10094 ((not org-reverse-note-order) nil)
10095 ((eq t org-reverse-note-order) t)
10096 ((not (listp org-reverse-note-order)) nil)
10097 (t (catch 'exit
10098 (let ((all org-reverse-note-order)
10099 entry)
10100 (while (setq entry (pop all))
10101 (if (string-match (car entry) buffer-file-name)
10102 (throw 'exit (cdr entry))))
10103 nil)))))
10105 (defvar org-refile-target-table nil
10106 "The list of refile targets, created by `org-refile'.")
10108 (defvar org-agenda-new-buffers nil
10109 "Buffers created to visit agenda files.")
10111 (defvar org-refile-cache nil
10112 "Cache for refile targets.")
10114 (defvar org-refile-markers nil
10115 "All the markers used for caching refile locations.")
10117 (defun org-refile-marker (pos)
10118 "Get a new refile marker, but only if caching is in use."
10119 (if (not org-refile-use-cache)
10120 pos
10121 (let ((m (make-marker)))
10122 (move-marker m pos)
10123 (push m org-refile-markers)
10124 m)))
10126 (defun org-refile-cache-clear ()
10127 "Clear the refile cache and disable all the markers."
10128 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10129 (setq org-refile-markers nil)
10130 (setq org-refile-cache nil)
10131 (message "Refile cache has been cleared"))
10133 (defun org-refile-cache-check-set (set)
10134 "Check if all the markers in the cache still have live buffers."
10135 (let (marker)
10136 (catch 'exit
10137 (while (and set (setq marker (nth 3 (pop set))))
10138 ;; if org-refile-use-outline-path is 'file, marker may be nil
10139 (when (and marker (null (marker-buffer marker)))
10140 (message "not found") (sit-for 3)
10141 (throw 'exit nil)))
10142 t)))
10144 (defun org-refile-cache-put (set &rest identifiers)
10145 "Push the refile targets SET into the cache, under IDENTIFIERS."
10146 (let* ((key (sha1 (prin1-to-string identifiers)))
10147 (entry (assoc key org-refile-cache)))
10148 (if entry
10149 (setcdr entry set)
10150 (push (cons key set) org-refile-cache))))
10152 (defun org-refile-cache-get (&rest identifiers)
10153 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10154 (cond
10155 ((not org-refile-cache) nil)
10156 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10157 (t
10158 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10159 org-refile-cache))))
10160 (and set (org-refile-cache-check-set set) set)))))
10162 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10163 "Produce a table with refile targets."
10164 (let ((case-fold-search nil)
10165 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10166 (entries (or org-refile-targets '((nil . (:level . 1)))))
10167 targets tgs txt re files f desc descre fast-path-p level pos0)
10168 (message "Getting targets...")
10169 (with-current-buffer (or default-buffer (current-buffer))
10170 (while (setq entry (pop entries))
10171 (setq files (car entry) desc (cdr entry))
10172 (setq fast-path-p nil)
10173 (cond
10174 ((null files) (setq files (list (current-buffer))))
10175 ((eq files 'org-agenda-files)
10176 (setq files (org-agenda-files 'unrestricted)))
10177 ((and (symbolp files) (fboundp files))
10178 (setq files (funcall files)))
10179 ((and (symbolp files) (boundp files))
10180 (setq files (symbol-value files))))
10181 (if (stringp files) (setq files (list files)))
10182 (cond
10183 ((eq (car desc) :tag)
10185 ((eq (car desc) :todo)
10187 ((eq (car desc) :regexp)
10188 (setq descre (cdr desc)))
10189 ((eq (car desc) :level)
10191 (if org-odd-levels-only
10192 (1- (* 2 (cdr desc)))
10193 (cdr desc)))
10195 ((eq (car desc) :maxlevel)
10196 (setq fast-path-p t)
10198 (if org-odd-levels-only
10199 (1- (* 2 (cdr desc)))
10200 (cdr desc)))
10202 (t (error "Bad refiling target description %s" desc)))
10203 (while (setq f (pop files))
10204 (with-current-buffer
10205 (if (bufferp f) f (org-get-agenda-file-buffer f))
10206 (or
10207 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10208 (progn
10209 (if (bufferp f) (setq f (buffer-file-name
10210 (buffer-base-buffer f))))
10211 (setq f (and f (expand-file-name f)))
10212 (if (eq org-refile-use-outline-path 'file)
10213 (push (list (file-name-nondirectory f) f nil nil) tgs))
10214 (save-excursion
10215 (save-restriction
10216 (widen)
10217 (goto-char (point-min))
10218 (while (re-search-forward descre nil t)
10219 (goto-char (setq pos0 (point-at-bol)))
10220 (catch 'next
10221 (when org-refile-target-verify-function
10222 (save-match-data
10223 (or (funcall org-refile-target-verify-function)
10224 (throw 'next t))))
10225 (when (and (looking-at org-complex-heading-regexp)
10226 (not (member (match-string 4) excluded-entries)))
10227 (setq level (org-reduced-level
10228 (- (match-end 1) (match-beginning 1)))
10229 txt (org-link-display-format (match-string 4))
10231 re (format org-complex-heading-regexp-format
10232 (regexp-quote (match-string 4))))
10233 (when org-refile-use-outline-path
10234 (setq txt (mapconcat
10235 'org-protect-slash
10236 (append
10237 (if (eq org-refile-use-outline-path
10238 'file)
10239 (list (file-name-nondirectory
10240 (buffer-file-name
10241 (buffer-base-buffer))))
10242 (if (eq org-refile-use-outline-path
10243 'full-file-path)
10244 (list (buffer-file-name
10245 (buffer-base-buffer)))))
10246 (org-get-outline-path fast-path-p
10247 level txt)
10248 (list txt))
10249 "/")))
10250 (push (list txt f re (org-refile-marker (point)))
10251 tgs)))
10252 (when (= (point) pos0)
10253 ;; verification function has not moved point
10254 (goto-char (point-at-eol))))))))
10255 (when org-refile-use-cache
10256 (org-refile-cache-put tgs (buffer-file-name) descre))
10257 (setq targets (append tgs targets))
10258 ))))
10259 (message "Getting targets...done")
10260 (nreverse targets)))
10262 (defun org-protect-slash (s)
10263 (while (string-match "/" s)
10265 s)
10267 (defvar org-olpa (make-vector 20 nil))
10269 (defun org-get-outline-path (&optional fastp level heading)
10270 "Return the outline path to the current entry, as a list.
10272 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10273 routine which makes outline path derivations for an entire file,
10274 avoiding backtracing. Refile target collection makes use of that."
10275 (if fastp
10276 (progn
10277 (if (> level 19)
10278 (error "Outline path failure, more than 19 levels"))
10279 (loop for i from level upto 19 do
10280 (aset org-olpa i nil))
10281 (prog1
10282 (delq nil (append org-olpa nil))
10283 (aset org-olpa level heading)))
10284 (let (rtn case-fold-search)
10285 (save-excursion
10286 (save-restriction
10287 (widen)
10288 (while (org-up-heading-safe)
10289 (when (looking-at org-complex-heading-regexp)
10290 (push (org-match-string-no-properties 4) rtn)))
10291 rtn)))))
10293 (defun org-format-outline-path (path &optional width prefix)
10294 "Format the outline path PATH for display.
10295 Width is the maximum number of characters that is available.
10296 Prefix is a prefix to be included in the returned string,
10297 such as the file name."
10298 (setq width (or width 79))
10299 (if prefix (setq width (- width (length prefix))))
10300 (if (not path)
10301 (or prefix "")
10302 (let* ((nsteps (length path))
10303 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10304 (maxwidth (if (<= total-width width)
10305 10000 ;; everything fits
10306 ;; we need to shorten the level headings
10307 (/ (- width nsteps) nsteps)))
10308 (org-odd-levels-only nil)
10309 (n 0)
10310 (total (1+ (length prefix))))
10311 (setq maxwidth (max maxwidth 10))
10312 (concat prefix
10313 (mapconcat
10314 (lambda (h)
10315 (setq n (1+ n))
10316 (if (and (= n nsteps) (< maxwidth 10000))
10317 (setq maxwidth (- total-width total)))
10318 (if (< (length h) maxwidth)
10319 (progn (setq total (+ total (length h) 1)) h)
10320 (setq h (substring h 0 (- maxwidth 2))
10321 total (+ total maxwidth 1))
10323 (setq h (substring h 0 (match-beginning 0))))
10324 (setq h (concat h "..")))
10325 (org-add-props h nil 'face
10326 (nth (% (1- n) org-n-level-faces)
10327 org-level-faces))
10328 h)
10329 path "/")))))
10331 (defun org-display-outline-path (&optional file current)
10332 "Display the current outline path in the echo area."
10333 (interactive "P")
10334 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10335 (case-fold-search nil)
10336 (path (and (org-mode-p) (org-get-outline-path))))
10337 (if current (setq path (append path
10338 (save-excursion
10339 (org-back-to-heading t)
10340 (if (looking-at org-complex-heading-regexp)
10341 (list (match-string 4)))))))
10342 (message "%s"
10343 (org-format-outline-path
10344 path
10345 (1- (frame-width))
10346 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10348 (defvar org-refile-history nil
10349 "History for refiling operations.")
10351 (defvar org-after-refile-insert-hook nil
10352 "Hook run after `org-refile' has inserted its stuff at the new location.
10353 Note that this is still *before* the stuff will be removed from
10354 the *old* location.")
10356 (defvar org-capture-last-stored-marker)
10357 (defun org-refile (&optional goto default-buffer rfloc)
10358 "Move the entry or entries at point to another heading.
10359 The list of target headings is compiled using the information in
10360 `org-refile-targets', which see.
10362 At the target location, the entry is filed as a subitem of the target
10363 heading. Depending on `org-reverse-note-order', the new subitem will
10364 either be the first or the last subitem.
10366 If there is an active region, all entries in that region will be moved.
10367 However, the region must fulfill the requirement that the first heading
10368 is the first one sets the top-level of the moved text - at most siblings
10369 below it are allowed.
10371 With prefix arg GOTO, the command will only visit the target location
10372 and not actually move anything.
10375 go to the location where the last refiling operation has put the subtree.
10376 With a prefix argument of `2', refile to the running clock.
10378 RFLOC can be a refile location obtained in a different way.
10380 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10382 If you are using target caching (see `org-refile-use-cache'),
10383 You have to clear the target cache in order to find new targets.
10384 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10385 prefix argument (`C-u C-u C-u C-c C-w')."
10387 (interactive "P")
10388 (if (member goto '(0 (64)))
10389 (org-refile-cache-clear)
10390 (let* ((cbuf (current-buffer))
10391 (regionp (org-region-active-p))
10392 (region-start (and regionp (region-beginning)))
10393 (region-end (and regionp (region-end)))
10394 (region-length (and regionp (- region-end region-start)))
10395 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10396 pos it nbuf file re level reversed)
10397 (setq last-command nil)
10398 (when regionp
10399 (goto-char region-start)
10400 (or (bolp) (goto-char (point-at-bol)))
10401 (setq region-start (point))
10402 (unless (org-kill-is-subtree-p
10403 (buffer-substring region-start region-end))
10404 (error "The region is not a (sequence of) subtree(s)")))
10405 (if (equal goto '(16))
10406 (org-refile-goto-last-stored)
10407 (when (or
10408 (and (equal goto 2)
10409 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10410 (prog1
10411 (setq it (list (or org-clock-heading "running clock")
10412 (buffer-file-name
10413 (marker-buffer org-clock-hd-marker))
10414 ""
10415 (marker-position org-clock-hd-marker)))
10416 (setq goto nil)))
10417 (setq it (or rfloc
10418 (save-excursion
10419 (org-refile-get-location
10420 (if goto "Goto" "Refile to") default-buffer
10421 org-refile-allow-creating-parent-nodes)))))
10422 (setq file (nth 1 it)
10423 re (nth 2 it)
10424 pos (nth 3 it))
10425 (if (and (not goto)
10426 pos
10427 (equal (buffer-file-name) file)
10428 (if regionp
10429 (and (>= pos region-start)
10430 (<= pos region-end))
10431 (and (>= pos (point))
10432 (< pos (save-excursion
10433 (org-end-of-subtree t t))))))
10434 (error "Cannot refile to position inside the tree or region"))
10436 (setq nbuf (or (find-buffer-visiting file)
10437 (find-file-noselect file)))
10438 (if goto
10439 (progn
10440 (org-pop-to-buffer-same-window nbuf)
10441 (goto-char pos)
10442 (org-show-context 'org-goto))
10443 (if regionp
10444 (progn
10445 (org-kill-new (buffer-substring region-start region-end))
10446 (org-save-markers-in-region region-start region-end))
10447 (org-copy-subtree 1 nil t))
10448 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10449 (find-file-noselect file)))
10450 (setq reversed (org-notes-order-reversed-p))
10451 (save-excursion
10452 (save-restriction
10453 (widen)
10454 (if pos
10455 (progn
10456 (goto-char pos)
10457 (looking-at org-outline-regexp)
10458 (setq level (org-get-valid-level (funcall outline-level) 1))
10459 (goto-char
10460 (if reversed
10461 (or (outline-next-heading) (point-max))
10462 (or (save-excursion (org-get-next-sibling))
10463 (org-end-of-subtree t t)
10464 (point-max)))))
10465 (setq level 1)
10466 (if (not reversed)
10467 (goto-char (point-max))
10468 (goto-char (point-min))
10469 (or (outline-next-heading) (goto-char (point-max)))))
10470 (if (not (bolp)) (newline))
10471 (org-paste-subtree level)
10472 (when org-log-refile
10473 (org-add-log-setup 'refile nil nil 'findpos
10474 org-log-refile)
10475 (unless (eq org-log-refile 'note)
10476 (save-excursion (org-add-log-note))))
10477 (and org-auto-align-tags (org-set-tags nil t))
10478 (bookmark-set "org-refile-last-stored")
10479 ;; If we are refiling for capture, make sure that the
10480 ;; last-capture pointers point here
10481 (when (org-bound-and-true-p org-refile-for-capture)
10482 (bookmark-set "org-capture-last-stored-marker")
10483 (move-marker org-capture-last-stored-marker (point)))
10484 (if (fboundp 'deactivate-mark) (deactivate-mark))
10485 (run-hooks 'org-after-refile-insert-hook))))
10486 (if regionp
10487 (delete-region (point) (+ (point) region-length))
10488 (org-cut-subtree))
10489 (when (featurep 'org-inlinetask)
10490 (org-inlinetask-remove-END-maybe))
10491 (setq org-markers-to-move nil)
10494 (defun org-refile-goto-last-stored ()
10495 "Go to the location where the last refile was stored."
10496 (interactive)
10497 (bookmark-jump "org-refile-last-stored")
10498 (message "This is the location of the last refile"))
10500 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10501 "Prompt the user for a refile location, using PROMPT.
10502 PROMPT should not be suffixed with a colon and a space, because
10503 this function appends the default value from
10504 `org-refile-history' automatically, if that is not empty."
10505 (let ((org-refile-targets org-refile-targets)
10506 (org-refile-use-outline-path org-refile-use-outline-path)
10507 excluded-entries)
10508 (when (and (eq major-mode 'org-mode)
10509 (not org-refile-use-cache))
10510 (org-map-tree
10511 (lambda()
10512 (setq excluded-entries
10513 (append excluded-entries (list (org-get-heading t t)))))))
10514 (setq org-refile-target-table
10515 (org-refile-get-targets default-buffer excluded-entries)))
10516 (unless org-refile-target-table
10517 (error "No refile targets"))
10518 (let* ((prompt (concat prompt
10519 (and (car org-refile-history)
10520 (concat " (default " (car org-refile-history) ")"))
10521 ": "))
10522 (cbuf (current-buffer))
10523 (partial-completion-mode nil)
10524 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10525 (cfunc (if (and org-refile-use-outline-path
10526 org-outline-path-complete-in-steps)
10527 'org-olpath-completing-read
10528 'org-icompleting-read))
10529 (extra (if org-refile-use-outline-path "/" ""))
10530 (filename (and cfn (expand-file-name cfn)))
10531 (tbl (mapcar
10532 (lambda (x)
10533 (if (and (not (member org-refile-use-outline-path
10534 '(file full-file-path)))
10535 (not (equal filename (nth 1 x))))
10536 (cons (concat (car x) extra " ("
10537 (file-name-nondirectory (nth 1 x)) ")")
10538 (cdr x))
10539 (cons (concat (car x) extra) (cdr x))))
10540 org-refile-target-table))
10541 (completion-ignore-case t)
10542 pa answ parent-target child parent old-hist)
10543 (setq old-hist org-refile-history)
10544 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10545 nil 'org-refile-history (car org-refile-history)))
10546 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10547 (org-refile-check-position pa)
10548 (if pa
10549 (progn
10550 (when (or (not org-refile-history)
10551 (not (eq old-hist org-refile-history))
10552 (not (equal (car pa) (car org-refile-history))))
10553 (setq org-refile-history
10554 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10555 org-refile-history
10556 (cdr org-refile-history))))
10557 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10558 (pop org-refile-history)))
10559 pa)
10561 (progn
10562 (setq parent (match-string 1 answ)
10563 child (match-string 2 answ))
10564 (setq parent-target (or (assoc parent tbl)
10565 (assoc (concat parent "/") tbl)))
10566 (when (and parent-target
10567 (or (eq new-nodes t)
10568 (and (eq new-nodes 'confirm)
10570 child)))))
10571 (org-refile-new-child parent-target child)))
10572 (error "Invalid target location")))))
10574 (defun org-refile-check-position (refile-pointer)
10575 "Check if the refile pointer matches the readline to which it points."
10576 (let* ((file (nth 1 refile-pointer))
10577 (re (nth 2 refile-pointer))
10578 (pos (nth 3 refile-pointer))
10579 buffer)
10580 (when (org-string-nw-p re)
10581 (setq buffer (if (markerp pos)
10582 (marker-buffer pos)
10583 (or (find-buffer-visiting file)
10584 (find-file-noselect file))))
10585 (with-current-buffer buffer
10586 (save-excursion
10587 (save-restriction
10588 (widen)
10589 (goto-char pos)
10590 (beginning-of-line 1)
10591 (unless (org-looking-at-p re)
10592 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10594 (defun org-refile-new-child (parent-target child)
10595 "Use refile target PARENT-TARGET to add new CHILD below it."
10596 (unless parent-target
10597 (error "Cannot find parent for new node"))
10598 (let ((file (nth 1 parent-target))
10599 (pos (nth 3 parent-target))
10600 level)
10601 (with-current-buffer (or (find-buffer-visiting file)
10602 (find-file-noselect file))
10603 (save-excursion
10604 (save-restriction
10605 (widen)
10606 (if pos
10607 (goto-char pos)
10608 (goto-char (point-max))
10609 (if (not (bolp)) (newline)))
10610 (when (looking-at org-outline-regexp)
10611 (setq level (funcall outline-level))
10612 (org-end-of-subtree t t))
10613 (org-back-over-empty-lines)
10615 (if pos (org-get-valid-level level 1) 1) ?*)
10617 (beginning-of-line 0)
10618 (list (concat (car parent-target) "/" child) file "" (point)))))))
10620 (defun org-olpath-completing-read (prompt collection &rest args)
10621 "Read an outline path like a file name."
10622 (let ((thetable collection)
10623 (org-completion-use-ido nil) ; does not work with ido.
10624 (org-completion-use-iswitchb nil)) ; or iswitchb
10625 (apply
10626 'org-icompleting-read prompt
10627 (lambda (string predicate &optional flag)
10628 (let (rtn r f (l (length string)))
10629 (cond
10630 ((eq flag nil)
10631 ;; try completion
10632 (try-completion string thetable))
10633 ((eq flag t)
10634 ;; all-completions
10635 (setq rtn (all-completions string thetable predicate))
10636 (mapcar
10637 (lambda (x)
10638 (setq r (substring x l))
10639 (if (string-match " ([^)]*)$" x)
10640 (setq f (match-string 0 x))
10641 (setq f ""))
10642 (if (string-match "/" r)
10643 (concat string (substring r 0 (match-end 0)) f)
10644 x))
10645 rtn))
10646 ((eq flag 'lambda)
10647 ;; exact match?
10648 (assoc string thetable)))
10649 ))
10650 args)))
10652 ;;;; Dynamic blocks
10654 (defun org-find-dblock (name)
10655 "Find the first dynamic block with name NAME in the buffer.
10656 If not found, stay at current position and return nil."
10657 (let (pos)
10658 (save-excursion
10659 (goto-char (point-min))
10661 nil t)
10662 (match-beginning 0))))
10663 (if pos (goto-char pos))
10664 pos))
10666 (defconst org-dblock-start-re
10668 "Matches the start line of a dynamic block, with parameters.")
10671 "Matches the end of a dynamic block.")
10673 (defun org-create-dblock (plist)
10674 "Create a dynamic block section, with parameters taken from PLIST.
10675 PLIST must contain a :name entry which is used as name of the block."
10677 (end-of-line 1)
10678 (newline))
10679 (let ((col (current-column))
10680 (name (plist-get plist :name)))
10681 (insert "#+BEGIN: " name)
10682 (while plist
10683 (if (eq (car plist) :name)
10684 (setq plist (cddr plist))
10685 (insert " " (prin1-to-string (pop plist)))))
10687 (beginning-of-line -2)))
10689 (defun org-prepare-dblock ()
10690 "Prepare dynamic block for refresh.
10691 This empties the block, puts the cursor at the insert position and returns
10692 the property list including an extra property :name with the block name."
10693 (unless (looking-at org-dblock-start-re)
10694 (error "Not at a dynamic block"))
10695 (let* ((begdel (1+ (match-end 0)))
10696 (name (org-no-properties (match-string 1)))
10697 (params (append (list :name name)
10698 (read (concat "(" (match-string 3) ")")))))
10699 (save-excursion
10700 (beginning-of-line 1)
10702 (setq params (plist-put params :indentation-column (current-column))))
10703 (unless (re-search-forward org-dblock-end-re nil t)
10704 (error "Dynamic block not terminated"))
10705 (setq params
10706 (append params
10707 (list :content (buffer-substring
10708 begdel (match-beginning 0)))))
10709 (delete-region begdel (match-beginning 0))
10710 (goto-char begdel)
10711 (open-line 1)
10712 params))
10714 (defun org-map-dblocks (&optional command)
10715 "Apply COMMAND to all dynamic blocks in the current buffer.
10716 If COMMAND is not given, use `org-update-dblock'."
10717 (let ((cmd (or command 'org-update-dblock)))
10718 (save-excursion
10719 (goto-char (point-min))
10720 (while (re-search-forward org-dblock-start-re nil t)
10721 (goto-char (match-beginning 0))
10722 (save-excursion
10723 (condition-case nil
10724 (funcall cmd)
10725 (error (message "Error during update of dynamic block"))))
10726 (unless (re-search-forward org-dblock-end-re nil t)
10727 (error "Dynamic block not terminated"))))))
10729 (defun org-dblock-update (&optional arg)
10730 "User command for updating dynamic blocks.
10731 Update the dynamic block at point. With prefix ARG, update all dynamic
10732 blocks in the buffer."
10733 (interactive "P")
10734 (if arg
10735 (org-update-all-dblocks)
10736 (or (looking-at org-dblock-start-re)
10737 (org-beginning-of-dblock))
10738 (org-update-dblock)))
10740 (defun org-update-dblock ()
10741 "Update the dynamic block at point.
10742 This means to empty the block, parse for parameters and then call
10743 the correct writing function."
10744 (interactive)
10745 (save-window-excursion
10746 (let* ((pos (point))
10747 (line (org-current-line))
10748 (params (org-prepare-dblock))
10749 (name (plist-get params :name))
10750 (indent (plist-get params :indentation-column))
10751 (cmd (intern (concat "org-dblock-write:" name))))
10752 (message "Updating dynamic block `%s' at line %d..." name line)
10753 (funcall cmd params)
10754 (message "Updating dynamic block `%s' at line %d...done" name line)
10755 (goto-char pos)
10756 (when (and indent (> indent 0))
10757 (setq indent (make-string indent ?\ ))
10758 (save-excursion
10759 (org-beginning-of-dblock)
10760 (forward-line 1)
10761 (while (not (looking-at org-dblock-end-re))
10762 (insert indent)
10763 (beginning-of-line 2))
10764 (when (looking-at org-dblock-end-re)
10766 (replace-match ""))
10767 (insert indent)))))))
10769 (defun org-beginning-of-dblock ()
10770 "Find the beginning of the dynamic block at point.
10771 Error if there is no such block at point."
10772 (let ((pos (point))
10773 beg)
10774 (end-of-line 1)
10775 (if (and (re-search-backward org-dblock-start-re nil t)
10776 (setq beg (match-beginning 0))
10777 (re-search-forward org-dblock-end-re nil t)
10778 (> (match-end 0) pos))
10779 (goto-char beg)
10780 (goto-char pos)
10781 (error "Not in a dynamic block"))))
10783 (defun org-update-all-dblocks ()
10784 "Update all dynamic blocks in the buffer.
10785 This function can be used in a hook."
10786 (interactive)
10787 (when (org-mode-p)
10788 (org-map-dblocks 'org-update-dblock)))
10791 ;;;; Completion
10793 (defconst org-additional-option-like-keywords
10794 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10795 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10796 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10797 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10798 "BEGIN:" "END:"
10799 "ORGTBL" "TBLFM:" "TBLNAME:"
10800 "BEGIN_EXAMPLE" "END_EXAMPLE"
10801 "BEGIN_QUOTE" "END_QUOTE"
10802 "BEGIN_VERSE" "END_VERSE"
10803 "BEGIN_CENTER" "END_CENTER"
10804 "BEGIN_SRC" "END_SRC"
10805 "BEGIN_RESULT" "END_RESULT"
10806 "SOURCE:" "SRCNAME:" "FUNCTION:"
10807 "RESULTS:" "DATA:"
10808 "HEADER:" "HEADERS:"
10809 "BABEL:"
10810 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10811 "CAPTION:" "LABEL:"
10812 "SETUPFILE:"
10813 "INCLUDE:"
10814 "BIND:"
10815 "MACRO:"))
10817 (defcustom org-structure-template-alist
10818 '(
10831 ("L" "#+latex: "
10835 ("H" "#+html: "
10838 ("A" "#+ascii: ")
10839 ("i" "#+index: ?"
10840 "#+index: ?")
10841 ("I" "#+include %file ?"
10843 )
10844 "Structure completion elements.
10845 This is a list of abbreviation keys and values. The value gets inserted
10846 if you type `<' followed by the key and then press the completion key,
10847 usually `M-TAB'. %file will be replaced by a file name after prompting
10848 for the file using completion. The cursor will be placed at the position
10849 of the `?` in the template.
10850 There are two templates for each key, the first uses the original Org syntax,
10851 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10852 the default when the /org-mtags.el/ module has been loaded. See also the
10853 variable `org-mtags-prefer-muse-templates'.
10854 This is an experimental feature, it is undecided if it is going to stay in."
10855 :group 'org-completion
10856 :type '(repeat
10857 (string :tag "Key")
10858 (string :tag "Template")
10859 (string :tag "Muse Template")))
10861 (defun org-try-structure-completion ()
10862 "Try to complete a structure template before point.
10864 expands them."
10865 (let ((l (buffer-substring (point-at-bol) (point)))
10866 a)
10869 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10870 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10871 (match-beginning 1)) a)
10872 t)))
10874 (defun org-complete-expand-structure-template (start cell)
10875 "Expand a structure template."
10876 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10877 (rpl (nth (if musep 2 1) cell))
10878 (ind ""))
10879 (delete-region start (point))
10881 (cond
10882 ((bolp))
10884 (setq ind (buffer-substring (point-at-bol) (point))))
10885 (t (newline))))
10886 (setq start (point))
10887 (if (string-match "%file" rpl)
10888 (setq rpl (replace-match
10889 (concat
10891 (save-match-data
10892 (abbreviate-file-name (read-file-name "Include file: ")))
10894 t t rpl)))
10897 (insert rpl)
10900 ;;;; TODO, DEADLINE, Comments
10902 (defun org-toggle-comment ()
10903 "Change the COMMENT state of an entry."
10904 (interactive)
10905 (save-excursion
10906 (org-back-to-heading)
10907 (let (case-fold-search)
10908 (if (looking-at (concat org-outline-regexp
10910 (replace-match "" t t nil 1)
10911 (if (looking-at org-outline-regexp)
10912 (progn
10913 (goto-char (match-end 0))
10914 (insert org-comment-string " ")))))))
10916 (defvar org-last-todo-state-is-todo nil
10917 "This is non-nil when the last TODO state change led to a TODO state.
10918 If the last change removed the TODO tag or switched to DONE, then
10919 this is nil.")
10921 (defvar org-setting-tags nil) ; dynamically skipped
10923 (defvar org-todo-setup-filter-hook nil
10924 "Hook for functions that pre-filter todo specs.
10925 Each function takes a todo spec and returns either nil or the spec
10926 transformed into canonical form." )
10928 (defvar org-todo-get-default-hook nil
10929 "Hook for functions that get a default item for todo.
10930 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10931 nil or a string to be used for the todo mark." )
10933 (defvar org-agenda-headline-snapshot-before-repeat)
10935 (defun org-current-effective-time ()
10936 "Return current time adjusted for `org-extend-today-until' variable"
10937 (let* ((ct (org-current-time))
10938 (dct (decode-time ct))
10939 (ct1
10940 (if (and org-use-effective-time
10941 (< (nth 2 dct) org-extend-today-until))
10942 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
10943 ct)))
10944 ct1))
10946 (defun org-todo-yesterday (&optional arg)
10947 "Like `org-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-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)
12076 (run-hooks 'org-log-buffer-setup-hook)))
12078 (defvar org-note-abort nil) ; dynamically scoped
12079 (defun org-store-log-note ()
12080 "Finish taking a log note, and insert it to where it belongs."
12081 (let ((txt (buffer-string))
12082 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12083 lines ind bul)
12084 (kill-buffer (current-buffer))
12086 (setq txt (replace-match "" t t txt)))
12088 (setq txt (replace-match "" t t txt)))
12091 (setq note
12092 (org-replace-escapes
12093 note
12094 (list (cons "%u" (user-login-name))
12095 (cons "%U" user-full-name)
12096 (cons "%t" (format-time-string
12097 (org-time-stamp-format 'long 'inactive)
12098 org-log-note-effective-time))
12099 (cons "%T" (format-time-string
12100 (org-time-stamp-format 'long nil)
12101 org-log-note-effective-time))
12102 (cons "%s" (if org-log-note-state
12104 ""))
12105 (cons "%S" (if org-log-note-previous-state
12109 (push note lines))
12110 (when (or current-prefix-arg org-note-abort)
12111 (when org-log-into-drawer
12112 (org-remove-empty-drawer-at
12113 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12114 org-log-note-marker))
12115 (setq lines nil))
12116 (when lines
12117 (with-current-buffer (marker-buffer org-log-note-marker)
12118 (save-excursion
12119 (goto-char org-log-note-marker)
12120 (move-marker org-log-note-marker nil)
12121 (end-of-line 1)
12123 (setq ind (save-excursion
12124 (if (ignore-errors (goto-char (org-in-item-p)))
12125 (let ((struct (org-list-struct)))
12126 (org-list-get-ind
12127 (org-list-get-top-point struct) struct))
12129 (cond
12130 ((and (org-at-heading-p)
12131 org-adapt-indentation)
12132 (1+ (org-current-level)))
12133 ((org-at-heading-p) 0)
12134 (t (org-get-indentation))))))
12135 (setq bul (org-list-bullet-string "-"))
12136 (org-indent-line-to ind)
12137 (insert bul (pop lines))
12138 (let ((ind-body (+ (length bul) ind)))
12139 (while lines
12141 (org-indent-line-to ind-body)
12142 (insert (pop lines))))
12143 (message "Note stored")
12144 (org-back-to-heading t)
12145 (org-cycle-hide-drawers 'children)))))
12146 (set-window-configuration org-log-note-window-configuration)
12147 (with-current-buffer (marker-buffer org-log-note-return-to)
12148 (goto-char org-log-note-return-to))
12149 (move-marker org-log-note-return-to nil)
12150 (and org-log-post-message (message "%s" org-log-post-message)))
12152 (defun org-remove-empty-drawer-at (drawer pos)
12153 "Remove an empty drawer DRAWER at position POS.
12154 POS may also be a marker."
12155 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12156 (save-excursion
12157 (save-restriction
12158 (widen)
12159 (goto-char pos)
12160 (if (org-in-regexp
12162 (replace-match ""))))))
12164 (defun org-sparse-tree (&optional arg)
12165 "Create a sparse tree, prompt for the details.
12166 This command can create sparse trees. You first need to select the type
12167 of match used to create the tree:
12169 t Show all TODO entries.
12170 T Show entries with a specific TODO keyword.
12171 m Show entries selected by a tags/property match.
12172 p Enter a property name and its value (both with completion on existing
12173 names/values) and show entries with that property.
12174 r Show entries matching a regular expression (`/' can be used as well)
12175 d Show deadlines due within `org-deadline-warning-days'.
12176 b Show deadlines and scheduled items before a date.
12177 a Show deadlines and scheduled items after a date."
12178 (interactive "P")
12179 (let (ans kwd value)
12180 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12181 (setq ans (read-char-exclusive))
12182 (cond
12183 ((equal ans ?d)
12184 (call-interactively 'org-check-deadlines))
12185 ((equal ans ?b)
12186 (call-interactively 'org-check-before-date))
12187 ((equal ans ?a)
12188 (call-interactively 'org-check-after-date))
12189 ((equal ans ?t)
12190 (org-show-todo-tree nil))
12191 ((equal ans ?T)
12192 (org-show-todo-tree '(4)))
12193 ((member ans '(?T ?m))
12194 (call-interactively 'org-match-sparse-tree))
12195 ((member ans '(?p ?P))
12196 (setq kwd (org-icompleting-read "Property: "
12197 (mapcar 'list (org-buffer-property-keys))))
12198 (setq value (org-icompleting-read "Value: "
12199 (mapcar 'list (org-property-values kwd))))
12202 (org-match-sparse-tree arg (concat kwd "=" value)))
12203 ((member ans '(?r ?R ?/))
12204 (call-interactively 'org-occur))
12207 (defvar org-occur-highlights nil
12208 "List of overlays used for occur matches.")
12209 (make-variable-buffer-local 'org-occur-highlights)
12210 (defvar org-occur-parameters nil
12211 "Parameters of the active org-occur calls.
12212 This is a list, each call to org-occur pushes as cons cell,
12213 containing the regular expression and the callback, onto the list.
12214 The list can contain several entries if `org-occur' has been called
12215 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12216 will only contain one set of parameters. When the highlights are
12217 removed (for example with `C-c C-c', or with the next edit (depending
12218 on `org-remove-highlights-with-change'), this variable is emptied
12219 as well.")
12220 (make-variable-buffer-local 'org-occur-parameters)
12222 (defun org-occur (regexp &optional keep-previous callback)
12223 "Make a compact tree which shows all matches of REGEXP.
12224 The tree will show the lines where the regexp matches, and all higher
12225 headlines above the match. It will also show the heading after the match,
12226 to make sure editing the matching entry is easy.
12227 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12228 call to `org-occur' will be kept, to allow stacking of calls to this
12229 command.
12230 If CALLBACK is non-nil, it is a function which is called to confirm
12231 that the match should indeed be shown."
12233 (when (equal regexp "")
12234 (error "Regexp cannot be empty"))
12235 (unless keep-previous
12236 (org-remove-occur-highlights nil nil t))
12237 (push (cons regexp callback) org-occur-parameters)
12238 (let ((cnt 0))
12239 (save-excursion
12240 (goto-char (point-min))
12241 (if (or (not keep-previous) ; do not want to keep
12242 (not org-occur-highlights)) ; no previous matches
12243 ;; hide everything
12244 (org-overview))
12245 (while (re-search-forward regexp nil t)
12246 (when (or (not callback)
12247 (save-match-data (funcall callback)))
12248 (setq cnt (1+ cnt))
12249 (when org-highlight-sparse-tree-matches
12250 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12251 (org-show-context 'occur-tree))))
12252 (when org-remove-highlights-with-change
12253 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12254 nil 'local))
12255 (unless org-sparse-tree-open-archived-trees
12256 (org-hide-archived-subtrees (point-min) (point-max)))
12257 (run-hooks 'org-occur-hook)
12258 (if (org-called-interactively-p 'interactive)
12259 (message "%d match(es) for regexp %s" cnt regexp))
12260 cnt))
12262 (defun org-occur-next-match (&optional n reset)
12263 "Function for `next-error-function' to find sparse tree matches.
12264 N is the number of matches to move, when negative move backwards.
12265 RESET is entirely ignored - this function always goes back to the
12266 starting point when no match is found."
12267 (let* ((limit (if (< n 0) (point-min) (point-max)))
12268 (search-func (if (< n 0)
12269 'previous-single-char-property-change
12270 'next-single-char-property-change))
12271 (n (abs n))
12272 (pos (point))
12273 p1)
12274 (catch 'exit
12275 (while (setq p1 (funcall search-func (point) 'org-type))
12276 (when (equal p1 limit)
12277 (goto-char pos)
12278 (error "No more matches"))
12279 (when (equal (get-char-property p1 'org-type) 'org-occur)
12280 (setq n (1- n))
12281 (when (= n 0)
12282 (goto-char p1)
12283 (throw 'exit (point))))
12284 (goto-char p1))
12285 (goto-char p1)
12286 (error "No more matches"))))
12288 (defun org-show-context (&optional key)
12289 "Make sure point and context are visible.
12290 How much context is shown depends upon the variables
12291 `org-show-hierarchy-above', `org-show-following-heading'. and
12292 `org-show-siblings'."
12293 (let ((heading-p (org-on-heading-p t))
12294 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12295 (following-p (org-get-alist-option org-show-following-heading key))
12296 (entry-p (org-get-alist-option org-show-entry-below key))
12297 (siblings-p (org-get-alist-option org-show-siblings key)))
12298 (catch 'exit
12299 ;; Show heading or entry text
12300 (if (and heading-p (not entry-p))
12301 (org-flag-heading nil) ; only show the heading
12302 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12303 (org-show-hidden-entry))) ; show entire entry
12304 (when following-p
12305 ;; Show next sibling, or heading below text
12306 (save-excursion
12307 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12308 (org-flag-heading nil))))
12309 (when siblings-p (org-show-siblings))
12310 (when hierarchy-p
12311 ;; show all higher headings, possibly with siblings
12312 (save-excursion
12313 (while (and (condition-case nil
12314 (progn (org-up-heading-all 1) t)
12315 (error nil))
12316 (not (bobp)))
12317 (org-flag-heading nil)
12318 (when siblings-p (org-show-siblings))))))))
12320 (defvar org-reveal-start-hook nil
12321 "Hook run before revealing a location.")
12323 (defun org-reveal (&optional siblings)
12324 "Show current entry, hierarchy above it, and the following headline.
12325 This can be used to show a consistent set of context around locations
12326 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12327 not t for the search context.
12329 With optional argument SIBLINGS, on each level of the hierarchy all
12330 siblings are shown. This repairs the tree structure to what it would
12331 look like when opened with hierarchical calls to `org-cycle'.
12333 go to the parent and show the
12334 entire tree."
12335 (interactive "P")
12336 (run-hooks 'org-reveal-start-hook)
12337 (let ((org-show-hierarchy-above t)
12338 (org-show-following-heading t)
12339 (org-show-siblings (if siblings t org-show-siblings)))
12340 (org-show-context nil))
12341 (when (equal siblings '(16))
12342 (save-excursion
12343 (when (org-up-heading-safe)
12344 (org-show-subtree)
12345 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12347 (defun org-highlight-new-match (beg end)
12348 "Highlight from BEG to END and mark the highlight is an occur headline."
12349 (let ((ov (make-overlay beg end)))
12350 (overlay-put ov 'face 'secondary-selection)
12351 (overlay-put ov 'org-type 'org-occur)
12352 (push ov org-occur-highlights)))
12354 (defun org-remove-occur-highlights (&optional beg end noremove)
12355 "Remove the occur highlights from the buffer.
12356 BEG and END are ignored. If NOREMOVE is nil, remove this function
12357 from the `before-change-functions' in the current buffer."
12358 (interactive)
12359 (unless org-inhibit-highlight-removal
12360 (mapc 'delete-overlay org-occur-highlights)
12361 (setq org-occur-highlights nil)
12362 (setq org-occur-parameters nil)
12363 (unless noremove
12364 (remove-hook 'before-change-functions
12365 'org-remove-occur-highlights 'local))))
12367 ;;;; Priorities
12370 "Regular expression matching the priority indicator.")
12372 (defvar org-remove-priority-next-time nil)
12374 (defun org-priority-up ()
12375 "Increase the priority of the current item."
12376 (interactive)
12377 (org-priority 'up))
12379 (defun org-priority-down ()
12380 "Decrease the priority of the current item."
12381 (interactive)
12382 (org-priority 'down))
12384 (defun org-priority (&optional action)
12385 "Change the priority of an item by ARG.
12386 ACTION can be `set', `up', `down', or a character."
12387 (interactive)
12388 (unless org-enable-priority-commands
12389 (error "Priority commands are disabled"))
12390 (setq action (or action 'set))
12391 (let (current new news have remove)
12392 (save-excursion
12393 (org-back-to-heading t)
12394 (if (looking-at org-priority-regexp)
12395 (setq current (string-to-char (match-string 2))
12396 have t))
12397 (cond
12398 ((eq action 'remove)
12399 (setq remove t new ?\ ))
12400 ((or (eq action 'set)
12401 (if (featurep 'xemacs) (characterp action) (integerp action)))
12402 (if (not (eq action 'set))
12403 (setq new action)
12404 (message "Priority %c-%c, SPC to remove: "
12405 org-highest-priority org-lowest-priority)
12406 (save-match-data
12407 (setq new (read-char-exclusive))))
12408 (if (and (= (upcase org-highest-priority) org-highest-priority)
12409 (= (upcase org-lowest-priority) org-lowest-priority))
12410 (setq new (upcase new)))
12411 (cond ((equal new ?\ ) (setq remove t))
12412 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12413 (error "Priority must be between `%c' and `%c'"
12414 org-highest-priority org-lowest-priority))))
12415 ((eq action 'up)
12416 (setq new (if have
12417 (1- current) ; normal cycling
12418 ;; last priority was empty
12419 (if (eq last-command this-command)
12420 org-lowest-priority ; wrap around empty to lowest
12421 ;; default
12422 (if org-priority-start-cycle-with-default
12423 org-default-priority
12424 (1- org-default-priority))))))
12425 ((eq action 'down)
12426 (setq new (if have
12427 (1+ current) ; normal cycling
12428 ;; last priority was empty
12429 (if (eq last-command this-command)
12430 org-highest-priority ; wrap around empty to highest
12431 ;; default
12432 (if org-priority-start-cycle-with-default
12433 org-default-priority
12434 (1+ org-default-priority))))))
12435 (t (error "Invalid action")))
12436 (if (or (< (upcase new) org-highest-priority)
12437 (> (upcase new) org-lowest-priority))
12438 (if (and (memq action '(up down))
12439 (not have) (not (eq last-command this-command)))
12440 ;; `new' is from default priority
12441 (error
12442 "The default can not be set, see `org-default-priority' why")
12443 ;; normal cycling: `new' is beyond highest/lowest priority
12444 ;; and is wrapped around to the empty priority
12445 (setq remove t)))
12446 (setq news (format "%c" new))
12447 (if have
12448 (if remove
12449 (replace-match "" t t nil 1)
12450 (replace-match news t t nil 2))
12451 (if remove
12452 (error "No priority cookie found in line")
12453 (let ((case-fold-search nil))
12454 (looking-at org-todo-line-regexp))
12455 (if (match-end 2)
12456 (progn
12457 (goto-char (match-end 2))
12458 (insert " [#" news "]"))
12459 (goto-char (match-beginning 3))
12460 (insert "[#" news "] "))))
12461 (org-preserve-lc (org-set-tags nil 'align)))
12462 (if remove
12463 (message "Priority removed")
12464 (message "Priority of current item set to %s" news))))
12466 (defun org-get-priority (s)
12467 "Find priority cookie and return priority."
12468 (if (functionp org-get-priority-function)
12469 (funcall org-get-priority-function)
12470 (save-match-data
12471 (if (not (string-match org-priority-regexp s))
12472 (* 1000 (- org-lowest-priority org-default-priority))
12473 (* 1000 (- org-lowest-priority
12474 (string-to-char (match-string 2 s))))))))
12476 ;;;; Tags
12478 (defvar org-agenda-archives-mode)
12479 (defvar org-map-continue-from nil
12480 "Position from where mapping should continue.
12481 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12483 (defvar org-scanner-tags nil
12484 "The current tag list while the tags scanner is running.")
12485 (defvar org-trust-scanner-tags nil
12486 "Should `org-get-tags-at' use the tags for the scanner.
12487 This is for internal dynamical scoping only.
12488 When this is non-nil, the function `org-get-tags-at' will return the value
12489 of `org-scanner-tags' instead of building the list by itself. This
12490 can lead to large speed-ups when the tags scanner is used in a file with
12491 many entries, and when the list of tags is retrieved, for example to
12492 obtain a list of properties. Building the tags list for each entry in such
12493 a file becomes an N^2 operation - but with this variable set, it scales
12494 as N.")
12496 (defun org-scan-tags (action matcher &optional todo-only)
12497 "Scan headline tags with inheritance and produce output ACTION.
12499 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12500 or `agenda' to produce an entry list for an agenda view. It can also be
12501 a Lisp form or a function that should be called at each matched headline, in
12502 this case the return value is a list of all return values from these calls.
12504 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12505 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12506 only lines with a TODO keyword are included in the output."
12507 (require 'org-agenda)
12510 (org-re
12512 (props (list 'face 'default
12513 'done-face 'org-agenda-done
12514 'undone-face 'default
12515 'mouse-face 'highlight
12516 'org-not-done-regexp org-not-done-regexp
12517 'org-todo-regexp org-todo-regexp
12518 'help-echo
12519 (format "mouse-2 or RET jump to org file %s"
12520 (abbreviate-file-name
12521 (or (buffer-file-name (buffer-base-buffer))
12522 (buffer-name (buffer-base-buffer)))))))
12523 (case-fold-search nil)
12524 (org-map-continue-from nil)
12525 lspos tags tags-list
12526 (tags-alist (list (cons 0 org-file-tags)))
12527 (llast 0) rtn rtn1 level category i txt
12528 todo marker entry priority)
12529 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12530 (setq action (list 'lambda nil action)))
12531 (save-excursion
12532 (goto-char (point-min))
12533 (when (eq action 'sparse-tree)
12534 (org-overview)
12535 (org-remove-occur-highlights))
12536 (while (re-search-forward re nil t)
12537 (catch :skip
12538 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12539 tags (if (match-end 4) (org-match-string-no-properties 4)))
12540 (goto-char (setq lspos (match-beginning 0)))
12541 (setq level (org-reduced-level (funcall outline-level))
12542 category (org-get-category))
12543 (setq i llast llast level)
12544 ;; remove tag lists from same and sublevels
12545 (while (>= i level)
12546 (when (setq entry (assoc i tags-alist))
12547 (setq tags-alist (delete entry tags-alist)))
12548 (setq i (1- i)))
12549 ;; add the next tags
12550 (when tags
12551 (setq tags (org-split-string tags ":")
12552 tags-alist
12553 (cons (cons level tags) tags-alist)))
12554 ;; compile tags for current headline
12555 (setq tags-list
12556 (if org-use-tag-inheritance
12557 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12558 tags)
12559 org-scanner-tags tags-list)
12560 (when org-use-tag-inheritance
12561 (setcdr (car tags-alist)
12562 (mapcar (lambda (x)
12563 (setq x (copy-sequence x))
12564 (org-add-prop-inherited x))
12565 (cdar tags-alist))))
12566 (when (and tags org-use-tag-inheritance
12567 (or (not (eq t org-use-tag-inheritance))
12568 org-tags-exclude-from-inheritance))
12569 ;; selective inheritance, remove uninherited ones
12570 (setcdr (car tags-alist)
12571 (org-remove-uninherited-tags (cdar tags-alist))))
12572 (when (and
12574 ;; eval matcher only when the todo condition is OK
12575 (and (or (not todo-only) (member todo org-not-done-keywords))
12576 (let ((case-fold-search t)) (eval matcher)))
12578 ;; Call the skipper, but return t if it does not skip,
12579 ;; so that the `and' form continues evaluating
12580 (progn
12581 (unless (eq action 'sparse-tree) (org-agenda-skip))
12582 t)
12584 ;; Check if timestamps are deselecting this entry
12585 (or (not todo-only)
12586 (and (member todo org-not-done-keywords)
12587 (or (not org-agenda-tags-todo-honor-ignore-options)
12588 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12590 ;; Extra check for the archive tag
12591 ;; FIXME: Does the skipper already do this????
12592 (or
12593 (not (member org-archive-tag tags-list))
12594 ;; we have an archive tag, should we use this anyway?
12595 (or (not org-agenda-skip-archived-trees)
12596 (and (eq action 'agenda) org-agenda-archives-mode))))
12598 ;; select this headline
12600 (cond
12601 ((eq action 'sparse-tree)
12602 (and org-highlight-sparse-tree-matches
12603 (org-get-heading) (match-end 0)
12604 (org-highlight-new-match
12605 (match-beginning 0) (match-beginning 1)))
12606 (org-show-context 'tags-tree))
12607 ((eq action 'agenda)
12608 (setq txt (org-format-agenda-item
12609 ""
12610 (concat
12611 (if (eq org-tags-match-list-sublevels 'indented)
12612 (make-string (1- level) ?.) "")
12613 (org-get-heading))
12614 category
12615 tags-list
12616 )
12617 priority (org-get-priority txt))
12618 (goto-char lspos)
12619 (setq marker (org-agenda-new-marker))
12620 (org-add-props txt props
12621 'org-marker marker 'org-hd-marker marker 'org-category category
12622 'todo-state todo
12623 'priority priority 'type "tagsmatch")
12624 (push txt rtn))
12625 ((functionp action)
12626 (setq org-map-continue-from nil)
12627 (save-excursion
12628 (setq rtn1 (funcall action))
12629 (push rtn1 rtn)))
12630 (t (error "Invalid action")))
12632 ;; if we are to skip sublevels, jump to end of subtree
12633 (unless org-tags-match-list-sublevels
12634 (org-end-of-subtree t)
12635 (backward-char 1))))
12636 ;; Get the correct position from where to continue
12637 (if org-map-continue-from
12638 (goto-char org-map-continue-from)
12639 (and (= (point) lspos) (end-of-line 1)))))
12640 (when (and (eq action 'sparse-tree)
12641 (not org-sparse-tree-open-archived-trees))
12642 (org-hide-archived-subtrees (point-min) (point-max)))
12643 (nreverse rtn)))
12645 (defun org-remove-uninherited-tags (tags)
12646 "Remove all tags that are not inherited from the list TAGS."
12647 (cond
12648 ((eq org-use-tag-inheritance t)
12649 (if org-tags-exclude-from-inheritance
12650 (org-delete-all org-tags-exclude-from-inheritance tags)
12651 tags))
12652 ((not org-use-tag-inheritance) nil)
12653 ((stringp org-use-tag-inheritance)
12654 (delq nil (mapcar
12655 (lambda (x)
12656 (if (and (string-match org-use-tag-inheritance x)
12657 (not (member x org-tags-exclude-from-inheritance)))
12658 x nil))
12659 tags)))
12660 ((listp org-use-tag-inheritance)
12661 (delq nil (mapcar
12662 (lambda (x)
12663 (if (member x org-use-tag-inheritance) x nil))
12664 tags)))))
12666 (defvar todo-only) ;; dynamically scoped
12668 (defun org-match-sparse-tree (&optional todo-only match)
12669 "Create a sparse tree according to tags string MATCH.
12670 MATCH can contain positive and negative selection of tags, like
12672 If optional argument TODO-ONLY is non-nil, only select lines that are
12673 also TODO lines."
12674 (interactive "P")
12675 (org-prepare-agenda-buffers (list (current-buffer)))
12676 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12678 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12680 (defvar org-cached-props nil)
12681 (defun org-cached-entry-get (pom property)
12682 (if (or (eq t org-use-property-inheritance)
12683 (and (stringp org-use-property-inheritance)
12684 (string-match org-use-property-inheritance property))
12685 (and (listp org-use-property-inheritance)
12686 (member property org-use-property-inheritance)))
12687 ;; Caching is not possible, check it directly
12688 (org-entry-get pom property 'inherit)
12689 ;; Get all properties, so that we can do complicated checks easily
12690 (cdr (assoc property (or org-cached-props
12691 (setq org-cached-props
12692 (org-entry-properties pom)))))))
12694 (defun org-global-tags-completion-table (&optional files)
12695 "Return the list of all tags in all agenda buffer/files.
12696 Optional FILES argument is a list of files to which can be used
12697 instead of the agenda files."
12698 (save-excursion
12699 (org-uniquify
12700 (delq nil
12701 (apply 'append
12702 (mapcar
12703 (lambda (file)
12704 (set-buffer (find-file-noselect file))
12705 (append (org-get-buffer-tags)
12706 (mapcar (lambda (x) (if (stringp (car-safe x))
12707 (list (car-safe x)) nil))
12708 org-tag-alist)))
12709 (if (and files (car files))
12710 files
12711 (org-agenda-files))))))))
12713 (defun org-make-tags-matcher (match)
12714 "Create the TAGS/TODO matcher form for the selection string MATCH."
12715 ;; todo-only is scoped dynamically into this function, and the function
12716 ;; may change it if the matcher asks for it.
12717 (unless match
12718 ;; Get a new match request, with completion
12719 (let ((org-last-tags-completion-table
12720 (org-global-tags-completion-table)))
12721 (setq match (org-completing-read-no-i
12722 "Match: " 'org-tags-completion-function nil nil nil
12723 'org-tags-history))))
12725 ;; Parse the string and create a lisp form
12726 (let ((match0 match)
12727 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12728 minus tag mm
12729 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12730 orterms term orlist re-p str-p level-p level-op time-p
12731 prop-p pn pv po gv rest)
12732 (if (string-match "/+" match)
12733 ;; match contains also a todo-matching request
12734 (progn
12735 (setq tagsmatch (substring match 0 (match-beginning 0))
12736 todomatch (substring match (match-end 0)))
12737 (if (string-match "^!" todomatch)
12738 (setq todo-only t todomatch (substring todomatch 1)))
12740 (setq todomatch nil)))
12741 ;; only matching tags
12742 (setq tagsmatch match todomatch nil))
12744 ;; Make the tags matcher
12746 (setq tagsmatcher t)
12747 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12748 (while (setq term (pop orterms))
12750 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12751 (while (string-match re term)
12752 (setq rest (substring term (match-end 0))
12753 minus (and (match-end 1)
12754 (equal (match-string 1 term) "-"))
12755 tag (save-match-data (replace-regexp-in-string
12757 (match-string 2 term)))
12758 re-p (equal (string-to-char tag) ?{)
12759 level-p (match-end 4)
12760 prop-p (match-end 5)
12761 mm (cond
12762 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12763 (level-p
12764 (setq level-op (org-op-to-function (match-string 3 term)))
12765 `(,level-op level ,(string-to-number
12766 (match-string 4 term))))
12767 (prop-p
12768 (setq pn (match-string 5 term)
12769 po (match-string 6 term)
12770 pv (match-string 7 term)
12771 re-p (equal (string-to-char pv) ?{)
12773 time-p (save-match-data
12775 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12776 (if time-p (setq pv (org-matcher-time pv)))
12777 (setq po (org-op-to-function po (if time-p 'time str-p)))
12778 (cond
12779 ((equal pn "CATEGORY")
12780 (setq gv '(get-text-property (point) 'org-category)))
12781 ((equal pn "TODO")
12782 (setq gv 'todo))
12783 (t
12784 (setq gv `(org-cached-entry-get nil ,pn))))
12785 (if re-p
12786 (if (eq po 'org<>)
12787 `(not (string-match ,pv (or ,gv "")))
12788 `(string-match ,pv (or ,gv "")))
12789 (if str-p
12790 `(,po (or ,gv "") ,pv)
12791 `(,po (string-to-number (or ,gv ""))
12792 ,(string-to-number pv) ))))
12793 (t `(member ,tag tags-list)))
12794 mm (if minus (list 'not mm) mm)
12795 term rest)
12796 (push mm tagsmatcher))
12797 (push (if (> (length tagsmatcher) 1)
12798 (cons 'and tagsmatcher)
12799 (car tagsmatcher))
12800 orlist)
12801 (setq tagsmatcher nil))
12802 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12803 (setq tagsmatcher
12804 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12805 ;; Make the todo matcher
12807 (setq todomatcher t)
12808 (setq orterms (org-split-string todomatch "|") orlist nil)
12809 (while (setq term (pop orterms))
12810 (while (string-match re term)
12811 (setq minus (and (match-end 1)
12812 (equal (match-string 1 term) "-"))
12813 kwd (match-string 2 term)
12814 re-p (equal (string-to-char kwd) ?{)
12815 term (substring term (match-end 0))
12816 mm (if re-p
12817 `(string-match ,(substring kwd 1 -1) todo)
12818 (list 'equal 'todo kwd))
12819 mm (if minus (list 'not mm) mm))
12820 (push mm todomatcher))
12821 (push (if (> (length todomatcher) 1)
12822 (cons 'and todomatcher)
12823 (car todomatcher))
12824 orlist)
12825 (setq todomatcher nil))
12826 (setq todomatcher (if (> (length orlist) 1)
12827 (cons 'or orlist) (car orlist))))
12829 ;; Return the string and lisp forms of the matcher
12830 (setq matcher (if todomatcher
12831 (list 'and tagsmatcher todomatcher)
12832 tagsmatcher))
12833 (cons match0 matcher)))
12835 (defun org-op-to-function (op &optional stringp)
12836 "Turn an operator into the appropriate function."
12837 (setq op
12838 (cond
12839 ((equal op "<" ) '(< string< org-time<))
12840 ((equal op ">" ) '(> org-string> org-time>))
12841 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12842 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12843 ((member op '("=" "==")) '(= string= org-time=))
12844 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12845 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12847 (defun org<> (a b) (not (= a b)))
12848 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12849 (defun org-string>= (a b) (not (string< a b)))
12850 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12851 (defun org-string<> (a b) (not (string= 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) (>= a b)))
12857 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12858 (defun org-2ft (s)
12859 "Convert S to a floating point time.
12860 If S is already a number, just return it. If it is a string, parse
12861 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12862 (cond
12863 ((numberp s) s)
12864 ((stringp s)
12865 (condition-case nil
12866 (float-time (apply 'encode-time (org-parse-time-string s)))
12867 (error 0.)))
12868 (t 0.)))
12870 (defun org-time-today ()
12871 "Time in seconds today at 0:00.
12872 Returns the float number of seconds since the beginning of the
12873 epoch to the beginning of today (00:00)."
12874 (float-time (apply 'encode-time
12875 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12877 (defun org-matcher-time (s)
12878 "Interpret a time comparison value."
12879 (save-match-data
12880 (cond
12881 ((string= s "<now>") (float-time))
12882 ((string= s "<today>") (org-time-today))
12883 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12884 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12886 (+ (org-time-today)
12887 (* (string-to-number (match-string 1 s))
12888 (cdr (assoc (match-string 2 s)
12889 '(("d" . 86400.0) ("w" . 604800.0)
12890 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12891 (t (org-2ft s)))))
12893 (defun org-match-any-p (re list)
12894 "Does re match any element of list?"
12895 (setq list (mapcar (lambda (x) (string-match re x)) list))
12896 (delq nil list))
12898 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12899 (defvar org-tags-overlay (make-overlay 1 1))
12900 (org-detach-overlay org-tags-overlay)
12902 (defun org-get-local-tags-at (&optional pos)
12903 "Get a list of tags defined in the current headline."
12904 (org-get-tags-at pos 'local))
12906 (defun org-get-local-tags ()
12907 "Get a list of tags defined in the current headline."
12908 (org-get-tags-at nil 'local))
12910 (defun org-get-tags-at (&optional pos local)
12911 "Get a list of all headline tags applicable at POS.
12912 POS defaults to point. If tags are inherited, the list contains
12913 the targets in the same sequence as the headlines appear, i.e.
12914 the tags of the current headline come last.
12915 When LOCAL is non-nil, only return tags from the current headline,
12916 ignore inherited ones."
12917 (interactive)
12918 (if (and org-trust-scanner-tags
12919 (or (not pos) (equal pos (point)))
12920 (not local))
12921 org-scanner-tags
12922 (let (tags ltags lastpos parent)
12923 (save-excursion
12924 (save-restriction
12925 (widen)
12926 (goto-char (or pos (point)))
12927 (save-match-data
12928 (catch 'done
12929 (condition-case nil
12930 (progn
12931 (org-back-to-heading t)
12932 (while (not (equal lastpos (point)))
12933 (setq lastpos (point))
12934 (when (looking-at
12936 (setq ltags (org-split-string
12937 (org-match-string-no-properties 1) ":"))
12938 (when parent
12939 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12940 (setq tags (append
12941 (if parent
12942 (org-remove-uninherited-tags ltags)
12943 ltags)
12944 tags)))
12945 (or org-use-tag-inheritance (throw 'done t))
12946 (if local (throw 'done t))
12947 (or (org-up-heading-safe) (error nil))
12948 (setq parent t)))
12949 (error nil)))))
12950 (if local
12951 tags
12952 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12954 (defun org-add-prop-inherited (s)
12955 (add-text-properties 0 (length s) '(inherited t) s)
12956 s)
12958 (defun org-toggle-tag (tag &optional onoff)
12959 "Toggle the tag TAG for the current line.
12960 If ONOFF is `on' or `off', don't toggle but set to this state."
12961 (let (res current)
12962 (save-excursion
12963 (org-back-to-heading t)
12965 (point-at-eol) t)
12966 (progn
12967 (setq current (match-string 1))
12968 (replace-match ""))
12969 (setq current ""))
12970 (setq current (nreverse (org-split-string current ":")))
12971 (cond
12972 ((eq onoff 'on)
12973 (setq res t)
12974 (or (member tag current) (push tag current)))
12975 ((eq onoff 'off)
12976 (or (not (member tag current)) (setq current (delete tag current))))
12977 (t (if (member tag current)
12978 (setq current (delete tag current))
12979 (setq res t)
12980 (push tag current))))
12981 (end-of-line 1)
12982 (if current
12983 (progn
12984 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12985 (org-set-tags nil t))
12986 (delete-horizontal-space))
12987 (run-hooks 'org-after-tags-change-hook))
12988 res))
12990 (defun org-align-tags-here (to-col)
12991 ;; Assumes that this is a headline
12992 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12993 (beginning-of-line 1)
12995 (< pos (match-beginning 2)))
12996 (progn
12997 (setq tags-l (- (match-end 2) (match-beginning 2)))
12998 (goto-char (match-beginning 1))
12999 (insert " ")
13000 (delete-region (point) (1+ (match-beginning 2)))
13001 (setq ncol (max (1+ (current-column))
13002 (1+ col)
13003 (if (> to-col 0)
13004 to-col
13005 (- (abs to-col) tags-l))))
13006 (setq p (point))
13007 (insert (make-string (- ncol (current-column)) ?\ ))
13008 (setq ncol (current-column))
13009 (when indent-tabs-mode (tabify p (point-at-eol)))
13010 (org-move-to-column (min ncol col) t))
13011 (goto-char pos))))
13013 (defun org-set-tags-command (&optional arg just-align)
13014 "Call the set-tags command for the current entry."
13015 (interactive "P")
13016 (if (org-on-heading-p)
13017 (org-set-tags arg just-align)
13018 (save-excursion
13019 (org-back-to-heading t)
13020 (org-set-tags arg just-align))))
13022 (defun org-set-tags-to (data)
13023 "Set the tags of the current entry to DATA, replacing the current tags.
13024 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13025 If DATA is nil or the empty string, any tags will be removed."
13026 (interactive "sTags: ")
13027 (setq data
13028 (cond
13029 ((eq data nil) "")
13030 ((equal data "") "")
13031 ((stringp data)
13032 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13033 ":"))
13034 ((listp data)
13035 (concat ":" (mapconcat 'identity data ":") ":"))
13036 (t nil)))
13037 (when data
13038 (save-excursion
13039 (org-back-to-heading t)
13040 (when (looking-at org-complex-heading-regexp)
13041 (if (match-end 5)
13042 (progn
13043 (goto-char (match-beginning 5))
13044 (insert data)
13045 (delete-region (point) (point-at-eol))
13046 (org-set-tags nil 'align))
13047 (goto-char (point-at-eol))
13048 (insert " " data)
13049 (org-set-tags nil 'align)))
13050 (beginning-of-line 1)
13052 (delete-region (match-beginning 1) (match-end 1))))))
13054 (defun org-align-all-tags ()
13055 "Align the tags i all headings."
13056 (interactive)
13057 (save-excursion
13058 (or (ignore-errors (org-back-to-heading t))
13059 (outline-next-heading))
13060 (if (org-on-heading-p)
13061 (org-set-tags t)
13062 (message "No headings"))))
13064 (defvar org-indent-indentation-per-level)
13065 (defun org-set-tags (&optional arg just-align)
13066 "Set the tags for the current headline.
13067 With prefix ARG, realign all tags in headings in the current buffer."
13068 (interactive "P")
13069 (let* ((re org-outline-regexp-bol)
13070 (current (org-get-tags-string))
13071 (col (current-column))
13072 (org-setting-tags t)
13073 table current-tags inherited-tags ; computed below when needed
13074 tags p0 c0 c1 rpl di tc level)
13075 (if arg
13076 (save-excursion
13077 (goto-char (point-min))
13078 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13079 (while (re-search-forward re nil t)
13080 (org-set-tags nil t)
13081 (end-of-line 1)))
13082 (message "All tags realigned to column %d" org-tags-column))
13083 (if just-align
13084 (setq tags current)
13085 ;; Get a new set of tags from the user
13086 (save-excursion
13087 (setq table (append org-tag-persistent-alist
13088 (or org-tag-alist (org-get-buffer-tags))
13089 (and
13090 org-complete-tags-always-offer-all-agenda-tags
13091 (org-global-tags-completion-table
13092 (org-agenda-files))))
13093 org-last-tags-completion-table table
13094 current-tags (org-split-string current ":")
13095 inherited-tags (nreverse
13096 (nthcdr (length current-tags)
13097 (nreverse (org-get-tags-at))))
13098 tags
13099 (if (or (eq t org-use-fast-tag-selection)
13100 (and org-use-fast-tag-selection
13101 (delq nil (mapcar 'cdr table))))
13102 (org-fast-tag-selection
13103 current-tags inherited-tags table
13104 (if org-fast-tag-selection-include-todo
13105 org-todo-key-alist))
13106 (let ((org-add-colon-after-tag-completion t))
13107 (org-trim
13108 (org-icompleting-read "Tags: "
13109 'org-tags-completion-function
13110 nil nil current 'org-tags-history))))))
13111 (while (string-match "[-+&]+" tags)
13112 ;; No boolean logic, just a list
13113 (setq tags (replace-match ":" t t tags))))
13115 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13117 (if org-tags-sort-function
13118 (setq tags (mapconcat 'identity
13119 (sort (org-split-string
13120 tags (org-re "[^[:alnum:]_@#%]+"))
13121 org-tags-sort-function) ":")))
13124 (setq tags "")
13125 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13126 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13128 ;; Insert new tags at the correct column
13129 (beginning-of-line 1)
13130 (setq level (or (and (looking-at org-outline-regexp)
13131 (- (match-end 0) (point) 1))
13132 1))
13133 (cond
13134 ((and (equal current "") (equal tags "")))
13135 ((re-search-forward
13137 (point-at-eol) t)
13138 (if (equal tags "")
13139 (setq rpl "")
13140 (goto-char (match-beginning 0))
13141 (setq c0 (current-column)
13142 ;; compute offset for the case of org-indent-mode active
13143 di (if org-indent-mode
13144 (* (1- org-indent-indentation-per-level) (1- level))
13145 0)
13146 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13147 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13148 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13149 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13150 (replace-match rpl t t)
13151 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13152 tags)
13153 (t (error "Tags alignment failed")))
13154 (org-move-to-column col)
13155 (unless just-align
13156 (run-hooks 'org-after-tags-change-hook)))))
13158 (defun org-change-tag-in-region (beg end tag off)
13159 "Add or remove TAG for each entry in the region.
13160 This works in the agenda, and also in an org-mode buffer."
13161 (interactive
13162 (list (region-beginning) (region-end)
13163 (let ((org-last-tags-completion-table
13164 (if (org-mode-p)
13165 (org-get-buffer-tags)
13166 (org-global-tags-completion-table))))
13167 (org-icompleting-read
13168 "Tag: " 'org-tags-completion-function nil nil nil
13169 'org-tags-history))
13170 (progn
13172 (equal (read-char-exclusive) ?r))))
13173 (if (fboundp 'deactivate-mark) (deactivate-mark))
13174 (let ((agendap (equal major-mode 'org-agenda-mode))
13175 l1 l2 m buf pos newhead (cnt 0))
13176 (goto-char end)
13177 (setq l2 (1- (org-current-line)))
13178 (goto-char beg)
13179 (setq l1 (org-current-line))
13180 (loop for l from l1 to l2 do
13181 (org-goto-line l)
13182 (setq m (get-text-property (point) 'org-hd-marker))
13183 (when (or (and (org-mode-p) (org-on-heading-p))
13184 (and agendap m))
13185 (setq buf (if agendap (marker-buffer m) (current-buffer))
13186 pos (if agendap m (point)))
13187 (with-current-buffer buf
13188 (save-excursion
13189 (save-restriction
13190 (goto-char pos)
13191 (setq cnt (1+ cnt))
13192 (org-toggle-tag tag (if off 'off 'on))
13193 (setq newhead (org-get-heading)))))
13194 (and agendap (org-agenda-change-all-lines newhead m))))
13195 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13197 (defun org-tags-completion-function (string predicate &optional flag)
13198 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13199 (confirm (lambda (x) (stringp (car x)))))
13201 (setq s1 (match-string 1 string)
13202 s2 (match-string 2 string))
13203 (setq s1 "" s2 string))
13204 (cond
13205 ((eq flag nil)
13206 ;; try completion
13207 (setq rtn (try-completion s2 ctable confirm))
13208 (if (stringp rtn)
13209 (setq rtn
13210 (concat s1 s2 (substring rtn (length s2))
13211 (if (and org-add-colon-after-tag-completion
13212 (assoc rtn ctable))
13213 ":" ""))))
13214 rtn)
13215 ((eq flag t)
13216 ;; all-completions
13217 (all-completions s2 ctable confirm)
13218 )
13219 ((eq flag 'lambda)
13220 ;; exact match?
13221 (assoc s2 ctable)))
13222 ))
13224 (defun org-fast-tag-insert (kwd tags face &optional end)
13225 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13226 (insert (format "%-12s" (concat kwd ":"))
13227 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13228 (or end "")))
13230 (defun org-fast-tag-show-exit (flag)
13231 (save-excursion
13232 (org-goto-line 3)
13234 (replace-match ""))
13235 (when flag
13236 (end-of-line 1)
13237 (org-move-to-column (- (window-width) 19) t)
13238 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13240 (defun org-set-current-tags-overlay (current prefix)
13241 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13242 (if (featurep 'xemacs)
13243 (org-overlay-display org-tags-overlay (concat prefix s)
13244 'secondary-selection)
13245 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13246 (org-overlay-display org-tags-overlay (concat prefix s)))))
13248 (defvar org-last-tag-selection-key nil)
13249 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13250 "Fast tag selection with single keys.
13251 CURRENT is the current list of tags in the headline, INHERITED is the
13252 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13253 possibly with grouping information. TODO-TABLE is a similar table with
13254 TODO keywords, should these have keys assigned to them.
13255 If the keys are nil, a-z are automatically assigned.
13256 Returns the new tags string, or nil to not change the current settings."
13257 (let* ((fulltable (append table todo-table))
13258 (maxlen (apply 'max (mapcar
13259 (lambda (x)
13260 (if (stringp (car x)) (string-width (car x)) 0))
13261 fulltable)))
13262 (buf (current-buffer))
13263 (expert (eq org-fast-tag-selection-single-key 'expert))
13264 (buffer-tags nil)
13265 (fwidth (+ maxlen 3 1 3))
13266 (ncol (/ (- (window-width) 4) fwidth))
13267 (i-face 'org-done)
13268 (c-face 'org-todo)
13269 tg cnt e c char c1 c2 ntable tbl rtn
13270 ov-start ov-end ov-prefix
13271 (exit-after-next org-fast-tag-selection-single-key)
13272 (done-keywords org-done-keywords)
13273 groups ingroup)
13274 (save-excursion
13275 (beginning-of-line 1)
13276 (if (looking-at
13278 (setq ov-start (match-beginning 1)
13279 ov-end (match-end 1)
13280 ov-prefix "")
13281 (setq ov-start (1- (point-at-eol))
13282 ov-end (1+ ov-start))
13284 (setq ov-prefix
13285 (concat
13286 (buffer-substring (1- (point)) (point))
13287 (if (> (current-column) org-tags-column)
13288 " "
13289 (make-string (- org-tags-column (current-column)) ?\ ))))))
13290 (move-overlay org-tags-overlay ov-start ov-end)
13291 (save-window-excursion
13292 (if expert
13293 (set-buffer (get-buffer-create " *Org tags*"))
13294 (delete-other-windows)
13295 (split-window-vertically)
13296 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13297 (erase-buffer)
13298 (org-set-local 'org-done-keywords done-keywords)
13301 (org-fast-tag-show-exit exit-after-next)
13302 (org-set-current-tags-overlay current ov-prefix)
13303 (setq tbl fulltable char ?a cnt 0)
13304 (while (setq e (pop tbl))
13305 (cond
13306 ((equal (car e) :startgroup)
13307 (push '() groups) (setq ingroup t)
13308 (when (not (= cnt 0))
13309 (setq cnt 0)
13311 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13312 ((equal (car e) :endgroup)
13313 (setq ingroup nil cnt 0)
13315 ((equal e '(:newline))
13316 (when (not (= cnt 0))
13317 (setq cnt 0)
13319 (setq e (car tbl))
13320 (while (equal (car tbl) '(:newline))
13322 (setq tbl (cdr tbl)))))
13323 (t
13324 (setq tg (copy-sequence (car e)) c2 nil)
13325 (if (cdr e)
13326 (setq c (cdr e))
13327 ;; automatically assign a character.
13328 (setq c1 (string-to-char
13329 (downcase (substring
13330 tg (if (= (string-to-char tg) ?@) 1 0)))))
13331 (if (or (rassoc c1 ntable) (rassoc c1 table))
13332 (while (or (rassoc char ntable) (rassoc char table))
13333 (setq char (1+ char)))
13334 (setq c2 c1))
13335 (setq c (or c2 char)))
13336 (if ingroup (push tg (car groups)))
13337 (setq tg (org-add-props tg nil 'face
13338 (cond
13339 ((not (assoc tg table))
13340 (org-get-todo-face tg))
13341 ((member tg current) c-face)
13342 ((member tg inherited) i-face)
13343 (t nil))))
13344 (if (and (= cnt 0) (not ingroup)) (insert " "))
13345 (insert "[" c "] " tg (make-string
13346 (- fwidth 4 (length tg)) ?\ ))
13347 (push (cons tg c) ntable)
13348 (when (= (setq cnt (1+ cnt)) ncol)
13350 (if ingroup (insert " "))
13351 (setq cnt 0)))))
13352 (setq ntable (nreverse ntable))
13354 (goto-char (point-min))
13355 (if (not expert) (org-fit-window-to-buffer))
13356 (setq rtn
13357 (catch 'exit
13358 (while t
13359 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13360 (if (not groups) "no " "")
13361 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13362 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13363 (setq org-last-tag-selection-key c)
13364 (cond
13366 ((= c ?!)
13367 (setq groups (not groups))
13368 (goto-char (point-min))
13369 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13370 ((= c ?\C-c)
13371 (if (not expert)
13372 (org-fast-tag-show-exit
13373 (setq exit-after-next (not exit-after-next)))
13374 (setq expert nil)
13375 (delete-other-windows)
13376 (set-window-buffer (split-window-vertically) " *Org tags*")
13377 (org-switch-to-buffer-other-window " *Org tags*")
13378 (org-fit-window-to-buffer)))
13379 ((or (= c ?\C-g)
13380 (and (= c ?q) (not (rassoc c ntable))))
13381 (org-detach-overlay org-tags-overlay)
13382 (setq quit-flag t))
13383 ((= c ?\ )
13384 (setq current nil)
13385 (if exit-after-next (setq exit-after-next 'now)))
13387 (condition-case nil
13388 (setq tg (org-icompleting-read
13389 "Tag: "
13390 (or buffer-tags
13391 (with-current-buffer buf
13392 (org-get-buffer-tags)))))
13393 (quit (setq tg "")))
13395 (add-to-list 'buffer-tags (list tg))
13396 (if (member tg current)
13397 (setq current (delete tg current))
13398 (push tg current)))
13399 (if exit-after-next (setq exit-after-next 'now)))
13400 ((setq e (rassoc c todo-table) tg (car e))
13401 (with-current-buffer buf
13402 (save-excursion (org-todo tg)))
13403 (if exit-after-next (setq exit-after-next 'now)))
13404 ((setq e (rassoc c ntable) tg (car e))
13405 (if (member tg current)
13406 (setq current (delete tg current))
13407 (loop for g in groups do
13408 (if (member tg g)
13409 (mapc (lambda (x)
13410 (setq current (delete x current)))
13411 g)))
13412 (push tg current))
13413 (if exit-after-next (setq exit-after-next 'now))))
13415 ;; Create a sorted list
13416 (setq current
13417 (sort current
13418 (lambda (a b)
13419 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13420 (if (eq exit-after-next 'now) (throw 'exit t))
13421 (goto-char (point-min))
13422 (beginning-of-line 2)
13423 (delete-region (point) (point-at-eol))
13424 (org-fast-tag-insert "Current" current c-face)
13425 (org-set-current-tags-overlay current ov-prefix)
13426 (while (re-search-forward
13428 (setq tg (match-string 1))
13429 (add-text-properties
13430 (match-beginning 1) (match-end 1)
13431 (list 'face
13432 (cond
13433 ((member tg current) c-face)
13434 ((member tg inherited) i-face)
13435 (t (get-text-property (match-beginning 1) 'face))))))
13436 (goto-char (point-min)))))
13437 (org-detach-overlay org-tags-overlay)
13438 (if rtn
13439 (mapconcat 'identity current ":")
13440 nil))))
13442 (defun org-get-tags-string ()
13443 "Get the TAGS string in the current headline."
13444 (unless (org-on-heading-p t)
13445 (error "Not on a heading"))
13446 (save-excursion
13447 (beginning-of-line 1)
13449 (org-match-string-no-properties 1)
13450 "")))
13452 (defun org-get-tags ()
13453 "Get the list of tags specified in the current headline."
13454 (org-split-string (org-get-tags-string) ":"))
13456 (defun org-get-buffer-tags ()
13457 "Get a table of all tags used in the buffer, for completion."
13458 (let (tags)
13459 (save-excursion
13460 (goto-char (point-min))
13461 (while (re-search-forward
13463 (when (equal (char-after (point-at-bol 0)) ?*)
13464 (mapc (lambda (x) (add-to-list 'tags x))
13465 (org-split-string (org-match-string-no-properties 1) ":")))))
13466 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13467 (mapcar 'list tags)))
13469 ;;;; The mapping API
13471 ;;;###autoload
13472 (defun org-map-entries (func &optional match scope &rest skip)
13473 "Call FUNC at each headline selected by MATCH in SCOPE.
13475 FUNC is a function or a lisp form. The function will be called without
13476 arguments, with the cursor positioned at the beginning of the headline.
13477 The return values of all calls to the function will be collected and
13478 returned as a list.
13480 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13481 does not need to preserve point. After evaluation, the cursor will be
13482 moved to the end of the line (presumably of the headline of the
13483 processed entry) and search continues from there. Under some
13484 circumstances, this may not produce the wanted results. For example,
13485 if you have removed (e.g. archived) the current (sub)tree it could
13486 mean that the next entry will be skipped entirely. In such cases, you
13487 can specify the position from where search should continue by making
13488 FUNC set the variable `org-map-continue-from' to the desired buffer
13489 position.
13491 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13492 Only headlines that are matched by this query will be considered during
13493 the iteration. When MATCH is nil or t, all headlines will be
13494 visited by the iteration.
13496 SCOPE determines the scope of this command. It can be any of:
13498 nil The current buffer, respecting the restriction if any
13499 tree The subtree started with the entry at point
13500 region The entries within the active region, if any
13501 file The current buffer, without restriction
13502 file-with-archives
13503 The current buffer, and any archives associated with it
13504 agenda All agenda files
13505 agenda-with-archives
13506 All agenda files with any archive files associated with them
13507 \(file1 file2 ...)
13508 If this is a list, all files in the list will be scanned
13510 The remaining args are treated as settings for the skipping facilities of
13511 the scanner. The following items can be given here:
13513 archive skip trees with the archive tag.
13514 comment skip trees with the COMMENT keyword
13515 function or Emacs Lisp form:
13516 will be used as value for `org-agenda-skip-function', so whenever
13517 the function returns t, FUNC will not be called for that
13518 entry and search will continue from the point where the
13519 function leaves it.
13521 If your function needs to retrieve the tags including inherited tags
13522 at the *current* entry, you can use the value of the variable
13523 `org-scanner-tags' which will be much faster than getting the value
13524 with `org-get-tags-at'. If your function gets properties with
13525 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13526 to t around the call to `org-entry-properties' to get the same speedup.
13527 Note that if your function moves around to retrieve tags and properties at
13528 a *different* entry, you cannot use these techniques."
13529 (let* ((org-agenda-archives-mode nil) ; just to make sure
13530 (org-agenda-skip-archived-trees (memq 'archive skip))
13531 (org-agenda-skip-comment-trees (memq 'comment skip))
13532 (org-agenda-skip-function
13533 (car (org-delete-all '(comment archive) skip)))
13534 (org-tags-match-list-sublevels t)
13535 matcher file res
13536 org-todo-keywords-for-agenda
13537 org-done-keywords-for-agenda
13538 org-todo-keyword-alist-for-agenda
13539 org-drawers-for-agenda
13540 org-tag-alist-for-agenda)
13542 (cond
13543 ((eq match t) (setq matcher t))
13544 ((eq match nil) (setq matcher t))
13545 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13547 (save-excursion
13548 (save-restriction
13549 (cond ((eq scope 'tree)
13550 (org-back-to-heading t)
13551 (org-narrow-to-subtree)
13552 (setq scope nil))
13553 ((and (eq scope 'region) (org-region-active-p))
13554 (narrow-to-region (region-beginning) (region-end))
13555 (setq scope nil)))
13557 (if (not scope)
13558 (progn
13559 (org-prepare-agenda-buffers
13560 (list (buffer-file-name (current-buffer))))
13561 (setq res (org-scan-tags func matcher)))
13562 ;; Get the right scope
13563 (cond
13564 ((and scope (listp scope) (symbolp (car scope)))
13565 (setq scope (eval scope)))
13566 ((eq scope 'agenda)
13567 (setq scope (org-agenda-files t)))
13568 ((eq scope 'agenda-with-archives)
13569 (setq scope (org-agenda-files t))
13570 (setq scope (org-add-archive-files scope)))
13571 ((eq scope 'file)
13572 (setq scope (list (buffer-file-name))))
13573 ((eq scope 'file-with-archives)
13574 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13575 (org-prepare-agenda-buffers scope)
13576 (while (setq file (pop scope))
13577 (with-current-buffer (org-find-base-buffer-visiting file)
13578 (save-excursion
13579 (save-restriction
13580 (widen)
13581 (goto-char (point-min))
13582 (setq res (append res (org-scan-tags func matcher))))))))))
13583 res))
13585 ;;;; Properties
13587 ;;; Setting and retrieving properties
13589 (defconst org-special-properties
13590 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13591 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13592 "The special properties valid in Org-mode.
13594 These are properties that are not defined in the property drawer,
13595 but in some other way.")
13597 (defconst org-default-properties
13598 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13599 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13600 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13601 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13602 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13603 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13604 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13605 "Some properties that are used by Org-mode for various purposes.
13606 Being in this list makes sure that they are offered for completion.")
13609 "Regular expression matching the first line of a property drawer.")
13612 "Regular expression matching the last line of a property drawer.")
13615 "Regular expression matching the first line of a property drawer.")
13618 "Regular expression matching the first line of a property drawer.")
13620 (defconst org-property-drawer-re
13623 "Matches an entire property drawer.")
13625 (defconst org-clock-drawer-re
13628 "Matches an entire clock drawer.")
13630 (defsubst org-re-property (property)
13631 "Return a regexp matching PROPERTY.
13632 Match group 1 will be set to the value "
13635 (defun org-property-action ()
13636 "Do an action on properties."
13637 (interactive)
13638 (let (c)
13639 (org-at-property-p)
13640 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13641 (setq c (read-char-exclusive))
13642 (cond
13643 ((equal c ?s)
13644 (call-interactively 'org-set-property))
13645 ((equal c ?d)
13646 (call-interactively 'org-delete-property))
13647 ((equal c ?D)
13648 (call-interactively 'org-delete-property-globally))
13649 ((equal c ?c)
13650 (call-interactively 'org-compute-property-at-point))
13651 (t (error "No such property action %c" c)))))
13653 (defun org-set-effort (&optional value)
13654 "Set the effort property of the current entry.
13655 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13656 allowed value."
13657 (interactive "P")
13658 (if (equal value 0) (setq value 10))
13659 (let* ((completion-ignore-case t)
13660 (prop org-effort-property)
13661 (cur (org-entry-get nil prop))
13662 (allowed (org-property-get-allowed-values nil prop 'table))
13663 (existing (mapcar 'list (org-property-values prop)))
13664 rpl
13665 (val (cond
13666 ((stringp value) value)
13667 ((and allowed (integerp value))
13668 (or (car (nth (1- value) allowed))
13669 (car (org-last allowed))))
13670 (allowed
13671 (message "Select 1-9,0, [RET%s]: %s"
13672 (if cur (concat "=" cur) "")
13673 (mapconcat 'car allowed " "))
13674 (setq rpl (read-char-exclusive))
13676 cur
13677 (setq rpl (- rpl ?0))
13678 (if (equal rpl 0) (setq rpl 10))
13679 (if (and (> rpl 0) (<= rpl (length allowed)))
13680 (car (nth (1- rpl) allowed))
13681 (org-completing-read "Effort: " allowed nil))))
13682 (t
13683 (let (org-completion-use-ido org-completion-use-iswitchb)
13684 (org-completing-read
13686 (concat "[" cur "]") "")
13687 ": ")
13688 existing nil nil "" nil cur))))))
13689 (unless (equal (org-entry-get nil prop) val)
13690 (org-entry-put nil prop val))
13691 (message "%s is now %s" prop val)))
13693 (defun org-at-property-p ()
13694 "Is cursor inside a property drawer?"
13695 (save-excursion
13696 (beginning-of-line 1)
13698 (save-match-data ;; Used by calling procedures
13699 (let ((p (point))
13700 (range (unless (org-before-first-heading-p)
13701 (org-get-property-block))))
13702 (and range (<= (car range) p) (< p (cdr range))))))))
13704 (defun org-get-property-block (&optional beg end force)
13705 "Return the (beg . end) range of the body of the property drawer.
13706 BEG and END can be beginning and end of subtree, if not given
13707 they will be found.
13708 If the drawer does not exist and FORCE is non-nil, create the drawer."
13709 (catch 'exit
13710 (save-excursion
13711 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13712 (end (or end (progn (outline-next-heading) (point)))))
13713 (goto-char beg)
13714 (if (re-search-forward org-property-start-re end t)
13715 (setq beg (1+ (match-end 0)))
13716 (if force
13717 (save-excursion
13718 (org-insert-property-drawer)
13719 (setq end (progn (outline-next-heading) (point))))
13720 (throw 'exit nil))
13721 (goto-char beg)
13722 (if (re-search-forward org-property-start-re end t)
13723 (setq beg (1+ (match-end 0)))))
13724 (if (re-search-forward org-property-end-re end t)
13725 (setq end (match-beginning 0))
13726 (or force (throw 'exit nil))
13727 (goto-char beg)
13728 (setq end beg)
13729 (org-indent-line-function)
13731 (cons beg end)))))
13733 (defun org-entry-properties (&optional pom which specific)
13734 "Get all properties of the entry at point-or-marker POM.
13735 This includes the TODO keyword, the tags, time strings for deadline,
13736 scheduled, and clocking, and any additional properties defined in the
13737 entry. The return value is an alist, keys may occur multiple times
13738 if the property key was used several times.
13739 POM may also be nil, in which case the current entry is used.
13740 If WHICH is nil or `all', get all properties. If WHICH is
13741 `special' or `standard', only get that subclass. If WHICH
13742 is a string only get exactly this property. SPECIFIC can be a string, the
13743 specific property we are interested in. Specifying it can speed
13744 things up because then unnecessary parsing is avoided."
13745 (setq which (or which 'all))
13746 (org-with-point-at pom
13747 (let ((clockstr (substring org-clock-string 0 -1))
13748 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13749 (case-fold-search nil)
13750 beg end range props sum-props key key1 value string clocksum)
13751 (save-excursion
13752 (when (condition-case nil
13753 (and (org-mode-p) (org-back-to-heading t))
13754 (error nil))
13755 (setq beg (point))
13756 (setq sum-props (get-text-property (point) 'org-summaries))
13757 (setq clocksum (get-text-property (point) :org-clock-minutes))
13758 (outline-next-heading)
13759 (setq end (point))
13760 (when (memq which '(all special))
13761 ;; Get the special properties, like TODO and tags
13762 (goto-char beg)
13763 (when (and (or (not specific) (string= specific "TODO"))
13764 (looking-at org-todo-line-regexp) (match-end 2))
13765 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13766 (when (and (or (not specific) (string= specific "PRIORITY"))
13767 (looking-at org-priority-regexp))
13768 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13769 (when (or (not specific) (string= specific "FILE"))
13770 (push (cons "FILE" buffer-file-name) props))
13771 (when (and (or (not specific) (string= specific "TAGS"))
13772 (setq value (org-get-tags-string))
13774 (push (cons "TAGS" value) props))
13775 (when (and (or (not specific) (string= specific "ALLTAGS"))
13776 (setq value (org-get-tags-at)))
13777 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13778 ":"))
13779 props))
13780 (when (or (not specific) (string= specific "BLOCKED"))
13781 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13782 (when (or (not specific)
13783 (member specific
13784 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13785 "TIMESTAMP" "TIMESTAMP_IA")))
13786 (catch 'match
13787 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13788 (setq key (if (match-end 1)
13789 (substring (org-match-string-no-properties 1)
13790 0 -1))
13791 string (if (equal key clockstr)
13792 (org-no-properties
13793 (org-trim
13794 (buffer-substring
13795 (match-beginning 3) (goto-char
13796 (point-at-eol)))))
13797 (substring (org-match-string-no-properties 3)
13798 1 -1)))
13799 ;; Get the correct property name from the key. This is
13800 ;; necessary if the user has configured time keywords.
13801 (setq key1 (concat key ":"))
13802 (cond
13803 ((not key)
13804 (setq key
13805 (if (= (char-after (match-beginning 3)) ?\[)
13806 "TIMESTAMP_IA" "TIMESTAMP")))
13807 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13808 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13809 ((equal key1 org-closed-string) (setq key "CLOSED"))
13810 ((equal key1 org-clock-string) (setq key "CLOCK")))
13811 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13812 (progn
13813 (push (cons key string) props)
13814 ;; no need to search further if match is found
13815 (throw 'match t))
13816 (when (or (equal key "CLOCK") (not (assoc key props)))
13817 (push (cons key string) props))))))
13818 )
13820 (when (memq which '(all standard))
13821 ;; Get the standard properties, like :PROP: ...
13822 (setq range (org-get-property-block beg end))
13823 (when range
13824 (goto-char (car range))
13825 (while (re-search-forward
13827 (cdr range) t)
13828 (setq key (org-match-string-no-properties 1)
13829 value (org-trim (or (org-match-string-no-properties 2) "")))
13830 (unless (member key excluded)
13831 (push (cons key (or value "")) props)))))
13832 (if clocksum
13833 (push (cons "CLOCKSUM"
13834 (org-columns-number-to-string (/ (float clocksum) 60.)
13835 'add_times))
13836 props))
13837 (unless (assoc "CATEGORY" props)
13838 (push (cons "CATEGORY" (org-get-category)) props))
13839 (append sum-props (nreverse props)))))))
13841 (defun org-entry-get (pom property &optional inherit literal-nil)
13842 "Get value of PROPERTY for entry at point-or-marker POM.
13843 If INHERIT is non-nil and the entry does not have the property,
13844 then also check higher levels of the hierarchy.
13845 If INHERIT is the symbol `selective', use inheritance only if the setting
13846 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13847 If the property is present but empty, the return value is the empty string.
13848 If the property is not present at all, nil is returned.
13851 do not interpret it as the list atom nil. This is used for inheritance
13853 (org-with-point-at pom
13854 (if (and inherit (if (eq inherit 'selective)
13855 (org-property-inherit-p property)
13856 t))
13857 (org-entry-get-with-inheritance property literal-nil)
13858 (if (member property org-special-properties)
13859 ;; We need a special property. Use `org-entry-properties' to
13860 ;; retrieve it, but specify the wanted property
13861 (cdr (assoc property (org-entry-properties nil 'special property)))
13862 (let ((range (unless (org-before-first-heading-p)
13863 (org-get-property-block))))
13864 (if (and range
13865 (goto-char (car range))
13866 (re-search-forward
13867 (org-re-property property)
13868 (cdr range) t))
13869 ;; Found the property, return it.
13870 (if (match-end 1)
13871 (if literal-nil
13872 (org-match-string-no-properties 1)
13873 (org-not-nil (org-match-string-no-properties 1)))
13874 "")))))))
13876 (defun org-property-or-variable-value (var &optional inherit)
13877 "Check if there is a property fixing the value of VAR.
13878 If yes, return this value. If not, return the current value of the variable."
13879 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13881 (read prop)
13882 (symbol-value var))))
13884 (defun org-entry-delete (pom property)
13885 "Delete the property PROPERTY from entry at point-or-marker POM."
13886 (org-with-point-at pom
13887 (if (member property org-special-properties)
13888 nil ; cannot delete these properties.
13889 (let ((range (org-get-property-block)))
13890 (if (and range
13891 (goto-char (car range))
13892 (re-search-forward
13893 (org-re-property property)
13894 (cdr range) t))
13895 (progn
13896 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13897 t)
13898 nil)))))
13900 ;; Multi-values properties are properties that contain multiple values
13901 ;; These values are assumed to be single words, separated by whitespace.
13902 (defun org-entry-add-to-multivalued-property (pom property value)
13903 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13904 (let* ((old (org-entry-get pom property))
13906 (setq value (org-entry-protect-space value))
13907 (unless (member value values)
13908 (setq values (cons value values))
13909 (org-entry-put pom property
13910 (mapconcat 'identity values " ")))))
13912 (defun org-entry-remove-from-multivalued-property (pom property value)
13913 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13914 (let* ((old (org-entry-get pom property))
13916 (setq value (org-entry-protect-space value))
13917 (when (member value values)
13918 (setq values (delete value values))
13919 (org-entry-put pom property
13920 (mapconcat 'identity values " ")))))
13922 (defun org-entry-member-in-multivalued-property (pom property value)
13923 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13924 (let* ((old (org-entry-get pom property))
13926 (setq value (org-entry-protect-space value))
13927 (member value values)))
13929 (defun org-entry-get-multivalued-property (pom property)
13930 "Return a list of values in a multivalued property."
13931 (let* ((value (org-entry-get pom property))
13933 (mapcar 'org-entry-restore-space values)))
13935 (defun org-entry-put-multivalued-property (pom property &rest values)
13936 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13937 VALUES should be a list of strings. Spaces will be protected."
13938 (org-entry-put pom property
13939 (mapconcat 'org-entry-protect-space values " "))
13940 (let* ((value (org-entry-get pom property))
13942 (mapcar 'org-entry-restore-space values)))
13944 (defun org-entry-protect-space (s)
13945 "Protect spaces and newline in string S."
13946 (while (string-match " " s)
13947 (setq s (replace-match "%20" t t s)))
13949 (setq s (replace-match "%0A" t t s)))
13950 s)
13952 (defun org-entry-restore-space (s)
13953 "Restore spaces and newline in string S."
13954 (while (string-match "%20" s)
13955 (setq s (replace-match " " t t s)))
13956 (while (string-match "%0A" s)
13958 s)
13960 (defvar org-entry-property-inherited-from (make-marker)
13961 "Marker pointing to the entry from where a property was inherited.
13962 Each call to `org-entry-get-with-inheritance' will set this marker to the
13963 location of the entry where the inheritance search matched. If there was
13964 no match, the marker will point nowhere.
13965 Note that also `org-entry-get' calls this function, if the INHERIT flag
13966 is set.")
13968 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13969 "Get entry property, and search higher levels if not present.
13970 The search will stop at the first ancestor which has the property defined.
13972 should be considered as undefined (this is the meaning of nil here).
13974 (move-marker org-entry-property-inherited-from nil)
13975 (let (tmp)
13976 (unless (org-before-first-heading-p)
13977 (save-excursion
13978 (save-restriction
13979 (widen)
13980 (catch 'ex
13981 (while t
13982 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13983 (org-back-to-heading t)
13984 (move-marker org-entry-property-inherited-from (point))
13985 (throw 'ex tmp))
13986 (or (org-up-heading-safe) (throw 'ex nil)))))))
13987 (setq tmp (or tmp
13988 (cdr (assoc property org-file-properties))
13989 (cdr (assoc property org-global-properties))
13990 (cdr (assoc property org-global-properties-fixed))))
13991 (if literal-nil tmp (org-not-nil tmp))))
13993 (defvar org-property-changed-functions nil
13994 "Hook called when the value of a property has changed.
13995 Each hook function should accept two arguments, the name of the property
13996 and the new value.")
13998 (defun org-entry-put (pom property value)
13999 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14000 (org-with-point-at pom
14001 (org-back-to-heading t)
14002 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14003 range)
14004 (cond
14005 ((equal property "TODO")
14007 (not (member value org-todo-keywords-1)))
14009 (if (or (not value)
14011 (setq value 'none))
14012 (org-todo value)
14013 (org-set-tags nil 'align))
14014 ((equal property "PRIORITY")
14016 (string-to-char value) ?\ ))
14017 (org-set-tags nil 'align))
14018 ((equal property "SCHEDULED")
14019 (if (re-search-forward org-scheduled-time-regexp end t)
14020 (cond
14021 ((eq value 'earlier) (org-timestamp-change -1 'day))
14022 ((eq value 'later) (org-timestamp-change 1 'day))
14023 (t (call-interactively 'org-schedule)))
14024 (call-interactively 'org-schedule)))
14025 ((equal property "DEADLINE")
14026 (if (re-search-forward org-deadline-time-regexp end t)
14027 (cond
14028 ((eq value 'earlier) (org-timestamp-change -1 'day))
14029 ((eq value 'later) (org-timestamp-change 1 'day))
14030 (t (call-interactively 'org-deadline)))
14031 (call-interactively 'org-deadline)))
14032 ((member property org-special-properties)
14033 (error "The %s property can not yet be set with `org-entry-put'"
14034 property))
14035 (t ; a non-special property
14036 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14037 (setq range (org-get-property-block beg end 'force))
14038 (goto-char (car range))
14039 (if (re-search-forward
14040 (org-re-property property) (cdr range) t)
14041 (progn
14042 (delete-region (match-beginning 0) (match-end 0))
14043 (goto-char (match-beginning 0)))
14044 (goto-char (cdr range))
14046 (backward-char 1)
14047 (org-indent-line-function))
14048 (insert ":" property ":")
14049 (and value (insert " " value))
14050 (org-indent-line-function)))))
14051 (run-hook-with-args 'org-property-changed-functions property value)))
14053 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14054 "Get all property keys in the current buffer.
14055 With INCLUDE-SPECIALS, also list the special properties that reflect things
14056 like tags and TODO state.
14057 With INCLUDE-DEFAULTS, also include properties that has special meaning
14058 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14059 and others.
14060 With INCLUDE-COLUMNS, also include property names given in COLUMN
14061 formats in the current buffer."
14062 (let (rtn range cfmt s p)
14063 (save-excursion
14064 (save-restriction
14065 (widen)
14066 (goto-char (point-min))
14067 (while (re-search-forward org-property-start-re nil t)
14068 (setq range (org-get-property-block))
14069 (goto-char (car range))
14070 (while (re-search-forward
14072 (cdr range) t)
14073 (add-to-list 'rtn (org-match-string-no-properties 1)))
14074 (outline-next-heading))))
14076 (when include-specials
14077 (setq rtn (append org-special-properties rtn)))
14079 (when include-defaults
14080 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14081 (add-to-list 'rtn org-effort-property))
14083 (when include-columns
14084 (save-excursion
14085 (save-restriction
14086 (widen)
14087 (goto-char (point-min))
14088 (while (re-search-forward
14090 nil t)
14091 (setq cfmt (match-string 2) s 0)
14093 cfmt s)
14094 (setq s (match-end 0)
14095 p (match-string 1 cfmt))
14096 (unless (or (equal p "ITEM")
14097 (member p org-special-properties))
14098 (add-to-list 'rtn (match-string 1 cfmt))))))))
14100 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14102 (defun org-property-values (key)
14103 "Return a list of all values of property KEY in the current buffer."
14104 (save-excursion
14105 (save-restriction
14106 (widen)
14107 (goto-char (point-min))
14108 (let ((re (org-re-property key))
14109 values)
14110 (while (re-search-forward re nil t)
14111 (add-to-list 'values (org-trim (match-string 1))))
14112 (delete "" values)))))
14114 (defun org-insert-property-drawer ()
14115 "Insert a property drawer into the current entry."
14116 (interactive)
14117 (org-back-to-heading t)
14118 (looking-at org-outline-regexp)
14119 (let ((indent (if org-adapt-indentation
14120 (- (match-end 0)(match-beginning 0))
14121 0))
14122 (beg (point))
14124 end hiddenp)
14125 (outline-next-heading)
14126 (setq end (point))
14127 (goto-char beg)
14128 (while (re-search-forward re end t))
14129 (setq hiddenp (outline-invisible-p))
14130 (end-of-line 1)
14133 (if (member (match-string 1) '("CLOCK:" ":END:"))
14134 ;; just skip this line
14135 (beginning-of-line 2)
14136 ;; Drawer start, find the end
14138 (beginning-of-line 1)))
14139 (org-skip-over-state-notes)
14141 (if (eq (char-before) ?*) (forward-char 1))
14143 (beginning-of-line 0)
14144 (org-indent-to-column indent)
14145 (beginning-of-line 2)
14146 (org-indent-to-column indent)
14147 (beginning-of-line 0)
14148 (if hiddenp
14149 (save-excursion
14150 (org-back-to-heading t)
14151 (hide-entry))
14152 (org-flag-drawer t))))
14154 (defvar org-property-set-functions-alist nil
14155 "Property set function alist.
14156 Each entry should have the following format:
14158 (PROPERTY . READ-FUNCTION)
14160 The read function will be called with the same argument as
14161 `org-completing-read'.")
14163 (defun org-set-property-function (property)
14164 "Get the function that should be used to set PROPERTY.
14165 This is computed according to `org-property-set-functions-alist'."
14166 (or (cdr (assoc property org-property-set-functions-alist))
14167 'org-completing-read))
14169 (defun org-read-property-value (property)
14170 "Read PROPERTY value from user."
14171 (let* ((completion-ignore-case t)
14172 (allowed (org-property-get-allowed-values nil property 'table))
14173 (cur (org-entry-get nil property))
14174 (prompt (concat property " value"
14176 (concat " [" cur "]") "") ": "))
14177 (set-function (org-set-property-function property))
14178 (val (if allowed
14179 (funcall set-function prompt allowed nil
14180 (not (get-text-property 0 'org-unrestricted
14181 (caar allowed))))
14182 (let (org-completion-use-ido org-completion-use-iswitchb)
14183 (funcall set-function prompt
14184 (mapcar 'list (org-property-values property))
14185 nil nil "" nil cur)))))
14186 (if (equal val "")
14187 cur
14188 val)))
14190 (defvar org-last-set-property nil)
14191 (defun org-read-property-name ()
14192 "Read a property name."
14193 (let* ((completion-ignore-case t)
14194 (keys (org-buffer-property-keys nil t t))
14195 (default-prop (or (save-excursion
14196 (save-match-data
14197 (beginning-of-line)
14199 (null (string= (match-string 1) "END"))
14200 (match-string 1))))
14201 org-last-set-property))
14202 (property (org-icompleting-read
14203 (concat "Property"
14204 (if default-prop (concat " [" default-prop "]") "")
14205 ": ")
14206 (mapcar 'list keys)
14207 nil nil nil nil
14208 default-prop
14209 )))
14210 (if (member property keys)
14211 property
14212 (or (cdr (assoc (downcase property)
14213 (mapcar (lambda (x) (cons (downcase x) x))
14214 keys)))
14215 property))))
14217 (defun org-set-property (property value)
14218 "In the current entry, set PROPERTY to VALUE.
14219 When called interactively, this will prompt for a property name, offering
14220 completion on existing and default properties. And then it will prompt
14221 for a value, offering completion either on allowed values (via an inherited
14222 xxx_ALL property) or on existing values in other instances of this property
14223 in the current file."
14224 (interactive (list nil nil))
14225 (let* ((property (or property (org-read-property-name)))
14226 (value (or value (org-read-property-value property))))
14227 (setq org-last-set-property property)
14228 (unless (equal (org-entry-get nil property) value)
14229 (org-entry-put nil property value))))
14231 (defun org-delete-property (property)
14232 "In the current entry, delete PROPERTY."
14233 (interactive
14234 (let* ((completion-ignore-case t)
14235 (prop (org-icompleting-read "Property: "
14236 (org-entry-properties nil 'standard))))
14237 (list prop)))
14238 (message "Property %s %s" property
14239 (if (org-entry-delete nil property)
14240 "deleted"
14241 "was not present in the entry")))
14243 (defun org-delete-property-globally (property)
14244 "Remove PROPERTY globally, from all entries."
14245 (interactive
14246 (let* ((completion-ignore-case t)
14247 (prop (org-icompleting-read
14248 "Globally remove property: "
14249 (mapcar 'list (org-buffer-property-keys)))))
14250 (list prop)))
14251 (save-excursion
14252 (save-restriction
14253 (widen)
14254 (goto-char (point-min))
14255 (let ((cnt 0))
14256 (while (re-search-forward
14257 (org-re-property property)
14258 nil t)
14259 (setq cnt (1+ cnt))
14260 (replace-match ""))
14263 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14265 (defun org-compute-property-at-point ()
14266 "Compute the property at point.
14267 This looks for an enclosing column format, extracts the operator and
14268 then applies it to the property in the column format's scope."
14269 (interactive)
14270 (unless (org-at-property-p)
14271 (error "Not at a property"))
14272 (let ((prop (org-match-string-no-properties 2)))
14273 (org-columns-get-format-and-top-level)
14274 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14275 (error "No operator defined for property %s" prop))
14276 (org-columns-compute prop)))
14278 (defvar org-property-allowed-value-functions nil
14279 "Hook for functions supplying allowed values for a specific property.
14280 The functions must take a single argument, the name of the property, and
14282 the values, this means that these values are intended as defaults for
14283 completion, but that other values should be allowed too.
14284 The functions must return nil if they are not responsible for this
14285 property.")
14287 (defun org-property-get-allowed-values (pom property &optional table)
14288 "Get allowed values for the property PROPERTY.
14289 When TABLE is non-nil, return an alist that can directly be used for
14290 completion."
14291 (let (vals)
14292 (cond
14293 ((equal property "TODO")
14294 (setq vals (org-with-point-at pom
14295 (append org-todo-keywords-1 '("")))))
14296 ((equal property "PRIORITY")
14297 (let ((n org-lowest-priority))
14298 (while (>= n org-highest-priority)
14299 (push (char-to-string n) vals)
14300 (setq n (1- n)))))
14301 ((member property org-special-properties))
14302 ((setq vals (run-hook-with-args-until-success
14303 'org-property-allowed-value-functions property)))
14304 (t
14305 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14307 (setq vals (car (read-from-string (concat "(" vals ")"))))
14308 (setq vals (mapcar (lambda (x)
14309 (cond ((stringp x) x)
14310 ((numberp x) (number-to-string x))
14311 ((symbolp x) (symbol-name x))
14312 (t "???")))
14313 vals)))))
14314 (when (member ":ETC" vals)
14315 (setq vals (remove ":ETC" vals))
14316 (org-add-props (car vals) '(org-unrestricted t)))
14317 (if table (mapcar 'list vals) vals)))
14319 (defun org-property-previous-allowed-value (&optional previous)
14320 "Switch to the next allowed value for this property."
14321 (interactive)
14322 (org-property-next-allowed-value t))
14324 (defun org-property-next-allowed-value (&optional previous)
14325 "Switch to the next allowed value for this property."
14326 (interactive)
14327 (unless (org-at-property-p)
14328 (error "Not at a property"))
14329 (let* ((key (match-string 2))
14330 (value (match-string 3))
14331 (allowed (or (org-property-get-allowed-values (point) key)
14332 (and (member value '("[ ]" "[-]" "[X]"))
14333 '("[ ]" "[X]"))))
14334 nval)
14335 (unless allowed
14336 (error "Allowed values for this property have not been defined"))
14337 (if previous (setq allowed (reverse allowed)))
14338 (if (member value allowed)
14339 (setq nval (car (cdr (member value allowed)))))
14340 (setq nval (or nval (car allowed)))
14341 (if (equal nval value)
14342 (error "Only one allowed value for this property"))
14343 (org-at-property-p)
14344 (replace-match (concat " :" key ": " nval) t t)
14345 (org-indent-line-function)
14346 (beginning-of-line 1)
14348 (run-hook-with-args 'org-property-changed-functions key nval)))
14350 (defun org-find-olp (path &optional this-buffer)
14351 "Return a marker pointing to the entry at outline path OLP.
14352 If anything goes wrong, throw an error.
14353 You can wrap this call to catch the error like this:
14355 (condition-case msg
14356 (org-mobile-locate-entry (match-string 4))
14357 (error (nth 1 msg)))
14359 The return value will then be either a string with the error message,
14360 or a marker if everything is OK.
14362 If THIS-BUFFER is set, the outline path does not contain a file,
14363 only headings."
14364 (let* ((file (if this-buffer buffer-file-name (pop path)))
14365 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14366 (level 1)
14367 (lmin 1)
14368 (lmax 1)
14369 limit re end found pos heading cnt flevel)
14370 (unless buffer (error "File not found :%s" file))
14371 (with-current-buffer buffer
14372 (save-excursion
14373 (save-restriction
14374 (widen)
14375 (setq limit (point-max))
14376 (goto-char (point-min))
14377 (while (setq heading (pop path))
14378 (setq re (format org-complex-heading-regexp-format
14379 (regexp-quote heading)))
14380 (setq cnt 0 pos (point))
14381 (while (re-search-forward re end t)
14382 (setq level (- (match-end 1) (match-beginning 1)))
14383 (if (and (>= level lmin) (<= level lmax))
14384 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14385 (when (= cnt 0) (error "Heading not found on level %d: %s"
14386 lmax heading))
14387 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14388 lmax heading))
14389 (goto-char found)
14390 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14391 (setq end (save-excursion (org-end-of-subtree t t))))
14392 (when (org-on-heading-p)
14393 (move-marker (make-marker) (point))))))))
14395 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14396 "Find node HEADING in BUFFER.
14397 Return a marker to the heading if it was found, or nil if not.
14398 If POS-ONLY is set, return just the position instead of a marker.
14400 The heading text must match exact, but it may have a TODO keyword,
14401 a priority cookie and tags in the standard locations."
14402 (with-current-buffer (or buffer (current-buffer))
14403 (save-excursion
14404 (save-restriction
14405 (widen)
14406 (goto-char (point-min))
14407 (let (case-fold-search)
14408 (if (re-search-forward
14409 (format org-complex-heading-regexp-format
14410 (regexp-quote heading)) nil t)
14411 (if pos-only
14412 (match-beginning 0)
14413 (move-marker (make-marker) (match-beginning 0)))))))))
14415 (defun org-find-exact-heading-in-directory (heading &optional dir)
14416 "Find Org node headline HEADING in all .org files in directory DIR.
14417 When the target headline is found, return a marker to this location."
14418 (let ((files (directory-files (or dir default-directory)
14420 file visiting m buffer)
14421 (catch 'found
14422 (while (setq file (pop files))
14423 (message "trying %s" file)
14424 (setq visiting (org-find-base-buffer-visiting file))
14425 (setq buffer (or visiting (find-file-noselect file)))
14426 (setq m (org-find-exact-headline-in-buffer
14427 heading buffer))
14428 (when (and (not m) (not visiting)) (kill-buffer buffer))
14429 (and m (throw 'found m))))))
14431 (defun org-find-entry-with-id (ident)
14432 "Locate the entry that contains the ID property with exact value IDENT.
14433 IDENT can be a string, a symbol or a number, this function will search for
14434 the string representation of it.
14435 Return the position where this entry starts, or nil if there is no such entry."
14436 (interactive "sID: ")
14437 (let ((id (cond
14438 ((stringp ident) ident)
14439 ((symbol-name ident) (symbol-name ident))
14440 ((numberp ident) (number-to-string ident))
14441 (t (error "IDENT %s must be a string, symbol or number" ident))))
14442 (case-fold-search nil))
14443 (save-excursion
14444 (save-restriction
14445 (widen)
14446 (goto-char (point-min))
14447 (when (re-search-forward
14449 nil t)
14450 (org-back-to-heading t)
14451 (point))))))
14453 ;;;; Timestamps
14455 (defvar org-last-changed-timestamp nil)
14456 (defvar org-last-inserted-timestamp nil
14457 "The last time stamp inserted with `org-insert-time-stamp'.")
14458 (defvar org-time-was-given) ; dynamically scoped parameter
14459 (defvar org-end-time-was-given) ; dynamically scoped parameter
14460 (defvar org-ts-what) ; dynamically scoped parameter
14462 (defun org-time-stamp (arg &optional inactive)
14463 "Prompt for a date/time and insert a time stamp.
14464 If the user specifies a time like HH:MM, or if this command is called
14465 with a prefix argument, the time stamp will contain date and time.
14466 Otherwise, only the date will be included. All parts of a date not
14467 specified by the user will be filled in from the current date/time.
14468 So if you press just return without typing anything, the time stamp
14469 will represent the current date/time. If there is already a timestamp
14470 at the cursor, it will be modified."
14471 (interactive "P")
14472 (let* ((ts nil)
14473 (default-time
14474 ;; Default time is either today, or, when entering a range,
14475 ;; the range start.
14476 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14477 (save-excursion
14478 (re-search-backward
14480 (- (point) 20) t)))
14481 (apply 'encode-time (org-parse-time-string (match-string 1)))
14482 (current-time)))
14483 (default-input (and ts (org-get-compact-tod ts)))
14484 (repeater (save-excursion
14485 (save-match-data
14486 (beginning-of-line)
14487 (when (re-search-forward
14489 (save-excursion (progn (end-of-line) (point))) t)
14490 (match-string 0)))))
14491 org-time-was-given org-end-time-was-given time)
14492 (cond
14493 ((and (org-at-timestamp-p t)
14494 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14495 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14496 (insert "--")
14497 (setq time (let ((this-command this-command))
14498 (org-read-date arg 'totime nil nil
14499 default-time default-input)))
14500 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14501 ((org-at-timestamp-p t)
14502 (setq time (let ((this-command this-command))
14503 (org-read-date arg 'totime nil nil default-time default-input)))
14504 (when (org-at-timestamp-p t) ; just to get the match data
14505 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14506 (replace-match "")
14507 (setq org-last-changed-timestamp
14508 (org-insert-time-stamp
14509 time (or org-time-was-given arg)
14510 inactive nil nil (list org-end-time-was-given)))
14511 (when repeater (goto-char (1- (point))) (insert " " repeater)
14512 (setq org-last-changed-timestamp
14513 (concat (substring org-last-inserted-timestamp 0 -1)
14514 " " repeater ">"))))
14515 (message "Timestamp updated"))
14516 (t
14517 (setq time (let ((this-command this-command))
14518 (org-read-date arg 'totime nil nil default-time default-input)))
14519 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14520 nil nil (list org-end-time-was-given))))))
14522 ;; FIXME: can we use this for something else, like computing time differences?
14523 (defun org-get-compact-tod (s)
14524 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14525 (let* ((t1 (match-string 1 s))
14526 (h1 (string-to-number (match-string 2 s)))
14527 (m1 (string-to-number (match-string 3 s)))
14528 (t2 (and (match-end 4) (match-string 5 s)))
14529 (h2 (and t2 (string-to-number (match-string 6 s))))
14530 (m2 (and t2 (string-to-number (match-string 7 s))))
14531 dh dm)
14532 (if (not t2)
14533 t1
14534 (setq dh (- h2 h1) dm (- m2 m1))
14535 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14536 (concat t1 "+" (number-to-string dh)
14537 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14539 (defun org-time-stamp-inactive (&optional arg)
14540 "Insert an inactive time stamp.
14541 An inactive time stamp is enclosed in square brackets instead of angle
14542 brackets. It is inactive in the sense that it does not trigger agenda entries,
14543 does not link to the calendar and cannot be changed with the S-cursor keys.
14544 So these are more for recording a certain time/date."
14545 (interactive "P")
14546 (org-time-stamp arg 'inactive))
14548 (defvar org-date-ovl (make-overlay 1 1))
14549 (overlay-put org-date-ovl 'face 'org-warning)
14550 (org-detach-overlay org-date-ovl)
14552 (defvar org-ans1) ; dynamically scoped parameter
14553 (defvar org-ans2) ; dynamically scoped parameter
14555 (defvar org-plain-time-of-day-regexp) ; defined below
14557 (defvar org-overriding-default-time nil) ; dynamically scoped
14558 (defvar org-read-date-overlay nil)
14559 (defvar org-dcst nil) ; dynamically scoped
14560 (defvar org-read-date-history nil)
14561 (defvar org-read-date-final-answer nil)
14562 (defvar org-read-date-analyze-futurep nil)
14563 (defvar org-read-date-analyze-forced-year nil)
14565 (defun org-read-date (&optional with-time to-time from-string prompt
14566 default-time default-input)
14567 "Read a date, possibly a time, and make things smooth for the user.
14568 The prompt will suggest to enter an ISO date, but you can also enter anything
14569 which will at least partially be understood by `parse-time-string'.
14570 Unrecognized parts of the date will default to the current day, month, year,
14571 hour and minute. If this command is called to replace a timestamp at point,
14572 of to enter the second timestamp of a range, the default time is taken
14573 from the existing stamp. Furthermore, the command prefers the future,
14574 so if you are giving a date where the year is not given, and the day-month
14575 combination is already past in the current year, it will assume you
14576 mean next year. For details, see the manual. A few examples:
14578 3-2-5 --> 2003-02-05
14579 feb 15 --> currentyear-02-15
14580 2/15 --> currentyear-02-15
14581 sep 12 9 --> 2009-09-12
14582 12:45 --> today 12:45
14583 22 sept 0:34 --> currentyear-09-22 0:34
14584 12 --> currentyear-currentmonth-12
14585 Fri --> nearest Friday (today or later)
14586 etc.
14588 Furthermore you can specify a relative date by giving, as the *first* thing
14589 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14590 change in days weeks, months, years.
14591 With a single plus or minus, the date is relative to today. With a double
14592 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14593 +4d --> four days from today
14594 +4 --> same as above
14595 +2w --> two weeks from today
14596 ++5 --> five days from default date
14598 The function understands only English month and weekday abbreviations,
14599 but this can be configured with the variables `parse-time-months' and
14600 `parse-time-weekdays'.
14602 While prompting, a calendar is popped up - you can also select the
14603 date with the mouse (button 1). The calendar shows a period of three
14604 months. To scroll it to other months, use the keys `>' and `<'.
14605 If you don't like the calendar, turn it off with
14606 \(setq org-read-date-popup-calendar nil)
14608 With optional argument TO-TIME, the date will immediately be converted
14609 to an internal time.
14610 With an optional argument WITH-TIME, the prompt will suggest to also
14611 insert a time. Note that when WITH-TIME is not set, you can still
14612 enter a time, and this function will inform the calling routine about
14613 this change. The calling routine may then choose to change the format
14614 used to insert the time stamp into the buffer to include the time.
14615 With optional argument FROM-STRING, read from this string instead from
14616 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14617 the time/date that is used for everything that is not specified by the
14618 user."
14619 (require 'parse-time)
14620 (let* ((org-time-stamp-rounding-minutes
14621 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14622 (org-dcst org-display-custom-times)
14623 (ct (org-current-time))
14624 (def (or org-overriding-default-time default-time ct))
14625 (defdecode (decode-time def))
14626 (dummy (progn
14627 (when (< (nth 2 defdecode) org-extend-today-until)
14628 (setcar (nthcdr 2 defdecode) -1)
14629 (setcar (nthcdr 1 defdecode) 59)
14630 (setq def (apply 'encode-time defdecode)
14631 defdecode (decode-time def)))))
14632 (calendar-frame-setup nil)
14633 (calendar-setup nil)
14634 (calendar-move-hook nil)
14635 (calendar-view-diary-initially-flag nil)
14636 (calendar-view-holidays-initially-flag nil)
14637 (timestr (format-time-string
14638 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14639 (prompt (concat (if prompt (concat prompt " ") "")
14640 (format "Date+time [%s]: " timestr)))
14641 ans (org-ans0 "") org-ans1 org-ans2 final)
14643 (cond
14644 (from-string (setq ans from-string))
14645 (org-read-date-popup-calendar
14646 (save-excursion
14647 (save-window-excursion
14648 (calendar)
14649 (unwind-protect
14650 (progn
14651 (calendar-forward-day (- (time-to-days def)
14652 (calendar-absolute-from-gregorian
14653 (calendar-current-date))))
14654 (org-eval-in-calendar nil t)
14655 (let* ((old-map (current-local-map))
14656 (map (copy-keymap calendar-mode-map))
14657 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14658 (org-defkey map (kbd "RET") 'org-calendar-select)
14659 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14660 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14661 (org-defkey minibuffer-local-map [(meta shift left)]
14662 (lambda () (interactive)
14663 (org-eval-in-calendar '(calendar-backward-month 1))))
14664 (org-defkey minibuffer-local-map [(meta shift right)]
14665 (lambda () (interactive)
14666 (org-eval-in-calendar '(calendar-forward-month 1))))
14667 (org-defkey minibuffer-local-map [(meta shift up)]
14668 (lambda () (interactive)
14669 (org-eval-in-calendar '(calendar-backward-year 1))))
14670 (org-defkey minibuffer-local-map [(meta shift down)]
14671 (lambda () (interactive)
14672 (org-eval-in-calendar '(calendar-forward-year 1))))
14673 (org-defkey minibuffer-local-map [?\e (shift left)]
14674 (lambda () (interactive)
14675 (org-eval-in-calendar '(calendar-backward-month 1))))
14676 (org-defkey minibuffer-local-map [?\e (shift right)]
14677 (lambda () (interactive)
14678 (org-eval-in-calendar '(calendar-forward-month 1))))
14679 (org-defkey minibuffer-local-map [?\e (shift up)]
14680 (lambda () (interactive)
14681 (org-eval-in-calendar '(calendar-backward-year 1))))
14682 (org-defkey minibuffer-local-map [?\e (shift down)]
14683 (lambda () (interactive)
14684 (org-eval-in-calendar '(calendar-forward-year 1))))
14685 (org-defkey minibuffer-local-map [(shift up)]
14686 (lambda () (interactive)
14687 (org-eval-in-calendar '(calendar-backward-week 1))))
14688 (org-defkey minibuffer-local-map [(shift down)]
14689 (lambda () (interactive)
14690 (org-eval-in-calendar '(calendar-forward-week 1))))
14691 (org-defkey minibuffer-local-map [(shift left)]
14692 (lambda () (interactive)
14693 (org-eval-in-calendar '(calendar-backward-day 1))))
14694 (org-defkey minibuffer-local-map [(shift right)]
14695 (lambda () (interactive)
14696 (org-eval-in-calendar '(calendar-forward-day 1))))
14697 (org-defkey minibuffer-local-map ">"
14698 (lambda () (interactive)
14699 (org-eval-in-calendar '(scroll-calendar-left 1))))
14700 (org-defkey minibuffer-local-map "<"
14701 (lambda () (interactive)
14702 (org-eval-in-calendar '(scroll-calendar-right 1))))
14703 (org-defkey minibuffer-local-map "\C-v"
14704 (lambda () (interactive)
14705 (org-eval-in-calendar
14706 '(calendar-scroll-left-three-months 1))))
14707 (org-defkey minibuffer-local-map "\M-v"
14708 (lambda () (interactive)
14709 (org-eval-in-calendar
14710 '(calendar-scroll-right-three-months 1))))
14711 (run-hooks 'org-read-date-minibuffer-setup-hook)
14712 (unwind-protect
14713 (progn
14714 (use-local-map map)
14715 (add-hook 'post-command-hook 'org-read-date-display)
14716 (setq org-ans0 (read-string prompt default-input
14717 'org-read-date-history nil))
14718 ;; org-ans0: from prompt
14719 ;; org-ans1: from mouse click
14720 ;; org-ans2: from calendar motion
14721 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14722 (remove-hook 'post-command-hook 'org-read-date-display)
14723 (use-local-map old-map)
14724 (when org-read-date-overlay
14725 (delete-overlay org-read-date-overlay)
14726 (setq org-read-date-overlay nil)))))
14727 (bury-buffer "*Calendar*")))))
14729 (t ; Naked prompt only
14730 (unwind-protect
14731 (setq ans (read-string prompt default-input
14732 'org-read-date-history timestr))
14733 (when org-read-date-overlay
14734 (delete-overlay org-read-date-overlay)
14735 (setq org-read-date-overlay nil)))))
14737 (setq final (org-read-date-analyze ans def defdecode))
14739 (when org-read-date-analyze-forced-year
14740 (message "Year was forced into %s"
14741 (if org-read-date-force-compatible-dates
14742 "compatible range (1970-2037)"
14743 "range representable on this machine"))
14744 (ding))
14746 ;; One round trip to get rid of 34th of August and stuff like that....
14747 (setq final (decode-time (apply 'encode-time final)))
14749 (setq org-read-date-final-answer ans)
14751 (if to-time
14752 (apply 'encode-time final)
14753 (if (and (boundp 'org-time-was-given) org-time-was-given)
14754 (format "%04d-%02d-%02d %02d:%02d"
14755 (nth 5 final) (nth 4 final) (nth 3 final)
14756 (nth 2 final) (nth 1 final))
14757 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14759 (defvar def)
14760 (defvar defdecode)
14761 (defvar with-time)
14762 (defun org-read-date-display ()
14763 "Display the current date prompt interpretation in the minibuffer."
14764 (when org-read-date-display-live
14765 (when org-read-date-overlay
14766 (delete-overlay org-read-date-overlay))
14767 (let ((p (point)))
14768 (end-of-line 1)
14769 (while (not (equal (buffer-substring
14770 (max (point-min) (- (point) 4)) (point))
14771 " "))
14772 (insert " "))
14773 (goto-char p))
14774 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14775 " " (or org-ans1 org-ans2)))
14776 (org-end-time-was-given nil)
14777 (f (org-read-date-analyze ans def defdecode))
14778 (fmts (if org-dcst
14779 org-time-stamp-custom-formats
14780 org-time-stamp-formats))
14781 (fmt (if (or with-time
14782 (and (boundp 'org-time-was-given) org-time-was-given))
14783 (cdr fmts)
14784 (car fmts)))
14785 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14786 (when (and org-end-time-was-given
14787 (string-match org-plain-time-of-day-regexp txt))
14788 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14789 org-end-time-was-given
14790 (substring txt (match-end 0)))))
14791 (when org-read-date-analyze-futurep
14792 (setq txt (concat txt " (=>F)")))
14793 (setq org-read-date-overlay
14794 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14795 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14797 (defun org-read-date-analyze (ans def defdecode)
14798 "Analyze the combined answer of the date prompt."
14799 ;; FIXME: cleanup and comment
14800 (let ((nowdecode (decode-time (current-time)))
14801 delta deltan deltaw deltadef year month day
14802 hour minute second wday pm h2 m2 tl wday1
14803 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14804 (setq org-read-date-analyze-futurep nil
14805 org-read-date-analyze-forced-year nil)
14807 (setq ans "+0"))
14809 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14810 (setq ans (replace-match "" t t ans)
14811 deltan (car delta)
14812 deltaw (nth 1 delta)
14813 deltadef (nth 2 delta)))
14815 ;; Check if there is an iso week date in there
14816 ;; If yes, store the info and postpone interpreting it until the rest
14817 ;; of the parsing is done
14818 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14819 (setq iso-year (if (match-end 1)
14820 (org-small-year-to-year
14821 (string-to-number (match-string 1 ans))))
14822 iso-weekday (if (match-end 3)
14823 (string-to-number (match-string 3 ans)))
14824 iso-week (string-to-number (match-string 2 ans)))
14825 (setq ans (replace-match "" t t ans)))
14827 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14828 (when (string-match
14830 (setq year (if (match-end 2)
14831 (string-to-number (match-string 2 ans))
14832 (progn (setq kill-year t)
14833 (string-to-number (format-time-string "%Y"))))
14834 month (string-to-number (match-string 3 ans))
14835 day (string-to-number (match-string 4 ans)))
14836 (if (< year 100) (setq year (+ 2000 year)))
14838 t nil ans)))
14840 ;; Help matching dottet european dates
14841 (when (string-match
14842 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14843 (setq year (if (match-end 3)
14844 (string-to-number (match-string 3 ans))
14845 (progn (setq kill-year t)
14846 (string-to-number (format-time-string "%Y"))))
14847 day (string-to-number (match-string 1 ans))
14848 month (string-to-number (match-string 2 ans))
14850 t nil ans)))
14852 ;; Help matching american dates, like 5/30 or 5/30/7
14853 (when (string-match
14854 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14855 (setq year (if (match-end 4)
14856 (string-to-number (match-string 4 ans))
14857 (progn (setq kill-year t)
14858 (string-to-number (format-time-string "%Y"))))
14859 month (string-to-number (match-string 1 ans))
14860 day (string-to-number (match-string 2 ans)))
14861 (if (< year 100) (setq year (+ 2000 year)))
14863 t nil ans)))
14864 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14865 ;; If there is a time with am/pm, and *no* time without it, we convert
14866 ;; so that matching will be successful.
14867 (loop for i from 1 to 2 do ; twice, for end time as well
14870 (setq hour (string-to-number (match-string 1 ans))
14871 minute (if (match-end 3)
14872 (string-to-number (match-string 3 ans))
14873 0)
14874 pm (equal ?p
14875 (string-to-char (downcase (match-string 4 ans)))))
14876 (if (and (= hour 12) (not pm))
14877 (setq hour 0)
14878 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14879 (setq ans (replace-match (format "%02d:%02d" hour minute)
14880 t t ans))))
14882 ;; Check if a time range is given as a duration
14883 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14884 (setq hour (string-to-number (match-string 1 ans))
14885 h2 (+ hour (string-to-number (match-string 3 ans)))
14886 minute (string-to-number (match-string 2 ans))
14887 m2 (+ minute (if (match-end 5) (string-to-number
14888 (match-string 5 ans))0)))
14889 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14890 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14891 t t ans)))
14893 ;; Check if there is a time range
14894 (when (boundp 'org-end-time-was-given)
14895 (setq org-time-was-given nil)
14896 (when (and (string-match org-plain-time-of-day-regexp ans)
14897 (match-end 8))
14898 (setq org-end-time-was-given (match-string 8 ans))
14899 (setq ans (concat (substring ans 0 (match-beginning 7))
14900 (substring ans (match-end 7))))))
14902 (setq tl (parse-time-string ans)
14903 day (or (nth 3 tl) (nth 3 defdecode))
14904 month (or (nth 4 tl)
14905 (if (and org-read-date-prefer-future
14906 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14907 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14908 (nth 4 defdecode)))
14909 year (or (and (not kill-year) (nth 5 tl))
14910 (if (and org-read-date-prefer-future
14911 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14912 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14913 (nth 5 defdecode)))
14914 hour (or (nth 2 tl) (nth 2 defdecode))
14915 minute (or (nth 1 tl) (nth 1 defdecode))
14916 second (or (nth 0 tl) 0)
14917 wday (nth 6 tl))
14919 (when (and (eq org-read-date-prefer-future 'time)
14920 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14921 (equal day (nth 3 nowdecode))
14922 (equal month (nth 4 nowdecode))
14923 (equal year (nth 5 nowdecode))
14924 (nth 2 tl)
14925 (or (< (nth 2 tl) (nth 2 nowdecode))
14926 (and (= (nth 2 tl) (nth 2 nowdecode))
14927 (nth 1 tl)
14928 (< (nth 1 tl) (nth 1 nowdecode)))))
14929 (setq day (1+ day)
14930 futurep t))
14932 ;; Special date definitions below
14933 (cond
14934 (iso-week
14935 ;; There was an iso week
14936 (require 'cal-iso)
14937 (setq futurep nil)
14938 (setq year (or iso-year year)
14939 day (or iso-weekday wday 1)
14940 wday nil ; to make sure that the trigger below does not match
14941 iso-date (calendar-gregorian-from-absolute
14942 (calendar-absolute-from-iso
14943 (list iso-week day year))))
14944 ; FIXME: Should we also push ISO weeks into the future?
14945 ; (when (and org-read-date-prefer-future
14946 ; (not iso-year)
14947 ; (< (calendar-absolute-from-gregorian iso-date)
14948 ; (time-to-days (current-time))))
14949 ; (setq year (1+ year)
14950 ; iso-date (calendar-gregorian-from-absolute
14951 ; (calendar-absolute-from-iso
14952 ; (list iso-week day year)))))
14953 (setq month (car iso-date)
14954 year (nth 2 iso-date)
14955 day (nth 1 iso-date)))
14956 (deltan
14957 (setq futurep nil)
14958 (unless deltadef
14959 (let ((now (decode-time (current-time))))
14960 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14961 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14962 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14963 ((equal deltaw "m") (setq month (+ month deltan)))
14964 ((equal deltaw "y") (setq year (+ year deltan)))))
14965 ((and wday (not (nth 3 tl)))
14966 (setq futurep nil)
14967 ;; Weekday was given, but no day, so pick that day in the week
14968 ;; on or after the derived date.
14969 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14970 (unless (equal wday wday1)
14971 (setq day (+ day (% (- wday wday1 -7) 7))))))
14972 (if (and (boundp 'org-time-was-given)
14973 (nth 2 tl))
14974 (setq org-time-was-given t))
14975 (if (< year 100) (setq year (+ 2000 year)))
14976 ;; Check of the date is representable
14977 (if org-read-date-force-compatible-dates
14978 (progn
14979 (if (< year 1970)
14980 (setq year 1970 org-read-date-analyze-forced-year t))
14981 (if (> year 2037)
14982 (setq year 2037 org-read-date-analyze-forced-year t)))
14983 (condition-case nil
14984 (ignore (encode-time second minute hour day month year))
14985 (error
14986 (setq year (nth 5 defdecode))
14987 (setq org-read-date-analyze-forced-year t))))
14988 (setq org-read-date-analyze-futurep futurep)
14989 (list second minute hour day month year)))
14991 (defvar parse-time-weekdays)
14993 (defun org-read-date-get-relative (s today default)
14994 "Check string S for special relative date string.
14995 TODAY and DEFAULT are internal times, for today and for a default.
14996 Return shift list (N what def-flag)
14998 N is the number of WHATs to shift.
14999 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15000 the DEFAULT date rather than TODAY."
15001 (when (and
15002 (string-match
15003 (concat
15008 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15009 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15010 (string-to-char (substring (match-string 1 s) -1))
15011 ?+))
15012 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15013 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15014 (what (if (match-end 3) (match-string 3 s) "d"))
15015 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15016 (date (if rel default today))
15017 (wday (nth 6 (decode-time date)))
15018 delta)
15019 (if wday1
15020 (progn
15021 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15022 (if (= dir ?-) (setq delta (- delta 7)))
15023 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15024 (list delta "d" rel))
15025 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15027 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15028 "Turn a user-specified date into the internal representation.
15029 The internal representation needed by the calendar is (month day year).
15030 This is a wrapper to handle the brain-dead convention in calendar that
15031 user function argument order change dependent on argument order."
15032 (if (boundp 'calendar-date-style)
15033 (cond
15034 ((eq calendar-date-style 'american)
15035 (list arg1 arg2 arg3))
15036 ((eq calendar-date-style 'european)
15037 (list arg2 arg1 arg3))
15038 ((eq calendar-date-style 'iso)
15039 (list arg2 arg3 arg1)))
15040 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15041 (if (org-bound-and-true-p european-calendar-style)
15042 (list arg2 arg1 arg3)
15043 (list arg1 arg2 arg3)))))
15045 (defun org-eval-in-calendar (form &optional keepdate)
15046 "Eval FORM in the calendar window and return to current window.
15047 Also, store the cursor date in variable org-ans2."
15048 (let ((sf (selected-frame))
15049 (sw (selected-window)))
15050 (select-window (get-buffer-window "*Calendar*" t))
15051 (eval form)
15052 (when (and (not keepdate) (calendar-cursor-to-date))
15053 (let* ((date (calendar-cursor-to-date))
15054 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15055 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15056 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15057 (select-window sw)
15058 (org-select-frame-set-input-focus sf)))
15060 (defun org-calendar-select ()
15061 "Return to `org-read-date' with the date currently selected.
15062 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15063 (interactive)
15064 (when (calendar-cursor-to-date)
15065 (let* ((date (calendar-cursor-to-date))
15066 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15067 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15068 (if (active-minibuffer-window) (exit-minibuffer))))
15070 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15071 "Insert a date stamp for the date given by the internal TIME.
15072 WITH-HM means use the stamp format that includes the time of the day.
15073 INACTIVE means use square brackets instead of angular ones, so that the
15074 stamp will not contribute to the agenda.
15075 PRE and POST are optional strings to be inserted before and after the
15076 stamp.
15077 The command returns the inserted time stamp."
15078 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15079 stamp)
15080 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15081 (insert-before-markers (or pre ""))
15082 (when (listp extra)
15083 (setq extra (car extra))
15084 (if (and (stringp extra)
15086 (setq extra (format "-%02d:%02d"
15087 (string-to-number (match-string 1 extra))
15088 (string-to-number (match-string 2 extra))))
15089 (setq extra nil)))
15090 (when extra
15091 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15092 (insert-before-markers (setq stamp (format-time-string fmt time)))
15093 (insert-before-markers (or post ""))
15094 (setq org-last-inserted-timestamp stamp)))
15096 (defun org-toggle-time-stamp-overlays ()
15097 "Toggle the use of custom time stamp formats."
15098 (interactive)
15099 (setq org-display-custom-times (not org-display-custom-times))
15100 (unless org-display-custom-times
15101 (let ((p (point-min)) (bmp (buffer-modified-p)))
15102 (while (setq p (next-single-property-change p 'display))
15103 (if (and (get-text-property p 'display)
15104 (eq (get-text-property p 'face) 'org-date))
15105 (remove-text-properties
15106 p (setq p (next-single-property-change p 'display))
15107 '(display t))))
15108 (set-buffer-modified-p bmp)))
15109 (if (featurep 'xemacs)
15110 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15111 (org-restart-font-lock)
15112 (setq org-table-may-need-update t)
15113 (if org-display-custom-times
15114 (message "Time stamps are overlayed with custom format")
15115 (message "Time stamp overlays removed")))
15117 (defun org-display-custom-time (beg end)
15118 "Overlay modified time stamp format over timestamp between BEG and END."
15119 (let* ((ts (buffer-substring beg end))
15120 t1 w1 with-hm tf time str w2 (off 0))
15121 (save-match-data
15122 (setq t1 (org-parse-time-string ts t))
15123 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15124 (setq off (- (match-end 0) (match-beginning 0)))))
15125 (setq end (- end off))
15126 (setq w1 (- end beg)
15127 with-hm (and (nth 1 t1) (nth 2 t1))
15128 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15129 time (org-fix-decoded-time t1)
15130 str (org-add-props
15131 (format-time-string
15132 (substring tf 1 -1) (apply 'encode-time time))
15133 nil 'mouse-face 'highlight)
15134 w2 (length str))
15135 (if (not (= w2 w1))
15136 (add-text-properties (1+ beg) (+ 2 beg)
15137 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15138 (if (featurep 'xemacs)
15139 (progn
15140 (put-text-property beg end 'invisible t)
15141 (put-text-property beg end 'end-glyph (make-glyph str)))
15142 (put-text-property beg end 'display str))))
15144 (defun org-translate-time (string)
15145 "Translate all timestamps in STRING to custom format.
15146 But do this only if the variable `org-display-custom-times' is set."
15147 (when org-display-custom-times
15148 (save-match-data
15149 (let* ((start 0)
15150 (re org-ts-regexp-both)
15151 t1 with-hm inactive tf time str beg end)
15152 (while (setq start (string-match re string start))
15153 (setq beg (match-beginning 0)
15154 end (match-end 0)
15155 t1 (save-match-data
15156 (org-parse-time-string (substring string beg end) t))
15157 with-hm (and (nth 1 t1) (nth 2 t1))
15158 inactive (equal (substring string beg (1+ beg)) "[")
15159 tf (funcall (if with-hm 'cdr 'car)
15160 org-time-stamp-custom-formats)
15161 time (org-fix-decoded-time t1)
15162 str (format-time-string
15163 (concat
15164 (if inactive "[" "<") (substring tf 1 -1)
15165 (if inactive "]" ">"))
15166 (apply 'encode-time time))
15167 string (replace-match str t t string)
15168 start (+ start (length str)))))))
15169 string)
15171 (defun org-fix-decoded-time (time)
15172 "Set 0 instead of nil for the first 6 elements of time.
15173 Don't touch the rest."
15174 (let ((n 0))
15175 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15177 (defun org-days-to-time (timestamp-string)
15178 "Difference between TIMESTAMP-STRING and now in days."
15179 (- (time-to-days (org-time-string-to-time timestamp-string))
15180 (time-to-days (current-time))))
15182 (defun org-deadline-close (timestamp-string &optional ndays)
15183 "Is the time in TIMESTAMP-STRING close to the current date?"
15184 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15185 (and (< (org-days-to-time timestamp-string) ndays)
15186 (not (org-entry-is-done-p))))
15188 (defun org-get-wdays (ts)
15189 "Get the deadline lead time appropriate for timestring TS."
15190 (cond
15191 ((<= org-deadline-warning-days 0)
15192 ;; 0 or negative, enforce this value no matter what
15193 (- org-deadline-warning-days))
15195 ;; lead time is specified.
15196 (floor (* (string-to-number (match-string 1 ts))
15197 (cdr (assoc (match-string 2 ts)
15198 '(("d" . 1) ("w" . 7)
15199 ("m" . 30.4) ("y" . 365.25)))))))
15200 ;; go for the default.
15201 (t org-deadline-warning-days)))
15203 (defun org-calendar-select-mouse (ev)
15204 "Return to `org-read-date' with the date currently selected.
15205 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15206 (interactive "e")
15207 (mouse-set-point ev)
15208 (when (calendar-cursor-to-date)
15209 (let* ((date (calendar-cursor-to-date))
15210 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15211 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15212 (if (active-minibuffer-window) (exit-minibuffer))))
15214 (defun org-check-deadlines (ndays)
15215 "Check if there are any deadlines due or past due.
15216 A deadline is considered due if it happens within `org-deadline-warning-days'
15217 days from today's date. If the deadline appears in an entry marked DONE,
15218 it is not shown. The prefix arg NDAYS can be used to test that many
15220 (interactive "P")
15221 (let* ((org-warn-days
15222 (cond
15223 ((equal ndays '(4)) 100000)
15224 (ndays (prefix-numeric-value ndays))
15225 (t (abs org-deadline-warning-days))))
15226 (case-fold-search nil)
15228 (callback
15229 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15231 (message "%d deadlines past-due or due within %d days"
15232 (org-occur regexp nil callback)
15233 org-warn-days)))
15235 (defun org-check-before-date (date)
15236 "Check if there are deadlines or scheduled entries before DATE."
15237 (interactive (list (org-read-date)))
15238 (let ((case-fold-search nil)
15242 (callback
15243 (lambda () (time-less-p
15244 (org-time-string-to-time (match-string 2))
15245 (org-time-string-to-time date)))))
15246 (message "%d entries before %s"
15247 (org-occur regexp nil callback) date)))
15249 (defun org-check-after-date (date)
15250 "Check if there are deadlines or scheduled entries after DATE."
15251 (interactive (list (org-read-date)))
15252 (let ((case-fold-search nil)
15256 (callback
15257 (lambda () (not
15258 (time-less-p
15259 (org-time-string-to-time (match-string 2))
15260 (org-time-string-to-time date))))))
15261 (message "%d entries after %s"
15262 (org-occur regexp nil callback) date)))
15264 (defun org-evaluate-time-range (&optional to-buffer)
15265 "Evaluate a time range by computing the difference between start and end.
15266 Normally the result is just printed in the echo area, but with prefix arg
15267 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15268 If the time range is actually in a table, the result is inserted into the
15269 next column.
15270 For time difference computation, a year is assumed to be exactly 365
15271 days in order to avoid rounding problems."
15272 (interactive "P")
15273 (or
15274 (org-clock-update-time-maybe)
15275 (save-excursion
15276 (unless (org-at-date-range-p t)
15277 (goto-char (point-at-bol))
15278 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15279 (if (not (org-at-date-range-p t))
15280 (error "Not at a time-stamp range, and none found in current line")))
15281 (let* ((ts1 (match-string 1))
15282 (ts2 (match-string 2))
15283 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15284 (match-end (match-end 0))
15285 (time1 (org-time-string-to-time ts1))
15286 (time2 (org-time-string-to-time ts2))
15287 (t1 (org-float-time time1))
15288 (t2 (org-float-time time2))
15289 (diff (abs (- t2 t1)))
15290 (negative (< (- t2 t1) 0))
15291 ;; (ys (floor (* 365 24 60 60)))
15292 (ds (* 24 60 60))
15293 (hs (* 60 60))
15294 (fy "%dy %dd %02d:%02d")
15295 (fy1 "%dy %dd")
15296 (fd "%dd %02d:%02d")
15297 (fd1 "%dd")
15298 (fh "%02d:%02d")
15299 y d h m align)
15300 (if havetime
15301 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15302 y 0
15303 d (floor (/ diff ds)) diff (mod diff ds)
15304 h (floor (/ diff hs)) diff (mod diff hs)
15305 m (floor (/ diff 60)))
15306 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15307 y 0
15308 d (floor (+ (/ diff ds) 0.5))
15309 h 0 m 0))
15310 (if (not to-buffer)
15311 (message "%s" (org-make-tdiff-string y d h m))
15312 (if (org-at-table-p)
15313 (progn
15314 (goto-char match-end)
15315 (setq align t)
15316 (and (looking-at " *|") (goto-char (match-end 0))))
15317 (goto-char match-end))
15318 (if (looking-at
15320 (replace-match ""))
15321 (if negative (insert " -"))
15322 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15323 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15324 (insert " " (format fh h m))))
15325 (if align (org-table-align))
15326 (message "Time difference inserted")))))
15328 (defun org-make-tdiff-string (y d h m)
15329 (let ((fmt "")
15330 (l nil))
15331 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15332 l (push y l)))
15333 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15334 l (push d l)))
15335 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15336 l (push h l)))
15337 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15338 l (push m l)))
15339 (apply 'format fmt (nreverse l))))
15341 (defun org-time-string-to-time (s)
15342 (apply 'encode-time (org-parse-time-string s)))
15343 (defun org-time-string-to-seconds (s)
15344 (org-float-time (org-time-string-to-time s)))
15346 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15347 "Convert a time stamp to an absolute day number.
15348 If there is a specifier for a cyclic time stamp, get the closest date to
15349 DAYNR.
15350 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15351 The variable date is bound by the calendar when this is called."
15352 (cond
15354 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15355 daynr
15356 (+ daynr 1000)))
15358 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15359 (time-to-days (current-time))) (match-string 0 s)
15360 prefer show-all))
15361 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15363 (defun org-days-to-iso-week (days)
15364 "Return the iso week number."
15365 (require 'cal-iso)
15366 (car (calendar-iso-from-absolute days)))
15368 (defun org-small-year-to-year (year)
15369 "Convert 2-digit years into 4-digit years.
15370 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15371 The year 2000 cannot be abbreviated. Any year larger than 99
15372 is returned unchanged."
15373 (if (< year 38)
15374 (setq year (+ 2000 year))
15375 (if (< year 100)
15376 (setq year (+ 1900 year))))
15377 year)
15379 (defun org-time-from-absolute (d)
15380 "Return the time corresponding to date D.
15381 D may be an absolute day number, or a calendar-type list (month day year)."
15382 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15383 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15385 (defun org-calendar-holiday ()
15386 "List of holidays, for Diary display in Org-mode."
15387 (require 'holidays)
15388 (let ((hl (funcall
15389 (if (fboundp 'calendar-check-holidays)
15390 'calendar-check-holidays 'check-calendar-holidays) date)))
15391 (if hl (mapconcat 'identity hl "; "))))
15393 (defun org-diary-sexp-entry (sexp entry date)
15394 "Process a SEXP diary ENTRY for DATE."
15395 (require 'diary-lib)
15396 (let ((result (if calendar-debug-sexp
15397 (let ((stack-trace-on-error t))
15398 (eval (car (read-from-string sexp))))
15399 (condition-case nil
15400 (eval (car (read-from-string sexp)))
15401 (error
15402 (beep)
15403 (message "Bad sexp at line %d in %s: %s"
15404 (org-current-line)
15405 (buffer-file-name) sexp)
15406 (sleep-for 2))))))
15407 (cond ((stringp result) (split-string result "; "))
15408 ((and (consp result)
15409 (not (consp (cdr result)))
15410 (stringp (cdr result))) (cdr result))
15411 ((and (consp result)
15412 (stringp (car result))) result)
15413 (result entry)
15414 (t nil))))
15416 (defun org-diary-to-ical-string (frombuf)
15417 "Get iCalendar entries from diary entries in buffer FROMBUF.
15418 This uses the icalendar.el library."
15419 (let* ((tmpdir (if (featurep 'xemacs)
15420 (temp-directory)
15421 temporary-file-directory))
15422 (tmpfile (make-temp-name
15423 (expand-file-name "orgics" tmpdir)))
15424 buf rtn b e)
15425 (with-current-buffer frombuf
15426 (icalendar-export-region (point-min) (point-max) tmpfile)
15427 (setq buf (find-buffer-visiting tmpfile))
15428 (set-buffer buf)
15429 (goto-char (point-min))
15430 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15431 (setq b (match-beginning 0)))
15432 (goto-char (point-max))
15433 (if (re-search-backward "^END:VEVENT" nil t)
15434 (setq e (match-end 0)))
15436 (kill-buffer buf)
15437 (delete-file tmpfile)
15438 rtn))
15440 (defun org-closest-date (start current change prefer show-all)
15441 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15442 When PREFER is `past', return a date that is either CURRENT or past.
15443 When PREFER is `future', return a date that is either CURRENT or future.
15444 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15445 ;; Make the proper lists from the dates
15446 (catch 'exit
15447 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15448 dn dw sday cday n1 n2 n0
15449 d m y y1 y2 date1 date2 nmonths nm ny m2)
15451 (setq start (org-date-to-gregorian start)
15452 current (org-date-to-gregorian
15453 (if show-all
15454 current
15455 (time-to-days (current-time))))
15456 sday (calendar-absolute-from-gregorian start)
15457 cday (calendar-absolute-from-gregorian current))
15459 (if (<= cday sday) (throw 'exit sday))
15462 (setq dn (string-to-number (match-string 1 change))
15463 dw (cdr (assoc (match-string 2 change) a1)))
15464 (error "Invalid change specifier: %s" change))
15465 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15466 (cond
15467 ((eq dw 'day)
15468 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15469 n2 (+ n1 dn)))
15470 ((eq dw 'year)
15471 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15472 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15473 (setq date1 (list m d y1)
15474 n1 (calendar-absolute-from-gregorian date1)
15475 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15476 n2 (calendar-absolute-from-gregorian date2)))
15477 ((eq dw 'month)
15478 ;; approx number of month between the two dates
15479 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15480 ;; How often does dn fit in there?
15481 (setq d (nth 1 start) m (car start) y (nth 2 start)
15482 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15483 m (+ m nm)
15484 ny (floor (/ m 12))
15485 y (+ y ny)
15486 m (- m (* ny 12)))
15487 (while (> m 12) (setq m (- m 12) y (1+ y)))
15488 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15489 (setq m2 (+ m dn) y2 y)
15490 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15491 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15492 (while (<= n2 cday)
15493 (setq n1 n2 m m2 y y2)
15494 (setq m2 (+ m dn) y2 y)
15495 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15496 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15497 ;; Make sure n1 is the earlier date
15498 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15499 (if show-all
15500 (cond
15501 ((eq prefer 'past) (if (= cday n2) n2 n1))
15502 ((eq prefer 'future) (if (= cday n1) n1 n2))
15503 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15504 (cond
15505 ((eq prefer 'past) (if (= cday n2) n2 n1))
15506 ((eq prefer 'future) (if (= cday n1) n1 n2))
15507 (t (if (= cday n1) n1 n2)))))))
15509 (defun org-date-to-gregorian (date)
15510 "Turn any specification of DATE into a Gregorian date for the calendar."
15511 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15512 ((and (listp date) (= (length date) 3)) date)
15513 ((stringp date)
15514 (setq date (org-parse-time-string date))
15515 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15516 ((listp date)
15517 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15519 (defun org-parse-time-string (s &optional nodefault)
15520 "Parse the standard Org-mode time string.
15521 This should be a lot faster than the normal `parse-time-string'.
15522 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15523 hour and minute fields will be nil if not given."
15524 (if (string-match org-ts-regexp0 s)
15525 (list 0
15526 (if (or (match-beginning 8) (not nodefault))
15527 (string-to-number (or (match-string 8 s) "0")))
15528 (if (or (match-beginning 7) (not nodefault))
15529 (string-to-number (or (match-string 7 s) "0")))
15530 (string-to-number (match-string 4 s))
15531 (string-to-number (match-string 3 s))
15532 (string-to-number (match-string 2 s))
15533 nil nil nil)
15534 (error "Not a standard Org-mode time string: %s" s)))
15536 (defun org-timestamp-up (&optional arg)
15537 "Increase the date item at the cursor by one.
15538 If the cursor is on the year, change the year. If it is on the month,
15539 the day or the time, change that.
15540 With prefix ARG, change by that many units."
15541 (interactive "p")
15542 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15544 (defun org-timestamp-down (&optional arg)
15545 "Decrease the date item at the cursor by one.
15546 If the cursor is on the year, change the year. If it is on the month,
15547 the day or the time, change that.
15548 With prefix ARG, change by that many units."
15549 (interactive "p")
15550 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15552 (defun org-timestamp-up-day (&optional arg)
15553 "Increase the date in the time stamp by one day.
15554 With prefix ARG, change that many days."
15555 (interactive "p")
15556 (if (and (not (org-at-timestamp-p t))
15557 (org-on-heading-p))
15558 (org-todo 'up)
15559 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15561 (defun org-timestamp-down-day (&optional arg)
15562 "Decrease the date in the time stamp by one day.
15563 With prefix ARG, change that many days."
15564 (interactive "p")
15565 (if (and (not (org-at-timestamp-p t))
15566 (org-on-heading-p))
15567 (org-todo 'down)
15568 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15570 (defun org-at-timestamp-p (&optional inactive-ok)
15571 "Determine if the cursor is in or at a timestamp."
15572 (interactive)
15573 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15574 (pos (point))
15575 (ans (or (looking-at tsr)
15576 (save-excursion
15578 (if (> (point) (point-min)) (backward-char 1))
15579 (and (looking-at tsr)
15580 (> (- (match-end 0) pos) -1))))))
15581 (and ans
15582 (boundp 'org-ts-what)
15583 (setq org-ts-what
15584 (cond
15585 ((= pos (match-beginning 0)) 'bracket)
15586 ((= pos (1- (match-end 0))) 'bracket)
15587 ((org-pos-in-match-range pos 2) 'year)
15588 ((org-pos-in-match-range pos 3) 'month)
15589 ((org-pos-in-match-range pos 7) 'hour)
15590 ((org-pos-in-match-range pos 8) 'minute)
15591 ((or (org-pos-in-match-range pos 4)
15592 (org-pos-in-match-range pos 5)) 'day)
15593 ((and (> pos (or (match-end 8) (match-end 5)))
15594 (< pos (match-end 0)))
15595 (- pos (or (match-end 8) (match-end 5))))
15596 (t 'day))))
15597 ans))
15599 (defun org-toggle-timestamp-type ()
15600 "Toggle the type (<active> or [inactive]) of a time stamp."
15601 (interactive)
15602 (when (org-at-timestamp-p t)
15603 (let ((beg (match-beginning 0)) (end (match-end 0))
15604 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15605 (save-excursion
15606 (goto-char beg)
15607 (while (re-search-forward "[][<>]" end t)
15608 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15609 t t)))
15610 (message "Timestamp is now %sactive"
15611 (if (equal (char-after beg) ?<) "" "in")))))
15613 (defun org-timestamp-change (n &optional what updown)
15614 "Change the date in the time stamp at point.
15615 The date will be changed by N times WHAT. WHAT can be `day', `month',
15616 `year', `minute', `second'. If WHAT is not given, the cursor position
15617 in the timestamp determines what will be changed."
15618 (let ((origin (point)) origin-cat
15619 with-hm inactive
15620 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15621 org-ts-what
15622 extra rem
15623 ts time time0)
15624 (if (not (org-at-timestamp-p t))
15625 (error "Not at a timestamp"))
15626 (if (and (not what) (eq org-ts-what 'bracket))
15627 (org-toggle-timestamp-type)
15628 ;; Point isn't on brackets. Remember the part of the time-stamp
15629 ;; the point was in. Indeed, size of time-stamps may change,
15630 ;; but point must be kept in the same category nonetheless.
15631 (setq origin-cat org-ts-what)
15632 (if (and (not what) (not (eq org-ts-what 'day))
15633 org-display-custom-times
15634 (get-text-property (point) 'display)
15635 (not (get-text-property (1- (point)) 'display)))
15636 (setq org-ts-what 'day))
15637 (setq org-ts-what (or what org-ts-what)
15638 inactive (= (char-after (match-beginning 0)) ?\[)
15639 ts (match-string 0))
15640 (replace-match "")
15641 (if (string-match
15643 ts)
15644 (setq extra (match-string 1 ts)))
15646 (setq with-hm t))
15647 (setq time0 (org-parse-time-string ts))
15648 (when (and updown
15649 (eq org-ts-what 'minute)
15650 (not current-prefix-arg))
15651 ;; This looks like s-up and s-down. Change by one rounding step.
15652 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15653 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15654 (setcar (cdr time0) (+ (nth 1 time0)
15655 (if (> n 0) (- rem) (- dm rem))))))
15656 (setq time
15657 (encode-time (or (car time0) 0)
15658 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15659 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15660 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15661 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15662 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15663 (nthcdr 6 time0)))
15664 (when (and (member org-ts-what '(hour minute))
15665 extra
15667 (setq extra (org-modify-ts-extra
15668 extra
15669 (if (eq org-ts-what 'hour) 2 5)
15670 n dm)))
15671 (when (integerp org-ts-what)
15672 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15673 (if (eq what 'calendar)
15674 (let ((cal-date (org-get-date-from-calendar)))
15675 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15676 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15677 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15678 (setcar time0 (or (car time0) 0))
15679 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15680 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15681 (setq time (apply 'encode-time time0))))
15682 ;; Insert the new time-stamp, and ensure point stays in the same
15683 ;; category as before (i.e. not after the last position in that
15684 ;; category).
15685 (let ((pos (point)))
15686 ;; Stay before inserted string. `save-excursion' is of no use.
15687 (setq org-last-changed-timestamp
15688 (org-insert-time-stamp time with-hm inactive nil nil extra))
15689 (goto-char pos))
15690 (save-match-data
15691 (looking-at org-ts-regexp3)
15692 (goto-char (cond
15693 ;; `day' category ends before `hour' if any, or at
15694 ;; the end of the day name.
15695 ((eq origin-cat 'day)
15696 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15697 ((eq origin-cat 'hour) (min (match-end 7) origin))
15698 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15699 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15700 ;; `year' and `month' have both fixed size: point
15701 ;; couldn't have moved into another part.
15702 (t origin))))
15703 ;; Update clock if on a CLOCK line.
15704 (org-clock-update-time-maybe)
15705 ;; Try to recenter the calendar window, if any.
15706 (if (and org-calendar-follow-timestamp-change
15707 (get-buffer-window "*Calendar*" t)
15708 (memq org-ts-what '(day month year)))
15709 (org-recenter-calendar (time-to-days time))))))
15711 (defun org-modify-ts-extra (s pos n dm)
15712 "Change the different parts of the lead-time and repeat fields in timestamp."
15713 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15714 ng h m new rem)
15715 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15716 (cond
15717 ((or (org-pos-in-match-range pos 2)
15718 (org-pos-in-match-range pos 3))
15719 (setq m (string-to-number (match-string 3 s))
15720 h (string-to-number (match-string 2 s)))
15721 (if (org-pos-in-match-range pos 2)
15722 (setq h (+ h n))
15723 (setq n (* dm (org-no-warnings (signum n))))
15724 (when (not (= 0 (setq rem (% m dm))))
15725 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15726 (setq m (+ m n)))
15727 (if (< m 0) (setq m (+ m 60) h (1- h)))
15728 (if (> m 59) (setq m (- m 60) h (1+ h)))
15729 (setq h (min 24 (max 0 h)))
15730 (setq ng 1 new (format "-%02d:%02d" h m)))
15731 ((org-pos-in-match-range pos 6)
15732 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15733 ((org-pos-in-match-range pos 5)
15734 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15736 ((org-pos-in-match-range pos 9)
15737 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15738 ((org-pos-in-match-range pos 8)
15739 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15741 (when ng
15742 (setq s (concat
15743 (substring s 0 (match-beginning ng))
15744 new
15745 (substring s (match-end ng))))))
15746 s))
15748 (defun org-recenter-calendar (date)
15749 "If the calendar is visible, recenter it to DATE."
15750 (let* ((win (selected-window))
15751 (cwin (get-buffer-window "*Calendar*" t))
15752 (calendar-move-hook nil))
15753 (when cwin
15754 (select-window cwin)
15755 (calendar-goto-date (if (listp date) date
15756 (calendar-gregorian-from-absolute date)))
15757 (select-window win))))
15759 (defun org-goto-calendar (&optional arg)
15760 "Go to the Emacs calendar at the current date.
15761 If there is a time stamp in the current line, go to that date.
15762 A prefix ARG can be used to force the current date."
15763 (interactive "P")
15764 (let ((tsr org-ts-regexp) diff
15765 (calendar-move-hook nil)
15766 (calendar-view-holidays-initially-flag nil)
15767 (calendar-view-diary-initially-flag nil))
15768 (if (or (org-at-timestamp-p)
15769 (save-excursion
15770 (beginning-of-line 1)
15771 (looking-at (concat ".*" tsr))))
15772 (let ((d1 (time-to-days (current-time)))
15773 (d2 (time-to-days
15774 (org-time-string-to-time (match-string 1)))))
15775 (setq diff (- d2 d1))))
15776 (calendar)
15777 (calendar-goto-today)
15778 (if (and diff (not arg)) (calendar-forward-day diff))))
15780 (defun org-get-date-from-calendar ()
15781 "Return a list (month day year) of date at point in calendar."
15782 (with-current-buffer "*Calendar*"
15783 (save-match-data
15784 (calendar-cursor-to-date))))
15786 (defun org-date-from-calendar ()
15787 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15788 If there is already a time stamp at the cursor position, update it."
15789 (interactive)
15790 (if (org-at-timestamp-p t)
15791 (org-timestamp-change 0 'calendar)
15792 (let ((cal-date (org-get-date-from-calendar)))
15793 (org-insert-time-stamp
15794 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15796 (defun org-minutes-to-hh:mm-string (m)
15797 "Compute H:MM from a number of minutes."
15798 (let ((h (/ m 60)))
15799 (setq m (- m (* 60 h)))
15800 (format org-time-clocksum-format h m)))
15802 (defun org-hh:mm-string-to-minutes (s)
15803 "Convert a string H:MM to a number of minutes.
15804 If the string is just a number, interpret it as minutes.
15805 In fact, the first hh:mm or number in the string will be taken,
15806 there can be extra stuff in the string.
15807 If no number is found, the return value is 0."
15808 (cond
15809 ((integerp s) s)
15811 (+ (* (string-to-number (match-string 1 s)) 60)
15812 (string-to-number (match-string 2 s))))
15814 (string-to-number (match-string 1 s)))
15815 (t 0)))
15817 (defcustom org-effort-durations
15818 `(("h" . 60)
15819 ("d" . ,(* 60 8))
15820 ("w" . ,(* 60 8 5))
15821 ("m" . ,(* 60 8 5 4))
15822 ("y" . ,(* 60 8 5 40)))
15823 "Conversion factor to minutes for an effort modifier.
15825 Each entry has the form (MODIFIER . MINUTES).
15827 In an effort string, a number followed by MODIFIER is multiplied
15828 by the specified number of MINUTES to obtain an effort in
15829 minutes.
15833 :group 'org-agenda
15834 :type '(alist :key-type (string :tag "Modifier")
15835 :value-type (number :tag "Minutes")))
15837 (defun org-duration-string-to-minutes (s)
15838 "Convert a duration string S to minutes.
15840 A bare number is interpreted as minutes, modifiers can be set by
15841 customizing `org-effort-durations' (which see).
15843 Entries containing a colon are interpreted as H:MM by
15844 `org-hh:mm-string-to-minutes'."
15845 (let ((result 0)
15847 (regexp-opt (mapcar 'car org-effort-durations))
15849 (while (string-match re s)
15850 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15851 (string-to-number (match-string 1 s))))
15852 (setq s (replace-match "" nil t s)))
15853 (incf result (org-hh:mm-string-to-minutes s))
15854 result))
15856 ;;;; Files
15858 (defun org-save-all-org-buffers ()
15859 "Save all Org-mode buffers without user confirmation."
15860 (interactive)
15861 (message "Saving all Org-mode buffers...")
15862 (save-some-buffers t 'org-mode-p)
15863 (when (featurep 'org-id) (org-id-locations-save))
15864 (message "Saving all Org-mode buffers... done"))
15866 (defun org-revert-all-org-buffers ()
15867 "Revert all Org-mode buffers.
15868 Prompt for confirmation when there are unsaved changes.
15869 Be sure you know what you are doing before letting this function
15870 overwrite your changes.
15872 This function is useful in a setup where one tracks org files
15873 with a version control system, to revert on one machine after pulling
15874 changes from another. I believe the procedure must be like this:
15876 1. M-x org-save-all-org-buffers
15877 2. Pull changes from the other machine, resolve conflicts
15878 3. M-x org-revert-all-org-buffers"
15879 (interactive)
15880 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15881 (error "Abort"))
15882 (save-excursion
15883 (save-window-excursion
15884 (mapc
15885 (lambda (b)
15886 (when (and (with-current-buffer b (org-mode-p))
15887 (with-current-buffer b buffer-file-name))
15888 (org-pop-to-buffer-same-window b)
15889 (revert-buffer t 'no-confirm)))
15890 (buffer-list))
15891 (when (and (featurep 'org-id) org-id-track-globally)
15892 (org-id-locations-load)))))
15894 ;;;; Agenda files
15896 ;;;###autoload
15897 (defun org-switchb (&optional arg)
15898 "Switch between Org buffers.
15899 With a prefix argument, restrict available to files.
15900 With two prefix arguments, restrict available buffers to agenda files.
15902 Defaults to `iswitchb' for buffer name completion.
15903 Set `org-completion-use-ido' to make it use ido instead."
15904 (interactive "P")
15905 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15906 ((equal arg '(16)) (org-buffer-list 'agenda))
15907 (t (org-buffer-list))))
15908 (org-completion-use-iswitchb org-completion-use-iswitchb)
15909 (org-completion-use-ido org-completion-use-ido))
15910 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15911 (setq org-completion-use-iswitchb t))
15912 (org-pop-to-buffer-same-window
15913 (org-icompleting-read "Org buffer: "
15914 (mapcar 'list (mapcar 'buffer-name blist))
15915 nil t))))
15917 ;;; Define some older names previously used for this functionality
15918 ;;;###autoload
15919 (defalias 'org-ido-switchb 'org-switchb)
15920 ;;;###autoload
15921 (defalias 'org-iswitchb 'org-switchb)
15923 (defun org-buffer-list (&optional predicate exclude-tmp)
15924 "Return a list of Org buffers.
15925 PREDICATE can be `export', `files' or `agenda'.
15927 export restrict the list to Export buffers.
15928 files restrict the list to buffers visiting Org files.
15929 agenda restrict the list to buffers visiting agenda files.
15931 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15932 (let* ((bfn nil)
15933 (agenda-files (and (eq predicate 'agenda)
15934 (mapcar 'file-truename (org-agenda-files t))))
15935 (filter
15936 (cond
15937 ((eq predicate 'files)
15938 (lambda (b) (with-current-buffer b (org-mode-p))))
15939 ((eq predicate 'export)
15940 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15941 ((eq predicate 'agenda)
15942 (lambda (b)
15943 (with-current-buffer b
15944 (and (org-mode-p)
15945 (setq bfn (buffer-file-name b))
15946 (member (file-truename bfn) agenda-files)))))
15947 (t (lambda (b) (with-current-buffer b
15948 (or (org-mode-p)
15949 (string-match "\*Org .*Export"
15950 (buffer-name b)))))))))
15951 (delq nil
15952 (mapcar
15953 (lambda(b)
15954 (if (and (funcall filter b)
15955 (or (not exclude-tmp)
15956 (not (string-match "tmp" (buffer-name b)))))
15957 b
15958 nil))
15959 (buffer-list)))))
15961 (defun org-agenda-files (&optional unrestricted archives)
15962 "Get the list of agenda files.
15963 Optional UNRESTRICTED means return the full list even if a restriction
15964 is currently in place.
15965 When ARCHIVES is t, include all archive files that are really being
15966 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15967 `org-agenda-archives-mode' is t."
15968 (let ((files
15969 (cond
15970 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15971 ((stringp org-agenda-files) (org-read-agenda-file-list))
15972 ((listp org-agenda-files) org-agenda-files)
15973 (t (error "Invalid value of `org-agenda-files'")))))
15974 (setq files (apply 'append
15975 (mapcar (lambda (f)
15976 (if (file-directory-p f)
15977 (directory-files
15978 f t org-agenda-file-regexp)
15979 (list f)))
15980 files)))
15981 (when org-agenda-skip-unavailable-files
15982 (setq files (delq nil
15983 (mapcar (function
15984 (lambda (file)
15985 (and (file-readable-p file) file)))
15986 files))))
15987 (when (or (eq archives t)
15988 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15989 (setq files (org-add-archive-files files)))
15990 files))
15992 (defun org-agenda-file-p (&optional file)
15993 "Return non-nil, if FILE is an agenda file.
15994 If FILE is omitted, use the file associated with the current
15995 buffer."
15996 (member (or file (buffer-file-name))
15997 (org-agenda-files t)))
15999 (defun org-edit-agenda-file-list ()
16000 "Edit the list of agenda files.
16001 Depending on setup, this either uses customize to edit the variable
16002 `org-agenda-files', or it visits the file that is holding the list. In the
16003 latter case, the buffer is set up in a way that saving it automatically kills
16004 the buffer and restores the previous window configuration."
16005 (interactive)
16006 (if (stringp org-agenda-files)
16007 (let ((cw (current-window-configuration)))
16008 (find-file org-agenda-files)
16009 (org-set-local 'org-window-configuration cw)
16010 (org-add-hook 'after-save-hook
16011 (lambda ()
16012 (set-window-configuration
16013 (prog1 org-window-configuration
16014 (kill-buffer (current-buffer))))
16015 (org-install-agenda-files-menu)
16016 (message "New agenda file list installed"))
16017 nil 'local)
16018 (message "%s" (substitute-command-keys
16020 (customize-variable 'org-agenda-files)))
16022 (defun org-store-new-agenda-file-list (list)
16023 "Set new value for the agenda file list and save it correctly."
16024 (if (stringp org-agenda-files)
16025 (let ((fe (org-read-agenda-file-list t)) b u)
16026 (while (setq b (find-buffer-visiting org-agenda-files))
16027 (kill-buffer b))
16028 (with-temp-file org-agenda-files
16029 (insert
16030 (mapconcat
16031 (lambda (f) ;; Keep un-expanded entries.
16032 (if (setq u (assoc f fe))
16033 (cdr u)
16034 f))
16037 (let ((org-mode-hook nil) (org-inhibit-startup t)
16038 (org-insert-mode-line-in-empty-file nil))
16039 (setq org-agenda-files list)
16040 (customize-save-variable 'org-agenda-files org-agenda-files))))
16042 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16043 "Read the list of agenda files from a file.
16044 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16045 filenames, used by `org-store-new-agenda-file-list' to write back
16046 un-expanded file names."
16047 (when (file-directory-p org-agenda-files)
16048 (error "`org-agenda-files' cannot be a single directory"))
16049 (when (stringp org-agenda-files)
16050 (with-temp-buffer
16051 (insert-file-contents org-agenda-files)
16052 (mapcar
16053 (lambda (f)
16054 (let ((e (expand-file-name (substitute-in-file-name f)
16055 org-directory)))
16056 (if pair-with-expansion
16057 (cons e f)
16058 e)))
16061 ;;;###autoload
16062 (defun org-cycle-agenda-files ()
16063 "Cycle through the files in `org-agenda-files'.
16064 If the current buffer visits an agenda file, find the next one in the list.
16065 If the current buffer does not, find the first agenda file."
16066 (interactive)
16067 (let* ((fs (org-agenda-files t))
16068 (files (append fs (list (car fs))))
16069 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16070 file)
16071 (unless files (error "No agenda files"))
16072 (catch 'exit
16073 (while (setq file (pop files))
16074 (if (equal (file-truename file) tcf)
16075 (when (car files)
16076 (find-file (car files))
16077 (throw 'exit t))))
16078 (find-file (car fs)))
16079 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16081 (defun org-agenda-file-to-front (&optional to-end)
16082 "Move/add the current file to the top of the agenda file list.
16083 If the file is not present in the list, it is added to the front. If it is
16084 present, it is moved there. With optional argument TO-END, add/move to the
16085 end of the list."
16086 (interactive "P")
16087 (let ((org-agenda-skip-unavailable-files nil)
16088 (file-alist (mapcar (lambda (x)
16089 (cons (file-truename x) x))
16090 (org-agenda-files t)))
16091 (ctf (file-truename buffer-file-name))
16092 x had)
16093 (setq x (assoc ctf file-alist) had x)
16095 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16096 (if to-end
16097 (setq file-alist (append (delq x file-alist) (list x)))
16098 (setq file-alist (cons x (delq x file-alist))))
16099 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16100 (org-install-agenda-files-menu)
16101 (message "File %s to %s of agenda file list"
16102 (if had "moved" "added") (if to-end "end" "front"))))
16104 (defun org-remove-file (&optional file)
16105 "Remove current file from the list of files in variable `org-agenda-files'.
16106 These are the files which are being checked for agenda entries.
16107 Optional argument FILE means use this file instead of the current."
16108 (interactive)
16109 (let* ((org-agenda-skip-unavailable-files nil)
16110 (file (or file buffer-file-name))
16111 (true-file (file-truename file))
16112 (afile (abbreviate-file-name file))
16113 (files (delq nil (mapcar
16114 (lambda (x)
16115 (if (equal true-file
16116 (file-truename x))
16117 nil x))
16118 (org-agenda-files t)))))
16119 (if (not (= (length files) (length (org-agenda-files t))))
16120 (progn
16121 (org-store-new-agenda-file-list files)
16122 (org-install-agenda-files-menu)
16123 (message "Removed file: %s" afile))
16124 (message "File was not in list: %s (not removed)" afile))))
16126 (defun org-file-menu-entry (file)
16127 (vector file (list 'find-file file) t))
16129 (defun org-check-agenda-file (file)
16130 "Make sure FILE exists. If not, ask user what to do."
16131 (when (not (file-exists-p file))
16132 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16133 (abbreviate-file-name file))
16134 (let ((r (downcase (read-char-exclusive))))
16135 (cond
16136 ((equal r ?r)
16137 (org-remove-file file)
16138 (throw 'nextfile t))
16139 (t (error "Abort"))))))
16141 (defun org-get-agenda-file-buffer (file)
16142 "Get a buffer visiting FILE. If the buffer needs to be created, add
16143 it to the list of buffers which might be released later."
16144 (let ((buf (org-find-base-buffer-visiting file)))
16145 (if buf
16146 buf ; just return it
16147 ;; Make a new buffer and remember it
16148 (setq buf (find-file-noselect file))
16149 (if buf (push buf org-agenda-new-buffers))
16150 buf)))
16152 (defun org-release-buffers (blist)
16153 "Release all buffers in list, asking the user for confirmation when needed.
16154 When a buffer is unmodified, it is just killed. When modified, it is saved
16155 \(if the user agrees) and then killed."
16156 (let (buf file)
16157 (while (setq buf (pop blist))
16158 (setq file (buffer-file-name buf))
16159 (when (and (buffer-modified-p buf)
16160 file
16161 (y-or-n-p (format "Save file %s? " file)))
16162 (with-current-buffer buf (save-buffer)))
16163 (kill-buffer buf))))
16165 (defun org-prepare-agenda-buffers (files)
16166 "Create buffers for all agenda files, protect archived trees and comments."
16167 (interactive)
16168 (let ((pa '(:org-archived t))
16169 (pc '(:org-comment t))
16170 (pall '(:org-archived t :org-comment t))
16171 (inhibit-read-only t)
16172 (rea (concat ":" org-archive-tag ":"))
16173 bmp file re)
16174 (save-excursion
16175 (save-restriction
16176 (while (setq file (pop files))
16177 (catch 'nextfile
16178 (if (bufferp file)
16179 (set-buffer file)
16180 (org-check-agenda-file file)
16181 (set-buffer (org-get-agenda-file-buffer file)))
16182 (widen)
16183 (setq bmp (buffer-modified-p))
16184 (org-refresh-category-properties)
16185 (setq org-todo-keywords-for-agenda
16186 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16187 (setq org-done-keywords-for-agenda
16188 (append org-done-keywords-for-agenda org-done-keywords))
16189 (setq org-todo-keyword-alist-for-agenda
16190 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16191 (setq org-drawers-for-agenda
16192 (append org-drawers-for-agenda org-drawers))
16193 (setq org-tag-alist-for-agenda
16194 (append org-tag-alist-for-agenda org-tag-alist))
16196 (save-excursion
16197 (remove-text-properties (point-min) (point-max) pall)
16198 (when org-agenda-skip-archived-trees
16199 (goto-char (point-min))
16200 (while (re-search-forward rea nil t)
16201 (if (org-on-heading-p t)
16202 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16203 (goto-char (point-min))
16205 (while (re-search-forward re nil t)
16206 (add-text-properties
16207 (match-beginning 0) (org-end-of-subtree t) pc)))
16208 (set-buffer-modified-p bmp)))))
16209 (setq org-todo-keywords-for-agenda
16210 (org-uniquify org-todo-keywords-for-agenda))
16211 (setq org-todo-keyword-alist-for-agenda
16212 (org-uniquify org-todo-keyword-alist-for-agenda)
16213 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16215 ;;;; Embedded LaTeX
16217 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16218 "Keymap for the minor `org-cdlatex-mode'.")
16220 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16221 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16222 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16223 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16224 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16226 (defvar org-cdlatex-texmathp-advice-is-done nil
16227 "Flag remembering if we have applied the advice to texmathp already.")
16229 (define-minor-mode org-cdlatex-mode
16230 "Toggle the minor `org-cdlatex-mode'.
16231 This mode supports entering LaTeX environment and math in LaTeX fragments
16232 in Org-mode.
16234 nil " OCDL" nil
16235 (when org-cdlatex-mode (require 'cdlatex))
16236 (unless org-cdlatex-texmathp-advice-is-done
16237 (setq org-cdlatex-texmathp-advice-is-done t)
16238 (defadvice texmathp (around org-math-always-on activate)
16239 "Always return t in org-mode buffers.
16240 This is because we want to insert math symbols without dollars even outside
16241 the LaTeX math segments. If Orgmode thinks that point is actually inside
16242 an embedded LaTeX fragment, let texmathp do its job.
16244 (interactive)
16245 (let (p)
16246 (cond
16247 ((not (org-mode-p)) ad-do-it)
16248 ((eq this-command 'cdlatex-math-symbol)
16249 (setq ad-return-value t
16250 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16251 (t
16252 (let ((p (org-inside-LaTeX-fragment-p)))
16253 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16254 (setq ad-return-value t
16255 texmathp-why '("Org-mode embedded math" . 0))
16256 (if p ad-do-it)))))))))
16258 (defun turn-on-org-cdlatex ()
16259 "Unconditionally turn on `org-cdlatex-mode'."
16260 (org-cdlatex-mode 1))
16262 (defun org-inside-LaTeX-fragment-p ()
16263 "Test if point is inside a LaTeX fragment.
16265 sequence appearing also before point.
16266 Even though the matchers for math are configurable, this function assumes
16268 delimiters are skipped when they have been removed by customization.
16269 The return value is nil, or a cons cell with the delimiter and the
16270 position of this delimiter.
16272 This function does a reasonably good job, but can locally be fooled by
16273 for example currency specifications. For example it will assume being in
16275 fragments that are properly closed, but during editing, we have to live
16276 with the uncertainty caused by missing closing delimiters. This function
16277 looks only before point, not after."
16278 (catch 'exit
16279 (let ((pos (point))
16280 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16281 (lim (progn
16283 (point)))
16284 dd-on str (start 0) m re)
16285 (goto-char pos)
16286 (when dodollar
16288 re (nth 1 (assoc "$" org-latex-regexps)))
16289 (while (string-match re str start)
16290 (cond
16291 ((= (match-end 0) (length str))
16292 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16293 ((= (match-end 0) (- (length str) 5))
16294 (throw 'exit nil))
16295 (t (setq start (match-end 0))))))
16296 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16297 (goto-char pos)
16298 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16299 (and (match-beginning 2) (throw 'exit nil))
16300 ;; count $$
16302 (setq dd-on (not dd-on)))
16303 (goto-char pos)
16304 (if dd-on (cons "$$" m))))))
16306 (defun org-inside-latex-macro-p ()
16307 "Is point inside a LaTeX macro or its arguments?"
16308 (save-match-data
16309 (org-in-regexp
16312 (defun org-try-cdlatex-tab ()
16313 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16314 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16315 - inside a LaTeX fragment, or
16316 - after the first word in a line, where an abbreviation expansion could
16317 insert a LaTeX environment."
16318 (when org-cdlatex-mode
16319 (cond
16320 ((save-excursion
16321 (skip-chars-backward "a-zA-Z0-9*")
16323 (bolp))
16324 (cdlatex-tab) t)
16325 ((org-inside-LaTeX-fragment-p)
16326 (cdlatex-tab) t)
16327 (t nil))))
16329 (defun org-cdlatex-underscore-caret (&optional arg)
16330 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16331 Revert to the normal definition outside of these fragments."
16332 (interactive "P")
16333 (if (org-inside-LaTeX-fragment-p)
16334 (call-interactively 'cdlatex-sub-superscript)
16335 (let (org-cdlatex-mode)
16336 (call-interactively (key-binding (vector last-input-event))))))
16338 (defun org-cdlatex-math-modify (&optional arg)
16339 "Execute `cdlatex-math-modify' in LaTeX fragments.
16340 Revert to the normal definition outside of these fragments."
16341 (interactive "P")
16342 (if (org-inside-LaTeX-fragment-p)
16343 (call-interactively 'cdlatex-math-modify)
16344 (let (org-cdlatex-mode)
16345 (call-interactively (key-binding (vector last-input-event))))))
16347 (defvar org-latex-fragment-image-overlays nil
16348 "List of overlays carrying the images of latex fragments.")
16349 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16351 (defun org-remove-latex-fragment-image-overlays ()
16352 "Remove all overlays with LaTeX fragment images in current buffer."
16353 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16354 (setq org-latex-fragment-image-overlays nil))
16356 (defun org-preview-latex-fragment (&optional subtree)
16357 "Preview the LaTeX fragment at point, or all locally or globally.
16358 If the cursor is in a LaTeX fragment, create the image and overlay
16359 it over the source code. If there is no fragment at point, display
16360 all fragments in the current text, from one headline to the next. With
16361 prefix SUBTREE, display all fragments in the current subtree. With a
16363 the cursor is before the first headline,
16364 display all fragments in the buffer.
16366 (interactive "P")
16367 (org-remove-latex-fragment-image-overlays)
16368 (save-excursion
16369 (save-restriction
16370 (let (beg end at msg)
16371 (cond
16372 ((or (equal subtree '(16))
16373 (not (save-excursion
16374 (re-search-backward org-outline-regexp-bol nil t))))
16375 (setq beg (point-min) end (point-max)
16376 msg "Creating images for buffer...%s"))
16377 ((equal subtree '(4))
16378 (org-back-to-heading)
16379 (setq beg (point) end (org-end-of-subtree t)
16380 msg "Creating images for subtree...%s"))
16381 (t
16382 (if (setq at (org-inside-LaTeX-fragment-p))
16383 (goto-char (max (point-min) (- (cdr at) 2)))
16384 (org-back-to-heading))
16385 (setq beg (point) end (progn (outline-next-heading) (point))
16386 msg (if at "Creating image...%s"
16387 "Creating images for entry...%s"))))
16388 (message msg "")
16389 (narrow-to-region beg end)
16390 (goto-char beg)
16391 (org-format-latex
16392 (concat "ltxpng/" (file-name-sans-extension
16393 (file-name-nondirectory
16394 buffer-file-name)))
16395 default-directory 'overlays msg at 'forbuffer 'dvipng)
16396 (message msg "done. Use `C-c C-c' to remove images.")))))
16398 (defvar org-latex-regexps
16400 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16403 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16407 "Regular expressions for matching embedded LaTeX.")
16409 (defvar org-export-have-math nil) ;; dynamic scoping
16410 (defun org-format-latex (prefix &optional dir overlays msg at
16411 forbuffer processing-type)
16412 "Replace LaTeX fragments with links to an image, and produce images.
16413 Some of the options can be changed using the variable
16414 `org-format-latex-options'."
16415 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16416 (let* ((prefixnodir (file-name-nondirectory prefix))
16417 (absprefix (expand-file-name prefix dir))
16418 (todir (file-name-directory absprefix))
16419 (opt org-format-latex-options)
16420 (matchers (plist-get opt :matchers))
16421 (re-list org-latex-regexps)
16422 (org-format-latex-header-extra
16423 (plist-get (org-infile-export-plist) :latex-header-extra))
16424 (cnt 0) txt hash link beg end re e checkdir
16425 executables-checked string
16426 m n block linkfile movefile ov)
16427 ;; Check the different regular expressions
16428 (while (setq e (pop re-list))
16429 (setq m (car e) re (nth 1 e) n (nth 2 e)
16431 (when (member m matchers)
16432 (goto-char (point-min))
16433 (while (re-search-forward re nil t)
16434 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16435 (not (get-text-property (match-beginning n)
16436 'org-protected))
16437 (or (not overlays)
16438 (not (eq (get-char-property (match-beginning n)
16439 'org-overlay-type)
16440 'org-latex-overlay))))
16441 (setq org-export-have-math t)
16442 (cond
16443 ((eq processing-type 'verbatim)
16444 ;; Leave the text verbatim, just protect it
16445 (add-text-properties (match-beginning n) (match-end n)
16446 '(org-protected t)))
16447 ((eq processing-type 'mathjax)
16448 ;; Prepare for MathJax processing
16449 (setq string (match-string n))
16450 (if (member m '("$" "$1"))
16451 (save-excursion
16452 (delete-region (match-beginning n) (match-end n))
16453 (goto-char (match-beginning n))
16456 '(org-protected t))))
16457 (add-text-properties (match-beginning n) (match-end n)
16458 '(org-protected t))))
16459 ((or (eq processing-type 'dvipng) t)
16460 ;; Process to an image
16461 (setq txt (match-string n)
16462 beg (match-beginning n) end (match-end n)
16463 cnt (1+ cnt))
16464 (let (print-length print-level) ; make sure full list is printed
16465 (setq hash (sha1 (prin1-to-string
16466 (list org-format-latex-header
16467 org-format-latex-header-extra
16468 org-export-latex-default-packages-alist
16469 org-export-latex-packages-alist
16470 org-format-latex-options
16471 forbuffer txt)))
16472 linkfile (format "%s_%s.png" prefix hash)
16473 movefile (format "%s_%s.png" absprefix hash)))
16474 (setq link (concat block "[[file:" linkfile "]]" block))
16475 (if msg (message msg cnt))
16476 (goto-char beg)
16477 (unless checkdir ; make sure the directory exists
16478 (setq checkdir t)
16479 (or (file-directory-p todir) (make-directory todir t)))
16481 (unless executables-checked
16482 (org-check-external-command
16483 "latex" "needed to convert LaTeX fragments to images")
16484 (org-check-external-command
16485 "dvipng" "needed to convert LaTeX fragments to images")
16486 (setq executables-checked t))
16488 (unless (file-exists-p movefile)
16489 (org-create-formula-image
16490 txt movefile opt forbuffer))
16491 (if overlays
16492 (progn
16493 (mapc (lambda (o)
16494 (if (eq (overlay-get o 'org-overlay-type)
16495 'org-latex-overlay)
16496 (delete-overlay o)))
16497 (overlays-in beg end))
16498 (setq ov (make-overlay beg end))
16499 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16500 (if (featurep 'xemacs)
16501 (progn
16502 (overlay-put ov 'invisible t)
16503 (overlay-put
16504 ov 'end-glyph
16505 (make-glyph (vector 'png :file movefile))))
16506 (overlay-put
16507 ov 'display
16508 (list 'image :type 'png :file movefile :ascent 'center)))
16509 (push ov org-latex-fragment-image-overlays)
16510 (goto-char end))
16511 (delete-region beg end)
16512 (insert (org-add-props link
16513 (list 'org-latex-src
16514 (replace-regexp-in-string
16517 ;; This function borrows from Ganesh Swami's latex2png.el
16518 (defun org-create-formula-image (string tofile options buffer)
16519 "This calls dvipng."
16520 (require 'org-latex)
16521 (let* ((tmpdir (if (featurep 'xemacs)
16522 (temp-directory)
16523 temporary-file-directory))
16524 (texfilebase (make-temp-name
16525 (expand-file-name "orgtex" tmpdir)))
16526 (texfile (concat texfilebase ".tex"))
16527 (dvifile (concat texfilebase ".dvi"))
16528 (pngfile (concat texfilebase ".png"))
16529 (fnh (if (featurep 'xemacs)
16530 (font-height (get-face-font 'default))
16531 (face-attribute 'default :height nil)))
16532 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16533 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16534 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16535 "Black"))
16536 (bg (or (plist-get options (if buffer :background :html-background))
16537 "Transparent")))
16538 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16539 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16540 (with-temp-file texfile
16541 (insert (org-splice-latex-header
16542 org-format-latex-header
16543 org-export-latex-default-packages-alist
16544 org-export-latex-packages-alist t
16545 org-format-latex-header-extra))
16547 (require 'org-latex)
16548 (org-export-latex-fix-inputenc))
16549 (let ((dir default-directory))
16550 (condition-case nil
16551 (progn
16552 (cd tmpdir)
16553 (call-process "latex" nil nil nil texfile))
16554 (error nil))
16555 (cd dir))
16556 (if (not (file-exists-p dvifile))
16557 (progn (message "Failed to create dvi file from %s" texfile) nil)
16558 (condition-case nil
16559 (call-process "dvipng" nil nil nil
16560 "-fg" fg "-bg" bg
16561 "-D" dpi
16562 ;;"-x" scale "-y" scale
16563 "-T" "tight"
16564 "-o" pngfile
16565 dvifile)
16566 (error nil))
16567 (if (not (file-exists-p pngfile))
16568 (if org-format-latex-signal-error
16569 (error "Failed to create png file from %s" texfile)
16570 (message "Failed to create png file from %s" texfile)
16571 nil)
16572 ;; Use the requested file name and clean up
16573 (copy-file pngfile tofile 'replace)
16574 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16575 (delete-file (concat texfilebase e)))
16576 pngfile))))
16578 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16579 "Fill a LaTeX header template TPL.
16580 In the template, the following place holders will be recognized:
16583 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16585 [NO-PACKAGES] do not include PKG
16586 [EXTRA] the string EXTRA
16587 [NO-EXTRA] do not include EXTRA
16589 For backward compatibility, if both the positive and the negative place
16591 assumed to be present at the end of the template.
16592 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16593 EXTRA is a string.
16594 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16595 (let (rpl (end ""))
16597 (setq rpl (if (or (match-end 1) (not def-pkg))
16598 "" (org-latex-packages-to-string def-pkg snippets-p t))
16599 tpl (replace-match rpl t t tpl))
16600 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16603 (setq rpl (if (or (match-end 1) (not pkg))
16604 "" (org-latex-packages-to-string pkg snippets-p t))
16605 tpl (replace-match rpl t t tpl))
16606 (if pkg (setq end
16608 (org-latex-packages-to-string pkg snippets-p)))))
16611 (setq rpl (if (or (match-end 1) (not extra))
16613 tpl (replace-match rpl t t tpl))
16619 tpl)))
16621 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16623 (setq pkg (mapconcat (lambda(p)
16624 (cond
16625 ((stringp p) p)
16626 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16627 (format "%% Package %s omitted" (cadr p)))
16628 ((equal "" (car p))
16630 (t
16632 (car p) (cadr p)))))
16633 pkg
16637 (defun org-dvipng-color (attr)
16638 "Return an rgb color specification for dvipng."
16639 (apply 'format "rgb %s %s %s"
16640 (mapcar 'org-normalize-color
16641 (color-values (face-attribute 'default attr nil)))))
16643 (defun org-normalize-color (value)
16644 "Return string to be used as color value for an RGB component."
16645 (format "%g" (/ value 65535.0)))
16647 ;; Image display
16650 (defvar org-inline-image-overlays nil)
16651 (make-variable-buffer-local 'org-inline-image-overlays)
16653 (defun org-toggle-inline-images (&optional include-linked)
16654 "Toggle the display of inline images.
16655 INCLUDE-LINKED is passed to `org-display-inline-images'."
16656 (interactive "P")
16657 (if org-inline-image-overlays
16658 (progn
16659 (org-remove-inline-images)
16660 (message "Inline image display turned off"))
16661 (org-display-inline-images include-linked)
16662 (if org-inline-image-overlays
16663 (message "%d images displayed inline"
16664 (length org-inline-image-overlays))
16665 (message "No images to display inline"))))
16667 (defun org-display-inline-images (&optional include-linked refresh beg end)
16668 "Display inline images.
16669 Normally only links without a description part are inlined, because this
16670 is how it will work for export. When INCLUDE-LINKED is set, also links
16671 with a description part will be inlined. This can be nice for a quick
16672 look at those images, but it does not reflect what exported files will look
16673 like.
16674 When REFRESH is set, refresh existing images between BEG and END.
16675 This will create new image displays only if necessary.
16676 BEG and END default to the buffer boundaries."
16677 (interactive "P")
16678 (unless refresh
16679 (org-remove-inline-images)
16680 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16681 (save-excursion
16682 (save-restriction
16683 (widen)
16684 (setq beg (or beg (point-min)) end (or end (point-max)))
16685 (goto-char (point-min))
16687 (substring (org-image-file-name-regexp) 0 -2)
16689 old file ov img)
16690 (while (re-search-forward re end t)
16691 (setq old (get-char-property-and-overlay (match-beginning 1)
16692 'org-image-overlay))
16693 (setq file (expand-file-name
16694 (concat (or (match-string 3) "") (match-string 4))))
16695 (when (file-exists-p file)
16696 (if (and (car-safe old) refresh)
16697 (image-refresh (overlay-get (cdr old) 'display))
16698 (setq img (save-match-data (create-image file)))
16699 (when img
16700 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16701 (overlay-put ov 'display img)
16702 (overlay-put ov 'face 'default)
16703 (overlay-put ov 'org-image-overlay t)
16704 (overlay-put ov 'modification-hooks
16705 (list 'org-display-inline-modification-hook))
16706 (push ov org-inline-image-overlays)))))))))
16708 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16709 "Remove inline-display overlay if a corresponding region is modified."
16710 (let ((inhibit-modification-hooks t))
16711 (when (and ov after)
16712 (delete ov org-inline-image-overlays)
16713 (delete-overlay ov))))
16715 (defun org-remove-inline-images ()
16716 "Remove inline display of images."
16717 (interactive)
16718 (mapc 'delete-overlay org-inline-image-overlays)
16719 (setq org-inline-image-overlays nil))
16721 ;;;; Key bindings
16723 ;; Make `C-c C-x' a prefix key
16724 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16726 ;; TAB key with modifiers
16727 (org-defkey org-mode-map "\C-i" 'org-cycle)
16728 (org-defkey org-mode-map [(tab)] 'org-cycle)
16729 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16730 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16732 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16733 ;; The following line is necessary under Suse GNU/Linux
16734 (unless (featurep 'xemacs)
16735 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16736 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16737 (define-key org-mode-map [backtab] 'org-shifttab)
16739 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16740 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16741 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16743 ;; Cursor keys with modifiers
16744 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16745 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16746 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16747 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16749 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16750 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16751 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16752 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16754 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16755 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16756 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16757 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16759 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16760 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16761 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16762 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16764 ;; Babel keys
16765 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16766 (mapc (lambda (pair)
16767 (define-key org-babel-map (car pair) (cdr pair)))
16768 org-babel-key-bindings)
16770 ;;; Extra keys for tty access.
16771 ;; We only set them when really needed because otherwise the
16772 ;; menus don't show the simple keys
16774 (when (or org-use-extra-keys
16775 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16776 (not window-system))
16777 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16778 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16779 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16780 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16781 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16782 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16783 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16784 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16785 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16786 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16787 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16788 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16789 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16790 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16791 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16792 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16793 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16794 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16795 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16796 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16797 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16798 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16799 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16800 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16801 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16802 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16803 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16804 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16806 ;; All the other keys
16808 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16809 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16810 (if (boundp 'narrow-map)
16811 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16812 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16813 (if (boundp 'narrow-map)
16814 (org-defkey narrow-map "b" 'org-narrow-to-block)
16815 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16816 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16817 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16818 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16819 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16820 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16821 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16822 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16823 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16824 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16825 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16826 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16827 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16828 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16829 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16830 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16831 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16833 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16834 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16835 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16836 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16837 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16838 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16839 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16840 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16841 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16842 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16843 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16844 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16845 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16846 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16847 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16848 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16849 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16850 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16851 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16852 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16854 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16855 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16856 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16857 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16858 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16859 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16860 (org-defkey org-mode-map "\C-c^" 'org-sort)
16861 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16862 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16863 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16864 (org-defkey org-mode-map "\C-m" 'org-return)
16865 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16866 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16867 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16868 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16869 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16870 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16871 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16872 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16873 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16874 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16875 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16876 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16877 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16878 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16879 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16880 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16881 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16882 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16883 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16884 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16885 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16886 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16888 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16889 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16890 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16891 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16893 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16894 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16895 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16896 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16897 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16898 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16899 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16900 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16901 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16902 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16904 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16905 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16906 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16907 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16908 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16909 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16910 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16912 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16913 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16914 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16915 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16916 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16918 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16920 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16922 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16923 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16925 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16928 (when (featurep 'xemacs)
16929 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16932 (defconst org-speed-commands-default
16933 '(
16934 ("Outline Navigation")
16935 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16936 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16937 ("f" . (org-speed-move-safe 'org-forward-same-level))
16938 ("b" . (org-speed-move-safe 'org-backward-same-level))
16939 ("u" . (org-speed-move-safe 'outline-up-heading))
16940 ("j" . org-goto)
16941 ("g" . (org-refile t))
16942 ("Outline Visibility")
16943 ("c" . org-cycle)
16944 ("C" . org-shifttab)
16945 (" " . org-display-outline-path)
16946 ("Outline Structure Editing")
16947 ("U" . org-shiftmetaup)
16948 ("D" . org-shiftmetadown)
16949 ("r" . org-metaright)
16950 ("l" . org-metaleft)
16951 ("R" . org-shiftmetaright)
16952 ("L" . org-shiftmetaleft)
16953 ("i" . (progn (forward-char 1) (call-interactively
16954 'org-insert-heading-respect-content)))
16955 ("^" . org-sort)
16956 ("w" . org-refile)
16957 ("a" . org-archive-subtree-default-with-confirmation)
16958 ("." . org-mark-subtree)
16959 ("Clock Commands")
16960 ("I" . org-clock-in)
16961 ("O" . org-clock-out)
16962 ("Meta Data Editing")
16963 ("t" . org-todo)
16964 ("0" . (org-priority ?\ ))
16965 ("1" . (org-priority ?A))
16966 ("2" . (org-priority ?B))
16967 ("3" . (org-priority ?C))
16968 (";" . org-set-tags-command)
16969 ("e" . org-set-effort)
16970 ("Agenda Views etc")
16971 ("v" . org-agenda)
16972 ("/" . org-sparse-tree)
16973 ("Misc")
16974 ("o" . org-open-at-point)
16975 ("?" . org-speed-command-help)
16976 ("<" . (org-agenda-set-restriction-lock 'subtree))
16977 (">" . (org-agenda-remove-restriction-lock))
16978 )
16979 "The default speed commands.")
16981 (defun org-print-speed-command (e)
16982 (if (> (length (car e)) 1)
16983 (progn
16985 (princ (car e))
16987 (princ (make-string (length (car e)) ?-))
16989 (princ (car e))
16990 (princ " ")
16991 (if (symbolp (cdr e))
16992 (princ (symbol-name (cdr e)))
16993 (prin1 (cdr e)))
16996 (defun org-speed-command-help ()
16997 "Show the available speed commands."
16998 (interactive)
16999 (if (not org-use-speed-commands)
17000 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17001 (with-output-to-temp-buffer "*Help*"
17003 (mapc 'org-print-speed-command org-speed-commands-user)
17006 (mapc 'org-print-speed-command org-speed-commands-default))
17007 (with-current-buffer "*Help*"
17008 (setq truncate-lines t))))
17010 (defun org-speed-move-safe (cmd)
17011 "Execute CMD, but make sure that the cursor always ends up in a headline.
17012 If not, return to the original position and throw an error."
17013 (interactive)
17014 (let ((pos (point)))
17015 (call-interactively cmd)
17016 (unless (and (bolp) (org-on-heading-p))
17017 (goto-char pos)
17018 (error "Boundary reached while executing %s" cmd))))
17020 (defvar org-self-insert-command-undo-counter 0)
17022 (defvar org-table-auto-blank-field) ; defined in org-table.el
17023 (defvar org-speed-command nil)
17025 (defun org-speed-command-default-hook (keys)
17026 "Hook for activating single-letter speed commands.
17027 `org-speed-commands-default' specifies a minimal command set. Use
17028 `org-speed-commands-user' for further customization."
17029 (when (or (and (bolp) (looking-at org-outline-regexp))
17030 (and (functionp org-use-speed-commands)
17031 (funcall org-use-speed-commands)))
17032 (cdr (assoc keys (append org-speed-commands-user
17033 org-speed-commands-default)))))
17035 (defun org-babel-speed-command-hook (keys)
17036 "Hook for activating single-letter code block commands."
17037 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17038 (cdr (assoc keys org-babel-key-bindings))))
17040 (defcustom org-speed-command-hook
17041 '(org-speed-command-default-hook org-babel-speed-command-hook)
17042 "Hook for activating speed commands at strategic locations.
17043 Hook functions are called in sequence until a valid handler is
17044 found.
17046 Each hook takes a single argument, a user-pressed command key
17047 which is also a `self-insert-command' from the global map.
17049 Within the hook, examine the cursor position and the command key
17050 and return nil or a valid handler as appropriate. Handler could
17051 be one of an interactive command, a function, or a form.
17053 Set `org-use-speed-commands' to non-nil value to enable this
17054 hook. The default setting is `org-speed-command-default-hook'."
17055 :group 'org-structure
17056 :type 'hook)
17058 (defun org-self-insert-command (N)
17059 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17060 If the cursor is in a table looking at whitespace, the whitespace is
17061 overwritten, and the table is not marked as requiring realignment."
17062 (interactive "p")
17063 (cond
17064 ((and org-use-speed-commands
17065 (setq org-speed-command
17066 (run-hook-with-args-until-success
17067 'org-speed-command-hook (this-command-keys))))
17068 (cond
17069 ((commandp org-speed-command)
17070 (setq this-command org-speed-command)
17071 (call-interactively org-speed-command))
17072 ((functionp org-speed-command)
17073 (funcall org-speed-command))
17074 ((and org-speed-command (listp org-speed-command))
17075 (eval org-speed-command))
17076 (t (let (org-use-speed-commands)
17077 (call-interactively 'org-self-insert-command)))))
17078 ((and
17079 (org-table-p)
17080 (progn
17081 ;; check if we blank the field, and if that triggers align
17082 (and (featurep 'org-table) org-table-auto-blank-field
17083 (member last-command
17084 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17086 ;; got extra space, this field does not determine column width
17087 (let (org-table-may-need-update) (org-table-blank-field))
17088 ;; no extra space, this field may determine column width
17089 (org-table-blank-field)))
17090 t)
17091 (eq N 1)
17093 (let (org-table-may-need-update)
17094 (goto-char (1- (match-end 0)))
17095 (delete-char -1)
17096 (goto-char (match-beginning 0))
17097 (self-insert-command N)))
17098 (t
17099 (setq org-table-may-need-update t)
17100 (self-insert-command N)
17101 (org-fix-tags-on-the-fly)
17102 (if org-self-insert-cluster-for-undo
17103 (if (not (eq last-command 'org-self-insert-command))
17104 (setq org-self-insert-command-undo-counter 1)
17105 (if (>= org-self-insert-command-undo-counter 20)
17106 (setq org-self-insert-command-undo-counter 1)
17107 (and (> org-self-insert-command-undo-counter 0)
17108 buffer-undo-list (listp buffer-undo-list)
17109 (not (cadr buffer-undo-list)) ; remove nil entry
17110 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17111 (setq org-self-insert-command-undo-counter
17112 (1+ org-self-insert-command-undo-counter))))))))
17114 (defun org-fix-tags-on-the-fly ()
17115 (when (and (equal (char-after (point-at-bol)) ?*)
17116 (org-on-heading-p))
17117 (org-align-tags-here org-tags-column)))
17119 (defun org-delete-backward-char (N)
17120 "Like `delete-backward-char', insert whitespace at field end in tables.
17121 When deleting backwards, in tables this function will insert whitespace in
17123 still be marked for re-alignment if the field did fill the entire column,
17124 because, in this case the deletion might narrow the column."
17125 (interactive "p")
17126 (if (and (org-table-p)
17127 (eq N 1)
17128 (string-match "|" (buffer-substring (point-at-bol) (point)))
17129 (looking-at ".*?|"))
17130 (let ((pos (point))
17132 (c org-table-may-need-update))
17133 (backward-delete-char N)
17134 (if (not overwrite-mode)
17135 (progn
17136 (skip-chars-forward "^|")
17137 (insert " ")
17138 (goto-char (1- pos))))
17139 ;; noalign: if there were two spaces at the end, this field
17140 ;; does not determine the width of the column.
17141 (if noalign (setq org-table-may-need-update c)))
17142 (backward-delete-char N)
17143 (org-fix-tags-on-the-fly)))
17145 (defun org-delete-char (N)
17146 "Like `delete-char', but insert whitespace at field end in tables.
17147 When deleting characters, in tables this function will insert whitespace in
17149 still be marked for re-alignment if the field did fill the entire column,
17150 because, in this case the deletion might narrow the column."
17151 (interactive "p")
17152 (if (and (org-table-p)
17153 (not (bolp))
17154 (not (= (char-after) ?|))
17155 (eq N 1))
17156 (if (looking-at ".*?|")
17157 (let ((pos (point))
17159 (c org-table-may-need-update))
17160 (replace-match (concat
17161 (substring (match-string 0) 1 -1)
17162 " |"))
17163 (goto-char pos)
17164 ;; noalign: if there were two spaces at the end, this field
17165 ;; does not determine the width of the column.
17166 (if noalign (setq org-table-may-need-update c)))
17167 (delete-char N))
17168 (delete-char N)
17169 (org-fix-tags-on-the-fly)))
17171 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17172 (put 'org-self-insert-command 'delete-selection t)
17173 (put 'orgtbl-self-insert-command 'delete-selection t)
17174 (put 'org-delete-char 'delete-selection 'supersede)
17175 (put 'org-delete-backward-char 'delete-selection 'supersede)
17176 (put 'org-yank 'delete-selection 'yank)
17178 ;; Make `flyspell-mode' delay after some commands
17179 (put 'org-self-insert-command 'flyspell-delayed t)
17180 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17181 (put 'org-delete-char 'flyspell-delayed t)
17182 (put 'org-delete-backward-char 'flyspell-delayed t)
17184 ;; Make pabbrev-mode expand after org-mode commands
17185 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17186 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17188 ;; How to do this: Measure non-white length of current string
17189 ;; If equal to column width, we should realign.
17191 (defun org-remap (map &rest commands)
17192 "In MAP, remap the functions given in COMMANDS.
17193 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17194 (let (new old)
17195 (while commands
17196 (setq old (pop commands) new (pop commands))
17197 (if (fboundp 'command-remapping)
17198 (org-defkey map (vector 'remap old) new)
17199 (substitute-key-definition old new map global-map)))))
17201 (when (eq org-enable-table-editor 'optimized)
17202 ;; If the user wants maximum table support, we need to hijack
17203 ;; some standard editing functions
17204 (org-remap org-mode-map
17205 'self-insert-command 'org-self-insert-command
17206 'delete-char 'org-delete-char
17207 'delete-backward-char 'org-delete-backward-char)
17208 (org-defkey org-mode-map "|" 'org-force-self-insert))
17210 (defvar org-ctrl-c-ctrl-c-hook nil
17211 "Hook for functions attaching themselves to `C-c C-c'.
17213 This can be used to add additional functionality to the C-c C-c
17214 key which executes context-dependent commands. This hook is run
17215 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17216 run after the last test.
17218 Each function will be called with no arguments. The function
17219 must check if the context is appropriate for it to act. If yes,
17220 it should do its thing and then return a non-nil value. If the
17221 context is wrong, just do nothing and return nil.")
17223 (defvar org-ctrl-c-ctrl-c-final-hook nil
17224 "Hook for functions attaching themselves to `C-c C-c'.
17226 This can be used to add additional functionality to the C-c C-c
17227 key which executes context-dependent commands. This hook is run
17228 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17229 before the first test.
17231 Each function will be called with no arguments. The function
17232 must check if the context is appropriate for it to act. If yes,
17233 it should do its thing and then return a non-nil value. If the
17234 context is wrong, just do nothing and return nil.")
17236 (defvar org-tab-first-hook nil
17237 "Hook for functions to attach themselves to TAB.
17238 See `org-ctrl-c-ctrl-c-hook' for more information.
17239 This hook runs as the first action when TAB is pressed, even before
17240 `org-cycle' messes around with the `outline-regexp' to cater for
17241 inline tasks and plain list item folding.
17242 If any function in this hook returns t, any other actions that
17243 would have been caused by TAB (such as table field motion or visibility
17244 cycling) will not occur.")
17246 (defvar org-tab-after-check-for-table-hook nil
17247 "Hook for functions to attach themselves to TAB.
17248 See `org-ctrl-c-ctrl-c-hook' for more information.
17249 This hook runs after it has been established that the cursor is not in a
17250 table, but before checking if the cursor is in a headline or if global cycling
17251 should be done.
17252 If any function in this hook returns t, not other actions like visibility
17253 cycling will be done.")
17255 (defvar org-tab-after-check-for-cycling-hook nil
17256 "Hook for functions to attach themselves to TAB.
17257 See `org-ctrl-c-ctrl-c-hook' for more information.
17258 This hook runs after it has been established that not table field motion and
17259 not visibility should be done because of current context. This is probably
17260 the place where a package like yasnippets can hook in.")
17262 (defvar org-tab-before-tab-emulation-hook nil
17263 "Hook for functions to attach themselves to TAB.
17264 See `org-ctrl-c-ctrl-c-hook' for more information.
17265 This hook runs after every other options for TAB have been exhausted, but
17268 (defvar org-metaleft-hook nil
17269 "Hook for functions attaching themselves to `M-left'.
17270 See `org-ctrl-c-ctrl-c-hook' for more information.")
17271 (defvar org-metaright-hook nil
17272 "Hook for functions attaching themselves to `M-right'.
17273 See `org-ctrl-c-ctrl-c-hook' for more information.")
17274 (defvar org-metaup-hook nil
17275 "Hook for functions attaching themselves to `M-up'.
17276 See `org-ctrl-c-ctrl-c-hook' for more information.")
17277 (defvar org-metadown-hook nil
17278 "Hook for functions attaching themselves to `M-down'.
17279 See `org-ctrl-c-ctrl-c-hook' for more information.")
17280 (defvar org-shiftmetaleft-hook nil
17281 "Hook for functions attaching themselves to `M-S-left'.
17282 See `org-ctrl-c-ctrl-c-hook' for more information.")
17283 (defvar org-shiftmetaright-hook nil
17284 "Hook for functions attaching themselves to `M-S-right'.
17285 See `org-ctrl-c-ctrl-c-hook' for more information.")
17286 (defvar org-shiftmetaup-hook nil
17287 "Hook for functions attaching themselves to `M-S-up'.
17288 See `org-ctrl-c-ctrl-c-hook' for more information.")
17289 (defvar org-shiftmetadown-hook nil
17290 "Hook for functions attaching themselves to `M-S-down'.
17291 See `org-ctrl-c-ctrl-c-hook' for more information.")
17292 (defvar org-metareturn-hook nil
17293 "Hook for functions attaching themselves to `M-RET'.
17294 See `org-ctrl-c-ctrl-c-hook' for more information.")
17295 (defvar org-shiftup-hook nil
17296 "Hook for functions attaching themselves to `S-up'.
17297 See `org-ctrl-c-ctrl-c-hook' for more information.")
17298 (defvar org-shiftup-final-hook nil
17299 "Hook for functions attaching themselves to `S-up'.
17300 This one runs after all other options except shift-select have been excluded.
17301 See `org-ctrl-c-ctrl-c-hook' for more information.")
17302 (defvar org-shiftdown-hook nil
17303 "Hook for functions attaching themselves to `S-down'.
17304 See `org-ctrl-c-ctrl-c-hook' for more information.")
17305 (defvar org-shiftdown-final-hook nil
17306 "Hook for functions attaching themselves to `S-down'.
17307 This one runs after all other options except shift-select have been excluded.
17308 See `org-ctrl-c-ctrl-c-hook' for more information.")
17309 (defvar org-shiftleft-hook nil
17310 "Hook for functions attaching themselves to `S-left'.
17311 See `org-ctrl-c-ctrl-c-hook' for more information.")
17312 (defvar org-shiftleft-final-hook nil
17313 "Hook for functions attaching themselves to `S-left'.
17314 This one runs after all other options except shift-select have been excluded.
17315 See `org-ctrl-c-ctrl-c-hook' for more information.")
17316 (defvar org-shiftright-hook nil
17317 "Hook for functions attaching themselves to `S-right'.
17318 See `org-ctrl-c-ctrl-c-hook' for more information.")
17319 (defvar org-shiftright-final-hook nil
17320 "Hook for functions attaching themselves to `S-right'.
17321 This one runs after all other options except shift-select have been excluded.
17322 See `org-ctrl-c-ctrl-c-hook' for more information.")
17324 (defun org-modifier-cursor-error ()
17325 "Throw an error, a modified cursor command was applied in wrong context."
17326 (error "This command is active in special context like tables, headlines or items"))
17328 (defun org-shiftselect-error ()
17329 "Throw an error because Shift-Cursor command was applied in wrong context."
17330 (if (and (boundp 'shift-select-mode) shift-select-mode)
17331 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17332 (error "This command works only in special context like headlines or timestamps")))
17334 (defun org-call-for-shift-select (cmd)
17335 (let ((this-command-keys-shift-translated t))
17336 (call-interactively cmd)))
17338 (defun org-shifttab (&optional arg)
17339 "Global visibility cycling or move to previous table field.
17340 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17341 on context.
17342 See the individual commands for more information."
17343 (interactive "P")
17344 (cond
17345 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17346 ((integerp arg)
17347 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17348 (message "Content view to level: %d" arg)
17349 (org-content (prefix-numeric-value arg2))
17350 (setq org-cycle-global-status 'overview)))
17351 (t (call-interactively 'org-global-cycle))))
17353 (defun org-shiftmetaleft ()
17354 "Promote subtree or delete table column.
17355 Calls `org-promote-subtree', `org-outdent-item',
17356 or `org-table-delete-column', depending on context.
17357 See the individual commands for more information."
17358 (interactive)
17359 (cond
17360 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17361 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17362 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17363 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17364 (t (org-modifier-cursor-error))))
17366 (defun org-shiftmetaright ()
17367 "Demote subtree or insert table column.
17368 Calls `org-demote-subtree', `org-indent-item',
17369 or `org-table-insert-column', depending on context.
17370 See the individual commands for more information."
17371 (interactive)
17372 (cond
17373 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17374 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17375 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17376 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17377 (t (org-modifier-cursor-error))))
17379 (defun org-shiftmetaup (&optional arg)
17380 "Move subtree up or kill table row.
17381 Calls `org-move-subtree-up' or `org-table-kill-row' or
17382 `org-move-item-up' depending on context. See the individual commands
17383 for more information."
17384 (interactive "P")
17385 (cond
17386 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17387 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17388 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17389 ((org-at-item-p) (call-interactively 'org-move-item-up))
17390 (t (org-modifier-cursor-error))))
17392 (defun org-shiftmetadown (&optional arg)
17393 "Move subtree down or insert table row.
17394 Calls `org-move-subtree-down' or `org-table-insert-row' or
17395 `org-move-item-down', depending on context. See the individual
17396 commands for more information."
17397 (interactive "P")
17398 (cond
17399 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17400 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17401 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17402 ((org-at-item-p) (call-interactively 'org-move-item-down))
17403 (t (org-modifier-cursor-error))))
17405 (defsubst org-hidden-tree-error ()
17406 (error
17407 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17409 (defun org-metaleft (&optional arg)
17410 "Promote heading or move table column to left.
17411 Calls `org-do-promote' or `org-table-move-column', depending on context.
17412 With no specific context, calls the Emacs default `backward-word'.
17413 See the individual commands for more information."
17414 (interactive "P")
17415 (cond
17416 ((run-hook-with-args-until-success 'org-metaleft-hook))
17417 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17418 ((org-with-limited-levels
17419 (or (org-on-heading-p)
17420 (and (org-region-active-p)
17421 (save-excursion
17422 (goto-char (region-beginning))
17423 (org-on-heading-p)))))
17424 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17425 (call-interactively 'org-do-promote))
17426 ;; At an inline task.
17427 ((org-on-heading-p)
17428 (call-interactively 'org-inlinetask-promote))
17429 ((or (org-at-item-p)
17430 (and (org-region-active-p)
17431 (save-excursion
17432 (goto-char (region-beginning))
17433 (org-at-item-p))))
17434 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17435 (call-interactively 'org-outdent-item))
17436 (t (call-interactively 'backward-word))))
17438 (defun org-metaright (&optional arg)
17439 "Demote subtree or move table column to right.
17440 Calls `org-do-demote' or `org-table-move-column', depending on context.
17441 With no specific context, calls the Emacs default `forward-word'.
17442 See the individual commands for more information."
17443 (interactive "P")
17444 (cond
17445 ((run-hook-with-args-until-success 'org-metaright-hook))
17446 ((org-at-table-p) (call-interactively 'org-table-move-column))
17447 ((org-with-limited-levels
17448 (or (org-on-heading-p)
17449 (and (org-region-active-p)
17450 (save-excursion
17451 (goto-char (region-beginning))
17452 (org-on-heading-p)))))
17453 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17454 (call-interactively 'org-do-demote))
17455 ;; At an inline task.
17456 ((org-on-heading-p)
17457 (call-interactively 'org-inlinetask-demote))
17458 ((or (org-at-item-p)
17459 (and (org-region-active-p)
17460 (save-excursion
17461 (goto-char (region-beginning))
17462 (org-at-item-p))))
17463 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17464 (call-interactively 'org-indent-item))
17465 (t (call-interactively 'forward-word))))
17467 (defun org-check-for-hidden (what)
17468 "Check if there are hidden headlines/items in the current visual line.
17469 WHAT can be either `headlines' or `items'. If the current line is
17470 an outline or item heading and it has a folded subtree below it,
17471 this function returns t, nil otherwise."
17472 (let ((re (cond
17473 ((eq what 'headlines) org-outline-regexp-bol)
17474 ((eq what 'items) (org-item-beginning-re))
17475 (t (error "This should not happen"))))
17476 beg end)
17477 (save-excursion
17478 (catch 'exit
17479 (unless (org-region-active-p)
17480 (setq beg (point-at-bol))
17481 (beginning-of-line 2)
17482 (while (and (not (eobp)) ;; this is like `next-line'
17483 (get-char-property (1- (point)) 'invisible))
17484 (beginning-of-line 2))
17485 (setq end (point))
17486 (goto-char beg)
17487 (goto-char (point-at-eol))
17488 (setq end (max end (point)))
17489 (while (re-search-forward re end t)
17490 (if (get-char-property (match-beginning 0) 'invisible)
17491 (throw 'exit t))))
17492 nil))))
17494 (defun org-metaup (&optional arg)
17495 "Move subtree up or move table row up.
17496 Calls `org-move-subtree-up' or `org-table-move-row' or
17497 `org-move-item-up', depending on context. See the individual commands
17498 for more information."
17499 (interactive "P")
17500 (cond
17501 ((run-hook-with-args-until-success 'org-metaup-hook))
17502 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17503 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17504 ((org-at-item-p) (call-interactively 'org-move-item-up))
17505 (t (transpose-lines 1) (beginning-of-line -1))))
17507 (defun org-metadown (&optional arg)
17508 "Move subtree down or move table row down.
17509 Calls `org-move-subtree-down' or `org-table-move-row' or
17510 `org-move-item-down', depending on context. See the individual
17511 commands for more information."
17512 (interactive "P")
17513 (cond
17514 ((run-hook-with-args-until-success 'org-metadown-hook))
17515 ((org-at-table-p) (call-interactively 'org-table-move-row))
17516 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17517 ((org-at-item-p) (call-interactively 'org-move-item-down))
17518 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17520 (defun org-shiftup (&optional arg)
17521 "Increase item in timestamp or increase priority of current headline.
17522 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17523 depending on context. See the individual commands for more information."
17524 (interactive "P")
17525 (cond
17526 ((run-hook-with-args-until-success 'org-shiftup-hook))
17527 ((and org-support-shift-select (org-region-active-p))
17528 (org-call-for-shift-select 'previous-line))
17529 ((org-at-timestamp-p t)
17530 (call-interactively (if org-edit-timestamp-down-means-later
17531 'org-timestamp-down 'org-timestamp-up)))
17532 ((and (not (eq org-support-shift-select 'always))
17533 org-enable-priority-commands
17534 (org-on-heading-p))
17535 (call-interactively 'org-priority-up))
17536 ((and (not org-support-shift-select) (org-at-item-p))
17537 (call-interactively 'org-previous-item))
17538 ((org-clocktable-try-shift 'up arg))
17539 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17540 (org-support-shift-select
17541 (org-call-for-shift-select 'previous-line))
17542 (t (org-shiftselect-error))))
17544 (defun org-shiftdown (&optional arg)
17545 "Decrease item in timestamp or decrease priority of current headline.
17546 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17547 depending on context. See the individual commands for more information."
17548 (interactive "P")
17549 (cond
17550 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17551 ((and org-support-shift-select (org-region-active-p))
17552 (org-call-for-shift-select 'next-line))
17553 ((org-at-timestamp-p t)
17554 (call-interactively (if org-edit-timestamp-down-means-later
17555 'org-timestamp-up 'org-timestamp-down)))
17556 ((and (not (eq org-support-shift-select 'always))
17557 org-enable-priority-commands
17558 (org-on-heading-p))
17559 (call-interactively 'org-priority-down))
17560 ((and (not org-support-shift-select) (org-at-item-p))
17561 (call-interactively 'org-next-item))
17562 ((org-clocktable-try-shift 'down arg))
17563 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17564 (org-support-shift-select
17565 (org-call-for-shift-select 'next-line))
17566 (t (org-shiftselect-error))))
17568 (defun org-shiftright (&optional arg)
17569 "Cycle the thing at point or in the current line, depending on context.
17570 Depending on context, this does one of the following:
17572 - switch a timestamp at point one day into the future
17573 - on a headline, switch to the next TODO keyword.
17574 - on an item, switch entire list to the next bullet type
17575 - on a property line, switch to the next allowed value
17576 - on a clocktable definition line, move time block into the future"
17577 (interactive "P")
17578 (cond
17579 ((run-hook-with-args-until-success 'org-shiftright-hook))
17580 ((and org-support-shift-select (org-region-active-p))
17581 (org-call-for-shift-select 'forward-char))
17582 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17583 ((and (not (eq org-support-shift-select 'always))
17584 (org-on-heading-p))
17585 (let ((org-inhibit-logging
17586 (not org-treat-S-cursor-todo-selection-as-state-change))
17587 (org-inhibit-blocking
17588 (not org-treat-S-cursor-todo-selection-as-state-change)))
17589 (org-call-with-arg 'org-todo 'right)))
17590 ((or (and org-support-shift-select
17591 (not (eq org-support-shift-select 'always))
17592 (org-at-item-bullet-p))
17593 (and (not org-support-shift-select) (org-at-item-p)))
17594 (org-call-with-arg 'org-cycle-list-bullet nil))
17595 ((and (not (eq org-support-shift-select 'always))
17596 (org-at-property-p))
17597 (call-interactively 'org-property-next-allowed-value))
17598 ((org-clocktable-try-shift 'right arg))
17599 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17600 (org-support-shift-select
17601 (org-call-for-shift-select 'forward-char))
17602 (t (org-shiftselect-error))))
17604 (defun org-shiftleft (&optional arg)
17605 "Cycle the thing at point or in the current line, depending on context.
17606 Depending on context, this does one of the following:
17608 - switch a timestamp at point one day into the past
17609 - on a headline, switch to the previous TODO keyword.
17610 - on an item, switch entire list to the previous bullet type
17611 - on a property line, switch to the previous allowed value
17612 - on a clocktable definition line, move time block into the past"
17613 (interactive "P")
17614 (cond
17615 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17616 ((and org-support-shift-select (org-region-active-p))
17617 (org-call-for-shift-select 'backward-char))
17618 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17619 ((and (not (eq org-support-shift-select 'always))
17620 (org-on-heading-p))
17621 (let ((org-inhibit-logging
17622 (not org-treat-S-cursor-todo-selection-as-state-change))
17623 (org-inhibit-blocking
17624 (not org-treat-S-cursor-todo-selection-as-state-change)))
17625 (org-call-with-arg 'org-todo 'left)))
17626 ((or (and org-support-shift-select
17627 (not (eq org-support-shift-select 'always))
17628 (org-at-item-bullet-p))
17629 (and (not org-support-shift-select) (org-at-item-p)))
17630 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17631 ((and (not (eq org-support-shift-select 'always))
17632 (org-at-property-p))
17633 (call-interactively 'org-property-previous-allowed-value))
17634 ((org-clocktable-try-shift 'left arg))
17635 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17636 (org-support-shift-select
17637 (org-call-for-shift-select 'backward-char))
17638 (t (org-shiftselect-error))))
17640 (defun org-shiftcontrolright ()
17641 "Switch to next TODO set."
17642 (interactive)
17643 (cond
17644 ((and org-support-shift-select (org-region-active-p))
17645 (org-call-for-shift-select 'forward-word))
17646 ((and (not (eq org-support-shift-select 'always))
17647 (org-on-heading-p))
17648 (org-call-with-arg 'org-todo 'nextset))
17649 (org-support-shift-select
17650 (org-call-for-shift-select 'forward-word))
17651 (t (org-shiftselect-error))))
17653 (defun org-shiftcontrolleft ()
17654 "Switch to previous TODO set."
17655 (interactive)
17656 (cond
17657 ((and org-support-shift-select (org-region-active-p))
17658 (org-call-for-shift-select 'backward-word))
17659 ((and (not (eq org-support-shift-select 'always))
17660 (org-on-heading-p))
17661 (org-call-with-arg 'org-todo 'previousset))
17662 (org-support-shift-select
17663 (org-call-for-shift-select 'backward-word))
17664 (t (org-shiftselect-error))))
17666 (defun org-shiftcontrolup ()
17667 "Change timestamps synchronously up in CLOCK log lines."
17668 (interactive)
17669 (cond ((and (not org-support-shift-select)
17670 (org-at-clock-log-p)
17671 (org-at-timestamp-p t))
17672 (org-clock-timestamps-up))
17673 (t (org-shiftselect-error))))
17675 (defun org-shiftcontroldown ()
17676 "Change timestamps synchronously down in CLOCK log lines."
17677 (interactive)
17678 (cond ((and (not org-support-shift-select)
17679 (org-at-clock-log-p)
17680 (org-at-timestamp-p t))
17681 (org-clock-timestamps-down))
17682 (t (org-shiftselect-error))))
17684 (defun org-ctrl-c-ret ()
17685 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17686 (interactive)
17687 (cond
17688 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17689 (t (call-interactively 'org-insert-heading))))
17691 (defun org-copy-visible (beg end)
17692 "Copy the visible parts of the region."
17693 (interactive "r")
17694 (let (snippets s)
17695 (save-excursion
17696 (save-restriction
17697 (narrow-to-region beg end)
17698 (setq s (goto-char (point-min)))
17699 (while (not (= (point) (point-max)))
17700 (goto-char (org-find-invisible))
17701 (push (buffer-substring s (point)) snippets)
17702 (setq s (goto-char (org-find-visible))))))
17703 (kill-new (apply 'concat (nreverse snippets)))))
17705 (defun org-copy-special ()
17706 "Copy region in table or copy current subtree.
17707 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17708 See the individual commands for more information."
17709 (interactive)
17710 (call-interactively
17711 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17713 (defun org-cut-special ()
17714 "Cut region in table or cut current subtree.
17715 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17716 See the individual commands for more information."
17717 (interactive)
17718 (call-interactively
17719 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17721 (defun org-paste-special (arg)
17722 "Paste rectangular region into table, or past subtree relative to level.
17723 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17724 See the individual commands for more information."
17725 (interactive "P")
17726 (if (org-at-table-p)
17727 (org-table-paste-rectangle)
17728 (org-paste-subtree arg)))
17730 (defun org-edit-special (&optional arg)
17731 "Call a special editor for the stuff at point.
17732 When at a table, call the formula editor with `org-table-edit-formulas'.
17733 When at the first line of an src example, call `org-edit-src-code'.
17734 When in an #+include line, visit the include file. Otherwise call
17735 `ffap' to visit the file at point."
17736 (interactive)
17737 ;; possibly prep session before editing source
17738 (when arg
17739 (let* ((info (org-babel-get-src-block-info))
17740 (lang (nth 0 info))
17741 (params (nth 2 info))
17742 (session (cdr (assoc :session params))))
17743 (when (and info session) ;; we are in a source-code block with a session
17744 (funcall
17745 (intern (concat "org-babel-prep-session:" lang)) session params))))
17746 (cond ;; proceed with `org-edit-special'
17747 ((save-excursion
17748 (beginning-of-line 1)
17749 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17750 (find-file (org-trim (match-string 1))))
17751 ((org-edit-src-code))
17752 ((org-edit-fixed-width-region))
17753 ((org-at-table.el-p)
17754 (org-edit-src-code))
17755 ((or (org-at-table-p)
17756 (save-excursion
17757 (beginning-of-line 1)
17759 (call-interactively 'org-table-edit-formulas))
17760 (t (call-interactively 'ffap))))
17762 (defun org-ctrl-c-ctrl-c (&optional arg)
17763 "Set tags in headline, or update according to changed information at point.
17765 This command does many different things, depending on context:
17767 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17768 this is what we do.
17770 - If the cursor is on a statistics cookie, update it.
17772 - If the cursor is in a headline, prompt for tags and insert them
17773 into the current line, aligned to `org-tags-column'. When called
17774 with prefix arg, realign all tags in the current buffer.
17776 - If the cursor is in one of the special #+KEYWORD lines, this
17777 triggers scanning the buffer for these lines and updating the
17778 information.
17780 - If the cursor is inside a table, realign the table. This command
17781 works even if the automatic table editor has been turned off.
17783 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17784 the entire table.
17786 - If the cursor is at a footnote reference or definition, jump to
17787 the corresponding definition or references, respectively.
17789 - If the cursor is a the beginning of a dynamic block, update it.
17791 - If the current buffer is a capture buffer, close note and file it.
17793 - If the cursor is on a <<<target>>>, update radio targets and
17794 corresponding links in this buffer.
17796 - If the cursor is on a numbered item in a plain list, renumber the
17797 ordered list.
17799 - If the cursor is on a checkbox, toggle it.
17801 - If the cursor is on a code block, evaluate it. The variable
17802 `org-confirm-babel-evaluate' can be used to control prompting
17803 before code block evaluation, by default every code block
17804 evaluation requires confirmation. Code block evaluation can be
17805 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17806 (interactive "P")
17807 (let ((org-enable-table-editor t))
17808 (cond
17809 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17810 org-occur-highlights
17811 org-latex-fragment-image-overlays)
17812 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17813 (org-remove-occur-highlights)
17814 (org-remove-latex-fragment-image-overlays)
17815 (message "Temporary highlights/overlays removed from current buffer"))
17816 ((and (local-variable-p 'org-finish-function (current-buffer))
17817 (fboundp org-finish-function))
17818 (funcall org-finish-function))
17819 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17820 ((or (looking-at org-property-start-re)
17821 (org-at-property-p))
17822 (call-interactively 'org-property-action))
17823 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17825 (or (org-on-heading-p) (org-at-item-p)))
17826 (call-interactively 'org-update-statistics-cookies))
17827 ((org-on-heading-p) (call-interactively 'org-set-tags))
17828 ((org-at-table.el-p)
17829 (message "Use C-c ' to edit table.el tables"))
17830 ((org-at-table-p)
17831 (org-table-maybe-eval-formula)
17832 (if arg
17833 (call-interactively 'org-table-recalculate)
17834 (org-table-maybe-recalculate-line))
17835 (call-interactively 'org-table-align)
17836 (orgtbl-send-table 'maybe))
17837 ((or (org-footnote-at-reference-p)
17838 (org-footnote-at-definition-p))
17839 (call-interactively 'org-footnote-action))
17840 ((org-at-item-checkbox-p)
17841 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17842 ;; list only if at top item.
17843 (let* ((cbox (match-string 1))
17844 (struct (org-list-struct))
17845 (old-struct (copy-tree struct))
17846 (parents (org-list-parents-alist struct))
17847 (prevs (org-list-prevs-alist struct))
17848 (orderedp (org-entry-get nil "ORDERED"))
17849 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17850 block-item)
17851 ;; Use a light version of `org-toggle-checkbox' to avoid
17852 ;; computing list structure twice.
17853 (org-list-set-checkbox (point-at-bol) struct
17854 (cond
17855 ((equal arg '(16)) "[-]")
17856 ((equal arg '(4)) nil)
17857 ((equal "[X]" cbox) "[ ]")
17858 (t "[X]")))
17859 (org-list-struct-fix-ind struct parents)
17860 (org-list-struct-fix-bul struct prevs)
17861 (setq block-item
17862 (org-list-struct-fix-box struct parents prevs orderedp))
17863 (when block-item
17864 (message
17865 "Checkboxes were removed due to unchecked box at line %d"
17866 (org-current-line block-item)))
17867 (org-list-struct-apply-struct struct old-struct)
17868 (org-update-checkbox-count-maybe)
17869 (when firstp (org-list-send-list 'maybe))))
17870 ((org-at-item-p)
17871 ;; Cursor at an item: repair list. Do checkbox related actions
17872 ;; only if function was called with an argument. Send list only
17873 ;; if at top item.
17874 (let* ((struct (org-list-struct))
17875 (old-struct (copy-tree struct))
17876 (parents (org-list-parents-alist struct))
17877 (prevs (org-list-prevs-alist struct))
17878 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17879 (org-list-struct-fix-ind struct parents)
17880 (org-list-struct-fix-bul struct prevs)
17881 (when arg
17882 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17883 (org-list-struct-fix-box struct parents prevs))
17884 (org-list-struct-apply-struct struct old-struct)
17885 (when arg (org-update-checkbox-count-maybe))
17886 (when firstp (org-list-send-list 'maybe))))
17887 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17888 ;; Dynamic block
17889 (beginning-of-line 1)
17890 (save-excursion (org-update-dblock)))
17891 ((save-excursion
17892 (beginning-of-line 1)
17894 (cond
17895 ((equal (match-string 1) "TBLFM")
17896 ;; Recalculate the table before this line
17897 (save-excursion
17898 (beginning-of-line 1)
17900 (if (org-at-table-p)
17901 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17902 (t
17903 (let ((org-inhibit-startup-visibility-stuff t)
17904 (org-startup-align-all-tables nil))
17905 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17906 (message "Local setup has been refreshed"))))
17907 ((org-clock-update-time-maybe))
17908 (t
17909 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17910 (error "C-c C-c can do nothing useful at this location"))))))
17912 (defun org-mode-restart ()
17913 "Restart Org-mode, to scan again for special lines.
17914 Also updates the keyword regular expressions."
17915 (interactive)
17916 (org-mode)
17917 (message "Org-mode restarted"))
17919 (defun org-kill-note-or-show-branches ()
17920 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17921 (interactive)
17922 (if (not org-finish-function)
17923 (progn
17924 (hide-subtree)
17925 (call-interactively 'show-branches))
17926 (let ((org-note-abort t))
17927 (funcall org-finish-function))))
17929 (defun org-return (&optional indent)
17930 "Goto next table row or insert a newline.
17931 Calls `org-table-next-row' or `newline', depending on context.
17932 See the individual commands for more information."
17933 (interactive)
17934 (cond
17935 ((bobp) (if indent (newline-and-indent) (newline)))
17936 ((org-at-table-p)
17937 (org-table-justify-field-maybe)
17938 (call-interactively 'org-table-next-row))
17939 ;; when `newline-and-indent' is called within a list, make sure
17940 ;; text moved stays inside the item.
17941 ((and (org-in-item-p) indent)
17942 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17943 (progn
17944 (save-match-data (newline))
17945 (org-indent-line-to (length (match-string 0))))
17946 (let ((ind (org-get-indentation)))
17947 (newline)
17948 (if (org-looking-back org-list-end-re)
17949 (org-indent-line-function)
17950 (org-indent-line-to ind)))))
17951 ((and org-return-follows-link
17952 (eq (get-text-property (point) 'face) 'org-link))
17953 (call-interactively 'org-open-at-point))
17954 ((and (org-at-heading-p)
17955 (looking-at
17957 (org-show-entry)
17958 (end-of-line 1)
17959 (newline))
17960 (t (if indent (newline-and-indent) (newline)))))
17962 (defun org-return-indent ()
17963 "Goto next table row or insert a newline and indent.
17964 Calls `org-table-next-row' or `newline-and-indent', depending on
17965 context. See the individual commands for more information."
17966 (interactive)
17967 (org-return t))
17969 (defun org-ctrl-c-star ()
17970 "Compute table, or change heading status of lines.
17971 Calls `org-table-recalculate' or `org-toggle-heading',
17972 depending on context."
17973 (interactive)
17974 (cond
17975 ((org-at-table-p)
17976 (call-interactively 'org-table-recalculate))
17977 (t
17978 ;; Convert all lines in region to list items
17979 (call-interactively 'org-toggle-heading))))
17981 (defun org-ctrl-c-minus ()
17982 "Insert separator line in table or modify bullet status of line.
17983 Also turns a plain line or a region of lines into list items.
17984 Calls `org-table-insert-hline', `org-toggle-item', or
17985 `org-cycle-list-bullet', depending on context."
17986 (interactive)
17987 (cond
17988 ((org-at-table-p)
17989 (call-interactively 'org-table-insert-hline))
17990 ((org-region-active-p)
17991 (call-interactively 'org-toggle-item))
17992 ((org-in-item-p)
17993 (call-interactively 'org-cycle-list-bullet))
17994 (t
17995 (call-interactively 'org-toggle-item))))
17997 (defun org-toggle-item (arg)
17998 "Convert headings or normal lines to items, items to normal lines.
17999 If there is no active region, only the current line is considered.
18001 If the first non blank line in the region is an headline, convert
18002 all headlines to items, shifting text accordingly.
18004 If it is an item, convert all items to normal lines.
18006 If it is normal text, change region into an item. With a prefix
18007 argument ARG, change each line in region into an item."
18008 (interactive "P")
18009 (let ((shift-text
18010 (function
18011 ;; Shift text in current section to IND, from point to END.
18012 ;; The function leaves point to END line.
18013 (lambda (ind end)
18014 (let ((min-i 1000) (end (copy-marker end)))
18015 ;; First determine the minimum indentation (MIN-I) of
18016 ;; the text.
18017 (save-excursion
18018 (catch 'exit
18019 (while (< (point) end)
18020 (let ((i (org-get-indentation)))
18021 (cond
18022 ;; Skip blank lines and inline tasks.
18024 ((looking-at org-outline-regexp-bol))
18025 ;; We can't find less than 0 indentation.
18026 ((zerop i) (throw 'exit (setq min-i 0)))
18027 ((< i min-i) (setq min-i i))))
18028 (forward-line))))
18029 ;; Then indent each line so that a line indented to
18030 ;; MIN-I becomes indented to IND. Ignore blank lines
18031 ;; and inline tasks in the process.
18032 (let ((delta (- ind min-i)))
18033 (while (< (point) end)
18035 (looking-at org-outline-regexp-bol))
18036 (org-indent-line-to (+ (org-get-indentation) delta)))
18037 (forward-line)))))))
18038 (skip-blanks
18039 (function
18040 ;; Return beginning of first non-blank line, starting from
18041 ;; line at POS.
18042 (lambda (pos)
18043 (save-excursion
18044 (goto-char pos)
18046 (point-at-bol)))))
18047 beg end)
18048 ;; Determine boundaries of changes.
18049 (if (org-region-active-p)
18050 (setq beg (funcall skip-blanks (region-beginning))
18051 end (copy-marker (region-end)))
18052 (setq beg (funcall skip-blanks (point-at-bol))
18053 end (copy-marker (point-at-eol))))
18054 ;; Depending on the starting line, choose an action on the text
18055 ;; between BEG and END.
18056 (org-with-limited-levels
18057 (save-excursion
18058 (goto-char beg)
18059 (cond
18060 ;; Case 1. Start at an item: de-itemize. Note that it only
18061 ;; happens when a region is active: `org-ctrl-c-minus'
18062 ;; would call `org-cycle-list-bullet' otherwise.
18063 ((org-at-item-p)
18064 (while (< (point) end)
18065 (when (org-at-item-p)
18067 (delete-region (point) (match-end 0)))
18068 (forward-line)))
18069 ;; Case 2. Start at an heading: convert to items.
18070 ((org-on-heading-p)
18071 (let* ((bul (org-list-bullet-string "-"))
18072 (bul-len (length bul))
18073 ;; Indentation of the first heading. It should be
18074 ;; relative to the indentation of its parent, if any.
18075 (start-ind (save-excursion
18076 (cond
18077 ((not org-adapt-indentation) 0)
18078 ((not (outline-previous-heading)) 0)
18079 (t (length (match-string 0))))))
18080 ;; Level of first heading. Further headings will be
18081 ;; compared to it to determine hierarchy in the list.
18082 (ref-level (org-reduced-level (org-outline-level))))
18083 (while (< (point) end)
18084 (let* ((level (org-reduced-level (org-outline-level)))
18085 (delta (max 0 (- level ref-level))))
18086 ;; If current headline is less indented than the first
18087 ;; one, set it as reference, in order to preserve
18088 ;; subtrees.
18089 (when (< level ref-level) (setq ref-level level))
18090 (replace-match bul t t)
18091 (org-indent-line-to (+ start-ind (* delta bul-len)))
18092 ;; Ensure all text down to END (or SECTION-END) belongs
18093 ;; to the newly created item.
18094 (let ((section-end (save-excursion
18095 (or (outline-next-heading) (point)))))
18096 (forward-line)
18097 (funcall shift-text
18098 (+ start-ind (* (1+ delta) bul-len))
18099 (min end section-end)))))))
18100 ;; Case 3. Normal line with ARG: turn each non-item line into
18101 ;; an item.
18102 (arg
18103 (while (< (point) end)
18104 (unless (or (org-on-heading-p) (org-at-item-p))
18106 (replace-match
18108 (forward-line)))
18109 ;; Case 4. Normal line without ARG: make the first line of
18110 ;; region an item, and shift indentation of others
18111 ;; lines to set them as item's body.
18112 (t (let* ((bul (org-list-bullet-string "-"))
18113 (bul-len (length bul))
18114 (ref-ind (org-get-indentation)))
18116 (insert bul)
18117 (forward-line)
18118 (while (< (point) end)
18119 ;; Ensure that lines less indented than first one
18120 ;; still get included in item body.
18121 (funcall shift-text
18122 (+ ref-ind bul-len)
18123 (min end (save-excursion (or (outline-next-heading)
18124 (point)))))
18125 (forward-line)))))))))
18127 (defun org-toggle-heading (&optional nstars)
18128 "Convert headings to normal text, or items or text to headings.
18129 If there is no active region, only the current line is considered.
18131 If the first non blank line is an headline, remove the stars from
18132 all headlines in the region.
18134 If it is a plain list item, turn all plain list items into headings.
18136 If it is a normal line, turn each and every normal line (i.e. not
18137 an heading or an item) in the region into a heading.
18139 When converting a line into a heading, the number of stars is chosen
18140 such that the lines become children of the current entry. However,
18141 when a prefix argument is given, its value determines the number of
18142 stars to add."
18143 (interactive "P")
18144 (let ((skip-blanks
18145 (function
18146 ;; Return beginning of first non-blank line, starting from
18147 ;; line at POS.
18148 (lambda (pos)
18149 (save-excursion
18150 (goto-char pos)
18152 (point-at-bol)))))
18153 beg end)
18154 ;; Determine boundaries of changes. If region ends at a bol, do
18155 ;; not consider the last line to be in the region.
18156 (if (org-region-active-p)
18157 (setq beg (funcall skip-blanks (region-beginning))
18158 end (copy-marker (save-excursion
18159 (goto-char (region-end))
18160 (if (bolp) (point) (point-at-eol)))))
18161 (setq beg (funcall skip-blanks (point-at-bol))
18162 end (copy-marker (point-at-eol))))
18163 ;; Ensure inline tasks don't count as headings.
18164 (org-with-limited-levels
18165 (save-excursion
18166 (goto-char beg)
18167 (cond
18168 ;; Case 1. Started at an heading: de-star headings.
18169 ((org-on-heading-p)
18170 (while (< (point) end)
18171 (when (org-on-heading-p t)
18172 (looking-at org-outline-regexp) (replace-match ""))
18173 (forward-line)))
18174 ;; Case 2. Started at an item: change items into headlines.
18175 ;; One star will be added by `org-list-to-subtree'.
18176 ((org-at-item-p)
18177 (let* ((stars (make-string
18178 (if nstars
18179 ;; subtract the star that will be added again by
18180 ;; `org-list-to-subtree'
18181 (1- (prefix-numeric-value current-prefix-arg))
18182 (or (org-current-level) 0))
18183 ?*))
18184 (add-stars
18185 (cond (nstars "") ; stars from prefix only
18186 ((equal stars "") "") ; before first heading
18187 (org-odd-levels-only "*") ; inside heading, odd
18188 (t "")))) ; inside heading, oddeven
18189 (while (< (point) end)
18190 (when (org-at-item-p)
18191 ;; Pay attention to cases when region ends before list.
18192 (let* ((struct (org-list-struct))
18193 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18194 (save-restriction
18195 (narrow-to-region (point) list-end)
18196 (insert
18197 (org-list-to-subtree
18198 (org-list-parse-list t)
18199 '(:istart (concat stars add-stars (funcall get-stars depth))
18200 :icount (concat stars add-stars (funcall get-stars depth))))))))
18201 (forward-line))))
18202 ;; Case 3. Started at normal text: make every line an heading,
18203 ;; skipping headlines and items.
18204 (t (let* ((stars (make-string
18205 (if nstars
18206 (prefix-numeric-value current-prefix-arg)
18207 (or (org-current-level) 0))
18208 ?*))
18209 (add-stars
18210 (cond (nstars "") ; stars from prefix only
18211 ((equal stars "") "*") ; before first heading
18212 (org-odd-levels-only "**") ; inside heading, odd
18213 (t "*"))) ; inside heading, oddeven
18214 (rpl (concat stars add-stars " ")))
18215 (while (< (point) end)
18216 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18218 (replace-match (concat rpl (match-string 2))))
18219 (forward-line)))))))))
18221 (defun org-meta-return (&optional arg)
18222 "Insert a new heading or wrap a region in a table.
18223 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18224 See the individual commands for more information."
18225 (interactive "P")
18226 (cond
18227 ((run-hook-with-args-until-success 'org-metareturn-hook))
18228 ((org-at-table-p)
18229 (call-interactively 'org-table-wrap-region))
18230 (t (call-interactively 'org-insert-heading))))
18232 ;;; Menu entries
18234 ;; Define the Org-mode menus
18235 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18236 '("Tbl"
18237 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18238 ["Next Field" org-cycle (org-at-table-p)]
18239 ["Previous Field" org-shifttab (org-at-table-p)]
18240 ["Next Row" org-return (org-at-table-p)]
18241 "--"
18242 ["Blank Field" org-table-blank-field (org-at-table-p)]
18243 ["Edit Field" org-table-edit-field (org-at-table-p)]
18244 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18245 "--"
18246 ("Column"
18247 ["Move Column Left" org-metaleft (org-at-table-p)]
18248 ["Move Column Right" org-metaright (org-at-table-p)]
18249 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18250 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18251 ("Row"
18252 ["Move Row Up" org-metaup (org-at-table-p)]
18253 ["Move Row Down" org-metadown (org-at-table-p)]
18254 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18255 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18256 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18257 "--"
18258 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18259 ("Rectangle"
18260 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18261 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18262 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18263 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18264 "--"
18265 ("Calculate"
18266 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18267 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18268 ["Edit Formulas" org-edit-special (org-at-table-p)]
18269 "--"
18270 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18271 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18272 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18273 "--"
18274 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18275 "--"
18276 ["Sum Column/Rectangle" org-table-sum
18277 (or (org-at-table-p) (org-region-active-p))]
18278 ["Which Column?" org-table-current-column (org-at-table-p)])
18279 ["Debug Formulas"
18280 org-table-toggle-formula-debugger
18281 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18282 ["Show Col/Row Numbers"
18283 org-table-toggle-coordinate-overlays
18284 :style toggle
18285 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18286 "--"
18287 ["Create" org-table-create (and (not (org-at-table-p))
18288 org-enable-table-editor)]
18289 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18290 ["Import from File" org-table-import (not (org-at-table-p))]
18291 ["Export to File" org-table-export (org-at-table-p)]
18292 "--"
18293 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18295 (easy-menu-define org-org-menu org-mode-map "Org menu"
18296 '("Org"
18297 ("Show/Hide"
18298 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18299 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18300 ["Sparse Tree..." org-sparse-tree t]
18301 ["Reveal Context" org-reveal t]
18302 ["Show All" show-all t]
18303 "--"
18304 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18305 "--"
18306 ["New Heading" org-insert-heading t]
18307 ("Navigate Headings"
18308 ["Up" outline-up-heading t]
18309 ["Next" outline-next-visible-heading t]
18310 ["Previous" outline-previous-visible-heading t]
18311 ["Next Same Level" outline-forward-same-level t]
18312 ["Previous Same Level" outline-backward-same-level t]
18313 "--"
18314 ["Jump" org-goto t])
18315 ("Edit Structure"
18316 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18317 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18318 "--"
18319 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18320 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18321 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18322 "--"
18323 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18324 "--"
18325 ["Copy visible text" org-copy-visible t]
18326 "--"
18327 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18328 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18329 ["Demote Heading" org-metaright (not (org-at-table-p))]
18330 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18331 "--"
18332 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18333 "--"
18334 ["Convert to odd levels" org-convert-to-odd-levels t]
18335 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18336 ("Editing"
18337 ["Emphasis..." org-emphasize t]
18338 ["Edit Source Example" org-edit-special t]
18339 "--"
18340 ["Footnote new/jump" org-footnote-action t]
18341 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18342 ("Archive"
18343 ["Archive (default method)" org-archive-subtree-default t]
18344 "--"
18345 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18346 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18347 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18348 )
18349 "--"
18350 ("Hyperlinks"
18351 ["Store Link (Global)" org-store-link t]
18352 ["Find existing link to here" org-occur-link-in-agenda-files t]
18353 ["Insert Link" org-insert-link t]
18354 ["Follow Link" org-open-at-point t]
18355 "--"
18356 ["Next link" org-next-link t]
18357 ["Previous link" org-previous-link t]
18358 "--"
18359 ["Descriptive Links"
18360 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18361 :style radio
18362 :selected (member '(org-link) buffer-invisibility-spec)]
18363 ["Literal Links"
18364 (progn
18365 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18366 :style radio
18367 :selected (not (member '(org-link) buffer-invisibility-spec))])
18368 "--"
18369 ("TODO Lists"
18370 ["TODO/DONE/-" org-todo t]
18371 ("Select keyword"
18372 ["Next keyword" org-shiftright (org-on-heading-p)]
18373 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18374 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18375 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18376 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18377 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18378 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18379 "--"
18380 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18381 :selected org-enforce-todo-dependencies :style toggle :active t]
18382 "Settings for tree at point"
18383 ["Do Children sequentially" org-toggle-ordered-property :style radio
18384 :selected (org-entry-get nil "ORDERED")
18385 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18386 ["Do Children parallel" org-toggle-ordered-property :style radio
18387 :selected (not (org-entry-get nil "ORDERED"))
18388 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18389 "--"
18390 ["Set Priority" org-priority t]
18391 ["Priority Up" org-shiftup t]
18392 ["Priority Down" org-shiftdown t]
18393 "--"
18394 ["Get news from all feeds" org-feed-update-all t]
18395 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18396 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18397 ("TAGS and Properties"
18398 ["Set Tags" org-set-tags-command t]
18399 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18400 "--"
18401 ["Set property" org-set-property t]
18402 ["Column view of properties" org-columns t]
18403 ["Insert Column View DBlock" org-insert-columns-dblock t])
18404 ("Dates and Scheduling"
18405 ["Timestamp" org-time-stamp t]
18406 ["Timestamp (inactive)" org-time-stamp-inactive t]
18407 ("Change Date"
18408 ["1 Day Later" org-shiftright t]
18409 ["1 Day Earlier" org-shiftleft t]
18410 ["1 ... Later" org-shiftup t]
18411 ["1 ... Earlier" org-shiftdown t])
18412 ["Compute Time Range" org-evaluate-time-range t]
18413 ["Schedule Item" org-schedule t]
18414 ["Deadline" org-deadline t]
18415 "--"
18416 ["Custom time format" org-toggle-time-stamp-overlays
18417 :style radio :selected org-display-custom-times]
18418 "--"
18419 ["Goto Calendar" org-goto-calendar t]
18420 ["Date from Calendar" org-date-from-calendar t]
18421 "--"
18422 ["Start/Restart Timer" org-timer-start t]
18423 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18424 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18425 ["Insert Timer String" org-timer t]
18426 ["Insert Timer Item" org-timer-item t])
18427 ("Logging work"
18428 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18429 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18430 ["Clock out" org-clock-out t]
18431 ["Clock cancel" org-clock-cancel t]
18432 "--"
18433 ["Mark as default task" org-clock-mark-default-task t]
18434 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18435 ["Goto running clock" org-clock-goto t]
18436 "--"
18437 ["Display times" org-clock-display t]
18438 ["Create clock table" org-clock-report t]
18439 "--"
18440 ["Record DONE time"
18441 (progn (setq org-log-done (not org-log-done))
18442 (message "Switching to %s will %s record a timestamp"
18443 (car org-done-keywords)
18444 (if org-log-done "automatically" "not")))
18445 :style toggle :selected org-log-done])
18446 "--"
18447 ["Agenda Command..." org-agenda t]
18448 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18449 ("File List for Agenda")
18450 ("Special views current file"
18451 ["TODO Tree" org-show-todo-tree t]
18452 ["Check Deadlines" org-check-deadlines t]
18453 ["Timeline" org-timeline t]
18454 ["Tags/Property tree" org-match-sparse-tree t])
18455 "--"
18456 ["Export/Publish..." org-export t]
18457 ("LaTeX"
18458 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18459 :selected org-cdlatex-mode]
18460 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18461 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18462 ["Modify math symbol" org-cdlatex-math-modify
18463 (org-inside-LaTeX-fragment-p)]
18464 ["Insert citation" org-reftex-citation t]
18465 "--"
18466 ["Template for BEAMER" org-insert-beamer-options-template t])
18467 "--"
18468 ("MobileOrg"
18469 ["Push Files and Views" org-mobile-push t]
18470 ["Get Captured and Flagged" org-mobile-pull t]
18471 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18472 "--"
18473 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18474 "--"
18475 ("Documentation"
18476 ["Show Version" org-version t]
18477 ["Info Documentation" org-info t])
18478 ("Customize"
18479 ["Browse Org Group" org-customize t]
18480 "--"
18481 ["Expand This Menu" org-create-customize-menu
18482 (fboundp 'customize-menu-create)])
18483 ["Send bug report" org-submit-bug-report t]
18484 "--"
18485 ("Refresh/Reload"
18486 ["Refresh setup current buffer" org-mode-restart t]
18487 ["Reload Org (after update)" org-reload t]
18488 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18489 ))
18491 (defun org-info (&optional node)
18492 "Read documentation for Org-mode in the info system.
18493 With optional NODE, go directly to that node."
18494 (interactive)
18495 (info (format "(org)%s" (or node ""))))
18497 ;;;###autoload
18498 (defun org-submit-bug-report ()
18499 "Submit a bug report on Org-mode via mail.
18501 Don't hesitate to report any problems or inaccurate documentation.
18503 If you don't have setup sending mail from (X)Emacs, please copy the
18504 output buffer into your mail program, as it gives us important
18505 information about your Org-mode version and configuration."
18506 (interactive)
18507 (require 'reporter)
18508 (org-load-modules-maybe)
18509 (org-require-autoloaded-modules)
18510 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18511 (reporter-submit-bug-report
18512 "emacs-orgmode@gnu.org"
18513 (org-version)
18514 (let (list)
18515 (save-window-excursion
18516 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18517 (delete-other-windows)
18518 (erase-buffer)
18519 (insert "You are about to submit a bug report to the Org-mode mailing list.
18521 We would like to add your full Org-mode and Outline configuration to the
18522 bug report. This greatly simplifies the work of the maintainer and
18523 other experts on the mailing list.
18525 HOWEVER, some variables you have customized may contain private
18526 information. The names of customers, colleagues, or friends, might
18527 appear in the form of file names, tags, todo states, or search strings.
18528 If you answer yes to the prompt, you might want to check and remove
18529 such private information before sending the email.")
18530 (add-text-properties (point-min) (point-max) '(face org-warning))
18531 (when (yes-or-no-p "Include your Org-mode configuration ")
18532 (mapatoms
18533 (lambda (v)
18534 (and (boundp v)
18536 (or (and (symbol-value v)
18538 (and
18539 (get v 'custom-type) (get v 'standard-value)
18540 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18541 (push v list)))))
18542 (kill-buffer (get-buffer "*Warn about privacy*"))
18543 list))
18544 nil nil
18545 "Remember to cover the basics, that is, what you expected to happen and
18546 what in fact did happen. You don't know how to make a good report? See
18548 http://orgmode.org/manual/Feedback.html#Feedback
18550 Your bug report will be posted to the Org-mode mailing list.
18551 ------------------------------------------------------------------------")
18552 (save-excursion
18557 (defun org-install-agenda-files-menu ()
18558 (let ((bl (buffer-list)))
18559 (save-excursion
18560 (while bl
18561 (set-buffer (pop bl))
18562 (if (org-mode-p) (setq bl nil)))
18563 (when (org-mode-p)
18564 (easy-menu-change
18565 '("Org") "File List for Agenda"
18566 (append
18567 (list
18568 ["Edit File List" (org-edit-agenda-file-list) t]
18569 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18570 ["Remove Current File from List" org-remove-file t]
18571 ["Cycle through agenda files" org-cycle-agenda-files t]
18572 ["Occur in all agenda files" org-occur-in-agenda-files t]
18573 "--")
18574 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18576 ;;;; Documentation
18578 ;;;###autoload
18579 (defun org-require-autoloaded-modules ()
18580 (interactive)
18581 (mapc 'require
18582 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18583 org-docbook org-exp org-html org-icalendar
18584 org-id org-latex
18585 org-publish org-remember org-table
18586 org-timer org-xoxo)))
18588 ;;;###autoload
18589 (defun org-reload (&optional uncompiled)
18590 "Reload all org lisp files.
18591 With prefix arg UNCOMPILED, load the uncompiled versions."
18592 (interactive "P")
18593 (require 'find-func)
18595 (dir-org (file-name-directory (org-find-library-name "org")))
18596 (dir-org-contrib (ignore-errors
18597 (file-name-directory
18598 (org-find-library-name "org-contribdir"))))
18599 (babel-files
18600 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18601 (append (list nil "comint" "eval" "exp" "keys"
18602 "lob" "ref" "table" "tangle")
18603 (delq nil
18604 (mapcar
18605 (lambda (lang)
18606 (when (cdr lang) (symbol-name (car lang))))
18607 org-babel-load-languages)))))
18608 (files
18609 (append (directory-files dir-org t file-re)
18610 babel-files
18611 (and dir-org-contrib
18612 (directory-files dir-org-contrib t file-re))))
18613 (remove-re (concat (if (featurep 'xemacs)
18614 "org-colview" "org-colview-xemacs")
18616 (setq files (mapcar 'file-name-sans-extension files))
18617 (setq files (mapcar
18618 (lambda (x) (if (string-match remove-re x) nil x))
18619 files))
18620 (setq files (delq nil files))
18621 (mapc
18622 (lambda (f)
18623 (when (featurep (intern (file-name-nondirectory f)))
18624 (if (and (not uncompiled)
18625 (file-exists-p (concat f ".elc")))
18626 (load (concat f ".elc") nil nil t)
18627 (load (concat f ".el") nil nil t))))
18628 files))
18629 (org-version))
18631 ;;;###autoload
18632 (defun org-customize ()
18633 "Call the customize function with org as argument."
18634 (interactive)
18635 (org-load-modules-maybe)
18636 (org-require-autoloaded-modules)
18637 (customize-browse 'org))
18639 (defun org-create-customize-menu ()
18640 "Create a full customization menu for Org-mode, insert it into the menu."
18641 (interactive)
18642 (org-load-modules-maybe)
18643 (org-require-autoloaded-modules)
18644 (if (fboundp 'customize-menu-create)
18645 (progn
18646 (easy-menu-change
18647 '("Org") "Customize"
18648 `(["Browse Org group" org-customize t]
18649 "--"
18650 ,(customize-menu-create 'org)
18651 ["Set" Custom-set t]
18652 ["Save" Custom-save t]
18653 ["Reset to Current" Custom-reset-current t]
18654 ["Reset to Saved" Custom-reset-saved t]
18655 ["Reset to Standard Settings" Custom-reset-standard t]))
18657 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18659 ;;;; Miscellaneous stuff
18661 ;;; Generally useful functions
18663 (defun org-get-at-bol (property)
18664 "Get text property PROPERTY at beginning of line."
18665 (get-text-property (point-at-bol) property))
18667 (defun org-find-text-property-in-string (prop s)
18668 "Return the first non-nil value of property PROP in string S."
18669 (or (get-text-property 0 prop s)
18670 (get-text-property (or (next-single-property-change 0 prop s) 0)
18671 prop s)))
18673 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18674 "Display the given MESSAGE as a warning."
18675 (if (fboundp 'display-warning)
18676 (display-warning 'org message
18677 (if (featurep 'xemacs) 'warning :warning))
18678 (let ((buf (get-buffer-create "*Org warnings*")))
18679 (with-current-buffer buf
18680 (goto-char (point-max))
18681 (insert "Warning (Org): " message)
18682 (unless (bolp)
18683 (newline)))
18684 (display-buffer buf)
18685 (sit-for 0))))
18687 (defun org-eval (form)
18688 "Eval FORM and return result."
18689 (condition-case error
18690 (eval form)
18691 (error (format "%%![Error: %s]" error))))
18693 (defun org-in-commented-line ()
18694 "Is point in a line starting with `#'?"
18695 (equal (char-after (point-at-bol)) ?#))
18697 (defun org-in-indented-comment-line ()
18698 "Is point in a line starting with `#' after some white space?"
18699 (save-excursion
18700 (save-match-data
18701 (goto-char (point-at-bol))
18704 (defun org-in-verbatim-emphasis ()
18705 (save-match-data
18706 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18708 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18709 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18710 (if (and marker (marker-buffer marker)
18711 (buffer-live-p (marker-buffer marker)))
18712 (progn
18713 (org-pop-to-buffer-same-window (marker-buffer marker))
18714 (if (or (> marker (point-max)) (< marker (point-min)))
18715 (widen))
18716 (goto-char marker)
18717 (org-show-context 'org-goto))
18718 (if bookmark
18719 (bookmark-jump bookmark)
18720 (error "Cannot find location"))))
18722 (defun org-quote-csv-field (s)
18723 "Quote field for inclusion in CSV material."
18726 s))
18728 (defun org-force-self-insert (N)
18729 "Needed to enforce self-insert under remapping."
18730 (interactive "p")
18731 (self-insert-command N))
18733 (defun org-string-width (s)
18734 "Compute width of string, ignoring invisible characters.
18735 This ignores character with invisibility property `org-link', and also
18736 characters with property `org-cwidth', because these will become invisible
18737 upon the next fontification round."
18738 (let (b l)
18739 (when (or (eq t buffer-invisibility-spec)
18740 (assq 'org-link buffer-invisibility-spec))
18741 (while (setq b (text-property-any 0 (length s)
18742 'invisible 'org-link s))
18743 (setq s (concat (substring s 0 b)
18744 (substring s (or (next-single-property-change
18745 b 'invisible s) (length s)))))))
18746 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18747 (setq s (concat (substring s 0 b)
18748 (substring s (or (next-single-property-change
18749 b 'org-cwidth s) (length s))))))
18750 (setq l (string-width s) b -1)
18751 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18752 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18753 l))
18755 (defun org-shorten-string (s maxlength)
18756 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18757 If the string is shorter or has length MAXLENGTH, just return the
18758 original string. If it is longer, the functions finds a space in the
18759 string, breaks this string off at that locations and adds three dots
18760 as ellipsis. Including the ellipsis, the string will not be longer
18761 than MAXLENGTH. If finding a good breaking point in the string does
18762 not work, the string is just chopped off in the middle of a word
18763 if necessary."
18764 (if (<= (length s) maxlength)
18765 s
18766 (let* ((n (max (- maxlength 4) 1))
18768 (if (string-match re s)
18769 (concat (match-string 1 s) "...")
18770 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18772 (defun org-get-indentation (&optional line)
18773 "Get the indentation of the current line, interpreting tabs.
18774 When LINE is given, assume it represents a line and compute its indentation."
18775 (if line
18776 (if (string-match "^ *" (org-remove-tabs line))
18777 (match-end 0))
18778 (save-excursion
18779 (beginning-of-line 1)
18781 (current-column))))
18783 (defun org-get-string-indentation (s)
18784 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18785 (let ((n -1) (i 0) (w tab-width) c)
18786 (catch 'exit
18787 (while (< (setq n (1+ n)) (length s))
18788 (setq c (aref s n))
18789 (cond ((= c ?\ ) (setq i (1+ i)))
18791 (t (throw 'exit t)))))
18792 i))
18794 (defun org-remove-tabs (s &optional width)
18795 "Replace tabulators in S with spaces.
18796 Assumes that s is a single line, starting in column 0."
18797 (setq width (or width tab-width))
18799 (setq s (replace-match
18800 (make-string
18801 (- (* width (/ (+ (match-beginning 0) width) width))
18802 (match-beginning 0)) ?\ )
18803 t t s)))
18804 s)
18806 (defun org-fix-indentation (line ind)
18807 "Fix indentation in LINE.
18808 IND is a cons cell with target and minimum indentation.
18809 If the current indentation in LINE is smaller than the minimum,
18810 leave it alone. If it is larger than ind, set it to the target."
18811 (let* ((l (org-remove-tabs line))
18812 (i (org-get-indentation l))
18813 (i1 (car ind)) (i2 (cdr ind)))
18814 (if (>= i i2) (setq l (substring line i2)))
18815 (if (> i1 0)
18816 (concat (make-string i1 ?\ ) l)
18817 l)))
18819 (defun org-remove-indentation (code &optional n)
18820 "Remove the maximum common indentation from the lines in CODE.
18821 N may optionally be the number of spaces to remove."
18822 (with-temp-buffer
18823 (insert code)
18824 (org-do-remove-indentation n)
18825 (buffer-string)))
18827 (defun org-do-remove-indentation (&optional n)
18828 "Remove the maximum common indentation from the buffer."
18829 (untabify (point-min) (point-max))
18830 (let ((min 10000) re)
18831 (if n
18832 (setq min n)
18833 (goto-char (point-min))
18835 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18836 (unless (or (= min 0) (= min 10000))
18838 (goto-char (point-min))
18839 (while (re-search-forward re nil t)
18840 (replace-match "")
18841 (end-of-line 1))
18842 min)))
18844 (defun org-fill-template (template alist)
18845 "Find each %key of ALIST in TEMPLATE and replace it."
18846 (let ((case-fold-search nil)
18847 entry key value)
18848 (setq alist (sort (copy-sequence alist)
18849 (lambda (a b) (< (length (car a)) (length (car b))))))
18850 (while (setq entry (pop alist))
18851 (setq template
18852 (replace-regexp-in-string
18853 (concat "%" (regexp-quote (car entry)))
18854 (cdr entry) template t t)))
18855 template))
18857 (defun org-base-buffer (buffer)
18858 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18859 (if (not buffer)
18860 buffer
18861 (or (buffer-base-buffer buffer)
18862 buffer)))
18864 (defun org-trim (s)
18865 "Remove whitespace at beginning and end of string."
18868 s)
18870 (defun org-wrap (string &optional width lines)
18871 "Wrap string to either a number of lines, or a width in characters.
18872 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18873 that costs. If there is a word longer than WIDTH, the text is actually
18874 wrapped to the length of that word.
18875 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18876 many lines, whatever width that takes.
18877 The return value is a list of lines, without newlines at the end."
18879 (maxword (apply 'max (mapcar 'org-string-width words)))
18880 w ll)
18881 (cond (width
18882 (org-do-wrap words (max maxword width)))
18883 (lines
18884 (setq w maxword)
18885 (setq ll (org-do-wrap words maxword))
18886 (if (<= (length ll) lines)
18887 ll
18888 (setq ll words)
18889 (while (> (length ll) lines)
18890 (setq w (1+ w))
18891 (setq ll (org-do-wrap words w)))
18892 ll))
18893 (t (error "Cannot wrap this")))))
18895 (defun org-do-wrap (words width)
18896 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18897 (let (lines line)
18898 (while words
18899 (setq line (pop words))
18900 (while (and words (< (+ (length line) (length (car words))) width))
18901 (setq line (concat line " " (pop words))))
18902 (setq lines (push line lines)))
18903 (nreverse lines)))
18905 (defun org-split-string (string &optional separators)
18906 "Splits STRING into substrings at SEPARATORS.
18907 No empty strings are returned if there are matches at the beginning
18908 and end of string."
18910 (start 0)
18911 notfirst
18912 (list nil))
18913 (while (and (string-match rexp string
18914 (if (and notfirst
18915 (= start (match-beginning 0))
18916 (< start (length string)))
18917 (1+ start) start))
18918 (< (match-beginning 0) (length string)))
18919 (setq notfirst t)
18920 (or (eq (match-beginning 0) 0)
18921 (and (eq (match-beginning 0) (match-end 0))
18922 (eq (match-beginning 0) start))
18923 (setq list
18924 (cons (substring string start (match-beginning 0))
18925 list)))
18926 (setq start (match-end 0)))
18927 (or (eq start (length string))
18928 (setq list
18929 (cons (substring string start)
18930 list)))
18931 (nreverse list)))
18933 (defun org-quote-vert (s)
18935 (while (string-match "|" s)
18937 s)
18939 (defun org-uuidgen-p (s)
18940 "Is S an ID created by UUIDGEN?"
18941 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18943 (defun org-context ()
18944 "Return a list of contexts of the current cursor position.
18945 If several contexts apply, all are returned.
18946 Each context entry is a list with a symbol naming the context, and
18947 two positions indicating start and end of the context. Possible
18948 contexts are:
18950 :headline anywhere in a headline
18951 :headline-stars on the leading stars in a headline
18952 :todo-keyword on a TODO keyword (including DONE) in a headline
18953 :tags on the TAGS in a headline
18954 :priority on the priority cookie in a headline
18955 :item on the first line of a plain list item
18956 :item-bullet on the bullet/number of a plain list item
18957 :checkbox on the checkbox in a plain list item
18958 :table in an org-mode table
18959 :table-special on a special filed in a table
18960 :table-table in a table.el table
18961 :link on a hyperlink
18962 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18963 :target on a <<target>>
18964 :radio-target on a <<<radio-target>>>
18965 :latex-fragment on a LaTeX fragment
18966 :latex-preview on a LaTeX fragment with overlayed preview image
18968 This function expects the position to be visible because it uses font-lock
18969 faces as a help to recognize the following contexts: :table-special, :link,
18970 and :keyword."
18971 (let* ((f (get-text-property (point) 'face))
18972 (faces (if (listp f) f (list f)))
18973 (p (point)) clist o)
18974 ;; First the large context
18975 (cond
18976 ((org-on-heading-p t)
18977 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18978 (when (progn
18979 (beginning-of-line 1)
18980 (looking-at org-todo-line-tags-regexp))
18981 (push (org-point-in-group p 1 :headline-stars) clist)
18982 (push (org-point-in-group p 2 :todo-keyword) clist)
18983 (push (org-point-in-group p 4 :tags) clist))
18984 (goto-char p)
18987 (push (org-point-in-group p 0 :priority) clist)))
18989 ((org-at-item-p)
18990 (push (org-point-in-group p 2 :item-bullet) clist)
18991 (push (list :item (point-at-bol)
18992 (save-excursion (org-end-of-item) (point)))
18993 clist)
18994 (and (org-at-item-checkbox-p)
18995 (push (org-point-in-group p 0 :checkbox) clist)))
18997 ((org-at-table-p)
18998 (push (list :table (org-table-begin) (org-table-end)) clist)
18999 (if (memq 'org-formula faces)
19000 (push (list :table-special
19001 (previous-single-property-change p 'face)
19002 (next-single-property-change p 'face)) clist)))
19003 ((org-at-table-p 'any)
19004 (push (list :table-table) clist)))
19005 (goto-char p)
19007 ;; Now the small context
19008 (cond
19009 ((org-at-timestamp-p)
19010 (push (org-point-in-group p 0 :timestamp) clist))
19011 ((memq 'org-link faces)
19012 (push (list :link
19013 (previous-single-property-change p 'face)
19014 (next-single-property-change p 'face)) clist))
19015 ((memq 'org-special-keyword faces)
19016 (push (list :keyword
19017 (previous-single-property-change p 'face)
19018 (next-single-property-change p 'face)) clist))
19019 ((org-on-target-p)
19020 (push (org-point-in-group p 0 :target) clist)
19021 (goto-char (1- (match-beginning 0)))
19022 (if (looking-at org-radio-target-regexp)
19023 (push (org-point-in-group p 0 :radio-target) clist))
19024 (goto-char p))
19025 ((setq o (car (delq nil
19026 (mapcar
19027 (lambda (x)
19028 (if (memq x org-latex-fragment-image-overlays) x))
19029 (overlays-at (point))))))
19030 (push (list :latex-fragment
19031 (overlay-start o) (overlay-end o)) clist)
19032 (push (list :latex-preview
19033 (overlay-start o) (overlay-end o)) clist))
19034 ((org-inside-LaTeX-fragment-p)
19035 ;; FIXME: positions wrong.
19036 (push (list :latex-fragment (point) (point)) clist)))
19038 (setq clist (nreverse (delq nil clist)))
19039 clist))
19041 ;; FIXME: Compare with at-regexp-p Do we need both?
19042 (defun org-in-regexp (re &optional nlines visually)
19043 "Check if point is inside a match of regexp.
19044 Normally only the current line is checked, but you can include NLINES extra
19045 lines both before and after point into the search.
19046 If VISUALLY is set, require that the cursor is not after the match but
19047 really on, so that the block visually is on the match."
19048 (catch 'exit
19049 (let ((pos (point))
19050 (eol (point-at-eol (+ 1 (or nlines 0))))
19051 (inc (if visually 1 0)))
19052 (save-excursion
19053 (beginning-of-line (- 1 (or nlines 0)))
19054 (while (re-search-forward re eol t)
19055 (if (and (<= (match-beginning 0) pos)
19056 (>= (+ inc (match-end 0)) pos))
19057 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19059 (defun org-at-regexp-p (regexp)
19060 "Is point inside a match of REGEXP in the current line?"
19061 (catch 'exit
19062 (save-excursion
19063 (let ((pos (point)) (end (point-at-eol)))
19064 (beginning-of-line 1)
19065 (while (re-search-forward regexp end t)
19066 (if (and (<= (match-beginning 0) pos)
19067 (>= (match-end 0) pos))
19068 (throw 'exit t)))
19069 nil))))
19071 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19072 "Non-nil when point is between matches of START-RE and END-RE.
19074 Also return a non-nil value when point is on one of the matches.
19076 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19077 buffer positions. Default values are the positions of headlines
19078 surrounding the point.
19080 The functions returns a cons cell whose car (resp. cdr) is the
19081 position before START-RE (resp. after END-RE)."
19082 (save-match-data
19083 (let ((pos (point))
19084 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19085 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19086 beg end)
19087 (save-excursion
19088 ;; Point is on a block when on START-RE or if START-RE can be
19089 ;; found before it...
19090 (and (or (org-at-regexp-p start-re)
19091 (re-search-backward start-re limit-up t))
19092 (setq beg (match-beginning 0))
19093 ;; ... and END-RE after it...
19094 (goto-char (match-end 0))
19095 (re-search-forward end-re limit-down t)
19096 (> (setq end (match-end 0)) pos)
19097 ;; ... without another START-RE in-between.
19098 (goto-char (match-beginning 0))
19099 (not (re-search-backward start-re pos t))
19100 ;; Return value.
19101 (cons beg end))))))
19103 (defun org-in-block-p (names)
19104 "Is point inside any block whose name belongs to NAMES?
19106 NAMES is a list of strings containing names of blocks."
19107 (save-match-data
19108 (catch 'exit
19109 (let ((case-fold-search t)
19110 (lim-up (save-excursion (outline-previous-heading)))
19111 (lim-down (save-excursion (outline-next-heading))))
19112 (mapc (lambda (name)
19113 (let ((n (regexp-quote name)))
19114 (when (org-between-regexps-p
19117 lim-up lim-down)
19118 (throw 'exit t))))
19119 names))
19120 nil)))
19122 (defun org-occur-in-agenda-files (regexp &optional nlines)
19123 "Call `multi-occur' with buffers for all agenda files."
19125 (let* ((files (org-agenda-files))
19126 (tnames (mapcar 'file-truename files))
19127 (extra org-agenda-text-search-extra-files)
19128 f)
19129 (when (eq (car extra) 'agenda-archives)
19130 (setq extra (cdr extra))
19131 (setq files (org-add-archive-files files)))
19132 (while (setq f (pop extra))
19133 (unless (member (file-truename f) tnames)
19134 (add-to-list 'files f 'append)
19135 (add-to-list 'tnames (file-truename f) 'append)))
19136 (multi-occur
19137 (mapcar (lambda (x)
19138 (with-current-buffer
19139 (or (get-file-buffer x) (find-file-noselect x))
19140 (widen)
19141 (current-buffer)))
19142 files)
19143 regexp)))
19145 (if (boundp 'occur-mode-find-occurrence-hook)
19146 ;; Emacs 23
19147 (add-hook 'occur-mode-find-occurrence-hook
19148 (lambda ()
19149 (when (org-mode-p)
19150 (org-reveal))))
19151 ;; Emacs 22
19152 (defadvice occur-mode-goto-occurrence
19153 (after org-occur-reveal activate)
19154 (and (org-mode-p) (org-reveal)))
19155 (defadvice occur-mode-goto-occurrence-other-window
19156 (after org-occur-reveal activate)
19157 (and (org-mode-p) (org-reveal)))
19158 (defadvice occur-mode-display-occurrence
19159 (after org-occur-reveal activate)
19160 (when (org-mode-p)
19161 (let ((pos (occur-mode-find-occurrence)))
19162 (with-current-buffer (marker-buffer pos)
19163 (save-excursion
19164 (goto-char pos)
19165 (org-reveal)))))))
19167 (defun org-occur-link-in-agenda-files ()
19168 "Create a link and search for it in the agendas.
19169 The link is not stored in `org-stored-links', it is just created
19170 for the search purpose."
19171 (interactive)
19172 (let ((link (condition-case nil
19173 (org-store-link nil)
19174 (error "Unable to create a link to here"))))
19175 (org-occur-in-agenda-files (regexp-quote link))))
19177 (defun org-uniquify (list)
19178 "Remove duplicate elements from LIST."
19179 (let (res)
19180 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19181 res))
19183 (defun org-delete-all (elts list)
19184 "Remove all elements in ELTS from LIST."
19185 (while elts
19186 (setq list (delete (pop elts) list)))
19187 list)
19189 (defun org-count (cl-item cl-seq)
19190 "Count the number of occurrences of ITEM in SEQ.
19191 Taken from `count' in cl-seq.el with all keyword arguments removed."
19192 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19193 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19194 (while (< cl-start cl-end)
19195 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19196 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19197 (setq cl-start (1+ cl-start)))
19198 cl-count))
19200 (defun org-remove-if (predicate seq)
19201 "Remove everything from SEQ that fulfills PREDICATE."
19202 (let (res e)
19203 (while seq
19204 (setq e (pop seq))
19205 (if (not (funcall predicate e)) (push e res)))
19206 (nreverse res)))
19208 (defun org-remove-if-not (predicate seq)
19209 "Remove everything from SEQ that does not fulfill PREDICATE."
19210 (let (res e)
19211 (while seq
19212 (setq e (pop seq))
19213 (if (funcall predicate e) (push e res)))
19214 (nreverse res)))
19216 (defun org-back-over-empty-lines ()
19217 "Move backwards over whitespace, to the beginning of the first empty line.
19218 Returns the number of empty lines passed."
19219 (let ((pos (point)))
19220 (if (cdr (assoc 'heading org-blank-before-new-entry))
19222 (unless (eobp)
19223 (forward-line -1)))
19224 (beginning-of-line 2)
19225 (goto-char (min (point) pos))
19226 (count-lines (point) pos)))
19228 (defun org-skip-whitespace ()
19231 (defun org-point-in-group (point group &optional context)
19232 "Check if POINT is in match-group GROUP.
19233 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19234 match. If the match group does not exist or point is not inside it,
19235 return nil."
19236 (and (match-beginning group)
19237 (>= point (match-beginning group))
19238 (<= point (match-end group))
19239 (if context
19240 (list context (match-beginning group) (match-end group))
19241 t)))
19243 (defun org-switch-to-buffer-other-window (&rest args)
19244 "Switch to buffer in a second window on the current frame.
19245 In particular, do not allow pop-up frames.
19246 Returns the newly created buffer."
19247 (let (pop-up-frames special-display-buffer-names special-display-regexps
19248 special-display-function)
19249 (apply 'switch-to-buffer-other-window args)))
19251 (defun org-combine-plists (&rest plists)
19252 "Create a single property list from all plists in PLISTS.
19253 The process starts by copying the first list, and then setting properties
19254 from the other lists. Settings in the last list are the most significant
19255 ones and overrule settings in the other lists."
19256 (let ((rtn (copy-sequence (pop plists)))
19257 p v ls)
19258 (while plists
19259 (setq ls (pop plists))
19260 (while ls
19261 (setq p (pop ls) v (pop ls))
19262 (setq rtn (plist-put rtn p v))))
19263 rtn))
19265 (defun org-move-line-down (arg)
19266 "Move the current line down. With prefix argument, move it past ARG lines."
19267 (interactive "p")
19268 (let ((col (current-column))
19269 beg end pos)
19270 (beginning-of-line 1) (setq beg (point))
19271 (beginning-of-line 2) (setq end (point))
19272 (beginning-of-line (+ 1 arg))
19273 (setq pos (move-marker (make-marker) (point)))
19274 (insert (delete-and-extract-region beg end))
19275 (goto-char pos)
19276 (org-move-to-column col)))
19278 (defun org-move-line-up (arg)
19279 "Move the current line up. With prefix argument, move it past ARG lines."
19280 (interactive "p")
19281 (let ((col (current-column))
19282 beg end pos)
19283 (beginning-of-line 1) (setq beg (point))
19284 (beginning-of-line 2) (setq end (point))
19285 (beginning-of-line (- arg))
19286 (setq pos (move-marker (make-marker) (point)))
19287 (insert (delete-and-extract-region beg end))
19288 (goto-char pos)
19289 (org-move-to-column col)))
19291 (defun org-replace-escapes (string table)
19292 "Replace %-escapes in STRING with values in TABLE.
19294 The sequences in STRING may contain normal field width and padding information,
19296 so values can contain further %-escapes if they are define later in TABLE."
19297 (let ((tbl (copy-alist table))
19298 (case-fold-search nil)
19299 (pchg 0)
19300 e re rpl)
19301 (while (setq e (pop tbl))
19302 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19303 (when (and (cdr e) (string-match re (cdr e)))
19304 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19305 (safe "SREF"))
19306 (add-text-properties 0 3 (list 'sref sref) safe)
19307 (setcdr e (replace-match safe t t (cdr e)))))
19308 (while (string-match re string)
19309 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19310 (cdr e)))
19311 (setq string (replace-match rpl t t string))))
19312 (while (setq pchg (next-property-change pchg string))
19313 (let ((sref (get-text-property pchg 'sref string)))
19314 (when (and sref (string-match "SREF" string pchg))
19315 (setq string (replace-match sref t t string)))))
19316 string))
19318 (defun org-sublist (list start end)
19319 "Return a section of LIST, from START to END.
19320 Counting starts at 1."
19321 (let (rtn (c start))
19322 (setq list (nthcdr (1- start) list))
19323 (while (and list (<= c end))
19324 (push (pop list) rtn)
19325 (setq c (1+ c)))
19326 (nreverse rtn)))
19328 (defun org-find-base-buffer-visiting (file)
19329 "Like `find-buffer-visiting' but always return the base buffer and
19330 not an indirect buffer."
19331 (let ((buf (or (get-file-buffer file)
19332 (find-buffer-visiting file))))
19333 (if buf
19334 (or (buffer-base-buffer buf) buf)
19335 nil)))
19337 (defun org-image-file-name-regexp (&optional extensions)
19338 "Return regexp matching the file names of images.
19339 If EXTENSIONS is given, only match these."
19340 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19341 (image-file-name-regexp)
19342 (let ((image-file-name-extensions
19343 (or extensions
19344 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19345 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19347 (regexp-opt (nconc (mapcar 'upcase
19348 image-file-name-extensions)
19349 image-file-name-extensions)
19350 t)
19353 (defun org-file-image-p (file &optional extensions)
19354 "Return non-nil if FILE is an image."
19355 (save-match-data
19356 (string-match (org-image-file-name-regexp extensions) file)))
19358 (defun org-get-cursor-date ()
19359 "Return the date at cursor in as a time.
19360 This works in the calendar and in the agenda, anywhere else it just
19361 returns the current time."
19362 (let (date day defd)
19363 (cond
19364 ((eq major-mode 'calendar-mode)
19365 (setq date (calendar-cursor-to-date)
19366 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19367 ((eq major-mode 'org-agenda-mode)
19368 (setq day (get-text-property (point) 'day))
19369 (if day
19370 (setq date (calendar-gregorian-from-absolute day)
19371 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19372 (nth 2 date))))))
19373 (or defd (current-time))))
19375 (defvar org-agenda-action-marker (make-marker)
19376 "Marker pointing to the entry for the next agenda action.")
19378 (defun org-mark-entry-for-agenda-action ()
19379 "Mark the current entry as target of an agenda action.
19380 Agenda actions are actions executed from the agenda with the key `k',
19381 which make use of the date at the cursor."
19382 (interactive)
19383 (move-marker org-agenda-action-marker
19384 (save-excursion (org-back-to-heading t) (point))
19385 (current-buffer))
19386 (message
19387 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19389 (defun org-mark-subtree ()
19390 "Mark the current subtree.
19391 This puts point at the start of the current subtree, and mark at the end.
19393 If point is in an inline task, mark that task instead."
19394 (interactive)
19395 (let ((inline-task-p
19396 (and (featurep 'org-inlinetask)
19397 (org-inlinetask-in-task-p)))
19398 (beg))
19399 ;; Get beginning of subtree
19400 (cond
19401 (inline-task-p (org-inlinetask-goto-beginning))
19402 ((org-at-heading-p) (beginning-of-line))
19403 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19404 (setq beg (point))
19405 ;; Get end of it
19406 (if inline-task-p
19407 (org-inlinetask-goto-end)
19408 (org-end-of-subtree))
19409 ;; Mark zone
19410 (push-mark (point) nil t)
19411 (goto-char beg)))
19413 ;;; Paragraph filling stuff.
19414 ;; We want this to be just right, so use the full arsenal.
19416 (defun org-indent-line-function ()
19417 "Indent line depending on context."
19418 (interactive)
19419 (let* ((pos (point))
19420 (itemp (org-at-item-p))
19421 (case-fold-search t)
19423 (inline-task-p (and (featurep 'org-inlinetask)
19424 (org-inlinetask-in-task-p)))
19425 (inline-re (and inline-task-p
19426 (org-inlinetask-outline-regexp)))
19427 column)
19428 (beginning-of-line 1)
19429 (cond
19430 ;; Comments
19431 ((looking-at "# ") (setq column 0))
19432 ;; Headings
19433 ((looking-at org-outline-regexp) (setq column 0))
19434 ;; Included files
19436 ;; Footnote definition
19437 ((looking-at org-footnote-definition-re) (setq column 0))
19438 ;; Literal examples
19440 (setq column (org-get-indentation))) ; do nothing
19441 ;; Lists
19442 ((ignore-errors (goto-char (org-in-item-p)))
19443 (setq column (if itemp
19444 (org-get-indentation)
19445 (org-list-item-body-column (point))))
19446 (goto-char pos))
19447 ;; Drawers
19449 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19450 (save-excursion
19451 (goto-char (1- (match-beginning 1)))
19452 (setq column (current-column))))
19453 ;; Special blocks
19455 (save-excursion
19456 (re-search-backward
19458 (setq column (org-get-indentation (match-string 0))))
19461 (save-excursion
19463 (setq column
19464 (cond ((equal (downcase (match-string 1)) "src")
19465 ;; src blocks: let `org-edit-src-exit' handle them
19466 (org-get-indentation))
19467 ((equal (downcase (match-string 1)) "example")
19468 (max (org-get-indentation)
19469 (org-get-indentation (match-string 0))))
19470 (t
19471 (org-get-indentation (match-string 0))))))
19472 ;; This line has nothing special, look at the previous relevant
19473 ;; line to compute indentation
19474 (t
19475 (beginning-of-line 0)
19476 (while (and (not (bobp))
19477 (not (looking-at org-drawer-regexp))
19478 ;; When point started in an inline task, do not move
19479 ;; above task starting line.
19480 (not (and inline-task-p (looking-at inline-re)))
19481 ;; Skip drawers, blocks, empty lines, verbatim,
19482 ;; comments, tables, footnotes definitions, lists,
19483 ;; inline tasks.
19485 (re-search-backward org-drawer-regexp nil t))
19489 (looking-at org-footnote-definition-re)
19490 (and (ignore-errors (goto-char (org-in-item-p)))
19491 (goto-char
19492 (org-list-get-top-point (org-list-struct))))
19493 (and (not inline-task-p)
19494 (featurep 'org-inlinetask)
19495 (org-inlinetask-in-task-p)
19496 (or (org-inlinetask-goto-beginning) t))))
19497 (beginning-of-line 0))
19498 (cond
19499 ;; There was an heading above.
19501 (if (not org-adapt-indentation)
19502 (setq column 0)
19503 (goto-char (match-end 0))
19504 (setq column (current-column))))
19505 ;; A drawer had started and is unfinished
19506 ((looking-at org-drawer-regexp)
19507 (goto-char (1- (match-beginning 1)))
19508 (setq column (current-column)))
19509 ;; Else, nothing noticeable found: get indentation and go on.
19510 (t (setq column (org-get-indentation))))))
19511 ;; Now apply indentation and move cursor accordingly
19512 (goto-char pos)
19513 (if (<= (current-column) (current-indentation))
19514 (org-indent-line-to column)
19515 (save-excursion (org-indent-line-to column)))
19516 ;; Special polishing for properties, see `org-property-format'
19517 (setq column (current-column))
19518 (beginning-of-line 1)
19519 (if (looking-at
19521 (replace-match (concat (match-string 1)
19522 (format org-property-format
19523 (match-string 2) (match-string 3)))
19524 t t))
19525 (org-move-to-column column)))
19527 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19528 "Variable to store copy of `adaptive-fill-regexp'.
19529 Since `adaptive-fill-regexp' is set to never match, we need to
19530 store a backup of its value before entering `org-mode' so that
19531 the functionality can be provided as a fall-back.")
19533 (defun org-set-autofill-regexps ()
19534 (interactive)
19535 ;; In the paragraph separator we include headlines, because filling
19536 ;; text in a line directly attached to a headline would otherwise
19537 ;; fill the headline as well.
19540 ;; The paragraph starter includes hand-formatted lists.
19541 (org-set-local
19542 'paragraph-start
19543 (concat
19552 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19553 ;; But only if the user has not turned off tables or fixed-width regions
19554 (org-set-local
19555 'auto-fill-inhibit-regexp
19556 (concat org-outline-regexp
19559 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19560 (concat
19562 (if org-enable-table-editor "|" "")
19563 (if org-enable-fixed-width-editor ":" "")
19564 "]"))))
19565 ;; We use our own fill-paragraph function, to make sure that tables
19566 ;; and fixed-width regions are not wrapped. That function will pass
19567 ;; through to `fill-paragraph' when appropriate.
19568 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19569 ;; Prevent auto-fill from inserting unwanted new items.
19570 (org-set-local 'fill-nobreak-predicate
19571 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19572 fill-nobreak-predicate
19573 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19574 ;; Adaptive filling: To get full control, first make sure that
19575 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19576 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19577 (org-set-local 'org-adaptive-fill-regexp-backup
19578 adaptive-fill-regexp))
19580 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19581 (org-set-local 'adaptive-fill-function
19582 'org-adaptive-fill-function)
19583 (org-set-local
19584 'align-mode-rules-list
19585 '((org-in-buffer-settings
19587 (modes . '(org-mode))))))
19589 (defun org-fill-item-nobreak-p ()
19590 "Non-nil when a line break at point would insert a new item."
19591 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19593 (defun org-fill-paragraph (&optional justify)
19594 "Re-align a table, pass through to fill-paragraph if no table."
19595 (let ((table-p (org-at-table-p))
19596 (table.el-p (org-at-table.el-p))
19597 (itemp (org-in-item-p)))
19598 (cond ((and (equal (char-after (point-at-bol)) ?*)
19599 (save-excursion (goto-char (point-at-bol))
19600 (looking-at org-outline-regexp)))
19601 t) ; skip headlines
19602 (table.el-p t) ; skip table.el tables
19603 (table-p (org-table-align) t) ; align Org tables
19604 (itemp ; align text in items
19605 (let* ((struct (save-excursion (goto-char itemp)
19606 (org-list-struct)))
19607 (parents (org-list-parents-alist struct))
19608 (children (org-list-get-children itemp struct parents))
19609 beg end prev next prefix)
19610 ;; Determine in which part of item point is: before
19611 ;; first child, after last child, between two
19612 ;; sub-lists, or simply in item if there's no child.
19613 (cond
19614 ((not children)
19615 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19616 beg itemp
19617 end (org-list-get-item-end itemp struct)))
19618 ((< (point) (setq next (car children)))
19619 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19620 beg itemp
19621 end next))
19622 ((> (point) (setq prev (car (last children))))
19623 (setq beg (org-list-get-item-end prev struct)
19624 end (org-list-get-item-end itemp struct)
19625 prefix (save-excursion
19626 (goto-char beg)
19628 (make-string (current-column) ?\ ))))
19629 (t (catch 'exit
19630 (while (setq next (pop children))
19631 (if (> (point) next)
19632 (setq prev next)
19633 (setq beg (org-list-get-item-end prev struct)
19634 end next
19635 prefix (save-excursion
19636 (goto-char beg)
19638 (make-string (current-column) ?\ )))
19639 (throw 'exit nil))))))
19640 ;; Use `fill-paragraph' with buffer narrowed to item
19641 ;; without any child, and with our computed PREFIX.
19642 (flet ((fill-context-prefix (from to &optional flr) prefix))
19643 (save-restriction
19644 (narrow-to-region beg end)
19645 (save-excursion (fill-paragraph justify)))) t))
19646 ;; Special case where point is not in a list but is on
19647 ;; a paragraph adjacent to a list: make sure this paragraph
19648 ;; doesn't get merged with the end of the list by narrowing
19649 ;; buffer first.
19650 ((save-excursion (forward-paragraph -1)
19651 (setq itemp (org-in-item-p)))
19652 (let ((struct (save-excursion (goto-char itemp)
19653 (org-list-struct))))
19654 (save-restriction
19655 (narrow-to-region (org-list-get-bottom-point struct)
19656 (save-excursion (forward-paragraph 1)
19657 (point)))
19658 (fill-paragraph justify) t)))
19659 ;; Else simply call `fill-paragraph'.
19660 (t nil))))
19662 ;; For reference, this is the default value of adaptive-fill-regexp
19665 (defun org-adaptive-fill-function ()
19666 "Return a fill prefix for org-mode files."
19667 (let (itemp)
19668 (save-excursion
19669 (cond
19670 ;; Comment line
19672 (match-string-no-properties 0))
19673 ;; Plain list item
19674 ((org-at-item-p)
19675 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19676 ;; Point is in a list after `backward-paragraph': original
19677 ;; point wasn't in the list, or filling would have been taken
19678 ;; care of by `org-auto-fill-function', but the list and the
19679 ;; real paragraph are not separated by a blank line. Thus, move
19680 ;; point after the list to go back to real paragraph and
19681 ;; determine fill-prefix.
19682 ((setq itemp (org-in-item-p))
19683 (goto-char itemp)
19684 (let* ((struct (org-list-struct))
19685 (bottom (org-list-get-bottom-point struct)))
19686 (goto-char bottom)
19687 (make-string (org-get-indentation) ?\ )))
19688 ;; Other text
19689 ((looking-at org-adaptive-fill-regexp-backup)
19690 (match-string-no-properties 0))))))
19692 (defun org-auto-fill-function ()
19693 "Auto-fill function."
19694 (let (itemp prefix)
19695 ;; When in a list, compute an appropriate fill-prefix and make
19696 ;; sure it will be used by `do-auto-fill'.
19697 (if (setq itemp (org-in-item-p))
19698 (progn
19699 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19700 (flet ((fill-context-prefix (from to &optional flr) prefix))
19701 (do-auto-fill)))
19702 ;; Else just use `do-auto-fill'.
19703 (do-auto-fill))))
19705 ;;; Other stuff.
19707 (defun org-toggle-fixed-width-section (arg)
19708 "Toggle the fixed-width export.
19709 If there is no active region, the QUOTE keyword at the current headline is
19710 inserted or removed. When present, it causes the text between this headline
19711 and the next to be exported as fixed-width text, and unmodified.
19712 If there is an active region, this command adds or removes a colon as the
19713 first character of this line. If the first character of a line is a colon,
19714 this line is also exported in fixed-width font."
19715 (interactive "P")
19716 (let* ((cc 0)
19717 (regionp (org-region-active-p))
19718 (beg (if regionp (region-beginning) (point)))
19719 (end (if regionp (region-end)))
19720 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19721 (case-fold-search nil)
19723 off)
19724 (if regionp
19725 (save-excursion
19726 (goto-char beg)
19727 (setq cc (current-column))
19728 (beginning-of-line 1)
19729 (setq off (looking-at re))
19730 (while (> nlines 0)
19731 (setq nlines (1- nlines))
19732 (beginning-of-line 1)
19733 (cond
19734 (arg
19735 (org-move-to-column cc t)
19737 (forward-line -1))
19738 ((and off (looking-at re))
19739 (replace-match "" t t nil 1))
19740 ((not off) (org-move-to-column cc t) (insert ": ")))
19741 (forward-line 1)))
19742 (save-excursion
19743 (org-back-to-heading)
19744 (if (looking-at (concat org-outline-regexp
19746 (replace-match "" t t nil 1)
19747 (if (looking-at org-outline-regexp)
19748 (progn
19749 (goto-char (match-end 0))
19750 (insert org-quote-string " "))))))))
19752 (defun org-reftex-citation ()
19753 "Use reftex-citation to insert a citation into the buffer.
19754 This looks for a line like
19756 #+BIBLIOGRAPHY: foo plain option:-d
19758 and derives from it that foo.bib is the bibliography file relevant
19759 for this document. It then installs the necessary environment for RefTeX
19760 to work in this buffer and calls `reftex-citation' to insert a citation
19761 into the buffer.
19763 Export of such citations to both LaTeX and HTML is handled by the contributed
19764 package org-exp-bibtex by Taru Karttunen."
19765 (interactive)
19766 (let ((reftex-docstruct-symbol 'rds)
19768 rds bib)
19769 (save-excursion
19770 (save-restriction
19771 (widen)
19772 (let ((case-fold-search t)
19774 (if (not (save-excursion
19775 (or (re-search-forward re nil t)
19776 (re-search-backward re nil t))))
19777 (error "No bibliography defined in file")
19778 (setq bib (concat (match-string 1) ".bib")
19779 rds (list (list 'bib bib)))))))
19780 (call-interactively 'reftex-citation)))
19782 ;;;; Functions extending outline functionality
19784 (defun org-beginning-of-line (&optional arg)
19785 "Go to the beginning of the current line. If that is invisible, continue
19786 to a visible line beginning. This makes the function of C-a more intuitive.
19787 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19788 first attempt, and only move to after the tags when the cursor is already
19789 beyond the end of the headline."
19790 (interactive "P")
19791 (let ((pos (point))
19792 (special (if (consp org-special-ctrl-a/e)
19793 (car org-special-ctrl-a/e)
19794 org-special-ctrl-a/e))
19795 refpos)
19796 (if (org-bound-and-true-p line-move-visual)
19797 (beginning-of-visual-line 1)
19798 (beginning-of-line 1))
19799 (if (and arg (fboundp 'move-beginning-of-line))
19800 (call-interactively 'move-beginning-of-line)
19801 (if (bobp)
19802 nil
19803 (backward-char 1)
19804 (if (org-truely-invisible-p)
19805 (while (and (not (bobp)) (org-truely-invisible-p))
19806 (backward-char 1)
19807 (beginning-of-line 1))
19808 (forward-char 1))))
19809 (when special
19810 (cond
19811 ((and (looking-at org-complex-heading-regexp)
19812 (= (char-after (match-end 1)) ?\ ))
19813 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19814 (point-at-eol)))
19815 (goto-char
19816 (if (eq special t)
19817 (cond ((> pos refpos) refpos)
19818 ((= pos (point)) refpos)
19819 (t (point)))
19820 (cond ((> pos (point)) (point))
19821 ((not (eq last-command this-command)) (point))
19822 (t refpos)))))
19823 ((org-at-item-p)
19824 (goto-char
19825 (if (eq special t)
19826 (cond ((> pos (match-end 0)) (match-end 0))
19827 ((= pos (point)) (match-end 0))
19828 (t (point)))
19829 (cond ((> pos (point)) (point))
19830 ((not (eq last-command this-command)) (point))
19831 (t (match-end 0))))))))
19832 (org-no-warnings
19833 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19835 (defun org-end-of-line (&optional arg)
19836 "Go to the end of the line.
19837 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19838 first attempt, and only move to after the tags when the cursor is already
19839 beyond the end of the headline."
19840 (interactive "P")
19841 (let ((special (if (consp org-special-ctrl-a/e)
19842 (cdr org-special-ctrl-a/e)
19843 org-special-ctrl-a/e)))
19844 (if (or (not special)
19845 (not (org-on-heading-p))
19846 arg)
19847 (call-interactively
19848 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19849 ((fboundp 'move-end-of-line) 'move-end-of-line)
19850 (t 'end-of-line)))
19851 (let ((pos (point)))
19852 (beginning-of-line 1)
19854 (if (eq special t)
19855 (if (or (< pos (match-beginning 1))
19856 (= pos (match-end 0)))
19857 (goto-char (match-beginning 1))
19858 (goto-char (match-end 0)))
19859 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19860 (goto-char (match-end 0))
19861 (goto-char (match-beginning 1))))
19862 (call-interactively (if (fboundp 'move-end-of-line)
19863 'move-end-of-line
19864 'end-of-line)))))
19865 (org-no-warnings
19866 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19868 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19869 (define-key org-mode-map "\C-e" 'org-end-of-line)
19871 (defun org-backward-sentence (&optional arg)
19872 "Go to beginning of sentence, or beginning of table field.
19873 This will call `backward-sentence' or `org-table-beginning-of-field',
19874 depending on context."
19875 (interactive "P")
19876 (cond
19877 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19878 (t (call-interactively 'backward-sentence))))
19880 (defun org-forward-sentence (&optional arg)
19881 "Go to end of sentence, or end of table field.
19882 This will call `forward-sentence' or `org-table-end-of-field',
19883 depending on context."
19884 (interactive "P")
19885 (cond
19886 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19887 (t (call-interactively 'forward-sentence))))
19889 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19890 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19892 (defun org-kill-line (&optional arg)
19893 "Kill line, to tags or end of line."
19894 (interactive "P")
19895 (cond
19896 ((or (not org-special-ctrl-k)
19897 (bolp)
19898 (not (org-on-heading-p)))
19899 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19900 org-ctrl-k-protect-subtree)
19901 (if (or (eq org-ctrl-k-protect-subtree 'error)
19902 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19903 (error "C-k aborted - would kill hidden subtree")))
19904 (call-interactively 'kill-line))
19906 (kill-region (point) (match-beginning 1))
19907 (org-set-tags nil t))
19908 (t (kill-region (point) (point-at-eol)))))
19910 (define-key org-mode-map "\C-k" 'org-kill-line)
19912 (defun org-yank (&optional arg)
19913 "Yank. If the kill is a subtree, treat it specially.
19914 This command will look at the current kill and check if is a single
19915 subtree, or a series of subtrees[1]. If it passes the test, and if the
19916 cursor is at the beginning of a line or after the stars of a currently
19917 empty headline, then the yank is handled specially. How exactly depends
19918 on the value of the following variables, both set by default.
19920 org-yank-folded-subtrees
19921 When set, the subtree(s) will be folded after insertion, but only
19922 if doing so would now swallow text after the yanked text.
19924 org-yank-adjusted-subtrees
19925 When set, the subtree will be promoted or demoted in order to
19926 fit into the local outline tree structure, which means that the level
19927 will be adjusted so that it becomes the smaller one of the two
19928 *visible* surrounding headings.
19930 Any prefix to this command will cause `yank' to be called directly with
19932 will just
19933 plainly yank the text as it is.
19935 \[1] The test checks if the first non-white line is a heading
19936 and if there are no other headings with fewer stars."
19937 (interactive "P")
19938 (org-yank-generic 'yank arg))
19940 (defun org-yank-generic (command arg)
19941 "Perform some yank-like command.
19943 This function implements the behavior described in the `org-yank'
19944 documentation. However, it has been generalized to work for any
19945 interactive command with similar behavior."
19947 ;; pretend to be command COMMAND
19948 (setq this-command command)
19950 (if arg
19951 (call-interactively command)
19953 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19954 (and (org-kill-is-subtree-p)
19955 (or (bolp)
19957 (string-match
19959 (buffer-substring (point-at-bol) (point)))))))
19960 swallowp)
19961 (cond
19962 ((and subtreep org-yank-folded-subtrees)
19963 (let ((beg (point))
19964 end)
19965 (if (and subtreep org-yank-adjusted-subtrees)
19966 (org-paste-subtree nil nil 'for-yank)
19967 (call-interactively command))
19969 (setq end (point))
19970 (goto-char beg)
19971 (when (and (bolp) subtreep
19972 (not (setq swallowp
19973 (org-yank-folding-would-swallow-text beg end))))
19974 (org-with-limited-levels
19975 (or (looking-at org-outline-regexp)
19976 (re-search-forward org-outline-regexp-bol end t))
19977 (while (and (< (point) end) (looking-at org-outline-regexp))
19978 (hide-subtree)
19979 (org-cycle-show-empty-lines 'folded)
19980 (condition-case nil
19981 (outline-forward-same-level 1)
19982 (error (goto-char end))))))
19983 (when swallowp
19984 (message
19985 "Inserted text not folded because that would swallow text"))
19987 (goto-char end)
19989 (beginning-of-line 1)
19990 (push-mark beg 'nomsg)))
19991 ((and subtreep org-yank-adjusted-subtrees)
19992 (let ((beg (point-at-bol)))
19993 (org-paste-subtree nil nil 'for-yank)
19994 (push-mark beg 'nomsg)))
19995 (t
19996 (call-interactively command))))))
19998 (defun org-yank-folding-would-swallow-text (beg end)
19999 "Would hide-subtree at BEG swallow any text after END?"
20000 (let (level)
20001 (org-with-limited-levels
20002 (save-excursion
20003 (goto-char beg)
20004 (when (or (looking-at org-outline-regexp)
20005 (re-search-forward org-outline-regexp-bol end t))
20006 (setq level (org-outline-level)))
20007 (goto-char end)
20009 (if (or (eobp)
20010 (and (bolp) (looking-at org-outline-regexp)
20011 (<= (org-outline-level) level)))
20012 nil ; Nothing would be swallowed
20013 t))))) ; something would swallow
20015 (define-key org-mode-map "\C-y" 'org-yank)
20017 (defun org-truely-invisible-p ()
20018 "Check if point is at a character currently not visible.
20019 This version does not only check the character property, but also
20020 `visible-mode'."
20021 ;; Early versions of noutline don't have `outline-invisible-p'.
20022 (if (org-bound-and-true-p visible-mode)
20023 nil
20024 (outline-invisible-p)))
20026 (defun org-invisible-p2 ()
20027 "Check if point is at a character currently not visible."
20028 (save-excursion
20029 (if (and (eolp) (not (bobp))) (backward-char 1))
20030 ;; Early versions of noutline don't have `outline-invisible-p'.
20031 (outline-invisible-p)))
20033 (defun org-back-to-heading (&optional invisible-ok)
20034 "Call `outline-back-to-heading', but provide a better error message."
20035 (condition-case nil
20036 (outline-back-to-heading invisible-ok)
20037 (error (error "Before first headline at position %d in buffer %s"
20038 (point) (current-buffer)))))
20040 (defun org-beginning-of-defun ()
20041 "Go to the beginning of the subtree, i.e. back to the heading."
20042 (org-back-to-heading))
20043 (defun org-end-of-defun ()
20044 "Go to the end of the subtree."
20045 (org-end-of-subtree nil t))
20047 (defun org-before-first-heading-p ()
20048 "Before first heading?"
20049 (save-excursion
20050 (end-of-line)
20051 (null (re-search-backward org-outline-regexp-bol nil t))))
20053 (defun org-on-heading-p (&optional ignored)
20054 (outline-on-heading-p t))
20055 (defun org-at-heading-p (&optional ignored)
20056 (outline-on-heading-p t))
20058 (defun org-point-at-end-of-empty-headline ()
20059 "If point is at the end of an empty headline, return t, else nil.
20060 If the heading only contains a TODO keyword, it is still still considered
20061 empty."
20063 (save-excursion
20064 (beginning-of-line 1)
20065 (let ((case-fold-search nil))
20068 (defun org-at-heading-or-item-p ()
20069 (or (org-on-heading-p) (org-at-item-p)))
20071 (defun org-on-target-p ()
20072 (or (org-in-regexp org-radio-target-regexp)
20073 (org-in-regexp org-target-regexp)))
20075 (defun org-up-heading-all (arg)
20076 "Move to the heading line of which the present line is a subheading.
20077 This function considers both visible and invisible heading lines.
20078 With argument, move up ARG levels."
20079 (if (fboundp 'outline-up-heading-all)
20080 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20081 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20083 (defun org-up-heading-safe ()
20084 "Move to the heading line of which the present line is a subheading.
20085 This version will not throw an error. It will return the level of the
20086 headline found, or nil if no higher level is found.
20088 Also, this function will be a lot faster than `outline-up-heading',
20089 because it relies on stars being the outline starters. This can really
20090 make a significant difference in outlines with very many siblings."
20091 (let (start-level re)
20092 (org-back-to-heading t)
20093 (setq start-level (funcall outline-level))
20094 (if (equal start-level 1)
20095 nil
20097 (if (re-search-backward re nil t)
20098 (funcall outline-level)))))
20100 (defun org-first-sibling-p ()
20101 "Is this heading the first child of its parents?"
20102 (interactive)
20103 (let ((re org-outline-regexp-bol)
20104 level l)
20105 (unless (org-at-heading-p t)
20106 (error "Not at a heading"))
20107 (setq level (funcall outline-level))
20108 (save-excursion
20109 (if (not (re-search-backward re nil t))
20110 t
20111 (setq l (funcall outline-level))
20112 (< l level)))))
20114 (defun org-goto-sibling (&optional previous)
20115 "Goto the next sibling, even if it is invisible.
20116 When PREVIOUS is set, go to the previous sibling instead. Returns t
20117 when a sibling was found. When none is found, return nil and don't
20118 move point."
20119 (let ((fun (if previous 're-search-backward 're-search-forward))
20120 (pos (point))
20121 (re org-outline-regexp-bol)
20122 level l)
20123 (when (condition-case nil (org-back-to-heading t) (error nil))
20124 (setq level (funcall outline-level))
20125 (catch 'exit
20126 (or previous (forward-char 1))
20127 (while (funcall fun re nil t)
20128 (setq l (funcall outline-level))
20129 (when (< l level) (goto-char pos) (throw 'exit nil))
20130 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20131 (goto-char pos)
20132 nil))))
20134 (defun org-show-siblings ()
20135 "Show all siblings of the current headline."
20136 (save-excursion
20137 (while (org-goto-sibling) (org-flag-heading nil)))
20138 (save-excursion
20139 (while (org-goto-sibling 'previous)
20140 (org-flag-heading nil))))
20142 (defun org-goto-first-child ()
20143 "Goto the first child, even if it is invisible.
20144 Return t when a child was found. Otherwise don't move point and
20145 return nil."
20146 (let (level (pos (point)) (re org-outline-regexp-bol))
20147 (when (condition-case nil (org-back-to-heading t) (error nil))
20148 (setq level (outline-level))
20149 (forward-char 1)
20150 (if (and (re-search-forward re nil t) (> (outline-level) level))
20151 (progn (goto-char (match-beginning 0)) t)
20152 (goto-char pos) nil))))
20154 (defun org-show-hidden-entry ()
20155 "Show an entry where even the heading is hidden."
20156 (save-excursion
20157 (org-show-entry)))
20159 (defun org-flag-heading (flag &optional entry)
20160 "Flag the current heading. FLAG non-nil means make invisible.
20161 When ENTRY is non-nil, show the entire entry."
20162 (save-excursion
20163 (org-back-to-heading t)
20164 ;; Check if we should show the entire entry
20165 (if entry
20166 (progn
20167 (org-show-entry)
20168 (save-excursion
20169 (and (outline-next-heading)
20170 (org-flag-heading nil))))
20171 (outline-flag-region (max (point-min) (1- (point)))
20172 (save-excursion (outline-end-of-heading) (point))
20173 flag))))
20175 (defun org-get-next-sibling ()
20176 "Move to next heading of the same level, and return point.
20177 If there is no such heading, return nil.
20178 This is like outline-next-sibling, but invisible headings are ok."
20179 (let ((level (funcall outline-level)))
20180 (outline-next-heading)
20181 (while (and (not (eobp)) (> (funcall outline-level) level))
20182 (outline-next-heading))
20183 (if (or (eobp) (< (funcall outline-level) level))
20184 nil
20185 (point))))
20187 (defun org-get-last-sibling ()
20188 "Move to previous heading of the same level, and return point.
20189 If there is no such heading, return nil."
20190 (let ((opoint (point))
20191 (level (funcall outline-level)))
20192 (outline-previous-heading)
20193 (when (and (/= (point) opoint) (outline-on-heading-p t))
20194 (while (and (> (funcall outline-level) level)
20195 (not (bobp)))
20196 (outline-previous-heading))
20197 (if (< (funcall outline-level) level)
20198 nil
20199 (point)))))
20201 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20202 ;; This contains an exact copy of the original function, but it uses
20203 ;; `org-back-to-heading', to make it work also in invisible
20204 ;; trees. And is uses an invisible-OK argument.
20205 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20206 ;; Furthermore, when used inside Org, finding the end of a large subtree
20207 ;; with many children and grandchildren etc, this can be much faster
20208 ;; than the outline version.
20209 (org-back-to-heading invisible-OK)
20210 (let ((first t)
20211 (level (funcall outline-level)))
20212 (if (and (org-mode-p) (< level 1000))
20213 ;; A true heading (not a plain list item), in Org-mode
20214 ;; This means we can easily find the end by looking
20215 ;; only for the right number of stars. Using a regexp to do
20216 ;; this is so much faster than using a Lisp loop.
20218 (forward-char 1)
20219 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20220 ;; something else, do it the slow way
20221 (while (and (not (eobp))
20222 (or first (> (funcall outline-level) level)))
20223 (setq first nil)
20224 (outline-next-heading)))
20225 (unless to-heading
20227 (progn
20228 ;; Go to end of line before heading
20229 (forward-char -1)
20231 ;; leave blank line before heading
20232 (forward-char -1))))))
20233 (point))
20235 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20236 "Use Org version in org-mode, for dramatic speed-up."
20237 (if (org-mode-p)
20238 (progn
20239 (org-end-of-subtree nil t)
20240 (unless (eobp) (backward-char 1)))
20241 ad-do-it))
20243 (defun org-end-of-meta-data-and-drawers ()
20244 "Jump to the first text after meta data and drawers in the current entry.
20245 This will move over empty lines, lines with planning time stamps,
20246 clocking lines, and drawers."
20247 (org-back-to-heading t)
20248 (let ((end (save-excursion (outline-next-heading) (point)))
20251 (forward-line 1)
20252 (while (re-search-forward re end t)
20253 (if (not (match-end 1))
20254 ;; empty or planning line
20255 (forward-line 1)
20256 ;; a drawer, find the end
20258 (forward-line 1)))
20260 (point)))
20262 (defun org-forward-same-level (arg &optional invisible-ok)
20263 "Move forward to the arg'th subheading at same level as this one.
20264 Stop at the first and last subheadings of a superior heading.
20265 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20266 it wil also look at invisible ones."
20267 (interactive "p")
20268 (org-back-to-heading invisible-ok)
20269 (org-on-heading-p)
20270 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20272 l)
20273 (forward-char 1)
20274 (while (> arg 0)
20275 (while (and (re-search-forward re nil 'move)
20276 (setq l (- (match-end 0) (match-beginning 0) 1))
20277 (= l level)
20278 (not invisible-ok)
20279 (progn (backward-char 1) (outline-invisible-p)))
20280 (if (< l level) (setq arg 1)))
20281 (setq arg (1- arg)))
20282 (beginning-of-line 1)))
20284 (defun org-backward-same-level (arg &optional invisible-ok)
20285 "Move backward to the arg'th subheading at same level as this one.
20286 Stop at the first and last subheadings of a superior heading."
20287 (interactive "p")
20288 (org-back-to-heading)
20289 (org-on-heading-p)
20290 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20292 l)
20293 (while (> arg 0)
20294 (while (and (re-search-backward re nil 'move)
20295 (setq l (- (match-end 0) (match-beginning 0) 1))
20296 (= l level)
20297 (not invisible-ok)
20298 (outline-invisible-p))
20299 (if (< l level) (setq arg 1)))
20300 (setq arg (1- arg)))))
20302 (defun org-show-subtree ()
20303 "Show everything after this heading at deeper levels."
20304 (outline-flag-region
20305 (point)
20306 (save-excursion
20307 (org-end-of-subtree t t))
20308 nil))
20310 (defun org-show-entry ()
20311 "Show the body directly following this heading.
20312 Show the heading too, if it is currently invisible."
20313 (interactive)
20314 (save-excursion
20315 (condition-case nil
20316 (progn
20317 (org-back-to-heading t)
20318 (outline-flag-region
20319 (max (point-min) (1- (point)))
20320 (save-excursion
20321 (if (re-search-forward
20323 (match-beginning 1)
20324 (point-max)))
20325 nil)
20326 (org-cycle-hide-drawers 'children))
20327 (error nil))))
20329 (defun org-make-options-regexp (kwds &optional extra)
20330 "Make a regular expression for keyword lines."
20331 (concat
20332 "^"
20339 ;; Make isearch reveal the necessary context
20340 (defun org-isearch-end ()
20341 "Reveal context after isearch exits."
20342 (when isearch-success ; only if search was successful
20343 (if (featurep 'xemacs)
20344 ;; Under XEmacs, the hook is run in the correct place,
20345 ;; we directly show the context.
20346 (org-show-context 'isearch)
20347 ;; In Emacs the hook runs *before* restoring the overlays.
20348 ;; So we have to use a one-time post-command-hook to do this.
20349 ;; (Emacs 22 has a special variable, see function `org-mode')
20350 (unless (and (boundp 'isearch-mode-end-hook-quit)
20351 isearch-mode-end-hook-quit)
20352 ;; Only when the isearch was not quitted.
20353 (org-add-hook 'post-command-hook 'org-isearch-post-command
20354 'append 'local)))))
20356 (defun org-isearch-post-command ()
20357 "Remove self from hook, and show context."
20358 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20359 (org-show-context 'isearch))
20362 ;;;; Integration with and fixes for other packages
20364 ;;; Imenu support
20366 (defvar org-imenu-markers nil
20367 "All markers currently used by Imenu.")
20368 (make-variable-buffer-local 'org-imenu-markers)
20370 (defun org-imenu-new-marker (&optional pos)
20371 "Return a new marker for use by Imenu, and remember the marker."
20372 (let ((m (make-marker)))
20373 (move-marker m (or pos (point)))
20374 (push m org-imenu-markers)
20375 m))
20377 (defun org-imenu-get-tree ()
20378 "Produce the index for Imenu."
20379 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20380 (setq org-imenu-markers nil)
20381 (let* ((n org-imenu-depth)
20382 (re (concat "^" (org-get-limited-outline-regexp)))
20383 (subs (make-vector (1+ n) nil))
20384 (last-level 0)
20385 m level head)
20386 (save-excursion
20387 (save-restriction
20388 (widen)
20389 (goto-char (point-max))
20390 (while (re-search-backward re nil t)
20391 (setq level (org-reduced-level (funcall outline-level)))
20392 (when (<= level n)
20393 (looking-at org-complex-heading-regexp)
20394 (setq head (org-link-display-format
20395 (org-match-string-no-properties 4))
20396 m (org-imenu-new-marker))
20397 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20398 (if (>= level last-level)
20399 (push (cons head m) (aref subs level))
20400 (push (cons head (aref subs (1+ level))) (aref subs level))
20401 (loop for i from (1+ level) to n do (aset subs i nil)))
20402 (setq last-level level)))))
20403 (aref subs 1)))
20405 (eval-after-load "imenu"
20406 '(progn
20407 (add-hook 'imenu-after-jump-hook
20408 (lambda ()
20409 (if (org-mode-p)
20410 (org-show-context 'org-goto))))))
20412 (defun org-link-display-format (link)
20413 "Replace a link with either the description, or the link target
20414 if no description is present"
20415 (save-match-data
20416 (if (string-match org-bracket-link-analytic-regexp link)
20417 (replace-match (if (match-end 5)
20418 (match-string 5 link)
20419 (concat (match-string 1 link)
20420 (match-string 3 link)))
20421 nil t link)
20422 link)))
20424 ;; Speedbar support
20426 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20427 "Overlay marking the agenda restriction line in speedbar.")
20428 (overlay-put org-speedbar-restriction-lock-overlay
20429 'face 'org-agenda-restriction-lock)
20430 (overlay-put org-speedbar-restriction-lock-overlay
20431 'help-echo "Agendas are currently limited to this item.")
20432 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20434 (defun org-speedbar-set-agenda-restriction ()
20435 "Restrict future agenda commands to the location at point in speedbar.
20437 (interactive)
20438 (require 'org-agenda)
20439 (let (p m tp np dir txt)
20440 (cond
20441 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20442 'org-imenu t))
20443 (setq m (get-text-property p 'org-imenu-marker))
20444 (with-current-buffer (marker-buffer m)
20445 (goto-char m)
20446 (org-agenda-set-restriction-lock 'subtree)))
20447 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20448 'speedbar-function 'speedbar-find-file))
20449 (setq tp (previous-single-property-change
20450 (1+ p) 'speedbar-function)
20451 np (next-single-property-change
20452 tp 'speedbar-function)
20453 dir (speedbar-line-directory)
20454 txt (buffer-substring-no-properties (or tp (point-min))
20455 (or np (point-max))))
20456 (with-current-buffer (find-file-noselect
20457 (let ((default-directory dir))
20458 (expand-file-name txt)))
20459 (unless (org-mode-p)
20460 (error "Cannot restrict to non-Org-mode file"))
20461 (org-agenda-set-restriction-lock 'file)))
20462 (t (error "Don't know how to restrict Org-mode's agenda")))
20463 (move-overlay org-speedbar-restriction-lock-overlay
20464 (point-at-bol) (point-at-eol))
20465 (setq current-prefix-arg nil)
20466 (org-agenda-maybe-redo)))
20468 (eval-after-load "speedbar"
20469 '(progn
20470 (speedbar-add-supported-extension ".org")
20471 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20472 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20473 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20474 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20475 (add-hook 'speedbar-visiting-tag-hook
20476 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20478 ;;; Fixes and Hacks for problems with other packages
20480 ;; Make flyspell not check words in links, to not mess up our keymap
20481 (defun org-mode-flyspell-verify ()
20482 "Don't let flyspell put overlays at active buttons, or on
20483 {todo,all-time,additional-option-like}-keywords."
20484 (let ((pos (max (1- (point)) (point-min)))
20485 (word (thing-at-point 'word)))
20486 (and (not (get-text-property pos 'keymap))
20487 (not (get-text-property pos 'org-no-flyspell))
20488 (not (member word org-todo-keywords-1))
20489 (not (member word org-all-time-keywords))
20490 (not (member word org-additional-option-like-keywords)))))
20492 (defun org-remove-flyspell-overlays-in (beg end)
20493 "Remove flyspell overlays in region."
20494 (and (org-bound-and-true-p flyspell-mode)
20495 (fboundp 'flyspell-delete-region-overlays)
20496 (flyspell-delete-region-overlays beg end))
20497 (add-text-properties beg end '(org-no-flyspell t)))
20499 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20500 (eval-after-load "bookmark"
20501 '(if (boundp 'bookmark-after-jump-hook)
20502 ;; We can use the hook
20503 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20504 ;; Hook not available, use advice
20505 (defadvice bookmark-jump (after org-make-visible activate)
20506 "Make the position visible."
20507 (org-bookmark-jump-unhide))))
20509 ;; Make sure saveplace shows the location if it was hidden
20510 (eval-after-load "saveplace"
20511 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20512 "Make the position visible."
20513 (org-bookmark-jump-unhide)))
20515 ;; Make sure ecb shows the location if it was hidden
20516 (eval-after-load "ecb"
20517 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20518 "Make hierarchy visible when jumping into location from ECB tree buffer."
20519 (if (org-mode-p)
20520 (org-show-context))))
20522 (defun org-bookmark-jump-unhide ()
20523 "Unhide the current position, to show the bookmark location."
20524 (and (org-mode-p)
20525 (or (outline-invisible-p)
20526 (save-excursion (goto-char (max (point-min) (1- (point))))
20527 (outline-invisible-p)))
20528 (org-show-context 'bookmark-jump)))
20530 ;; Make session.el ignore our circular variable
20531 (eval-after-load "session"
20532 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20534 ;;;; Experimental code
20536 (defun org-closed-in-range ()
20537 "Sparse tree of items closed in a certain time range.
20538 Still experimental, may disappear in the future."
20539 (interactive)
20540 ;; Get the time interval from the user.
20541 (let* ((time1 (org-float-time
20542 (org-read-date nil 'to-time nil "Starting date: ")))
20543 (time2 (org-float-time
20544 (org-read-date nil 'to-time nil "End date:")))
20545 ;; callback function
20546 (callback (lambda ()
20547 (let ((time
20548 (org-float-time
20549 (apply 'encode-time
20550 (org-parse-time-string
20551 (match-string 1))))))
20552 ;; check if time in interval
20553 (and (>= time time1) (<= time time2))))))
20554 ;; make tree, check each match with the callback
20557 ;;;; Finish up
20559 (provide 'org)
20561 (run-hooks 'org-load-hook)
20563 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20565 ;;; org.el ends here