| blob | c5b1f465bfcc3c163904089c6424a968e192fb3b |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
114 ;; babel
123 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
155 :key-type
192 ;;;; Customization variables
194 "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
197 identifier."
201 ;;; Version
207 "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
234 ;;; Compatibility constants
236 ;;; The custom variables
239 "Outline-based notes management and organizer."
245 "Mode hook for Org-mode, run after the mode was turned on."
250 "Hook that is run after org.el has been loaded."
255 "Hook that is run after an Org log buffer is created."
264 "Load all extensions listed in `org-modules'."
269 org-modules)
273 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
282 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
283 "Modules that should always be loaded together with org.el.
284 If a description starts with <C>, the file is not part of Emacs
285 and loading it will require that you have downloaded and properly installed
286 the org-mode distribution.
288 You can also use this system to load external packages (i.e. neither Org
289 core modules, nor modules from the CONTRIB directory). Just add symbols
290 to the end of the list. If the package is called org-xyz.el, then you need
291 to add the symbol `xyz', and the package must have a call to
293 (provide 'org-xyz)"
296 :type
327 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
336 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
345 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
362 "Non-nil means make shift-cursor commands select text when possible.
364 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys 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 "Non-nil means Org will display descriptive links.
1331 E.g. [[http://orgmode.org][Org website]] will be displayed as
1333 description. When set to `nil', Org will display the full links
1334 literally.
1336 You can interactively set the value of this variable using the
1337 `org-toggle-link-display'."
1342 "Options concerning storing links in Org-mode."
1347 "Format of the description part of a link to an email or usenet message.
1348 The following %-escapes will be replaced by corresponding information:
1356 %s subject
1357 %d date
1358 %m message-id.
1360 You may use normal field width specification between the % and the letter.
1361 This is for example useful to limit the length of the subject.
1375 It should match if the message is from the user him/herself."
1380 "Non-nil means storing a link to an Org file will use entry IDs.
1382 Note that before this variable is even considered, org-id must be loaded,
1383 so please customize `org-modules' and turn it on.
1385 The variable can have the following values:
1387 t Create an ID if needed to make a link to the current entry.
1389 create-if-interactive
1390 If `org-store-link' is called directly (interactively, as a user
1391 command), do create an ID to support the link. But when doing the
1392 job for remember, only use the ID if it already exists. The
1393 purpose of this setting is to avoid proliferation of unwanted
1394 IDs, just because you happen to be in an Org file when you
1395 call `org-remember' that automatically and preemptively
1396 creates a link. If you do want to get an ID link in a remember
1397 template to an entry not having an ID, create it first by
1398 explicitly creating a link to it, using `C-c C-l' first.
1400 create-if-interactive-and-no-custom-id
1401 Like create-if-interactive, but do not create an ID if there is
1402 a CUSTOM_ID property defined in the entry. This is the default.
1404 use-existing
1405 Use existing ID, do not create one.
1407 nil Never use an ID to make a link, instead link using a text search for
1408 the headline text."
1413 create-if-interactive)
1415 create-if-interactive-and-no-custom-id)
1420 "Non-nil means file links from `org-store-link' contain context.
1421 A search string will be added to the file name with :: as separator and
1422 used to find the context when the link is activated by the command
1423 `org-open-at-point'. When this option is t, the entire active region
1424 will be placed in the search string of the file link. If set to a
1425 positive integer, only the first n lines of context will be stored.
1428 negates this setting for the duration of the command."
1433 "Non-nil means keep link in list for entire session.
1435 The command `org-store-link' adds a link pointing to the current
1436 location to an internal list. These links accumulate during a session.
1437 The command `org-insert-link' can be used to insert links into any
1438 Org-mode file (offering completion for all stored links). When this
1440 will be removed from the list, to make completing the unused links
1441 more efficient."
1446 "Options concerning following links in Org-mode."
1451 "Function to translate links with different syntax to Org syntax.
1452 This can be used to translate links created for example by the Planner
1453 or emacs-wiki packages to Org syntax.
1454 The function must accept two parameters, a TYPE containing the link
1456 which is everything after the link protocol. It should return a cons
1457 with possibly modified values of type and path.
1458 Org contains a function for this, so if you set this variable to
1459 `org-translate-link-from-planner', you should be able follow many
1460 links created by planner."
1465 "Hook that is run after a link has been followed."
1470 "Non-nil means on links TAB will follow the link.
1471 Needs to be set before org.el is loaded.
1472 This really should not be used, it does not make sense, and the
1473 implementation is bad."
1478 "Non-nil means on links RET will follow the link."
1484 "Non-nil means mouse-1 on a link will follow the link.
1485 A longer mouse click will still set point. Does not work on XEmacs.
1486 Needs to be set before org.el is loaded."
1491 "Number of different positions to be recorded in the ring.
1492 Changing this requires a restart of Emacs to work correctly."
1497 "Non-nil means internal links in Org files must exactly match a headline.
1498 When nil, the link search tries to match a phrase with all words
1499 in the search text."
1505 query-to-create)))
1512 "Setup the frame configuration for following links.
1513 When following a link with Emacs, it may often be useful to display
1514 this link in another window or frame. This variable can be used to
1515 set this up for the different types of links.
1516 For VM, use any of
1517 `vm-visit-folder'
1518 `vm-visit-folder-other-window'
1519 `vm-visit-folder-other-frame'
1520 For Gnus, use any of
1521 `gnus'
1522 `gnus-other-frame'
1523 `org-gnus-no-new-news'
1524 For FILE, use any of
1525 `find-file'
1526 `find-file-other-window'
1527 `find-file-other-frame'
1528 For Wanderlust use any of
1529 `wl'
1530 `wl-other-frame'
1531 For the calendar, use the variable `calendar-setup'.
1532 For BBDB, it is currently only possible to display the matches in
1533 another window."
1557 "Non-nil means use indirect buffer to display infile links.
1558 Activating internal links (from one location in a file to another location
1559 in the same file) normally just jumps to the location. When the link is
1561 is displayed in
1562 another window. When this option is set, the other window actually displays
1563 an indirect buffer clone of the current buffer, to avoid any visibility
1564 changes to the current buffer."
1569 "Non-nil means `org-open-file' will open non-existing files.
1570 When nil, an error will be generated.
1571 This variable applies only to external applications because they
1572 might choke on non-existing files. If the link is to a file that
1573 will be opened in Emacs, the variable is ignored."
1578 "Non-nil means a link to a directory really means to index.org.
1579 When nil, following a directory link will run dired or open a finder/explorer
1580 window on that directory."
1585 "Function and arguments to call for following mailto links.
1586 This is a list with the first element being a Lisp function, and the
1587 remaining elements being arguments to the function. In string arguments,
1588 %a will be replaced by the address, and %s will be replaced by the subject
1589 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1598 "Non-nil means ask for confirmation before executing shell links.
1599 Shell links can be dangerous: just think about a link
1601 [[shell:rm -rf ~/*][Google Search]]
1604 but really it would remove your entire home directory.
1605 Therefore we advise against setting this variable to nil.
1606 Just change it to `y-or-n-p' if you want to confirm with a
1614 'safe-local-variable
1618 "A regexp to skip confirmation for shell links."
1623 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1624 Elisp links can be dangerous: just think about a link
1629 but really it would remove your entire home directory.
1630 Therefore we advise against setting this variable to nil.
1631 Just change it to `y-or-n-p' if you want to confirm with a
1639 'safe-local-variable
1643 "A regexp to skip confirmation for Elisp links."
1651 "Default file applications on a UNIX or GNU/Linux system.
1662 "Default file applications on a MacOS X system.
1664 for some files for which the OS does not have a good default.
1672 'mswindows-shell-execute
1677 'mswindows-shell-execute
1680 "Default file applications on a Windows NT system.
1685 '(
1690 )
1691 "External applications for opening `file:path' items in a document.
1692 Org-mode uses system defaults for different file types, but
1693 you can use this variable to set the application for a given file
1694 extension. The entries in this list are cons cells where the car identifies
1695 files and the cdr the corresponding command. Possible values for the
1696 file identifier are
1698 ways, depending on its contents:
1700 - Alphanumeric characters only:
1701 Match links with this file extension.
1703 to open PDFs with evince.
1705 - Regular expression: Match links where the
1706 filename matches the regexp. If you want to
1707 use groups here, use shy groups.
1711 to open *.html and *.xhtml with firefox.
1713 - Regular expression which contains (non-shy) groups:
1715 anything after that, matches the regexp.
1716 In a custom command string, %1, %2, etc. are replaced with
1717 the parts of the link that were matched by the groups.
1718 For backwards compatibility, if a command string is given
1719 that does not use any of the group matches, this case is
1720 handled identically to the second one (i.e. match against
1721 file name only).
1722 In a custom lisp form, you can access the group matches with
1723 (match-string n link).
1726 to open [[file:document.pdf::5]] with evince at page 5.
1728 `directory' Matches a directory
1729 `remote' Matches a remote file, accessible through tramp or efs.
1730 Remote files most likely should be visited through Emacs
1731 because external applications cannot handle such paths.
1732 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1733 so all files Emacs knows how to handle. Using this with
1734 command `emacs' will open most files in Emacs. Beware that this
1735 will also open html files inside Emacs, unless you add
1737 t Default for files not matched by any of the other options.
1738 `system' The system command to open files, like `open' on Windows
1739 and Mac OS X, and mailcap under GNU/Linux. This is the command
1740 that will be selected if you call `C-c C-o' with a double
1743 Possible values for the command are:
1744 `emacs' The file will be visited by the current Emacs process.
1745 `default' Use the default application for this file type, which is the
1746 association for t in the list, most likely in the system-specific
1747 part.
1748 This can be used to overrule an unwanted setting in the
1749 system-specific variable.
1751 This command is specified by the entry whose car is `system'.
1752 Most likely, the system-specific version of this variable
1753 does define this command, but you can overrule/replace it
1754 here.
1755 string A command to be executed by a shell; %s will be replaced
1756 by the path to the file.
1757 sexp A Lisp form which will be evaluated. The file path will
1758 be available in the Lisp variable `file'.
1759 For more examples, see the system specific constants
1760 `org-file-apps-defaults-macosx'
1761 `org-file-apps-defaults-windowsnt'
1762 `org-file-apps-defaults-gnu'."
1772 auto-mode))
1783 "Options concerning refiling entries in Org-mode."
1788 "Directory with org files.
1789 This is just a default location to look for Org files. There is no need
1790 at all to put your files into this directory. It is only used in the
1791 following situations:
1793 1. When a remember template specifies a target file that is not an
1794 absolute path. The path will then be interpreted relative to
1795 `org-directory'
1796 2. When a remember note is filed away in an interactive way (when exiting the
1797 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1798 with `org-directory' as the default path."
1804 "Default target for storing notes.
1805 Used as a fall back file for org-remember.el and org-capture.el, for
1806 templates that do not specify a target file."
1811 file))
1814 "The default interface to be used for `org-goto'.
1815 Allowed values are:
1816 outline The interface shows an outline of the relevant file
1817 and the correct heading is found by moving through
1818 the outline or by searching with incremental search.
1819 outline-path-completion Headlines in the current buffer are offered via
1820 completion. This is the interface also used by
1821 the refile command."
1828 "Maximum target level when running `org-goto' with refile interface."
1833 "Non-nil means store new notes at the beginning of a file or entry.
1834 When nil, new notes will be filed to the end of a file or entry.
1835 This can also be a list with cons cells of regular expressions that
1836 are matched against file names, and values."
1846 "Information to record when a task is refiled.
1848 Possible values are:
1850 nil Don't add anything
1851 time Add a time stamp to the task
1852 note Prompt for a note and add it with template `org-log-note-headings'
1854 This option can also be set with on a per-file-basis with
1856 #+STARTUP: nologrefile
1857 #+STARTUP: logrefile
1858 #+STARTUP: lognoterefile
1860 You can have local logging settings for a subtree by setting the LOGGING
1861 property to one or more of these keywords.
1863 When bulk-refiling from the agenda, the value `note' is forbidden and
1864 will temporarily be changed to `time'."
1874 This is list of cons cells. Each cell contains:
1875 - a specification of the files to be considered, either a list of files,
1876 or a symbol whose function or variable value will be used to retrieve
1877 a file name or a list of file names. If you use `org-agenda-files' for
1878 that, all agenda files will be scanned for targets. Nil means consider
1879 headings in the current buffer.
1880 - A specification of how to find candidate refile targets. This may be
1881 any of:
1883 This tag has to be present in all target headlines, inheritance will
1884 not be considered.
1886 todo keyword.
1888 headlines that are refiling targets.
1889 - a cons cell (:level . N). Any headline of level N is considered a target.
1890 Note that, when `org-odd-levels-only' is set, level corresponds to
1891 order in hierarchy, not to the number of stars.
1892 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1893 Note that, when `org-odd-levels-only' is set, level corresponds to
1894 order in hierarchy, not to the number of stars.
1896 You can set the variable `org-refile-target-verify-function' to a function
1897 to verify each headline found by the simple criteria above.
1899 When this variable is nil, all top-level headlines in the current buffer
1900 are used, equivalent to the value `((nil . (:level . 1))'."
1916 "Function to verify if the headline at point should be a refile target.
1917 The function will be called without arguments, with point at the
1918 beginning of the headline. It should return t and leave point
1919 where it is if the headline is a valid target for refiling.
1921 If the target should not be selected, the function must return nil.
1922 In addition to this, it may move point to a place from where the search
1923 should be continued. For example, the function may decide that the entire
1924 subtree of the current entry should be excluded and move point to the end
1925 of the subtree."
1930 "Non-nil means cache refile targets to speed up the process.
1931 The cache for a particular file will be updated automatically when
1932 the buffer has been killed, or when any of the marker used for flagging
1933 refile targets no longer points at a live buffer.
1934 If you have added new entries to a buffer that might themselves be targets,
1935 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1936 find that easier, `C-u C-u C-u C-c C-w'."
1941 "Non-nil means provide refile targets as paths.
1942 So a level 3 headline will be available as level1/level2/level3.
1944 When the value is `file', also include the file name (without directory)
1945 into the path. In this case, you can also stop the completion after
1946 the file name, to get entries inserted as top level in the file.
1948 When `full-file-path', include the full file path."
1957 "Non-nil means complete the outline path in hierarchical steps.
1958 When Org-mode uses the refile interface to select an outline path
1959 \(see variable `org-refile-use-outline-path'), the completion of
1960 the path can be done is a single go, or if can be done in steps down
1961 the headline hierarchy. Going in steps is probably the best if you
1962 do not use a special completion package like `ido' or `icicles'.
1963 However, when using these packages, going in one step can be very
1964 fast, while still showing the whole path to the entry."
1969 "Non-nil means allow to create new nodes as refile targets.
1971 of an existing node. When the value of this variable is `confirm',
1972 new node creation must be confirmed by the user (recommended)
1973 When nil, the completion must match an existing entry.
1975 Note that, if the new heading is not seen by the criteria
1976 listed in `org-refile-targets', multiple instances of the same
1977 heading would be created by trying again to file under the new
1978 heading."
1986 "Non-nil means also refile active region within a subtree.
1988 By default `org-refile' doesn't allow refiling regions if they
1989 don't contain a set of subtrees, but it might be convenient to
1990 do so sometimes: in that case, the first line of the region is
1991 converted to a headline before refiling."
1996 "Options concerning TODO items in Org-mode."
2001 "Options concerning Progress logging in Org-mode."
2008 "The available interpretation symbols for customizing `org-todo-keywords'.
2012 "List of TODO entry keyword sequences and their interpretation.
2015 Each sequence starts with a symbol, either `sequence' or `type',
2016 indicating if the keywords should be interpreted as a sequence of
2017 action steps, or as different types of TODO items. The first
2018 keywords are states requiring action - these states will select a headline
2019 for inclusion into the global TODO list Org-mode produces. If one of
2022 the last keyword is treated as the only DONE state of the sequence.
2025 additional state where no keyword is present. For details about this
2026 cycling, see the manual.
2028 TODO keywords and interpretation can also be set on a per-file basis with
2029 the special #+SEQ_TODO and #+TYP_TODO lines.
2031 Each keyword can optionally specify a character for fast state selection
2032 \(in combination with the variable `org-use-fast-todo-selection')
2033 and specifiers for state change logging, using the same syntax
2036 indicates to record a time stamp each time this state is selected.
2038 Each keyword may also specify if a timestamp or a note should be
2039 recorded when entering or leaving the state, by adding additional
2040 characters in the parenthesis after the keyword. This looks like this:
2042 record only the time of the state change. With X and Y being either
2044 Y when leaving the state if and only if the *target* state does not
2045 define X. You may omit any of the fast-selection key or X or /Y,
2046 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2048 For backward compatibility, this variable may also be just a list
2049 of keywords - in this case the interpretation (sequence or type) will be
2050 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2060 ;;Quick and dirty way to see
2061 ;;`org-todo-interpretations'. This takes the
2062 ;;place of item arguments
2063 :convert-widget
2070 org-todo-interpretation-widgets))
2071 widget))
2102 "Controls how TODO keywords are interpreted.
2103 This variable is in principle obsolete and is only used for
2104 backward compatibility, if the interpretation of todo keywords is
2105 not given already in `org-todo-keywords'. See that variable for
2106 more information."
2113 "Non-nil means use the fast todo selection scheme with C-c C-t.
2114 This variable describes if and under what circumstances the cycling
2115 mechanism for TODO keywords will be replaced by a single-key, direct
2116 selection scheme.
2118 When nil, fast selection is never used.
2120 When the symbol `prefix', it will be used when `org-todo' is called with
2121 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2122 in an agenda buffer.
2124 When t, fast selection is used by default. In this case, the prefix
2125 argument forces cycling instead.
2127 In all cases, the special interface is only used if access keys have actually
2128 been assigned by the user, i.e. if keywords in the configuration are followed
2129 by a letter in parenthesis, like TODO(t)."
2137 "Non-nil means update todo statistics after insert and toggle.
2138 ALL-HEADLINES means update todo statistics by including headlines
2139 with no TODO keyword as well, counting them as not done.
2140 A list of TODO keywords means the same, but skip keywords that are
2141 not in this list.
2143 When this is set, todo statistics is updated in the parent of the
2144 current entry each time a todo state is changed."
2154 "Non-nil means TODO statistics covers just direct children.
2155 When nil, all entries in the subtree are considered.
2156 This has only an effect if `org-provide-todo-statistics' is set.
2157 To set this to nil for only a single subtree, use a COOKIE_DATA
2163 "Hook which is run after the state of a TODO item was changed.
2164 The new state (a string with a TODO keyword, or nil) is available in the
2165 Lisp variable `state'."
2170 "Hook for functions that are allowed to block a state change.
2172 Each function gets as its single argument a property list, see
2173 `org-trigger-hook' for more information about this list.
2175 If any of the functions in this hook returns nil, the state change
2179 "Hook for functions that are triggered by a state change.
2181 Each function gets as its single argument a property list with at least
2182 the following elements:
2184 (:type type-of-change :position pos-at-entry-start
2185 :from old-state :to new-state)
2187 Depending on the type, more properties may be present.
2189 This mechanism is currently implemented for:
2191 TODO state changes
2192 ------------------
2193 :type todo-state-change
2194 :from previous state (keyword as a string), or nil, or a symbol
2195 'todo' or 'done', to indicate the general type of state.
2199 "Non-nil means undone TODO entries will block switching the parent to DONE.
2200 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2201 be blocked if any prior sibling is not yet done.
2202 Finally, if the parent is blocked because of ordered siblings of its own,
2203 the child will also be blocked.
2204 This variable needs to be set before org.el is loaded, and you need to
2205 restart Emacs after a change to make the change effective. The only way
2206 to change is while Emacs is running is through the customize interface."
2218 "Non-nil means unchecked boxes will block switching the parent to DONE.
2219 When this is nil, checkboxes have no influence on switching TODO states.
2220 When non-nil, you first need to check off all check boxes before the TODO
2221 entry can be switched to DONE.
2222 This variable needs to be set before org.el is loaded, and you need to
2223 restart Emacs after a change to make the change effective. The only way
2224 to change is while Emacs is running is through the customize interface."
2236 "Non-nil means inserting a TODO heading is treated as state change.
2238 logging will apply if appropriate. When nil, the new TODO item will
2239 be inserted directly, and no logging will take place."
2244 "Non-nil means switching TODO states with S-cursor counts as state change.
2245 This is the default behavior. However, setting this to nil allows a
2246 convenient way to select a TODO state and bypass any logging associated
2247 with that."
2252 "Tag changes that should be triggered by TODO state changes.
2253 This is a list. Each entry is
2255 (state-change (tag . flag) .......)
2257 State-change can be a string with a state, and empty string to indicate the
2258 state that has no TODO keyword, or it can be one of the symbols `todo'
2259 or `done', meaning any not-done or done state, respectively."
2273 "Information to record when a task moves to the DONE state.
2275 Possible values are:
2277 nil Don't add anything, just change the keyword
2278 time Add a time stamp to the task
2279 note Prompt for a note and add it with template `org-log-note-headings'
2281 This option can also be set with on a per-file-basis with
2283 #+STARTUP: nologdone
2284 #+STARTUP: logdone
2285 #+STARTUP: lognotedone
2287 You can have local logging settings for a subtree by setting the LOGGING
2288 property to one or more of these keywords."
2296 ;; Normalize old uses of org-log-done.
2303 "Information to record when the scheduling date of a tasks is modified.
2305 Possible values are:
2307 nil Don't add anything, just change the date
2308 time Add a time stamp to the task
2309 note Prompt for a note and add it with template `org-log-note-headings'
2311 This option can also be set with on a per-file-basis with
2313 #+STARTUP: nologreschedule
2314 #+STARTUP: logreschedule
2315 #+STARTUP: lognotereschedule"
2324 "Information to record when the deadline date of a tasks is modified.
2326 Possible values are:
2328 nil Don't add anything, just change the date
2329 time Add a time stamp to the task
2330 note Prompt for a note and add it with template `org-log-note-headings'
2332 This option can also be set with on a per-file-basis with
2334 #+STARTUP: nologredeadline
2335 #+STARTUP: logredeadline
2336 #+STARTUP: lognoteredeadline
2338 You can have local logging settings for a subtree by setting the LOGGING
2339 property to one or more of these keywords."
2348 "Non-nil means record a note when clocking out of an item.
2349 This can also be configured on a per-file basis by adding one of
2350 the following lines anywhere in the buffer:
2352 #+STARTUP: lognoteclock-out
2353 #+STARTUP: nolognoteclock-out"
2359 "Non-nil means the CLOSED time stamp will contain date and time.
2360 When nil, only the date will be recorded."
2374 "Headings for notes added to entries.
2375 The value is an alist, with the car being a symbol indicating the note
2376 context, and the cdr is the heading to be used. The heading may also be the
2377 empty string.
2378 %t in the heading will be replaced by a time stamp.
2379 %T will be an active time stamp instead the default inactive one
2380 %s will be replaced by the new TODO state, in double quotes.
2381 %S will be replaced by the old TODO state, in double quotes.
2382 %u will be replaced by the user name.
2383 %U will be replaced by the full user name.
2385 In fact, it is not a good idea to change the `state' entry, because
2386 agenda log mode depends on the format of these entries."
2392 "Heading when changing todo state (todo sequence only)"
2406 "Non-nil means insert state change notes and time stamps into a drawer.
2407 When nil, state changes notes will be inserted after the headline and
2408 any scheduling and clock lines, but not inside a drawer.
2410 The value of this variable should be the name of the drawer to use.
2411 LOGBOOK is proposed as the default drawer for this purpose, you can
2412 also set this to a string to define the drawer of your choice.
2416 If this variable is set, `org-log-state-notes-insert-after-drawers'
2417 will be ignored.
2419 You can set the property LOG_INTO_DRAWER to overrule this setting for
2420 a subtree."
2432 "Return the value of `org-log-into-drawer', but let properties overrule.
2433 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2434 used instead of the default value."
2442 "Non-nil means insert state change notes after any drawers in entry.
2443 Only the drawers that *immediately* follow the headline and the
2444 deadline/scheduled line are skipped.
2445 When nil, insert notes right after the heading and perhaps the line
2446 with deadline/scheduling if present.
2448 This variable will have no effect if `org-log-into-drawer' is
2449 set."
2455 "Non-nil means the latest state note will be directly after heading.
2456 When nil, the state change notes will be ordered according to time."
2462 "The TODO state to which a repeater should return the repeating task.
2463 By default this is the first task in a TODO sequence, or the previous state
2464 in a TODO_TYP set. But you can specify another task here.
2465 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2471 "Non-nil means record moving through the DONE state when triggering repeat.
2472 An auto-repeating task is immediately switched back to TODO when
2475 record a closing note, there will be no record of the task moving
2476 through DONE. This variable forces taking a note anyway.
2478 nil Don't force a record
2479 time Record a time stamp
2480 note Record a note
2482 This option can also be set with on a per-file-basis with
2484 #+STARTUP: logrepeat
2485 #+STARTUP: lognoterepeat
2486 #+STARTUP: nologrepeat
2488 You can have local logging settings for a subtree by setting the LOGGING
2489 property to one or more of these keywords."
2499 "Priorities in Org-mode."
2504 "Non-nil means priority commands are active.
2505 When nil, these commands will be disabled, so that you never accidentally
2506 set a priority."
2511 "The highest priority of TODO items. A character like ?A, ?B etc.
2512 Must have a smaller ASCII number than `org-lowest-priority'."
2517 "The lowest priority of TODO items. A character like ?A, ?B etc.
2518 Must have a larger ASCII number than `org-highest-priority'."
2523 "The default priority of TODO items.
2524 This is the priority an item gets if no explicit priority is given.
2525 When starting to cycle on an empty priority the first step in the cycle
2526 depends on `org-priority-start-cycle-with-default'. The resulting first
2527 step priority must not exceed the range from `org-highest-priority' to
2528 `org-lowest-priority' which means that `org-default-priority' has to be
2529 in this range exclusive or inclusive the range boundaries. Else the
2530 first step refuses to set the default and the second will fall back
2531 to (depending on the command used) the highest or lowest priority."
2536 "Non-nil means start with default priority when starting to cycle.
2537 When this is nil, the first step in the cycle will be (depending on the
2538 command used) one higher or lower than the default priority.
2539 See also `org-default-priority'."
2544 "Function to extract the priority from a string.
2545 The string is normally the headline. If this is nil Org computes the
2546 priority from the priority cookie like [#A] in the headline. It returns
2547 an integer, increasing by 1000 for each priority level.
2548 The user can set a different function here, which should take a string
2549 as an argument and return the numeric priority."
2554 "Options concerning time stamps and deadlines in Org-mode."
2559 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2560 When nil, these labeled time stamps are forces into the second line of an
2561 entry, just after the headline. When scheduling from the global TODO list,
2562 the time stamp will always be forced into the second line."
2567 "Formats for `format-time-string' which are used for time stamps.
2571 "Number of minutes to round time stamps to.
2572 These are two values, the first applies when first creating a time stamp.
2573 The second applies when changing it with the commands `S-up' and `S-down'.
2574 When changing the time stamp, this means that it will change in steps
2575 of N minutes, as given by the second value.
2577 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2578 numbers should be factors of 60, so for example 5, 10, 15.
2580 When this is larger than 1, you can still force an exact time stamp by using
2581 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2582 and by using a prefix arg to `S-up/down' to specify the exact number
2583 of minutes to shift."
2593 ;; Normalize old customizations of this variable.
2597 org-time-stamp-rounding-minutes)))
2600 "Non-nil means overlay custom formats over all time stamps.
2601 The formats are defined through the variable `org-time-stamp-custom-formats'.
2602 To turn this on on a per-file basis, insert anywhere in the file:
2603 #+STARTUP: customtime"
2611 "Custom formats for time stamps. See `format-time-string' for the syntax.
2612 These are overlayed over the default ISO format if the variable
2613 `org-display-custom-times' is set. Time like %H:%M should be at the
2614 end of the second format. The custom formats are also honored by export
2615 commands, if custom time display is turned on at the time of export."
2620 "Get the right format for a time string."
2625 f)))
2628 "The format string used when creating CLOCKSUM lines.
2629 This is also used when org-mode generates a time duration."
2635 org-mode generates a time duration."
2640 "The format string used when creating CLOCKSUM lines, or when
2641 org-mode generates a time duration."
2646 "No. of days before expiration during which a deadline becomes active.
2647 This variable governs the display in sparse trees and in the agenda.
2648 When 0 or negative, it means use this number (the absolute value of it)
2649 even if a deadline has a different individual lead time specified.
2651 Custom commands can set this variable in the options section."
2657 "Non-nil means assume future for incomplete date input from user.
2658 This affects the following situations:
2659 1. The user gives a month but not a year.
2662 2. The user gives a day, but no month.
2665 it will be considered as *this* month.
2667 If you set this variable to the symbol `time', then also the following
2668 will work:
2670 3. If the user gives a time, but no day. If the time is before now,
2671 to will be interpreted as tomorrow.
2673 Currently none of this works for ISO week specifications.
2675 When this option is nil, the current day, month and year will always be
2676 used as defaults.
2678 See also `org-agenda-jump-prefer-future'."
2686 "Should the agenda jump command prefer the future for incomplete dates?
2687 The default is to do the same as configured in `org-read-date-prefer-future'.
2688 But you can also set a deviating value here.
2689 This may t or nil, or the symbol `org-read-date-prefer-future'."
2694 org-read-date-prefer-future)
2699 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2701 Depending on the system Emacs is running on, certain dates cannot
2702 be represented with the type used internally to represent time.
2703 Dates between 1970-1-1 and 2038-1-1 can always be represented
2704 correctly. Some systems allow for earlier dates, some for later,
2705 some for both. One way to find out it to insert any date into an
2706 Org buffer, putting the cursor on the year and hitting S-up and
2707 S-down to test the range.
2709 When this variable is set to t, the date/time prompt will not let
2710 you specify dates outside the 1970-2037 range, so it is certain that
2711 these dates will work in whatever version of Emacs you are
2712 running, and also that you can move a file from one Emacs implementation
2713 to another. WHenever Org is forcing the year for you, it will display
2714 a message and beep.
2716 When this variable is nil, Org will check if the date is
2717 representable in the specific Emacs implementation you are using.
2718 If not, it will force a year, usually the current year, and beep
2719 to remind you. Currently this setting is not recommended because
2720 the likelihood that you will open your Org files in an Emacs that
2721 has limited date range is not negligible.
2723 A workaround for this problem is to use diary sexp dates for time
2724 stamps outside of this range."
2729 "Non-nil means display current interpretation of date prompt live.
2730 This display will be in an overlay, in the minibuffer."
2735 "Non-nil means pop up a calendar when prompting for a date.
2736 In the calendar, the date can be selected with mouse-1. However, the
2737 minibuffer will also be active, and you can simply enter the date as well.
2738 When nil, only the minibuffer will be available."
2746 "Hook to be used to set up keys for the date/time interface.
2747 Add key definitions to `minibuffer-local-map', which will be a temporary
2748 copy."
2753 "The hour when your day really ends. Must be an integer.
2754 This has influence for the following applications:
2756 the time given here, the day recognized as TODAY is actually yesterday.
2757 - When a date is read from the user and it is still before the time given
2758 here, the current date and time will be assumed to be yesterday, 23:59.
2759 Also, timestamps inserted in remember templates follow this rule.
2761 IMPORTANT: This is a feature whose implementation is and likely will
2762 remain incomplete. Really, it is only here because past midnight seems to
2763 be the favorite working time of John Wiegley :-)"
2768 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2769 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2771 23:59 of the previous day."
2776 "Non-nil means S-down will increase the time in a time stamp.
2777 When nil, S-up will increase."
2782 "Non-nil means make the calendar window follow timestamp changes.
2783 When a timestamp is modified and the calendar window is visible, it will be
2784 moved to the new date."
2789 "Options concerning tags in Org-mode."
2794 "List of tags allowed in Org-mode files.
2795 When this list is nil, Org-mode will base TAG input on what is already in the
2796 buffer.
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."
2815 "List of tags that will always appear in all Org-mode files.
2816 This is in addition to any in buffer settings or customizations
2817 of `org-tag-alist'.
2818 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2819 The value of this variable is an alist, the car of each entry must be a
2820 keyword as a string, the cdr may be a character that is used to select
2821 that tag through the fast-tag-selection interface.
2822 See the manual for details.
2823 To disable these tags on a per-file basis, insert anywhere in the file:
2824 #+STARTUP: noptag"
2835 "If non-nil, always offer completion for all tags of all agenda files.
2836 Instead of customizing this variable directly, you might want to
2837 set it locally for capture buffers, because there no list of
2838 tags in that file can be created dynamically (there are none).
2840 (add-hook 'org-capture-mode-hook
2841 (lambda ()
2842 (set (make-local-variable
2843 'org-complete-tags-always-offer-all-agenda-tags)
2844 t)))"
2849 "List of tags that can be inherited by all entries in the file.
2850 The tags will be inherited if the variable `org-use-tag-inheritance'
2851 says they should be.
2855 "Non-nil means use fast tag selection scheme.
2856 This is a special interface to select and deselect tags with single keys.
2857 When nil, fast selection is never used.
2858 When the symbol `auto', fast selection is used if and only if selection
2859 characters for tags have been configured, either through the variable
2860 `org-tag-alist' or through a #+TAGS line in the buffer.
2861 When t, fast selection is always used and selection keys are assigned
2862 automatically if necessary."
2870 "Non-nil means fast tag selection exits after first change.
2871 When nil, you have to press RET to exit it.
2872 During fast tag selection, you can toggle this flag with `C-c'.
2873 This variable can also have the value `expert'. In this case, the window
2874 displaying the tags menu is not even shown, until you press C-c again."
2882 "Non-nil means fast tags selection interface will also offer TODO states.
2886 "The column to which tags should be indented in a headline.
2887 If this number is positive, it specifies the column. If it is negative,
2888 it means that the tags should be flushright to that column. For example,
2889 -80 works well for a normal 80 character screen."
2894 "Non-nil keeps tags aligned when modifying headlines.
2895 Some operations (i.e. demoting) change the length of a headline and
2896 therefore shift the tags around. With this option turned on, after
2897 each such operation the tags are again aligned to `org-tags-column'."
2902 "Non-nil means tags in levels apply also for sublevels.
2903 When nil, only the tags directly given in a specific line apply there.
2904 This may also be a list of tags that should be inherited, or a regexp that
2905 matches tags that should be inherited. Additional control is possible
2906 with the variable `org-tags-exclude-from-inheritance' which gives an
2907 explicit list of tags to be excluded from inheritance., even if the value of
2908 `org-use-tag-inheritance' would select it for inheritance.
2910 If this option is t, a match early-on in a tree can lead to a large
2911 number of matches in the subtree when constructing the agenda or creating
2912 a sparse tree. If you only want to see the first match in a tree during
2913 a search, check out the variable `org-tags-match-list-sublevels'."
2922 "List of tags that should never be inherited.
2923 This is a way to exclude a few tags from inheritance. For way to do
2924 the opposite, to actively allow inheritance for selected tags,
2925 see the variable `org-use-tag-inheritance'."
2930 "Check if TAG is one that should be inherited."
2942 "Non-nil means list also sublevels of headlines matching a search.
2943 This variable applies to tags/property searches, and also to stuck
2944 projects because this search is based on a tags match as well.
2946 When set to the symbol `indented', sublevels are indented with
2947 leading dots.
2949 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2950 the sublevels of a headline matching a tag search often also match
2951 the same search. Listing all of them can create very long lists.
2952 Setting this variable to nil causes subtrees of a match to be skipped.
2954 This variable is semi-obsolete and probably should always be true. It
2955 is better to limit inheritance to certain tags using the variables
2956 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2964 "When set, tags are sorted using this function as a comparator."
2980 "Options concerning properties in Org-mode."
2985 "How property key/value pairs should be formatted by `indent-line'.
2986 When `indent-line' hits a property definition, it will format the line
2987 according to this format, mainly to make sure that the values are
2988 lined-up with respect to each other."
2993 "Alist of properties and functions to adjust inserted values.
2994 Elements of this alist must be of the form
2996 ([string] [function])
2998 where [string] must be a property name and [function] must be a
2999 lambda expression: this lambda expression must take one argument,
3000 the value to adjust, and return the new value as a string.
3004 and the clock summary:
3007 (let ((clocksum (org-clock-sum-current-item))
3008 (effort (org-duration-string-to-minutes
3010 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3015 "Non-nil means properties apply also for sublevels.
3017 This setting is chiefly used during property searches. Turning it on can
3018 cause significant overhead when doing a search, which is why it is not
3019 on by default.
3021 When nil, only the properties directly given in the current entry count.
3022 When t, every property is inherited. The value may also be a list of
3023 properties that should have inheritance, or a regular expression matching
3024 properties that should be inherited.
3026 However, note that some special properties use inheritance under special
3027 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3029 for valid values of a property.
3031 Note for programmers:
3032 When querying an entry with `org-entry-get', you can control if inheritance
3033 should be used. By default, `org-entry-get' looks only at the local
3034 properties. You can request inheritance by setting the inherit argument
3035 to t (to force inheritance) or to `selective' (to respect the setting
3036 in this variable)."
3045 "Check if PROPERTY is one that should be inherited."
3056 "The default column format, if no other format has been defined.
3057 This variable can be set on the per-file basis by inserting a line
3059 #+COLUMNS: %25ITEM ....."
3064 "The ellipses to be used when a field in column view is truncated.
3065 When this is the empty string, as many characters as possible are shown,
3066 but then there will be no visual indication that the field has been truncated.
3067 When this is a string of length N, the last N characters of a truncated
3068 field are replaced by this string. If the column is narrower than the
3069 ellipses string, only part of the ellipses string will be shown."
3074 "Function that modifies values for display in column view.
3075 For example, it can be used to cut out a certain part from a time stamp.
3076 The function must take 2 arguments:
3078 column-title The title of the column (*not* the property name)
3079 value The value that should be modified.
3081 The function should return the value that should be displayed,
3082 or nil if the normal value should be used."
3087 "The property that is being used to keep track of effort estimates.
3088 Effort estimates given in this property need to have the format H:MM."
3096 "List of property/value pairs that can be inherited by any entry.
3098 These are fixed values, for the preset properties. The user variable
3099 that can be used to add to this list is `org-global-properties'.
3101 The entries in this list are cons cells where the car is a property
3102 name and cdr is a string with the value. If the value represents
3107 "List of property/value pairs that can be inherited by any entry.
3109 This list will be combined with the constant `org-global-properties-fixed'.
3111 The entries in this list are cons cells where the car is a property
3112 name and cdr is a string with the value.
3114 You can set buffer-local values for the same purpose in the variable
3115 `org-file-properties' this by adding lines like
3117 #+PROPERTY: NAME VALUE"
3124 "List of property/value pairs that can be inherited by any entry.
3125 Valid for the current buffer.
3130 "Options concerning agenda views in Org-mode."
3135 "Variable used by org files to set a category for agenda display.
3136 Such files should use a file variable to set it, for example
3140 or contain a special line
3142 #+CATEGORY: ELisp
3144 If the file does not specify a category, then file's base name
3150 "The files to be used for agenda display.
3154 If an entry is a directory, all files in that directory that are matched by
3155 `org-agenda-file-regexp' will be part of the file list.
3157 If the value of the variable is not a list but a single file name, then
3158 the list of agenda files is actually stored and maintained in that file, one
3159 agenda file per line. In this file paths can be given relative to
3160 `org-directory'. Tilde expansion and environment variable substitution
3161 are also made."
3168 "Regular expression to match files for `org-agenda-files'.
3169 If any element in the list in that variable contains a directory instead
3170 of a normal file, all files in that directory that are matched by this
3171 regular expression will be included."
3176 "List of extra files to be searched by text search commands.
3177 These files will be search in addition to the agenda files by the
3178 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3179 Note that these files will only be searched for text search commands,
3180 not for the other agenda views like todo lists, tag searches or the weekly
3181 agenda. This variable is intended to list notes and possibly archive files
3182 that should also be searched by these two commands.
3183 In fact, if the first element in the list is the symbol `agenda-archives',
3184 than all archive files of all agenda files will be added to the search
3185 scope."
3196 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3197 A nil value means to remove them, after a query, from the list."
3202 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3203 The command `org-calendar-goto-agenda' will be bound to this key. The
3204 default is the character `c' because then `c' can be used to switch back and
3205 forth between agenda and calendar."
3210 "The key to be installed in `calendar-mode-map' for agenda-action.
3211 The command `org-agenda-action' will be bound to this key. The
3212 default is the character `k' because we use the same key in the agenda."
3217 "The key to be installed in `calendar-mode-map' for adding diary entries.
3218 This option is irrelevant until `org-agenda-diary-file' has been configured
3219 to point to an Org-mode file. When that is the case, the command
3220 `org-agenda-diary-entry' will be bound to the key given here, by default
3221 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3222 if you want to continue doing this, you need to change this to a different
3223 key."
3228 "File to which to add new entries with the `i' key in agenda and calendar.
3229 When this is the symbol `diary-file', the functionality in the Emacs
3230 calendar will be used to add entries to the `diary-file'. But when this
3231 points to a file, `org-agenda-diary-entry' will be used instead."
3247 org-calendar-insert-diary-entry-key
3251 "Options for embedding LaTeX code into Org-mode."
3259 "Options for creating images from LaTeX fragments.
3260 This is a property list with the following properties:
3262 `default' means use the foreground of the default face.
3264 `default' means use the background of the default face.
3265 :scale a scaling factor for the size of the images, to get more pixels
3266 :html-foreground, :html-background, :html-scale
3267 the same numbers for HTML export.
3268 :matchers a list indicating which matchers should be used to
3269 find LaTeX fragments. Valid members of this list are:
3280 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3281 When nil, just push out a message."
3290 \[PACKAGES]
3291 \[DEFAULT-PACKAGES]
3292 % The settings below are copied from fullpage.sty
3305 "The document header used for processing LaTeX fragments.
3306 It is imperative that this header make sure that no page number
3307 appears on the page. The package defined in the variables
3308 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3310 will be appended."
3317 "Set the packages alist and make sure it has 3 elements per entry."
3321 x))
3322 val)))
3326 "Get the packages alist and make sure it has 3 elements per entry."
3330 x))
3333 ;; The following variables are defined here because is it also used
3334 ;; when formatting latex fragments. Originally it was part of the
3335 ;; LaTeX exporter, which is why the name includes "export".
3352 )
3353 "Alist of default packages to be inserted in the header.
3354 Change this only if one of the packages here causes an incompatibility
3355 with another package you are using.
3356 The packages in this list are needed by one part or another of Org-mode
3357 to function properly.
3359 - inputenc, fontenc: for basic font and character selection
3360 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3361 for interpreting the entities in `org-entities'. You can skip some of these
3362 packages if you don't use any of the symbols in it.
3363 - graphicx: for including images
3364 - float, wrapfig: for figure placement
3365 - longtable: for long tables
3366 - hyperref: for cross references
3368 Therefore you should not modify this variable unless you know what you
3369 are doing. The one reason to change it anyway is that you might be loading
3370 some other package that conflicts with one of the default packages.
3372 If SNIPPET-FLAG is t, the package also needs to be included when
3373 compiling LaTeX snippets into images for inclusion into HTML."
3386 "Alist of packages to be inserted in every LaTeX header.
3387 These will be inserted after `org-export-latex-default-packages-alist'.
3389 SNIPPET-FLAG, when t, indicates that this package is also needed when
3390 turning LaTeX snippets into images for inclusion into HTML.
3391 Make sure that you only list packages here which:
3392 - you want in every file
3393 - do not conflict with the default packages in
3394 `org-export-latex-default-packages-alist'
3395 - do not conflict with the setup in `org-format-latex-header'."
3409 "Settings for Org-mode appearance."
3414 "Non-nil means fontify only the stars in each headline.
3415 When nil, the entire headline is fontified.
3416 Changing it requires restart of `font-lock-mode' to become effective
3417 also in regions already fontified."
3422 "Non-nil means hide the first N-1 stars in a headline.
3423 This works by using the face `org-hide' for these stars. This
3424 face is white for a light background, and black for a dark
3425 background. You may have to customize the face `org-hide' to
3426 make this work.
3427 Changing it requires restart of `font-lock-mode' to become effective
3428 also in regions already fontified.
3429 You may also set this on a per-file basis by adding one of the following
3430 lines to the buffer:
3432 #+STARTUP: hidestars
3433 #+STARTUP: showstars"
3438 "List of symbols corresponding to keywords to be hidden the org buffer.
3439 For example, a value '(title) for this list will make the document's title
3440 appear in the buffer without the initial #+TITLE: keyword."
3448 "Non-nil means change the face of a headline if it is marked DONE.
3449 Normally, only the TODO/DONE keyword indicates the state of a headline.
3450 When this is non-nil, the headline after the keyword is set to the
3451 `org-headline-done' as an additional indication."
3456 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3457 Changing this variable requires a restart of Emacs to take effect."
3462 "Non-nil means fontify the whole line for headings.
3463 This is useful when setting a background color for the
3464 org-level-* faces."
3469 "Non-nil means fontify what is treated specially by the exporters."
3474 "Non-nil mean font-lock should hide the emphasis marker characters."
3479 "Non-nil means show entities as UTF8 characters.
3485 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3490 "Regular expression for matching emphasis.
3491 After a match, the match groups contain these elements:
3492 0 The match of the full regular expression, including the characters
3493 before and after the proper match
3494 1 The character before the proper match, or empty at beginning of line
3495 2 The proper match, including the leading and trailing markers
3496 3 The leading marker like * or /, indicating the type of highlighting
3497 4 The text between the emphasis markers, not including the markers
3504 "Set variable and compute the emphasis regular expression."
3508 org-emphasis-alist org-emphasis-regexp-components)
3520 ;; make sure special characters appear at the right position in the class
3532 ;; Make the regexp
3540 body1
3552 body1
3560 "Components used to build the regular expression for emphasis.
3561 This is a list with five entries. Terminology: In an emphasis string
3565 specify what is allowed/forbidden in each part:
3567 pre Chars allowed as prematch. Beginning of line will be allowed too.
3568 post Chars allowed as postmatch. End of line will be allowed too.
3569 border The chars *forbidden* as border characters.
3571 non-shy groups here, and don't allow newline here.
3572 newline The maximum number of newlines allowed in an emphasis exp.
3574 Use customize to modify this, or restart Emacs after changing it."
3593 )
3594 "Special syntax for emphasized text.
3595 Text starting and ending with a special character will be emphasized, for
3596 example *bold*, _underlined_ and /italic/. This variable sets the marker
3597 characters, the face to be used by font-lock for highlighting in Org-mode
3598 Emacs buffers, and the HTML tags to be used for this.
3599 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3600 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3601 Use customize to modify this, or restart Emacs after changing it."
3616 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3619 ;;; Miscellaneous options
3622 "Completion in Org-mode."
3627 "Non-nil means use ido completion wherever possible.
3628 Note that `ido-mode' must be active for this variable to be relevant.
3629 If you decide to turn this variable on, you might well want to turn off
3630 `org-outline-path-complete-in-steps'.
3631 See also `org-completion-use-iswitchb'."
3636 "Non-nil means use iswitchb completion wherever possible.
3637 Note that `iswitchb-mode' must be active for this variable to be relevant.
3638 If you decide to turn this variable on, you might well want to turn off
3639 `org-outline-path-complete-in-steps'.
3640 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3646 Normal means, no org-mode-specific context."
3650 ;;; Functions and variables from their packages
3651 ;; Declared here to avoid compiler warnings
3653 ;; XEmacs only
3659 ;; Emacs only
3662 ;; Various packages
3680 org-format-agenda-item "org-agenda"
3711 ;;; Autoload and prepare some org modules
3713 ;; Some table stuff that needs to be defined here, because it is used
3714 ;; by the functions setting up org-mode or checking for table context.
3727 "Detect the first line outside a table when searching from within it.
3730 ;; Autoload the functions in org-table.el that are needed by functions here.
3735 org-table-convert org-table-convert-region org-table-copy-down
3736 org-table-copy-region org-table-create
3737 org-table-create-or-convert-from-region
3738 org-table-create-with-table.el org-table-current-dline
3739 org-table-cut-region org-table-delete-column org-table-edit-field
3740 org-table-edit-formulas org-table-end org-table-eval-formula
3741 org-table-export org-table-field-info
3742 org-table-get-stored-formulas org-table-goto-column
3743 org-table-hline-and-move org-table-import org-table-insert-column
3744 org-table-insert-hline org-table-insert-row org-table-iterate
3745 org-table-justify-field-maybe org-table-kill-row
3746 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3747 org-table-move-column org-table-move-column-left
3748 org-table-move-column-right org-table-move-row
3749 org-table-move-row-down org-table-move-row-up
3750 org-table-next-field org-table-next-row org-table-paste-rectangle
3751 org-table-previous-field org-table-recalculate
3752 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3753 org-table-toggle-coordinate-overlays
3754 org-table-toggle-formula-debugger org-table-wrap-region
3755 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3756 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3757 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3760 "Return t if the cursor is inside an org-type table.
3761 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3766 org-table-line-regexp)))
3767 nil))
3771 "Return t if and only if we are at a table.el table."
3777 "If there is a table.el table nearby, recognize it and move into it."
3783 nil
3793 t
3798 t)
3799 nil)
3800 nil))
3803 "Return t if the cursor is inside a hline in a table."
3808 nil))
3813 "Apply FUNCTION to the start of all tables in the buffer."
3829 ;; Declare and autoload functions from org-exp.el & Co
3837 org-insert-export-options-template
3838 org-table-clean-before-export))
3841 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3842 org-export-region-as-ascii))
3845 org-replace-region-by-latex org-export-region-as-latex
3846 org-export-as-latex org-export-as-pdf
3847 org-export-as-pdf-and-open))
3850 org-export-as-html-batch org-export-as-html-to-buffer
3851 org-replace-region-by-html org-export-region-as-html
3852 org-export-as-html))
3855 org-replace-region-by-docbook org-export-region-as-docbook
3856 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3857 org-export-as-docbook))
3860 org-export-icalendar-all-agenda-files
3861 org-export-icalendar-combine-agenda-files))
3865 ;; Declare and autoload functions from org-agenda.el
3870 org-todo-list org-tags-view org-agenda-list-stuck-projects
3871 org-diary org-agenda-to-appt
3872 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3874 ;; Autoload org-remember
3879 org-remember-apply-template org-remember org-remember-handler)))
3884 org-capture-import-remember-templates)))
3886 ;; Autoload org-clock.el
3901 "Return non-nil if clock is currently running.
3902 The return value is actually the clock marker."
3907 "org-clock"
3909 org-clock-goto org-clock-sum org-clock-display
3910 org-clock-remove-overlays org-clock-report
3911 org-clocktable-shift org-dblock-write:clocktable
3912 org-get-clocktable org-resolve-clocks)))
3915 "If this is a CLOCK line, update it and return t.
3916 Otherwise, return nil."
3925 ts te h m s neg)
3928 nil)
3933 ;; The clock is running here
3954 t))))))
3957 "Check if the current buffer contains the running clock.
3958 If yes, offer to stop it and to save the buffer with the changes."
3967 "Check if this line starts a clock table, if yes, shift the time block."
3971 ;; Autoload org-timer.el
3975 "org-timer"
3977 org-timer-change-times-in-region
3978 org-timer-set-timer
3979 org-timer-reset-timers
3980 org-timer-show-remaining-time)))
3982 ;; Autoload org-feed.el
3986 "org-feed"
3990 ;; Autoload org-indent.el
3992 ;; Define the variable already here, to make sure we have it.
3994 "Non-nil if Org-Indent mode is enabled.
3999 "org-indent"
4002 ;; Autoload org-mobile.el
4006 "org-mobile"
4009 ;; Autoload archiving code
4010 ;; The stuff that is needed for cycling and tags has to be defined here.
4013 "Options concerning archiving in Org-mode."
4018 "The location where subtrees should be archived.
4020 The value of this variable is a string, consisting of two parts,
4021 separated by a double-colon. The first part is a filename and
4022 the second part is a headline.
4024 When the filename is omitted, archiving happens in the same file.
4025 %s in the filename will be replaced by the current file
4026 name (without the directory part). Archiving to a different file
4027 is useful to keep archived entries from contributing to the
4028 Org-mode Agenda.
4030 The archived entries will be filed as subtrees of the specified
4031 headline. When the headline is omitted, the subtrees are simply
4032 filed away at the end of the file, as top-level entries. Also in
4033 the heading you can use %s to represent the file name, this can be
4034 useful when using the same archive for a number of different files.
4036 Here are a few examples:
4038 If the current file is Projects.org, archive in file
4039 Projects.org_archive, as top-level trees. This is the default.
4042 Archive in the current file, under the top-level headline
4046 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4049 Archive in file ~/org/archive.org (absolute path), under headlines
4053 Archive in file ./basement (relative path), as level 3 trees
4056 You may set this option on a per-file basis by adding to the buffer a
4057 line like
4059 #+ARCHIVE: basement::** Finished Tasks
4061 You may also define it locally for a subtree by setting an ARCHIVE property
4062 in the entry. If such a property is found in an entry, or anywhere up
4063 the hierarchy, it will be used."
4068 "The tag that marks a subtree as archived.
4069 An archived subtree does not open during visibility cycling, and does
4070 not contribute to the agenda listings.
4071 After changing this, font-lock must be restarted in the relevant buffers to
4072 get the proper fontification."
4078 "Non-nil means the agenda will skip any items located in archived trees.
4079 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4080 variable is no longer recommended, you should leave it at the value t.
4081 Instead, use the key `v' to cycle the archives-mode in the agenda."
4087 "Non-nil means ignore archived trees when creating column view."
4093 "Non-nil means `org-cycle' will open archived trees.
4094 An archived tree is a tree marked with the tag ARCHIVE.
4095 When nil, archived trees will stay folded. You can still open them with
4096 normal outline commands like `show-all', but not with the cycling commands."
4102 "Non-nil means sparse tree construction shows matches in archived trees.
4103 When nil, matches in these trees are highlighted, but the trees are kept in
4104 collapsed state."
4110 "Re-hide all archived subtrees after a visibility state change."
4121 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4124 "Cycle subtree even if it is archived."
4131 "Re-hide all archived subtrees after a visibility state change."
4146 flag)))
4153 org-archive-to-archive-sibling org-toggle-archive-tag
4154 org-archive-subtree-default
4155 org-archive-subtree-default-with-confirmation)))
4157 ;; Autoload Column View Code
4165 org-columns-compute org-agenda-columns org-columns-remove-overlays
4168 ;; Autoload ID code
4176 org-id-get-with-outline-path-completion
4177 org-id-get-with-outline-drilling org-id-store-link
4178 org-id-goto org-id-find org-id-store-link))
4180 ;; Autoload Plotting Code
4185 ;;; Variables for pre-computed regular expressions, all buffer local
4203 "Matches a headline and puts everything into groups:
4204 group 1: the stars
4205 group 2: The todo keyword, maybe
4206 group 3: Priority cookie
4207 group 4: True headline
4211 "Printf format to make regexp to match an exact headline.
4212 This regexp will match the headline of any node which hase the exact
4213 headline text that is put into the format, but may have any TODO state,
4217 "Matches a headline and puts TODO state into group 2 if present.
4272 "Regular expression to match a plain time or time range.
4273 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4274 groups carry important information:
4275 0 the full match
4276 1 the first time, range or not
4284 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4285 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4286 groups carry important information:
4287 0 the full match
4288 7 hours of duration
4297 "Regular expression to match a timestamp time or time range.
4298 After a match, the following groups carry important information:
4299 0 the full match
4300 1 date plus weekday, for back referencing to make sure both times are on the same day
4301 2 the first time, range or not
4356 "Variable associated with STARTUP options for org-mode.
4357 Each element is a list of three items: The startup options as written
4358 in the #+STARTUP line, the corresponding variable, and the value to
4359 set this variable to if the option is found. An optional forth element PUSH
4363 "Precompute regular expressions for current buffer."
4383 kwds kws0 kwsa key log value cat arch tags const links hw dws
4384 tail sep kws1 prio props ftags drawers beamer-p
4406 ;; general TODO-like setup
4418 links)))
4424 props)))
4429 ftags
4439 l var val)
4469 ))))
4486 ;; Process the TODO keywords
4488 ;; Use the global values as if they had been given locally.
4500 kws)))
4503 kwsa nil
4506 ;; 1 2
4514 kw)
4516 kws0)
4533 ;; Process the constants
4541 ;; Process the tags.
4552 tgs))
4560 ;; Compute the regular expressions and other local variables
4568 org-drawer-regexp
4572 org-not-done-keywords
4574 org-todo-regexp
4577 org-not-done-regexp
4581 org-not-done-heading-regexp
4585 org-todo-line-regexp
4589 org-complex-heading-regexp
4596 org-complex-heading-regexp-format
4605 org-nl-done-regexp
4609 org-todo-line-tags-regexp
4614 org-looking-at-done-regexp
4619 org-deadline-time-regexp
4621 org-deadline-line-regexp
4623 org-scheduled-regexp
4625 org-scheduled-time-regexp
4627 org-closed-time-regexp
4629 org-keyword-time-regexp
4635 org-keyword-time-not-clock-regexp
4641 org-maybe-keyword-time-regexp
4647 org-planning-or-clock-line-re
4652 org-all-time-keywords
4655 org-clock-string org-closed-string))
4656 )
4661 "Return the contents of FILE, as a string."
4675 "Extract the log state setting from a TODO keyword string.
4689 "Remove a pair of parenthesis at the end of each string in LIST."
4693 x))
4694 list))
4697 "Assign fast keys to a keyword-key alist.
4698 Respect keys that are already there."
4716 ;;; Some variables used in various places
4723 "Function to be called when `C-c C-c' is used.
4727 ;; FIXME: Occasionally check by commenting these, to make sure
4728 ;; no other functions uses these, forgetting to let-bind them.
4733 ;; Defined somewhere in this file, but used before definition.
4739 ;;;; Define the Org-mode
4742 (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"))
4745 ;; We use a before-change function to check if a table might need
4746 ;; an update.
4748 "Indicates that a table might need an update.
4749 This variable is set by `org-before-change-function'.
4752 "Every change indicates that a table might need an update."
4762 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4763 ;; some places -- e.g. see the macro org-with-limited-levels.
4764 ;;
4765 ;; In Org buffers, the value of `outline-regexp' is that of
4766 ;; `org-outline-regexp'. The only function still directly relying on
4767 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4768 ;; job when `orgstruct-mode' is active.
4772 "Regexp to match Org headlines.
4773 This is similar to `org-outline-regexp' but additionally makes
4776 ;;;###autoload
4778 "Outline-based notes management and organizer, alias
4781 Org-mode develops organizational tasks around a NOTES file which
4782 contains information about projects as plain text. Org-mode is
4783 implemented on top of outline-mode, which is ideal to keep the content
4784 of large files well structured. It supports ToDo items, deadlines and
4785 time stamps, which magically appear in the diary listing of the Emacs
4786 calendar. Tables are easily created with a built-in table editor.
4787 Plain text URL-like links connect to websites, emails (VM), Usenet
4788 messages (Gnus), BBDB entries, and any files related to the project.
4789 For printing and sharing of notes, an Org-mode file (or a part of it)
4790 can be exported as a structured ASCII or HTML file.
4792 The following commands are available:
4796 ;; Get rid of Outline menus, they are not needed
4797 ;; Need to do this here because define-derived-mode sets up
4798 ;; the keymap so late. Still, it is a waste to call this each time
4799 ;; we switch another buffer into org-mode.
4802 ;; Assume this is Greg's port, it uses easymenu
4827 org-display-table 4
4830 org-ellipsis)))
4835 ;; tag faces set outside customize.... force initialization.
4837 ;; Calc embedded
4843 ;; Activate before-change-function
4847 ;; Check for running clock before killing a buffer
4849 ;; Paragraphs and auto-filling
4853 ;; Beginning/end of defun
4856 ;; Next error for sparse trees
4858 ;; Make sure dependence stuff works reliably, even for users who set it
4859 ;; too late :-(
4871 ;; Comment characters
4875 ;; Align options lines
4877 'align-mode-rules-list
4882 ;; Imenu
4886 ;; Make isearch reveal context
4889 ;; Emacs 21 and XEmacs make use of the hook
4891 ;; Emacs 22 deals with this through a special variable
4895 ;; Turn on org-beamer-mode?
4898 ;; Setup the pcomplete hooks
4911 ;; If empty file that did not turn on org-mode automatically, make it to.
4936 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4946 "Return today date, considering `org-extend-today-until'."
4951 ;;;; Font-Lock stuff, including the activators
4982 "Regular expression used to analyze links.
4983 Here is what the match groups contain after a match:
4984 1: http:
4985 2: http
4986 3: path
4987 4: [desc]
4995 "Number of stacked braces for sub/superscript matching.
4996 This has to be set before loading org.el to be effective."
5001 "Create a regular expression which will match a balanced sexp.
5002 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5003 as single character strings.
5004 The regexp returned will match the entire expression including the
5005 delimiters. It will also define a single group which contains the
5006 match except for the outermost delimiters. The maximum depth of
5007 stacked delimiters is N. Escaping delimiters is not possible."
5036 "Update the link regular expressions.
5037 This should be called after the variable `org-link-types' has changed."
5041 org-link-re-with-space
5047 org-link-re-with-space2
5053 org-link-re-with-space3
5058 org-angle-link-re
5064 org-plain-link-re
5068 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5069 org-bracket-link-regexp
5071 org-bracket-link-analytic-regexp
5079 org-bracket-link-analytic-regexp++
5087 org-any-link-re
5096 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5098 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5099 "Regular expression matching time strings for analysis.
5100 This one does not require the space after the date, so it can be used
5102 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5118 "Regular expression matching a time stamp or time stamp range.
5124 "Run through the buffer and add overlays to emphasised strings."
5133 'face
5146 rtn))
5149 "Insert or change an emphasis, i.e. a font like bold or italic.
5150 If there is an active region, change that region to a new emphasis.
5151 If there is no region, just insert the marker characters and position
5152 the cursor between them.
5153 CHAR should be either the marker character, or the first character of the
5154 HTML tag associated with that emphasis. If CHAR is a space, the means
5155 to remove the emphasis of the selected region.
5156 If char is not given (for example in an interactive call) it
5157 will be prompted for."
5208 "Run through the buffer and add overlays to links."
5217 nil
5223 t)))))
5231 t)))
5234 "When non-nil, fontify code in code blocks."
5245 "Fontify #+ lines and blocks, in the correct ways."
5248 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5249 limit t)
5257 end end1 quoting block-type ovl)
5260 ;; a single line of backend-specific content
5268 ; for backend-specific code
5269 t)
5271 ;; Truly a block
5283 beg end
5291 ;; remove old background overlays
5296 ;; add a background overlay
5310 t))
5323 ;; just any other in-buffer setting, but not indented
5327 t)
5336 t)
5344 "Run through the buffer and add overlays to links."
5352 t)))
5355 "Run through the buffer and add overlays to footnotes."
5362 'keymap org-mouse-map
5363 'help-echo
5365 "Footnote definition"
5367 'font-lock-fontified t
5368 'font-lock-multiline t
5372 "Run through the buffer and add overlays to bracketed links."
5376 ;; FIXME: above we should remove the escapes.
5377 ;; but that requires another match, protecting match data,
5378 ;; a lot of overhead for font-lock.
5385 ;; We need to remove the invisible property here. Table narrowing
5386 ;; may have made some of this invisible.
5404 t)))
5407 "Run through the buffer and add overlays to dates."
5419 t)))
5428 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5432 "Run through the buffer and add overlays to target matches."
5440 'keymap org-mouse-map
5444 t)))))
5447 "Find all radio targets in this file and update the regular expression."
5462 t)))
5469 ;; This should be with the exporter code, but we also use if for font-locking
5479 "Compute regular expression for stuff treated specially by exporters."
5486 org-latex-regexps)))
5514 org-entities)))
5518 org-latex-entities)
5519 nil))
5521 ))
5522 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5525 org-export-html-special-string-regexps)))
5530 ))))
5532 'org-latex-and-specials-regexp
5537 "Run through the buffer and add overlays to links."
5541 limit t))
5555 rtn)))
5558 "Restart `font-lock-mode', to force refontification."
5564 "Return a list of all targets in this file.
5565 With optional argument RADIO, only find radio targets."
5567 rtn)
5572 rtn)))
5575 "Make regular expression matching all strings in TARGETS.
5576 The regular expression finds the targets also if there is a line break
5577 between words."
5586 x)
5587 targets
5599 t)))
5602 "Compute the outline level of the heading at point.
5603 This function assumes that the cursor is at the beginning of a line matched
5604 by `outline-regexp'. Otherwise it returns garbage.
5605 If this is called at a normal headline, the level is the number of stars.
5606 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5613 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5620 "Functions that can manipulate `org-font-lock-extra-keywords'.
5621 This is calles after `org-font-lock-extra-keywords' is defined, but before
5622 it is installed to be used by font lock. This can be useful if something
5633 ;; Call the hook
5635 ;; Headlines
5642 ;; Table lines
5645 ;; Table internals
5650 ;; Drawers
5653 ;; Properties
5657 ;; Links
5667 ;; TODO lines
5670 ;; DONE
5676 nil)
5677 ;; Priorities
5679 ;; Tags
5681 ;; Special keywords
5686 ;; Emphasis
5691 ;; Checkboxes
5692 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5697 ;; Description list items
5700 ;; ARCHIVEd headings
5702 org-outline-regexp-bol
5705 ;; Specials
5709 ;; Code
5711 ;; COMMENT
5716 ;; Blocks and meta lines
5718 )))
5721 ;; Now set the full font-lock-keywords
5728 "Toggle the composition display of entities as UTF8 characters."
5740 "Find an entity to fontify."
5746 limit t)
5758 nil))))
5761 "Fontify string S like in Org-mode."
5773 "Get the right face for match N in font-lock matching of headlines."
5786 "Get the right face for a TODO keyword KWD.
5787 If KWD is a number, get the corresponding match group."
5795 "Create a face list that inherits INHERIT, but sets the foreground color.
5796 When FACE-OR-COLOR is not a string, just return it."
5800 face-or-color)
5801 face-or-color))
5804 "Add the special tag faces."
5813 "Add the special priority faces."
5820 org-priority-faces)))
5825 "Get the right face for a TODO keyword KWD.
5826 If KWD is a number, get the corresponding match group."
5833 "Remove fontification and activation overlays from links."
5838 deactivate-mark buffer-file-name buffer-file-truename)
5842 invisible t intangible t
5843 org-no-flyspell t org-emphasis t))
5853 "Remove specific display properties that have been added by font lock.
5854 The will remove the raise properties that are used to show superscripts
5855 and subscripts."
5865 "Add raise properties to sub/superscripts."
5869 org-match-substring-regexp
5870 org-match-substring-with-braces-regexp)
5871 limit t)
5881 ;; FIXME: Should we go back one character here, for a_b^c
5882 ;; (goto-char (1- pos)) ;????????????????????
5884 t
5886 'display
5902 t)))))
5904 ;;;; Visibility cycling, including org-goto and indirect buffer
5906 ;;; Cycling
5913 ;;;###autoload
5918 "TAB-action and visibility cycling for Org-mode.
5920 This is the command invoked in Org-mode by the TAB key. Its main purpose
5921 is outline visibility cycling, but it also invokes other actions
5922 in special contexts.
5924 - When this function is called with a prefix argument, rotate the entire
5925 buffer through 3 states (global cycling)
5926 1. OVERVIEW: Show only top-level headlines.
5927 2. CONTENTS: Show all headlines of all levels, but no body text.
5928 3. SHOW ALL: Show everything.
5929 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5930 determined by the variable `org-startup-folded', and by any VISIBILITY
5931 properties in the buffer.
5932 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5933 including any drawers.
5935 - When inside a table, re-align the table and move to the next field.
5937 - When point is at the beginning of a headline, rotate the subtree started
5938 by this line through 3 different states (local cycling)
5939 1. FOLDED: Only the main headline is shown.
5940 2. CHILDREN: The main headline and the direct children are shown.
5941 From this state, you can move to one of the children
5942 and zoom in further.
5943 3. SUBTREE: Show the entire subtree, including body text.
5944 If there is no subtree, switch directly from CHILDREN to FOLDED.
5946 - When point is at the beginning of an empty headline and the variable
5947 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5948 of the headline by demoting and promoting it to likely levels. This
5949 speeds up creation document structure by pressing TAB once or several
5950 times right after creating a new headline.
5952 - When there is a numeric prefix, go up to a heading with level ARG, do
5953 a `show-subtree' and return to the previous cursor position. If ARG
5954 is negative, go up that many levels.
5956 - When point is not at the beginning of a headline, execute the global
5957 binding for TAB, which is re-indenting the line. See the option
5958 `org-cycle-emulate-tab' for details.
5960 - Special case: if point is at the beginning of the buffer and there is
5961 no headline in line 1, this function will act as if called with prefix arg
5962 (C-u TAB, same as S-TAB) also when called without prefix arg.
5963 But only if also the variable `org-cycle-global-at-bob' is t."
5973 org-inlinetask-min-level
5978 limit-level)))
5981 outline-regexp
5989 org-cycle-hook))
5993 ;; special case: use global cycling
6007 ;; Table: enter it or move to the next field.
6018 ;; Global cycling: delegate to `org-cycle-internal-global'.
6021 ;; Drawers: delegate to `org-flag-drawer'.
6029 ;; Show-subtree, ARG levels up from here.
6037 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6043 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6050 ;; From there: TAB emulation and template completion.
6074 t
6083 "Do the global cycling action."
6087 ;; We just created the overview - now do table of contents
6088 ;; This can be slow in very large buffers, so indicate action
6098 ;; We just showed the table of contents - now show everything
6106 ;; Default action: go to overview
6114 "Do the local cycling action."
6116 ;; First, determine end of headline (EOH), end of subtree or item
6117 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6141 ;; Determine end invisible part of buffer (EOL)
6143 ;; XEmacs doesn't have `next-single-char-property-change'
6153 ;; Find out what to do next and set `this-command'
6156 ;; Nothing is hidden behind this heading
6168 org-cycle-skip-children-state-if-no-children))))
6169 ;; Entire subtree is hidden in one line: children view
6175 ;; Fold every list in subtree to top-level items.
6197 ;; We just showed the children, or no children are there,
6198 ;; now show everything.
6205 ;; Default action: hide the subtree.
6212 ;;;###autoload
6214 "Cycle the global visibility. For details see `org-cycle'.
6216 With a numeric prefix, show all headlines up to that level."
6232 "Set the visibility required by startup options and properties."
6247 "Switch subtree visibilities according to :VISIBILITY: property."
6254 nil t)
6278 ;; This function uses outline-regexp instead of the more fundamental
6279 ;; org-outline-regexp so that org-cycle-global works outside of Org
6280 ;; buffers, where outline-regexp is needed.
6282 "Switch to overview mode, showing only top-level headlines.
6283 Really, this shows all headlines with level equal or greater than the level
6284 of the first headline in the buffer. This is important, because if the
6285 first headline is not level one, then (hide-sublevels 1) gives confusing
6286 results."
6297 "Show all headlines in the buffer, like a table of contents.
6298 With numerical argument N, show content up to level N."
6301 ;; Visit all headings and show their offspring
6308 t)
6317 "Adjust the window after a change in outline visibility.
6318 This function is the default value of the hook `org-cycle-hook'."
6328 "Remove outline overlays that do not contain non-white stuff."
6338 "Fix visibility issues after moving a subtree."
6339 ;; First, find a reasonable region to look at:
6340 ;; Start two siblings above, end three below
6358 ;; Properly fold already folded siblings
6369 "Show empty lines above all visible headlines.
6370 The region to be covered depends on STATE when called through
6371 `org-cycle-hook'. Lisp program can use t for STATE to get the
6372 entire buffer covered. Note that an empty line is only shown if there
6373 are at least `org-cycle-separator-lines' empty lines before the headline."
6383 beg end b e)
6407 ;; Never hide empty lines at the end of the file.
6417 "Move to the parent and re-show empty lines before visible headlines."
6423 "Return `org-agenda-files' list, plus all open org-mode files.
6424 This is useful for operations that need to scan all of a user's
6425 open and agenda-wise Org files."
6433 files))
6436 "Return the beginning position of the current entry."
6440 "Return the end position of the current entry."
6444 "Re-hide all drawers after a visibility state change."
6470 "Is the end of the current subtree visible?"
6475 "Move cursor to the first headline and recenter the headline.
6476 Optional argument N means put the headline into the Nth line of the window."
6482 ;;; Saving and restoring visibility
6485 "Return a list of the locations of all outline overlays.
6486 These are overlays with the `invisible' property value `outline'.
6487 The return value is a list of cons cells, with start and stop
6488 positions for each overlay.
6489 If USE-MARKERS is set, return the positions as markers."
6507 "Create visibility overlays for all positions in DATA.
6508 DATA should have been made by `org-outline-overlay-data'."
6517 data)))))
6519 ;;; Folding of blocks
6530 "Call FUNCTION at the head of all source blocks in the current buffer.
6531 Optional arguments START and END can be used to limit the range."
6543 "Toggle the visibility of all blocks in the current buffer."
6547 "Fold all blocks in the current buffer."
6553 "Unfold all blocks in the current buffer."
6559 "Toggle visibility of block at point."
6570 "Toggle the visibility of the current block."
6577 ov)
6593 ;; make the block accessible to isearch
6595 ov 'isearch-open-invisible
6606 ;; org-tab-after-check-for-cycling-hook
6608 ;; Remove overlays when changing major mode
6613 ;;; Org-goto
6619 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6635 nil)
6636 (org-defkey map "q" 'org-goto-quit)
6637 (org-defkey map "n" 'outline-next-visible-heading)
6638 (org-defkey map "p" 'outline-previous-visible-heading)
6639 (org-defkey map "f" 'outline-forward-same-level)
6640 (org-defkey map "b" 'outline-backward-same-level)
6641 (org-defkey map "u" 'outline-up-heading))
6642 (org-defkey map "/" 'org-occur)
6643 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6644 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6645 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6646 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6647 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6648 map))
6650 (defconst org-goto-help
6651 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6652 RET=jump to location [Q]uit and return to previous location
6653 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6655 (defvar org-goto-start-pos) ; dynamically scoped parameter
6657 ;; FIXME: Docstring does not mention both interfaces
6658 (defun org-goto (&optional alternative-interface)
6659 "Look up a different location in the current file, keeping current visibility.
6661 When you want look-up or go to a different location in a document, the
6662 fastest way is often to fold the entire buffer and then dive into the tree.
6663 This method has the disadvantage, that the previous location will be folded,
6664 which may not be what you want.
6666 This command works around this by showing a copy of the current buffer
6667 in an indirect buffer, in overview mode. You can dive into the tree in
6668 that copy, use org-occur and incremental search to find a location.
6669 When pressing RET or `Q', the command returns to the original buffer in
6670 which the visibility is still unchanged. After RET is will also jump to
6671 the location selected in the indirect buffer and expose the headline
6672 hierarchy above."
6673 (interactive "P")
6674 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6675 (org-refile-use-outline-path t)
6676 (org-refile-target-verify-function nil)
6677 (interface
6678 (if (not alternative-interface)
6679 org-goto-interface
6680 (if (eq org-goto-interface 'outline)
6681 'outline-path-completion
6682 'outline)))
6683 (org-goto-start-pos (point))
6684 (selected-point
6685 (if (eq interface 'outline)
6686 (car (org-get-location (current-buffer) org-goto-help))
6687 (let ((pa (org-refile-get-location "Goto")))
6688 (org-refile-check-position pa)
6689 (nth 3 pa)))))
6690 (if selected-point
6691 (progn
6692 (org-mark-ring-push org-goto-start-pos)
6693 (goto-char selected-point)
6694 (if (or (outline-invisible-p) (org-invisible-p2))
6695 (org-show-context 'org-goto)))
6696 (message "Quit"))))
6698 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6699 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6700 (defvar org-goto-local-auto-isearch-map) ; defined below
6702 (defun org-get-location (buf help)
6703 "Let the user select a location in the Org-mode buffer BUF.
6704 This function uses a recursive edit. It returns the selected position
6705 or nil."
6706 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6707 (isearch-hide-immediately nil)
6708 (isearch-search-fun-function
6709 (lambda () 'org-goto-local-search-headings))
6710 (org-goto-selected-point org-goto-exit-command)
6711 (pop-up-frames nil)
6712 (special-display-buffer-names nil)
6713 (special-display-regexps nil)
6714 (special-display-function nil))
6715 (save-excursion
6716 (save-window-excursion
6717 (delete-other-windows)
6718 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6719 (org-pop-to-buffer-same-window
6720 (condition-case nil
6721 (make-indirect-buffer (current-buffer) "*org-goto*")
6722 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6723 (with-output-to-temp-buffer "*Help*"
6724 (princ help))
6725 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6726 (setq buffer-read-only nil)
6727 (let ((org-startup-truncated t)
6728 (org-startup-folded nil)
6729 (org-startup-align-all-tables nil))
6730 (org-mode)
6731 (org-overview))
6732 (setq buffer-read-only t)
6733 (if (and (boundp 'org-goto-start-pos)
6734 (integer-or-marker-p org-goto-start-pos))
6735 (let ((org-show-hierarchy-above t)
6736 (org-show-siblings t)
6737 (org-show-following-heading t))
6738 (goto-char org-goto-start-pos)
6739 (and (outline-invisible-p) (org-show-context)))
6740 (goto-char (point-min)))
6741 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6742 (message "Select location and press RET")
6743 (use-local-map org-goto-map)
6744 (recursive-edit)
6745 ))
6746 (kill-buffer "*org-goto*")
6747 (cons org-goto-selected-point org-goto-exit-command)))
6749 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6750 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6751 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6752 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6754 (defun org-goto-local-search-headings (string bound noerror)
6755 "Search and make sure that any matches are in headlines."
6756 (catch 'return
6757 (while (if isearch-forward
6758 (search-forward string bound noerror)
6759 (search-backward string bound noerror))
6760 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6761 (and (member :headline context)
6762 (not (member :tags context))))
6763 (throw 'return (point))))))
6765 (defun org-goto-local-auto-isearch ()
6766 "Start isearch."
6767 (interactive)
6768 (goto-char (point-min))
6769 (let ((keys (this-command-keys)))
6770 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6771 (isearch-mode t)
6772 (isearch-process-search-char (string-to-char keys)))))
6774 (defun org-goto-ret (&optional arg)
6775 "Finish `org-goto' by going to the new location."
6776 (interactive "P")
6777 (setq org-goto-selected-point (point)
6778 org-goto-exit-command 'return)
6779 (throw 'exit nil))
6781 (defun org-goto-left ()
6782 "Finish `org-goto' by going to the new location."
6783 (interactive)
6784 (if (org-on-heading-p)
6785 (progn
6786 (beginning-of-line 1)
6787 (setq org-goto-selected-point (point)
6788 org-goto-exit-command 'left)
6789 (throw 'exit nil))
6790 (error "Not on a heading")))
6792 (defun org-goto-right ()
6793 "Finish `org-goto' by going to the new location."
6794 (interactive)
6795 (if (org-on-heading-p)
6796 (progn
6797 (setq org-goto-selected-point (point)
6798 org-goto-exit-command 'right)
6799 (throw 'exit nil))
6800 (error "Not on a heading")))
6802 (defun org-goto-quit ()
6803 "Finish `org-goto' without cursor motion."
6804 (interactive)
6805 (setq org-goto-selected-point nil)
6806 (setq org-goto-exit-command 'quit)
6807 (throw 'exit nil))
6809 ;;; Indirect buffer display of subtrees
6811 (defvar org-indirect-dedicated-frame nil
6812 "This is the frame being used for indirect tree display.")
6813 (defvar org-last-indirect-buffer nil)
6815 (defun org-tree-to-indirect-buffer (&optional arg)
6816 "Create indirect buffer and narrow it to current subtree.
6817 With numerical prefix ARG, go up to this level and then take that tree.
6818 If ARG is negative, go up that many levels.
6819 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6820 indirect buffer previously made with this command, to avoid proliferation of
6821 indirect buffers. However, when you call the command with a \
6823 when `org-indirect-buffer-display' is `new-frame', the last buffer
6824 is kept so that you can work with several indirect buffers at the same time.
6825 If `org-indirect-buffer-display' is `dedicated-frame', the \
6827 requests that a new frame be made for the new buffer, so that the dedicated
6828 frame is not changed."
6829 (interactive "P")
6830 (let ((cbuf (current-buffer))
6831 (cwin (selected-window))
6832 (pos (point))
6833 beg end level heading ibuf)
6834 (save-excursion
6835 (org-back-to-heading t)
6836 (when (numberp arg)
6837 (setq level (org-outline-level))
6838 (if (< arg 0) (setq arg (+ level arg)))
6839 (while (> (setq level (org-outline-level)) arg)
6840 (outline-up-heading 1 t)))
6841 (setq beg (point)
6842 heading (org-get-heading))
6843 (org-end-of-subtree t t)
6844 (if (org-on-heading-p) (backward-char 1))
6845 (setq end (point)))
6846 (if (and (buffer-live-p org-last-indirect-buffer)
6847 (not (eq org-indirect-buffer-display 'new-frame))
6848 (not arg))
6849 (kill-buffer org-last-indirect-buffer))
6850 (setq ibuf (org-get-indirect-buffer cbuf)
6851 org-last-indirect-buffer ibuf)
6852 (cond
6853 ((or (eq org-indirect-buffer-display 'new-frame)
6854 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6855 (select-frame (make-frame))
6856 (delete-other-windows)
6857 (org-pop-to-buffer-same-window ibuf)
6858 (org-set-frame-title heading))
6859 ((eq org-indirect-buffer-display 'dedicated-frame)
6860 (raise-frame
6861 (select-frame (or (and org-indirect-dedicated-frame
6862 (frame-live-p org-indirect-dedicated-frame)
6863 org-indirect-dedicated-frame)
6864 (setq org-indirect-dedicated-frame (make-frame)))))
6865 (delete-other-windows)
6866 (org-pop-to-buffer-same-window ibuf)
6867 (org-set-frame-title (concat "Indirect: " heading)))
6868 ((eq org-indirect-buffer-display 'current-window)
6869 (org-pop-to-buffer-same-window ibuf))
6870 ((eq org-indirect-buffer-display 'other-window)
6871 (pop-to-buffer ibuf))
6872 (t (error "Invalid value")))
6873 (if (featurep 'xemacs)
6874 (save-excursion (org-mode) (turn-on-font-lock)))
6875 (narrow-to-region beg end)
6876 (show-all)
6877 (goto-char pos)
6878 (and (window-live-p cwin) (select-window cwin))))
6880 (defun org-get-indirect-buffer (&optional buffer)
6881 (setq buffer (or buffer (current-buffer)))
6882 (let ((n 1) (base (buffer-name buffer)) bname)
6883 (while (buffer-live-p
6884 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6885 (setq n (1+ n)))
6886 (condition-case nil
6887 (make-indirect-buffer buffer bname 'clone)
6888 (error (make-indirect-buffer buffer bname)))))
6890 (defun org-set-frame-title (title)
6891 "Set the title of the current frame to the string TITLE."
6892 ;; FIXME: how to name a single frame in XEmacs???
6893 (unless (featurep 'xemacs)
6894 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6896 ;;;; Structure editing
6898 ;;; Inserting headlines
6900 (defun org-previous-line-empty-p ()
6901 (save-excursion
6902 (and (not (bobp))
6903 (or (beginning-of-line 0) t)
6904 (save-match-data
6907 (defun org-insert-heading (&optional force-heading invisible-ok)
6908 "Insert a new heading or item with same depth at point.
6909 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6910 If point is at the beginning of a headline, insert a sibling before the
6911 current headline. If point is not at the beginning, split the line,
6912 create the new headline with the text in the current line after point
6913 \(but see also the variable `org-M-RET-may-split-line').
6915 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6916 This is important for non-interactive uses of the command."
6917 (interactive "P")
6918 (if (or (= (buffer-size) 0)
6919 (and (not (save-excursion
6920 (and (ignore-errors (org-back-to-heading invisible-ok))
6921 (org-on-heading-p))))
6922 (or force-heading (not (org-in-item-p)))))
6923 (progn
6925 (run-hooks 'org-insert-heading-hook))
6926 (when (or force-heading (not (org-insert-item)))
6927 (let* ((empty-line-p nil)
6928 (level nil)
6929 (on-heading (org-on-heading-p))
6930 (head (save-excursion
6931 (condition-case nil
6932 (progn
6933 (org-back-to-heading invisible-ok)
6934 (when (and (not on-heading)
6935 (featurep 'org-inlinetask)
6936 (integerp org-inlinetask-min-level)
6937 (>= (length (match-string 0))
6938 org-inlinetask-min-level))
6939 ;; Find a heading level before the inline task
6940 (while (and (setq level (org-up-heading-safe))
6941 (>= level org-inlinetask-min-level)))
6942 (if (org-on-heading-p)
6943 (org-back-to-heading invisible-ok)
6944 (error "This should not happen")))
6945 (setq empty-line-p (org-previous-line-empty-p))
6946 (match-string 0))
6947 (error "*"))))
6948 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6949 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6950 pos hide-previous previous-pos)
6951 (cond
6952 ((and (org-on-heading-p) (bolp)
6953 (or (bobp)
6954 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6955 ;; insert before the current line
6956 (open-line (if blank 2 1)))
6957 ((and (bolp)
6958 (not org-insert-heading-respect-content)
6959 (or (bobp)
6960 (save-excursion
6961 (backward-char 1) (not (outline-invisible-p)))))
6962 ;; insert right here
6963 nil)
6964 (t
6965 ;; somewhere in the line
6966 (save-excursion
6967 (setq previous-pos (point-at-bol))
6968 (end-of-line)
6969 (setq hide-previous (outline-invisible-p)))
6970 (and org-insert-heading-respect-content (org-show-subtree))
6971 (let ((split
6972 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6973 (save-excursion
6974 (let ((p (point)))
6975 (goto-char (point-at-bol))
6976 (and (looking-at org-complex-heading-regexp)
6977 (> p (match-beginning 4)))))))
6978 tags pos)
6979 (cond
6980 (org-insert-heading-respect-content
6981 (org-end-of-subtree nil t)
6982 (when (featurep 'org-inlinetask)
6983 (while (and (not (eobp))
6985 (>= (length (match-string 1))
6986 org-inlinetask-min-level))
6987 (org-end-of-subtree nil t)))
6988 (or (bolp) (newline))
6989 (or (org-previous-line-empty-p)
6990 (and blank (newline)))
6991 (open-line 1))
6992 ((org-on-heading-p)
6993 (when hide-previous
6994 (show-children)
6995 (org-show-entry))
6997 (setq tags (and (match-end 2) (match-string 2)))
6998 (and (match-end 1)
6999 (delete-region (match-beginning 1) (match-end 1)))
7000 (setq pos (point-at-bol))
7001 (or split (end-of-line 1))
7002 (delete-horizontal-space)
7004 (buffer-substring (point-at-bol) (point)))
7005 (insert " "))
7006 (newline (if blank 2 1))
7007 (when tags
7008 (save-excursion
7009 (goto-char pos)
7010 (end-of-line 1)
7011 (insert " " tags)
7012 (org-set-tags nil 'align))))
7013 (t
7014 (or split (end-of-line 1))
7015 (newline (if blank 2 1)))))))
7016 (insert head) (just-one-space)
7017 (setq pos (point))
7018 (end-of-line 1)
7019 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7020 (when (and org-insert-heading-respect-content hide-previous)
7021 (save-excursion
7022 (goto-char previous-pos)
7023 (hide-subtree)))
7024 (run-hooks 'org-insert-heading-hook)))))
7026 (defun org-get-heading (&optional no-tags no-todo)
7027 "Return the heading of the current entry, without the stars.
7028 When NO-TAGS is non-nil, don't include tags.
7029 When NO-TODO is non-nil, don't include TODO keywords."
7030 (save-excursion
7031 (org-back-to-heading t)
7032 (cond
7033 ((and no-tags no-todo)
7034 (looking-at org-complex-heading-regexp)
7035 (match-string 4))
7036 (no-tags
7038 (match-string 1))
7039 (no-todo
7042 (match-string 2))
7044 (match-string 1)))))
7046 (defun org-heading-components ()
7047 "Return the components of the current heading.
7048 This is a list with the following elements:
7049 - the level as an integer
7050 - the reduced level, different if `org-odd-levels-only' is set.
7051 - the TODO keyword, or nil
7052 - the priority character, like ?A, or nil if no priority is given
7053 - the headline text itself, or the tags string if no headline text
7054 - the tags string, or nil."
7055 (save-excursion
7056 (org-back-to-heading t)
7057 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7058 (list (length (match-string 1))
7059 (org-reduced-level (length (match-string 1)))
7060 (org-match-string-no-properties 2)
7061 (and (match-end 3) (aref (match-string 3) 2))
7062 (org-match-string-no-properties 4)
7063 (org-match-string-no-properties 5)))))
7065 (defun org-get-entry ()
7066 "Get the entry text, after heading, entire subtree."
7067 (save-excursion
7068 (org-back-to-heading t)
7069 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7071 (defun org-insert-heading-after-current ()
7072 "Insert a new heading with same level as current, after current subtree."
7073 (interactive)
7074 (org-back-to-heading)
7075 (org-insert-heading)
7076 (org-move-subtree-down)
7077 (end-of-line 1))
7079 (defun org-insert-heading-respect-content ()
7080 (interactive)
7081 (let ((org-insert-heading-respect-content t))
7082 (org-insert-heading t)))
7084 (defun org-insert-todo-heading-respect-content (&optional force-state)
7085 (interactive "P")
7086 (let ((org-insert-heading-respect-content t))
7087 (org-insert-todo-heading force-state t)))
7089 (defun org-insert-todo-heading (arg &optional force-heading)
7090 "Insert a new heading with the same level and TODO state as current heading.
7091 If the heading has no TODO state, or if the state is DONE, use the first
7092 state (TODO by default). Also with prefix arg, force first state."
7093 (interactive "P")
7094 (when (or force-heading (not (org-insert-item 'checkbox)))
7095 (org-insert-heading force-heading)
7096 (save-excursion
7097 (org-back-to-heading)
7098 (outline-previous-heading)
7099 (looking-at org-todo-line-regexp))
7100 (let*
7101 ((new-mark-x
7102 (if (or arg
7103 (not (match-beginning 2))
7104 (member (match-string 2) org-done-keywords))
7105 (car org-todo-keywords-1)
7106 (match-string 2)))
7107 (new-mark
7108 (or
7109 (run-hook-with-args-until-success
7110 'org-todo-get-default-hook new-mark-x nil)
7111 new-mark-x)))
7112 (beginning-of-line 1)
7113 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7114 (if org-treat-insert-todo-heading-as-state-change
7115 (org-todo new-mark)
7116 (insert new-mark " "))))
7117 (when org-provide-todo-statistics
7118 (org-update-parent-todo-statistics))))
7120 (defun org-insert-subheading (arg)
7121 "Insert a new subheading and demote it.
7122 Works for outline headings and for plain lists alike."
7123 (interactive "P")
7124 (org-insert-heading arg)
7125 (cond
7126 ((org-on-heading-p) (org-do-demote))
7127 ((org-at-item-p) (org-indent-item))))
7129 (defun org-insert-todo-subheading (arg)
7130 "Insert a new subheading with TODO keyword or checkbox and demote it.
7131 Works for outline headings and for plain lists alike."
7132 (interactive "P")
7133 (org-insert-todo-heading arg)
7134 (cond
7135 ((org-on-heading-p) (org-do-demote))
7136 ((org-at-item-p) (org-indent-item))))
7138 ;;; Promotion and Demotion
7140 (defvar org-after-demote-entry-hook nil
7141 "Hook run after an entry has been demoted.
7142 The cursor will be at the beginning of the entry.
7143 When a subtree is being demoted, the hook will be called for each node.")
7145 (defvar org-after-promote-entry-hook nil
7146 "Hook run after an entry has been promoted.
7147 The cursor will be at the beginning of the entry.
7148 When a subtree is being promoted, the hook will be called for each node.")
7150 (defun org-promote-subtree ()
7151 "Promote the entire subtree.
7152 See also `org-promote'."
7153 (interactive)
7154 (save-excursion
7155 (org-with-limited-levels (org-map-tree 'org-promote)))
7156 (org-fix-position-after-promote))
7158 (defun org-demote-subtree ()
7159 "Demote the entire subtree. See `org-demote'.
7160 See also `org-promote'."
7161 (interactive)
7162 (save-excursion
7163 (org-with-limited-levels (org-map-tree 'org-demote)))
7164 (org-fix-position-after-promote))
7167 (defun org-do-promote ()
7168 "Promote the current heading higher up the tree.
7169 If the region is active in `transient-mark-mode', promote all headings
7170 in the region."
7171 (interactive)
7172 (save-excursion
7173 (if (org-region-active-p)
7174 (org-map-region 'org-promote (region-beginning) (region-end))
7175 (org-promote)))
7176 (org-fix-position-after-promote))
7178 (defun org-do-demote ()
7179 "Demote the current heading lower down the tree.
7180 If the region is active in `transient-mark-mode', demote all headings
7181 in the region."
7182 (interactive)
7183 (save-excursion
7184 (if (org-region-active-p)
7185 (org-map-region 'org-demote (region-beginning) (region-end))
7186 (org-demote)))
7187 (org-fix-position-after-promote))
7189 (defun org-fix-position-after-promote ()
7190 "Make sure that after pro/demotion cursor position is right."
7191 (let ((pos (point)))
7192 (when (save-excursion
7193 (beginning-of-line 1)
7194 (looking-at org-todo-line-regexp)
7195 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7196 (cond ((eobp) (insert " "))
7197 ((eolp) (insert " "))
7198 ((equal (char-after) ?\ ) (forward-char 1))))))
7200 (defun org-current-level ()
7201 "Return the level of the current entry, or nil if before the first headline.
7202 The level is the number of stars at the beginning of the headline."
7203 (save-excursion
7204 (org-with-limited-levels
7205 (ignore-errors
7206 (org-back-to-heading t)
7207 (funcall outline-level)))))
7209 (defun org-get-previous-line-level ()
7210 "Return the outline depth of the last headline before the current line.
7211 Returns 0 for the first headline in the buffer, and nil if before the
7212 first headline."
7213 (let ((current-level (org-current-level))
7214 (prev-level (when (> (line-number-at-pos) 1)
7215 (save-excursion
7216 (beginning-of-line 0)
7217 (org-current-level)))))
7218 (cond ((null current-level) nil) ; Before first headline
7219 ((null prev-level) 0) ; At first headline
7220 (prev-level))))
7222 (defun org-reduced-level (l)
7223 "Compute the effective level of a heading.
7224 This takes into account the setting of `org-odd-levels-only'."
7225 (cond
7226 ((zerop l) 0)
7227 (org-odd-levels-only (1+ (floor (/ l 2))))
7228 (t l)))
7230 (defun org-level-increment ()
7231 "Return the number of stars that will be added or removed at a
7232 time to headlines when structure editing, based on the value of
7233 `org-odd-levels-only'."
7234 (if org-odd-levels-only 2 1))
7236 (defun org-get-valid-level (level &optional change)
7237 "Rectify a level change under the influence of `org-odd-levels-only'
7238 LEVEL is a current level, CHANGE is by how much the level should be
7239 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7240 even level numbers will become the next higher odd number."
7241 (if org-odd-levels-only
7242 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7243 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7244 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7245 (max 1 (+ level (or change 0)))))
7247 (if (boundp 'define-obsolete-function-alias)
7248 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7249 (define-obsolete-function-alias 'org-get-legal-level
7250 'org-get-valid-level)
7251 (define-obsolete-function-alias 'org-get-legal-level
7252 'org-get-valid-level "23.1")))
7254 (defun org-promote ()
7255 "Promote the current heading higher up the tree.
7256 If the region is active in `transient-mark-mode', promote all headings
7257 in the region."
7258 (org-back-to-heading t)
7259 (let* ((level (save-match-data (funcall outline-level)))
7260 (after-change-functions (remove 'flyspell-after-change-function
7261 after-change-functions))
7262 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7263 (diff (abs (- level (length up-head) -1))))
7264 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7265 (replace-match up-head nil t)
7266 ;; Fixup tag positioning
7267 (and org-auto-align-tags (org-set-tags nil t))
7268 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7269 (run-hooks 'org-after-promote-entry-hook)))
7271 (defun org-demote ()
7272 "Demote the current heading lower down the tree.
7273 If the region is active in `transient-mark-mode', demote all headings
7274 in the region."
7275 (org-back-to-heading t)
7276 (let* ((level (save-match-data (funcall outline-level)))
7277 (after-change-functions (remove 'flyspell-after-change-function
7278 after-change-functions))
7279 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7280 (diff (abs (- level (length down-head) -1))))
7281 (replace-match down-head nil t)
7282 ;; Fixup tag positioning
7283 (and org-auto-align-tags (org-set-tags nil t))
7284 (if org-adapt-indentation (org-fixup-indentation diff))
7285 (run-hooks 'org-after-demote-entry-hook)))
7287 (defun org-cycle-level ()
7288 "Cycle the level of an empty headline through possible states.
7289 This goes first to child, then to parent, level, then up the hierarchy.
7290 After top level, it switches back to sibling level."
7291 (interactive)
7292 (let ((org-adapt-indentation nil))
7293 (when (org-point-at-end-of-empty-headline)
7294 (setq this-command 'org-cycle-level) ; Only needed for caching
7295 (let ((cur-level (org-current-level))
7296 (prev-level (org-get-previous-line-level)))
7297 (cond
7298 ;; If first headline in file, promote to top-level.
7299 ((= prev-level 0)
7300 (loop repeat (/ (- cur-level 1) (org-level-increment))
7301 do (org-do-promote)))
7302 ;; If same level as prev, demote one.
7303 ((= prev-level cur-level)
7304 (org-do-demote))
7305 ;; If parent is top-level, promote to top level if not already.
7306 ((= prev-level 1)
7307 (loop repeat (/ (- cur-level 1) (org-level-increment))
7308 do (org-do-promote)))
7309 ;; If top-level, return to prev-level.
7310 ((= cur-level 1)
7311 (loop repeat (/ (- prev-level 1) (org-level-increment))
7312 do (org-do-demote)))
7313 ;; If less than prev-level, promote one.
7314 ((< cur-level prev-level)
7315 (org-do-promote))
7316 ;; If deeper than prev-level, promote until higher than
7317 ;; prev-level.
7318 ((> cur-level prev-level)
7319 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7320 do (org-do-promote))))
7321 t))))
7323 (defun org-map-tree (fun)
7324 "Call FUN for every heading underneath the current one."
7325 (org-back-to-heading)
7326 (let ((level (funcall outline-level)))
7327 (save-excursion
7328 (funcall fun)
7329 (while (and (progn
7330 (outline-next-heading)
7331 (> (funcall outline-level) level))
7332 (not (eobp)))
7333 (funcall fun)))))
7335 (defun org-map-region (fun beg end)
7336 "Call FUN for every heading between BEG and END."
7337 (let ((org-ignore-region t))
7338 (save-excursion
7339 (setq end (copy-marker end))
7340 (goto-char beg)
7341 (if (and (re-search-forward org-outline-regexp-bol nil t)
7342 (< (point) end))
7343 (funcall fun))
7344 (while (and (progn
7345 (outline-next-heading)
7346 (< (point) end))
7347 (not (eobp)))
7348 (funcall fun)))))
7350 (defun org-fixup-indentation (diff)
7351 "Change the indentation in the current entry by DIFF.
7352 However, if any line in the current entry has no indentation, or if it
7353 would end up with no indentation after the change, nothing at all is done."
7354 (save-excursion
7355 (let* ((end (save-excursion (outline-next-heading)
7356 (point-marker)))
7357 ;; FIXME we should use `org-end-of-meta-data-and-drawers'
7358 ;; here but it matches misplaced :END:...
7359 (drawer-end (save-excursion
7360 (and (re-search-forward
7361 org-property-end-re end t)
7362 (match-end 0))))
7363 (prohibit (if (> diff 0)
7366 col)
7367 (while (re-search-forward
7372 (beginning-of-line)
7374 (goto-char (match-end 0))
7375 (setq col (current-column))
7376 (if (< diff 0) (replace-match ""))
7377 (org-indent-to-column (+ diff col))
7378 (if drawer-end (setq drawer-end (+ diff drawer-end))))
7379 (end-of-line))
7380 (unless (save-excursion (end-of-line 1)
7381 (re-search-forward prohibit end t))
7382 (while (and (< (point) end)
7384 (goto-char (match-end 0))
7385 (setq col (current-column))
7386 (if (< diff 0) (replace-match ""))
7387 (org-indent-to-column (+ diff col))))
7388 (move-marker end nil))))
7390 (defun org-convert-to-odd-levels ()
7391 "Convert an org-mode file with all levels allowed to one with odd levels.
7392 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7393 level 5 etc."
7394 (interactive)
7395 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7396 (let ((outline-level 'org-outline-level)
7397 (org-odd-levels-only nil) n)
7398 (save-excursion
7399 (goto-char (point-min))
7401 (setq n (- (length (match-string 0)) 2))
7402 (while (>= (setq n (1- n)) 0)
7403 (org-demote))
7404 (end-of-line 1))))))
7406 (defun org-convert-to-oddeven-levels ()
7407 "Convert an org-mode file with only odd levels to one with odd/even levels.
7408 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7409 file contains a section with an even level, conversion would
7410 destroy the structure of the file. An error is signaled in this
7411 case."
7412 (interactive)
7413 (goto-char (point-min))
7414 ;; First check if there are no even levels
7416 (org-show-context t)
7417 (error "Not all levels are odd in this file. Conversion not possible"))
7418 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7419 (let ((outline-regexp org-outline-regexp)
7420 (outline-level 'org-outline-level)
7421 (org-odd-levels-only nil) n)
7422 (save-excursion
7423 (goto-char (point-min))
7425 (setq n (/ (1- (length (match-string 0))) 2))
7426 (while (>= (setq n (1- n)) 0)
7427 (org-promote))
7428 (end-of-line 1))))))
7430 (defun org-tr-level (n)
7431 "Make N odd if required."
7432 (if org-odd-levels-only (1+ (/ n 2)) n))
7434 ;;; Vertical tree motion, cutting and pasting of subtrees
7436 (defun org-move-subtree-up (&optional arg)
7437 "Move the current subtree up past ARG headlines of the same level."
7438 (interactive "p")
7439 (org-move-subtree-down (- (prefix-numeric-value arg))))
7441 (defun org-move-subtree-down (&optional arg)
7442 "Move the current subtree down past ARG headlines of the same level."
7443 (interactive "p")
7444 (setq arg (prefix-numeric-value arg))
7445 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7446 'org-get-last-sibling))
7447 (ins-point (make-marker))
7448 (cnt (abs arg))
7449 (col (current-column))
7450 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7451 ;; Select the tree
7452 (org-back-to-heading)
7453 (setq beg0 (point))
7454 (save-excursion
7455 (setq ne-beg (org-back-over-empty-lines))
7456 (setq beg (point)))
7457 (save-match-data
7458 (save-excursion (outline-end-of-heading)
7459 (setq folded (outline-invisible-p)))
7460 (outline-end-of-subtree))
7461 (outline-next-heading)
7462 (setq ne-end (org-back-over-empty-lines))
7463 (setq end (point))
7464 (goto-char beg0)
7465 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7466 ;; include less whitespace
7467 (save-excursion
7468 (goto-char beg)
7469 (forward-line (- ne-beg ne-end))
7470 (setq beg (point))))
7471 ;; Find insertion point, with error handling
7472 (while (> cnt 0)
7473 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7474 (progn (goto-char beg0)
7475 (error "Cannot move past superior level or buffer limit")))
7476 (setq cnt (1- cnt)))
7477 (if (> arg 0)
7478 ;; Moving forward - still need to move over subtree
7479 (progn (org-end-of-subtree t t)
7480 (save-excursion
7481 (org-back-over-empty-lines)
7482 (or (bolp) (newline)))))
7483 (setq ne-ins (org-back-over-empty-lines))
7484 (move-marker ins-point (point))
7485 (setq txt (buffer-substring beg end))
7486 (org-save-markers-in-region beg end)
7487 (delete-region beg end)
7488 (org-remove-empty-overlays-at beg)
7489 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7490 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7492 (let ((bbb (point)))
7493 (insert-before-markers txt)
7494 (org-reinstall-markers-in-region bbb)
7495 (move-marker ins-point bbb))
7497 (setq ins-end (point))
7498 (goto-char ins-point)
7499 (org-skip-whitespace)
7500 (when (and (< arg 0)
7501 (org-first-sibling-p)
7502 (> ne-ins ne-beg))
7503 ;; Move whitespace back to beginning
7504 (save-excursion
7505 (goto-char ins-end)
7506 (let ((kill-whole-line t))
7507 (kill-line (- ne-ins ne-beg)) (point)))
7509 (move-marker ins-point nil)
7510 (if folded
7511 (hide-subtree)
7512 (org-show-entry)
7513 (show-children)
7514 (org-cycle-hide-drawers 'children))
7515 (org-clean-visibility-after-subtree-move)
7516 ;; move back to the initial column we were at
7517 (move-to-column col)))
7519 (defvar org-subtree-clip ""
7520 "Clipboard for cut and paste of subtrees.
7521 This is actually only a copy of the kill, because we use the normal kill
7522 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7524 (defvar org-subtree-clip-folded nil
7525 "Was the last copied subtree folded?
7526 This is used to fold the tree back after pasting.")
7528 (defun org-cut-subtree (&optional n)
7529 "Cut the current subtree into the clipboard.
7530 With prefix arg N, cut this many sequential subtrees.
7531 This is a short-hand for marking the subtree and then cutting it."
7532 (interactive "p")
7533 (org-copy-subtree n 'cut))
7535 (defun org-copy-subtree (&optional n cut force-store-markers)
7536 "Cut the current subtree into the clipboard.
7537 With prefix arg N, cut this many sequential subtrees.
7538 This is a short-hand for marking the subtree and then copying it.
7539 If CUT is non-nil, actually cut the subtree.
7540 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7541 of some markers in the region, even if CUT is non-nil. This is
7542 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7543 (interactive "p")
7544 (let (beg end folded (beg0 (point)))
7545 (if (org-called-interactively-p 'any)
7546 (org-back-to-heading nil) ; take what looks like a subtree
7547 (org-back-to-heading t)) ; take what is really there
7548 (org-back-over-empty-lines)
7549 (setq beg (point))
7551 (save-match-data
7552 (save-excursion (outline-end-of-heading)
7553 (setq folded (outline-invisible-p)))
7554 (condition-case nil
7555 (org-forward-same-level (1- n) t)
7556 (error nil))
7557 (org-end-of-subtree t t))
7558 (org-back-over-empty-lines)
7559 (setq end (point))
7560 (goto-char beg0)
7561 (when (> end beg)
7562 (setq org-subtree-clip-folded folded)
7563 (when (or cut force-store-markers)
7564 (org-save-markers-in-region beg end))
7565 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7566 (setq org-subtree-clip (current-kill 0))
7567 (message "%s: Subtree(s) with %d characters"
7568 (if cut "Cut" "Copied")
7569 (length org-subtree-clip)))))
7571 (defun org-paste-subtree (&optional level tree for-yank)
7572 "Paste the clipboard as a subtree, with modification of headline level.
7573 The entire subtree is promoted or demoted in order to match a new headline
7574 level.
7576 If the cursor is at the beginning of a headline, the same level as
7577 that headline is used to paste the tree
7579 If not, the new level is derived from the *visible* headings
7580 before and after the insertion point, and taken to be the inferior headline
7581 level of the two. So if the previous visible heading is level 3 and the
7582 next is level 4 (or vice versa), level 4 will be used for insertion.
7583 This makes sure that the subtree remains an independent subtree and does
7584 not swallow low level entries.
7586 You can also force a different level, either by using a numeric prefix
7587 argument, or by inserting the heading marker by hand. For example, if the
7590 If optional TREE is given, use this text instead of the kill ring.
7592 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7593 move back over whitespace before inserting, and move point to the end of
7594 the inserted text when done."
7595 (interactive "P")
7596 (setq tree (or tree (and kill-ring (current-kill 0))))
7597 (unless (org-kill-is-subtree-p tree)
7598 (error "%s"
7599 (substitute-command-keys
7601 (org-with-limited-levels
7602 (let* ((visp (not (outline-invisible-p)))
7603 (txt tree)
7605 (old-level (if (string-match org-outline-regexp-bol txt)
7606 (- (match-end 0) (match-beginning 0) 1)
7607 -1))
7608 (force-level (cond (level (prefix-numeric-value level))
7610 (string-match
7612 (point-at-bol) (point))))
7613 (- (match-end 1) (match-beginning 1)))
7614 ((and (bolp)
7615 (looking-at org-outline-regexp))
7616 (- (match-end 0) (point) 1))
7617 (t nil)))
7618 (previous-level (save-excursion
7619 (condition-case nil
7620 (progn
7621 (outline-previous-visible-heading 1)
7622 (if (looking-at ^re_)
7623 (- (match-end 0) (match-beginning 0) 1)
7624 1))
7625 (error 1))))
7626 (next-level (save-excursion
7627 (condition-case nil
7628 (progn
7629 (or (looking-at org-outline-regexp)
7630 (outline-next-visible-heading 1))
7631 (if (looking-at ^re_)
7632 (- (match-end 0) (match-beginning 0) 1)
7633 1))
7634 (error 1))))
7635 (new-level (or force-level (max previous-level next-level)))
7636 (shift (if (or (= old-level -1)
7637 (= new-level -1)
7638 (= old-level new-level))
7639 0
7640 (- new-level old-level)))
7641 (delta (if (> shift 0) -1 1))
7642 (func (if (> shift 0) 'org-demote 'org-promote))
7643 (org-odd-levels-only nil)
7644 beg end newend)
7645 ;; Remove the forced level indicator
7646 (if force-level
7647 (delete-region (point-at-bol) (point)))
7648 ;; Paste
7649 (beginning-of-line (if (bolp) 1 2))
7650 (unless for-yank (org-back-over-empty-lines))
7651 (setq beg (point))
7652 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7653 (insert-before-markers txt)
7655 (setq newend (point))
7656 (org-reinstall-markers-in-region beg)
7657 (setq end (point))
7658 (goto-char beg)
7660 (setq beg (point))
7661 (if (and (outline-invisible-p) visp)
7662 (save-excursion (outline-show-heading)))
7663 ;; Shift if necessary
7664 (unless (= shift 0)
7665 (save-restriction
7666 (narrow-to-region beg end)
7667 (while (not (= shift 0))
7668 (org-map-region func (point-min) (point-max))
7669 (setq shift (+ delta shift)))
7670 (goto-char (point-min))
7671 (setq newend (point-max))))
7672 (when (or (org-called-interactively-p 'interactive) for-yank)
7673 (message "Clipboard pasted as level %d subtree" new-level))
7674 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7675 kill-ring
7676 (eq org-subtree-clip (current-kill 0))
7677 org-subtree-clip-folded)
7678 ;; The tree was folded before it was killed/copied
7679 (hide-subtree))
7680 (and for-yank (goto-char newend)))))
7682 (defun org-kill-is-subtree-p (&optional txt)
7683 "Check if the current kill is an outline subtree, or a set of trees.
7684 Returns nil if kill does not start with a headline, or if the first
7685 headline level is not the largest headline level in the tree.
7686 So this will actually accept several entries of equal levels as well,
7687 which is OK for `org-paste-subtree'.
7688 If optional TXT is given, check this string instead of the current kill."
7689 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7690 (re (org-get-limited-outline-regexp))
7691 (^re (concat "^" re))
7692 (start-level (and kill
7693 (string-match
7695 kill)
7696 (- (match-end 2) (match-beginning 2) 1)))
7697 (start (1+ (or (match-beginning 2) -1))))
7698 (if (not start-level)
7699 (progn
7700 nil) ;; does not even start with a heading
7701 (catch 'exit
7702 (while (setq start (string-match ^re kill (1+ start)))
7703 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7704 (throw 'exit nil)))
7705 t))))
7707 (defvar org-markers-to-move nil
7708 "Markers that should be moved with a cut-and-paste operation.
7709 Those markers are stored together with their positions relative to
7710 the start of the region.")
7712 (defun org-save-markers-in-region (beg end)
7713 "Check markers in region.
7714 If these markers are between BEG and END, record their position relative
7715 to BEG, so that after moving the block of text, we can put the markers back
7716 into place.
7717 This function gets called just before an entry or tree gets cut from the
7718 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7719 called immediately, to move the markers with the entries."
7720 (setq org-markers-to-move nil)
7721 (when (featurep 'org-clock)
7722 (org-clock-save-markers-for-cut-and-paste beg end))
7723 (when (featurep 'org-agenda)
7724 (org-agenda-save-markers-for-cut-and-paste beg end)))
7726 (defun org-check-and-save-marker (marker beg end)
7727 "Check if MARKER is between BEG and END.
7728 If yes, remember the marker and the distance to BEG."
7729 (when (and (marker-buffer marker)
7730 (equal (marker-buffer marker) (current-buffer)))
7731 (if (and (>= marker beg) (< marker end))
7732 (push (cons marker (- marker beg)) org-markers-to-move))))
7734 (defun org-reinstall-markers-in-region (beg)
7735 "Move all remembered markers to their position relative to BEG."
7736 (mapc (lambda (x)
7737 (move-marker (car x) (+ beg (cdr x))))
7738 org-markers-to-move)
7739 (setq org-markers-to-move nil))
7741 (defun org-narrow-to-subtree ()
7742 "Narrow buffer to the current subtree."
7743 (interactive)
7744 (save-excursion
7745 (save-match-data
7746 (org-with-limited-levels
7747 (narrow-to-region
7748 (progn (org-back-to-heading t) (point))
7749 (progn (org-end-of-subtree t t)
7750 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7751 (point)))))))
7753 (defun org-narrow-to-block ()
7754 "Narrow buffer to the current block."
7755 (interactive)
7756 (let* ((case-fold-search t)
7759 (if blockp
7760 (narrow-to-region (car blockp) (cdr blockp))
7761 (error "Not in a block"))))
7763 (eval-when-compile
7764 (defvar org-property-drawer-re))
7766 (defvar org-property-start-re) ;; defined below
7767 (defun org-clone-subtree-with-time-shift (n &optional shift)
7768 "Clone the task (subtree) at point N times.
7769 The clones will be inserted as siblings.
7771 In interactive use, the user will be prompted for the number of
7772 clones to be produced, and for a time SHIFT, which may be a
7773 repeater as used in time stamps, for example `+3d'.
7775 When a valid repeater is given and the entry contains any time
7776 stamps, the clones will become a sequence in time, with time
7777 stamps in the subtree shifted for each clone produced. If SHIFT
7778 is nil or the empty string, time stamps will be left alone. The
7779 ID property of the original subtree is removed.
7781 If the original subtree did contain time stamps with a repeater,
7782 the following will happen:
7783 - the repeater will be removed in each clone
7784 - an additional clone will be produced, with the current, unshifted
7785 date(s) in the entry.
7786 - the original entry will be placed *after* all the clones, with
7787 repeater intact.
7788 - the start days in the repeater in the original entry will be shifted
7789 to past the last clone.
7790 I this way you can spell out a number of instances of a repeating task,
7791 and still retain the repeater to cover future instances of the task."
7792 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7793 (let (beg end template task idprop
7794 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7795 (if (not (and (integerp n) (> n 0)))
7796 (error "Invalid number of replications %s" n))
7799 shift)))
7800 (error "Invalid shift specification %s" shift))
7801 (when doshift
7802 (setq shift-n (string-to-number (match-string 1 shift))
7803 shift-what (cdr (assoc (match-string 2 shift)
7804 '(("d" . day) ("w" . week)
7805 ("m" . month) ("y" . year))))))
7806 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7807 (setq nmin 1 nmax n)
7808 (org-back-to-heading t)
7809 (setq beg (point))
7810 (setq idprop (org-entry-get nil "ID"))
7811 (org-end-of-subtree t t)
7813 (setq end (point))
7814 (setq template (buffer-substring beg end))
7815 ;; Remove clocks and empty drawers
7816 (with-temp-buffer
7817 (insert template)
7818 (goto-char (point-min))
7819 (while (re-search-forward
7821 (replace-match "")
7822 (kill-whole-line))
7823 (goto-char (point-min))
7824 (while (re-search-forward
7826 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7827 (setq template (buffer-substring (point-min) (point-max))))
7828 (when (and doshift
7830 (delete-region beg end)
7831 (setq end beg)
7832 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7833 (goto-char end)
7834 (loop for n from nmin to nmax do
7835 ;; prepare clone
7836 (with-temp-buffer
7837 (insert template)
7838 (org-mode)
7839 (goto-char (point-min))
7840 (and idprop (if org-clone-delete-id
7841 (org-entry-delete nil "ID")
7842 (org-id-get-create t)))
7843 (while (re-search-forward org-property-start-re nil t)
7844 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7845 (goto-char (point-min))
7846 (when doshift
7847 (while (re-search-forward org-ts-regexp-both nil t)
7848 (org-timestamp-change (* n shift-n) shift-what))
7849 (unless (= n n-no-remove)
7850 (goto-char (point-min))
7851 (while (re-search-forward org-ts-regexp nil t)
7852 (save-excursion
7853 (goto-char (match-beginning 0))
7855 (delete-region (match-beginning 1) (match-end 1)))))))
7856 (setq task (buffer-string)))
7857 (insert task))
7858 (goto-char beg)))
7860 ;;; Outline Sorting
7862 (defun org-sort (with-case)
7863 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7864 Optional argument WITH-CASE means sort case-sensitively.
7865 With a double prefix argument, also remove duplicate entries."
7866 (interactive "P")
7867 (cond
7868 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7869 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7870 (t
7871 (org-call-with-arg 'org-sort-entries with-case))))
7873 (defun org-sort-remove-invisible (s)
7874 (remove-text-properties 0 (length s) org-rm-props s)
7875 (while (string-match org-bracket-link-regexp s)
7876 (setq s (replace-match (if (match-end 2)
7877 (match-string 3 s)
7878 (match-string 1 s)) t t s)))
7879 s)
7881 (defvar org-priority-regexp) ; defined later in the file
7883 (defvar org-after-sorting-entries-or-items-hook nil
7884 "Hook that is run after a bunch of entries or items have been sorted.
7885 When children are sorted, the cursor is in the parent line when this
7886 hook gets called. When a region or a plain list is sorted, the cursor
7887 will be in the first entry of the sorted region/list.")
7889 (defun org-sort-entries
7890 (&optional with-case sorting-type getkey-func compare-func property)
7891 "Sort entries on a certain level of an outline tree.
7892 If there is an active region, the entries in the region are sorted.
7893 Else, if the cursor is before the first entry, sort the top-level items.
7894 Else, the children of the entry at point are sorted.
7896 Sorting can be alphabetically, numerically, by date/time as given by
7897 a time stamp, by a property or by priority.
7899 The command prompts for the sorting type unless it has been given to the
7900 function through the SORTING-TYPE argument, which needs to be a character,
7901 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7902 precise meaning of each character:
7904 n Numerically, by converting the beginning of the entry/item to a number.
7905 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7906 t By date/time, either the first active time stamp in the entry, or, if
7907 none exist, by the first inactive one.
7908 s By the scheduled date/time.
7909 d By deadline date/time.
7910 c By creation time, which is assumed to be the first inactive time stamp
7911 at the beginning of a line.
7912 p By priority according to the cookie.
7913 r By the value of a property.
7915 Capital letters will reverse the sort order.
7917 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7918 called with point at the beginning of the record. It must return either
7919 a string or a number that should serve as the sorting key for that record.
7921 Comparing entries ignores case by default. However, with an optional argument
7922 WITH-CASE, the sorting considers case as well."
7923 (interactive "P")
7924 (let ((case-func (if with-case 'identity 'downcase))
7925 start beg end stars re re2
7926 txt what tmp)
7927 ;; Find beginning and end of region to sort
7928 (cond
7929 ((org-region-active-p)
7930 ;; we will sort the region
7931 (setq end (region-end)
7932 what "region")
7933 (goto-char (region-beginning))
7934 (if (not (org-on-heading-p)) (outline-next-heading))
7935 (setq start (point)))
7936 ((or (org-on-heading-p)
7937 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7938 ;; we will sort the children of the current headline
7939 (org-back-to-heading)
7940 (setq start (point)
7941 end (progn (org-end-of-subtree t t)
7943 (org-back-over-empty-lines)
7944 (point))
7945 what "children")
7946 (goto-char start)
7947 (show-subtree)
7948 (outline-next-heading))
7949 (t
7950 ;; we will sort the top-level entries in this file
7951 (goto-char (point-min))
7952 (or (org-on-heading-p) (outline-next-heading))
7953 (setq start (point))
7954 (goto-char (point-max))
7955 (beginning-of-line 1)
7957 ;; File ends in a non-white line
7958 (end-of-line 1)
7960 (setq end (point-max))
7961 (setq what "top-level")
7962 (goto-char start)
7963 (show-all)))
7965 (setq beg (point))
7966 (if (>= beg end) (error "Nothing to sort"))
7969 (setq stars (match-string 1)
7970 re (concat "^" (regexp-quote stars) " +")
7972 txt (buffer-substring beg end))
7974 (if (and (not (equal stars "*")) (string-match re2 txt))
7975 (error "Region to sort contains a level above the first entry"))
7977 (unless sorting-type
7978 (message
7979 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7981 A/N/T/S/D/C/P/O/F means reversed:"
7982 what)
7983 (setq sorting-type (read-char-exclusive))
7985 (and (= (downcase sorting-type) ?f)
7986 (setq getkey-func
7987 (org-icompleting-read "Sort using function: "
7988 obarray 'fboundp t nil nil))
7989 (setq getkey-func (intern getkey-func)))
7991 (and (= (downcase sorting-type) ?r)
7992 (setq property
7993 (org-icompleting-read "Property: "
7994 (mapcar 'list (org-buffer-property-keys t))
7995 nil t))))
7997 (message "Sorting entries...")
7999 (save-restriction
8000 (narrow-to-region start end)
8001 (let ((dcst (downcase sorting-type))
8002 (case-fold-search nil)
8003 (now (current-time)))
8004 (sort-subr
8005 (/= dcst sorting-type)
8006 ;; This function moves to the beginning character of the "record" to
8007 ;; be sorted.
8008 (lambda nil
8009 (if (re-search-forward re nil t)
8010 (goto-char (match-beginning 0))
8011 (goto-char (point-max))))
8012 ;; This function moves to the last character of the "record" being
8013 ;; sorted.
8014 (lambda nil
8015 (save-match-data
8016 (condition-case nil
8017 (outline-forward-same-level 1)
8018 (error
8019 (goto-char (point-max))))))
8020 ;; This function returns the value that gets sorted against.
8021 (lambda nil
8022 (cond
8023 ((= dcst ?n)
8024 (if (looking-at org-complex-heading-regexp)
8025 (string-to-number (match-string 4))
8026 nil))
8027 ((= dcst ?a)
8028 (if (looking-at org-complex-heading-regexp)
8029 (funcall case-func (match-string 4))
8030 nil))
8031 ((= dcst ?t)
8032 (let ((end (save-excursion (outline-next-heading) (point))))
8033 (if (or (re-search-forward org-ts-regexp end t)
8034 (re-search-forward org-ts-regexp-both end t))
8035 (org-time-string-to-seconds (match-string 0))
8036 (org-float-time now))))
8037 ((= dcst ?c)
8038 (let ((end (save-excursion (outline-next-heading) (point))))
8039 (if (re-search-forward
8041 end t)
8042 (org-time-string-to-seconds (match-string 0))
8043 (org-float-time now))))
8044 ((= dcst ?s)
8045 (let ((end (save-excursion (outline-next-heading) (point))))
8046 (if (re-search-forward org-scheduled-time-regexp end t)
8047 (org-time-string-to-seconds (match-string 1))
8048 (org-float-time now))))
8049 ((= dcst ?d)
8050 (let ((end (save-excursion (outline-next-heading) (point))))
8051 (if (re-search-forward org-deadline-time-regexp end t)
8052 (org-time-string-to-seconds (match-string 1))
8053 (org-float-time now))))
8054 ((= dcst ?p)
8055 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8056 (string-to-char (match-string 2))
8057 org-default-priority))
8058 ((= dcst ?r)
8059 (or (org-entry-get nil property) ""))
8060 ((= dcst ?o)
8061 (if (looking-at org-complex-heading-regexp)
8062 (- 9999 (length (member (match-string 2)
8063 org-todo-keywords-1)))))
8064 ((= dcst ?f)
8065 (if getkey-func
8066 (progn
8067 (setq tmp (funcall getkey-func))
8068 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8069 tmp)
8070 (error "Invalid key function `%s'" getkey-func)))
8071 (t (error "Invalid sorting type `%c'" sorting-type))))
8072 nil
8073 (cond
8074 ((= dcst ?a) 'string<)
8075 ((= dcst ?f) compare-func)
8076 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8077 (t nil)))))
8078 (run-hooks 'org-after-sorting-entries-or-items-hook)
8079 (message "Sorting entries...done")))
8081 (defun org-do-sort (table what &optional with-case sorting-type)
8082 "Sort TABLE of WHAT according to SORTING-TYPE.
8083 The user will be prompted for the SORTING-TYPE if the call to this
8084 function does not specify it. WHAT is only for the prompt, to indicate
8085 what is being sorted. The sorting key will be extracted from
8086 the car of the elements of the table.
8087 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8088 (unless sorting-type
8089 (message
8090 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8091 what)
8092 (setq sorting-type (read-char-exclusive)))
8093 (let ((dcst (downcase sorting-type))
8094 extractfun comparefun)
8095 ;; Define the appropriate functions
8096 (cond
8097 ((= dcst ?n)
8098 (setq extractfun 'string-to-number
8099 comparefun (if (= dcst sorting-type) '< '>)))
8100 ((= dcst ?a)
8101 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8102 (lambda(x) (downcase (org-sort-remove-invisible x))))
8103 comparefun (if (= dcst sorting-type)
8104 'string<
8105 (lambda (a b) (and (not (string< a b))
8106 (not (string= a b)))))))
8107 ((= dcst ?t)
8108 (setq extractfun
8109 (lambda (x)
8110 (if (or (string-match org-ts-regexp x)
8111 (string-match org-ts-regexp-both x))
8112 (org-float-time
8113 (org-time-string-to-time (match-string 0 x)))
8114 0))
8115 comparefun (if (= dcst sorting-type) '< '>)))
8116 (t (error "Invalid sorting type `%c'" sorting-type)))
8118 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8119 table)
8120 (lambda (a b) (funcall comparefun (car a) (car b))))))
8123 ;;; The orgstruct minor mode
8125 ;; Define a minor mode which can be used in other modes in order to
8126 ;; integrate the org-mode structure editing commands.
8128 ;; This is really a hack, because the org-mode structure commands use
8129 ;; keys which normally belong to the major mode. Here is how it
8130 ;; works: The minor mode defines all the keys necessary to operate the
8131 ;; structure commands, but wraps the commands into a function which
8132 ;; tests if the cursor is currently at a headline or a plain list
8133 ;; item. If that is the case, the structure command is used,
8134 ;; temporarily setting many Org-mode variables like regular
8135 ;; expressions for filling etc. However, when any of those keys is
8136 ;; used at a different location, function uses `key-binding' to look
8137 ;; up if the key has an associated command in another currently active
8138 ;; keymap (minor modes, major mode, global), and executes that
8139 ;; command. There might be problems if any of the keys is otherwise
8140 ;; used as a prefix key.
8142 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8143 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8144 ;; addresses this by checking explicitly for both bindings.
8146 (defvar orgstruct-mode-map (make-sparse-keymap)
8147 "Keymap for the minor `orgstruct-mode'.")
8149 (defvar org-local-vars nil
8150 "List of local variables, for use by `orgstruct-mode'.")
8152 ;;;###autoload
8153 (define-minor-mode orgstruct-mode
8154 "Toggle the minor mode `orgstruct-mode'.
8155 This mode is for using Org-mode structure commands in other
8156 modes. The following keys behave as if Org-mode were active, if
8157 the cursor is on a headline, or on a plain list item (both as
8158 defined by Org-mode).
8160 M-up Move entry/item up
8161 M-down Move entry/item down
8162 M-left Promote
8163 M-right Demote
8164 M-S-up Move entry/item up
8165 M-S-down Move entry/item down
8166 M-S-left Promote subtree
8167 M-S-right Demote subtree
8168 M-q Fill paragraph and items like in Org-mode
8169 C-c ^ Sort entries
8170 C-c - Cycle list bullet
8171 TAB Cycle item visibility
8172 M-RET Insert new heading/item
8173 S-M-RET Insert new TODO heading / Checkbox item
8174 C-c C-c Set tags / toggle checkbox"
8175 nil " OrgStruct" nil
8176 (org-load-modules-maybe)
8177 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8179 ;;;###autoload
8180 (defun turn-on-orgstruct ()
8181 "Unconditionally turn on `orgstruct-mode'."
8182 (orgstruct-mode 1))
8184 (defun orgstruct++-mode (&optional arg)
8185 "Toggle `orgstruct-mode', the enhanced version of it.
8186 In addition to setting orgstruct-mode, this also exports all indentation
8187 and autofilling variables from org-mode into the buffer. It will also
8188 recognize item context in multiline items.
8189 Note that turning off orgstruct-mode will *not* remove the
8190 indentation/paragraph settings. This can only be done by refreshing the
8192 (interactive "P")
8193 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8194 (if (< arg 1)
8195 (orgstruct-mode -1)
8196 (orgstruct-mode 1)
8197 (let (var val)
8198 (mapc
8199 (lambda (x)
8200 (when (string-match
8202 (symbol-name (car x)))
8203 (setq var (car x) val (nth 1 x))
8204 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8205 org-local-vars)
8206 (org-set-local 'orgstruct-is-++ t))))
8208 (defvar orgstruct-is-++ nil
8209 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8210 (make-variable-buffer-local 'orgstruct-is-++)
8212 ;;;###autoload
8213 (defun turn-on-orgstruct++ ()
8214 "Unconditionally turn on `orgstruct++-mode'."
8215 (orgstruct++-mode 1))
8217 (defun orgstruct-error ()
8218 "Error when there is no default binding for a structure key."
8219 (interactive)
8220 (error "This key has no function outside structure elements"))
8222 (defun orgstruct-setup ()
8223 "Setup orgstruct keymaps."
8224 (let ((nfunc 0)
8225 (bindings
8226 (list
8227 '([(meta up)] org-metaup)
8228 '([(meta down)] org-metadown)
8229 '([(meta left)] org-metaleft)
8230 '([(meta right)] org-metaright)
8231 '([(meta shift up)] org-shiftmetaup)
8232 '([(meta shift down)] org-shiftmetadown)
8233 '([(meta shift left)] org-shiftmetaleft)
8234 '([(meta shift right)] org-shiftmetaright)
8235 '([?\e (up)] org-metaup)
8236 '([?\e (down)] org-metadown)
8237 '([?\e (left)] org-metaleft)
8238 '([?\e (right)] org-metaright)
8239 '([?\e (shift up)] org-shiftmetaup)
8240 '([?\e (shift down)] org-shiftmetadown)
8241 '([?\e (shift left)] org-shiftmetaleft)
8242 '([?\e (shift right)] org-shiftmetaright)
8243 '([(shift up)] org-shiftup)
8244 '([(shift down)] org-shiftdown)
8245 '([(shift left)] org-shiftleft)
8246 '([(shift right)] org-shiftright)
8247 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8248 '("\M-q" fill-paragraph)
8249 '("\C-c^" org-sort)
8250 '("\C-c-" org-cycle-list-bullet)))
8251 elt key fun cmd)
8252 (while (setq elt (pop bindings))
8253 (setq nfunc (1+ nfunc))
8254 (setq key (org-key (car elt))
8255 fun (nth 1 elt)
8256 cmd (orgstruct-make-binding fun nfunc key))
8257 (org-defkey orgstruct-mode-map key cmd))
8259 ;; Special treatment needed for TAB and RET
8260 (org-defkey orgstruct-mode-map [(tab)]
8261 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8262 (org-defkey orgstruct-mode-map "\C-i"
8263 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8265 (org-defkey orgstruct-mode-map "\M-\C-m"
8266 (orgstruct-make-binding 'org-insert-heading 105
8267 "\M-\C-m" [(meta return)]))
8268 (org-defkey orgstruct-mode-map [(meta return)]
8269 (orgstruct-make-binding 'org-insert-heading 106
8270 [(meta return)] "\M-\C-m"))
8272 (org-defkey orgstruct-mode-map [(shift meta return)]
8273 (orgstruct-make-binding 'org-insert-todo-heading 107
8274 [(meta return)] "\M-\C-m"))
8276 (org-defkey orgstruct-mode-map "\e\C-m"
8277 (orgstruct-make-binding 'org-insert-heading 108
8278 "\e\C-m" [?\e (return)]))
8279 (org-defkey orgstruct-mode-map [?\e (return)]
8280 (orgstruct-make-binding 'org-insert-heading 109
8281 [?\e (return)] "\e\C-m"))
8282 (org-defkey orgstruct-mode-map [?\e (shift return)]
8283 (orgstruct-make-binding 'org-insert-todo-heading 110
8284 [?\e (return)] "\e\C-m"))
8286 (unless org-local-vars
8287 (setq org-local-vars (org-get-local-variables)))
8289 t))
8291 (defun orgstruct-make-binding (fun n &rest keys)
8292 "Create a function for binding in the structure minor mode.
8293 FUN is the command to call inside a table. N is used to create a unique
8294 command name. KEYS are keys that should be checked in for a command
8295 to execute outside of tables."
8296 (eval
8297 (list 'defun
8298 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8299 '(arg)
8301 "Outside of structure, run the binding of `"
8302 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8303 "'.")
8304 '(interactive "p")
8305 (list 'if
8306 `(org-context-p 'headline 'item
8307 (and orgstruct-is-++
8308 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8309 'item-body))
8310 (list 'org-run-like-in-org-mode (list 'quote fun))
8311 (list 'let '(orgstruct-mode)
8312 (list 'call-interactively
8313 (append '(or)
8314 (mapcar (lambda (k)
8315 (list 'key-binding k))
8316 keys)
8317 '('orgstruct-error))))))))
8319 (defun org-context-p (&rest contexts)
8320 "Check if local context is any of CONTEXTS.
8321 Possible values in the list of contexts are `table', `headline', and `item'."
8322 (let ((pos (point)))
8323 (goto-char (point-at-bol))
8324 (prog1 (or (and (memq 'table contexts)
8326 (and (memq 'headline contexts)
8327 (looking-at org-outline-regexp))
8328 (and (memq 'item contexts)
8330 (and (memq 'item-body contexts)
8331 (org-in-item-p)))
8332 (goto-char pos))))
8334 (defun org-get-local-variables ()
8335 "Return a list of all local variables in an org-mode buffer."
8336 (let (varlist)
8337 (with-current-buffer (get-buffer-create "*Org tmp*")
8338 (erase-buffer)
8339 (org-mode)
8340 (setq varlist (buffer-local-variables)))
8341 (kill-buffer "*Org tmp*")
8342 (delq nil
8343 (mapcar
8344 (lambda (x)
8345 (setq x
8346 (if (symbolp x)
8347 (list x)
8348 (list (car x) (list 'quote (cdr x)))))
8349 (if (string-match
8350 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8351 (symbol-name (car x)))
8352 x nil))
8353 varlist))))
8355 (defun org-clone-local-variables (from-buffer &optional regexp)
8356 "Clone local variables from FROM-BUFFER.
8357 Optional argument REGEXP selects variables to clone."
8358 (mapc
8359 (lambda (pair)
8360 (and (symbolp (car pair))
8361 (or (null regexp)
8362 (string-match regexp (symbol-name (car pair))))
8363 (set (make-local-variable (car pair))
8364 (cdr pair))))
8365 (buffer-local-variables from-buffer)))
8367 ;;;###autoload
8368 (defun org-run-like-in-org-mode (cmd)
8369 "Run a command, pretending that the current buffer is in Org-mode.
8370 This will temporarily bind local variables that are typically bound in
8371 Org-mode to the values they have in Org-mode, and then interactively
8372 call CMD."
8373 (org-load-modules-maybe)
8374 (unless org-local-vars
8375 (setq org-local-vars (org-get-local-variables)))
8376 (eval (list 'let org-local-vars
8377 (list 'call-interactively (list 'quote cmd)))))
8379 ;;;; Archiving
8381 (defun org-get-category (&optional pos force-refresh)
8382 "Get the category applying to position POS."
8383 (if force-refresh (org-refresh-category-properties))
8384 (let ((pos (or pos (point))))
8385 (or (get-text-property pos 'org-category)
8386 (progn (org-refresh-category-properties)
8387 (get-text-property pos 'org-category)))))
8389 (defun org-refresh-category-properties ()
8390 "Refresh category text properties in the buffer."
8391 (let ((def-cat (cond
8392 ((null org-category)
8393 (if buffer-file-name
8394 (file-name-sans-extension
8395 (file-name-nondirectory buffer-file-name))
8396 "???"))
8397 ((symbolp org-category) (symbol-name org-category))
8398 (t org-category)))
8399 beg end cat pos optionp)
8400 (org-unmodified
8401 (save-excursion
8402 (save-restriction
8403 (widen)
8404 (goto-char (point-min))
8405 (put-text-property (point) (point-max) 'org-category def-cat)
8406 (while (re-search-forward
8408 (setq pos (match-end 0)
8409 optionp (equal (char-after (match-beginning 0)) ?#)
8410 cat (org-trim (match-string 2)))
8411 (if optionp
8412 (setq beg (point-at-bol) end (point-max))
8413 (org-back-to-heading t)
8414 (setq beg (point) end (org-end-of-subtree t t)))
8415 (put-text-property beg end 'org-category cat)
8416 (goto-char pos)))))))
8419 ;;;; Link Stuff
8421 ;;; Link abbreviations
8423 (defun org-link-expand-abbrev (link)
8424 "Apply replacements as defined in `org-link-abbrev-alist."
8426 (let* ((key (match-string 1 link))
8427 (as (or (assoc key org-link-abbrev-alist-local)
8428 (assoc key org-link-abbrev-alist)))
8429 (tag (and (match-end 2) (match-string 3 link)))
8430 rpl)
8431 (if (not as)
8432 link
8433 (setq rpl (cdr as))
8434 (cond
8435 ((symbolp rpl) (funcall rpl tag))
8436 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8437 ((string-match "%h" rpl)
8438 (replace-match (url-hexify-string (or tag "")) t t rpl))
8439 (t (concat rpl tag)))))
8440 link))
8442 ;;; Storing and inserting links
8444 (defvar org-insert-link-history nil
8445 "Minibuffer history for links inserted with `org-insert-link'.")
8447 (defvar org-stored-links nil
8448 "Contains the links stored with `org-store-link'.")
8450 (defvar org-store-link-plist nil
8451 "Plist with info about the most recently link created with `org-store-link'.")
8453 (defvar org-link-protocols nil
8454 "Link protocols added to Org-mode using `org-add-link-type'.")
8456 (defvar org-store-link-functions nil
8457 "List of functions that are called to create and store a link.
8458 Each function will be called in turn until one returns a non-nil
8459 value. Each function should check if it is responsible for creating
8460 this link (for example by looking at the major mode).
8461 If not, it must exit and return nil.
8462 If yes, it should return a non-nil value after a calling
8463 `org-store-link-props' with a list of properties and values.
8464 Special properties are:
8468 This is obligatory as well.
8469 :description Optional default description for the second pair
8470 of brackets in an Org-mode link. The user can still change
8471 this when inserting this link into an Org-mode buffer.
8473 In addition to these, any additional properties can be specified
8474 and then used in remember templates.")
8476 (defun org-add-link-type (type &optional follow export)
8477 "Add TYPE to the list of `org-link-types'.
8478 Re-compute all regular expressions depending on `org-link-types'
8480 FOLLOW and EXPORT are two functions.
8482 FOLLOW should take the link path as the single argument and do whatever
8483 is necessary to follow the link, for example find a file or display
8484 a mail message.
8486 EXPORT should format the link path for export to one of the export formats.
8487 It should be a function accepting three arguments:
8490 desc the description of the link, if any, or a description added by
8491 org-export-normalize-links if there is none
8492 format the export format, a symbol like `html' or `latex' or `ascii'..
8494 The function may use the FORMAT information to return different values
8495 depending on the format. The return value will be put literally into
8496 the exported file. If the return value is nil, this means Org should
8497 do what it normally does with links which do not have EXPORT defined.
8499 Org-mode has a built-in default for exporting links. If you are happy with
8500 this default, there is no need to define an export function for the link
8501 type. For a simple example of an export function, see `org-bbdb.el'."
8502 (add-to-list 'org-link-types type t)
8503 (org-make-link-regexps)
8504 (if (assoc type org-link-protocols)
8505 (setcdr (assoc type org-link-protocols) (list follow export))
8506 (push (list type follow export) org-link-protocols)))
8508 (defvar org-agenda-buffer-name)
8510 ;;;###autoload
8511 (defun org-store-link (arg)
8513 This link is added to `org-stored-links' and can later be inserted
8516 For some link types, a prefix arg is interpreted:
8517 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8518 For file links, arg negates `org-context-in-file-links'."
8519 (interactive "P")
8520 (org-load-modules-maybe)
8521 (setq org-store-link-plist nil) ; reset
8522 (org-with-limited-levels
8523 (let (link cpltxt desc description search txt custom-id agenda-link)
8524 (cond
8526 ((run-hook-with-args-until-success 'org-store-link-functions)
8527 (setq link (plist-get org-store-link-plist :link)
8528 desc (or (plist-get org-store-link-plist :description) link)))
8530 ((equal (buffer-name) "*Org Edit Src Example*")
8531 (let (label gc)
8532 (while (or (not label)
8533 (save-excursion
8534 (save-restriction
8535 (widen)
8536 (goto-char (point-min))
8537 (re-search-forward
8538 (regexp-quote (format org-coderef-label-format label))
8539 nil t))))
8540 (when label (message "Label exists already") (sit-for 2))
8541 (setq label (read-string "Code line label: " label)))
8542 (end-of-line 1)
8543 (setq link (format org-coderef-label-format label))
8544 (setq gc (- 79 (length link)))
8545 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8546 (insert link)
8547 (setq link (concat "(" label ")") desc nil)))
8549 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8550 ;; We are in the agenda, link to referenced location
8551 (let ((m (or (get-text-property (point) 'org-hd-marker)
8552 (get-text-property (point) 'org-marker))))
8553 (when m
8554 (org-with-point-at m
8555 (setq agenda-link
8556 (if (org-called-interactively-p 'any)
8557 (call-interactively 'org-store-link)
8558 (org-store-link nil)))))))
8560 ((eq major-mode 'calendar-mode)
8561 (let ((cd (calendar-cursor-to-date)))
8562 (setq link
8563 (format-time-string
8564 (car org-time-stamp-formats)
8565 (apply 'encode-time
8566 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8567 nil nil nil))))
8568 (org-store-link-props :type "calendar" :date cd)))
8570 ((eq major-mode 'w3-mode)
8571 (setq cpltxt (if (and (buffer-name)
8572 (not (string-match "Untitled" (buffer-name))))
8573 (buffer-name)
8574 (url-view-url t))
8575 link (org-make-link (url-view-url t)))
8576 (org-store-link-props :type "w3" :url (url-view-url t)))
8578 ((eq major-mode 'w3m-mode)
8579 (setq cpltxt (or w3m-current-title w3m-current-url)
8580 link (org-make-link w3m-current-url))
8581 (org-store-link-props :type "w3m" :url (url-view-url t)))
8583 ((setq search (run-hook-with-args-until-success
8584 'org-create-file-search-functions))
8585 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8586 "::" search))
8587 (setq cpltxt (or description link)))
8589 ((eq major-mode 'image-mode)
8590 (setq cpltxt (concat "file:"
8591 (abbreviate-file-name buffer-file-name))
8592 link (org-make-link cpltxt))
8593 (org-store-link-props :type "image" :file buffer-file-name))
8595 ((eq major-mode 'dired-mode)
8596 ;; link to the file in the current line
8597 (let ((file (dired-get-filename nil t)))
8598 (setq file (if file
8599 (abbreviate-file-name
8600 (expand-file-name (dired-get-filename nil t)))
8601 ;; otherwise, no file so use current directory.
8602 default-directory))
8603 (setq cpltxt (concat "file:" file)
8604 link (org-make-link cpltxt))))
8606 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8607 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8608 (cond
8610 (setq cpltxt
8611 (concat "file:"
8612 (abbreviate-file-name
8613 (buffer-file-name (buffer-base-buffer)))
8614 "::" (match-string 1))
8615 link (org-make-link cpltxt)))
8616 ((and (featurep 'org-id)
8617 (or (eq org-link-to-org-use-id t)
8618 (and (eq org-link-to-org-use-id 'create-if-interactive)
8619 (org-called-interactively-p 'any))
8620 (and (eq org-link-to-org-use-id
8621 'create-if-interactive-and-no-custom-id)
8622 (org-called-interactively-p 'any)
8623 (not custom-id))
8624 (and org-link-to-org-use-id
8625 (org-entry-get nil "ID"))))
8626 ;; We can make a link using the ID.
8627 (setq link (condition-case nil
8628 (prog1 (org-id-store-link)
8629 (setq desc (plist-get org-store-link-plist
8630 :description)))
8631 (error
8632 ;; probably before first headline, link to file only
8633 (concat "file:"
8634 (abbreviate-file-name
8635 (buffer-file-name (buffer-base-buffer))))))))
8636 (t
8637 ;; Just link to current headline
8638 (setq cpltxt (concat "file:"
8639 (abbreviate-file-name
8640 (buffer-file-name (buffer-base-buffer)))))
8641 ;; Add a context search string
8642 (when (org-xor org-context-in-file-links arg)
8643 (setq txt (cond
8644 ((org-on-heading-p) nil)
8645 ((org-region-active-p)
8646 (buffer-substring (region-beginning) (region-end)))
8647 (t nil)))
8649 (setq cpltxt
8650 (concat cpltxt "::"
8651 (condition-case nil
8652 (org-make-org-heading-search-string txt)
8653 (error "")))
8654 desc (or (nth 4 (ignore-errors
8655 (org-heading-components))) "NONE"))))
8657 (setq cpltxt (substring cpltxt 0 -2)))
8658 (setq link (org-make-link cpltxt)))))
8660 ((buffer-file-name (buffer-base-buffer))
8661 ;; Just link to this file here.
8662 (setq cpltxt (concat "file:"
8663 (abbreviate-file-name
8664 (buffer-file-name (buffer-base-buffer)))))
8665 ;; Add a context string
8666 (when (org-xor org-context-in-file-links arg)
8667 (setq txt (if (org-region-active-p)
8668 (buffer-substring (region-beginning) (region-end))
8669 (buffer-substring (point-at-bol) (point-at-eol))))
8670 ;; Only use search option if there is some text.
8672 (setq cpltxt
8673 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8674 desc "NONE")))
8675 (setq link (org-make-link cpltxt)))
8677 ((org-called-interactively-p 'interactive)
8678 (error "Cannot link to a buffer which is not visiting a file"))
8680 (t (setq link nil)))
8682 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8683 (setq link (or link cpltxt)
8684 desc (or desc cpltxt))
8685 (if (equal desc "NONE") (setq desc nil))
8687 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8688 (progn
8689 (setq org-stored-links
8690 (cons (list link desc) org-stored-links))
8691 (message "Stored: %s" (or desc link))
8692 (when custom-id
8693 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8694 "::#" custom-id))
8695 (setq org-stored-links
8696 (cons (list link desc) org-stored-links))))
8697 (or agenda-link (and link (org-make-link-string link desc)))))))
8699 (defun org-store-link-props (&rest plist)
8700 "Store link properties, extract names and addresses."
8701 (let (x adr)
8702 (when (setq x (plist-get plist :from))
8703 (setq adr (mail-extract-address-components x))
8704 (setq plist (plist-put plist :fromname (car adr)))
8705 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8706 (when (setq x (plist-get plist :to))
8707 (setq adr (mail-extract-address-components x))
8708 (setq plist (plist-put plist :toname (car adr)))
8709 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8710 (let ((from (plist-get plist :from))
8711 (to (plist-get plist :to)))
8712 (when (and from to org-from-is-user-regexp)
8713 (setq plist
8714 (plist-put plist :fromto
8715 (if (string-match org-from-is-user-regexp from)
8716 (concat "to %t")
8717 (concat "from %f"))))))
8718 (setq org-store-link-plist plist))
8720 (defun org-add-link-props (&rest plist)
8721 "Add these properties to the link property list."
8722 (let (key value)
8723 (while plist
8724 (setq key (pop plist) value (pop plist))
8725 (setq org-store-link-plist
8726 (plist-put org-store-link-plist key value)))))
8728 (defun org-email-link-description (&optional fmt)
8729 "Return the description part of an email link.
8730 This takes information from `org-store-link-plist' and formats it
8731 according to FMT (default from `org-email-link-description-format')."
8732 (setq fmt (or fmt org-email-link-description-format))
8733 (let* ((p org-store-link-plist)
8734 (to (plist-get p :toaddress))
8735 (from (plist-get p :fromaddress))
8736 (table
8737 (list
8738 (cons "%c" (plist-get p :fromto))
8739 (cons "%F" (plist-get p :from))
8740 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8741 (cons "%T" (plist-get p :to))
8742 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8743 (cons "%s" (plist-get p :subject))
8744 (cons "%d" (plist-get p :date))
8745 (cons "%m" (plist-get p :message-id)))))
8746 (when (string-match "%c" fmt)
8747 ;; Check if the user wrote this message
8748 (if (and org-from-is-user-regexp from to
8749 (save-match-data (string-match org-from-is-user-regexp from)))
8750 (setq fmt (replace-match "to %t" t t fmt))
8751 (setq fmt (replace-match "from %f" t t fmt))))
8752 (org-replace-escapes fmt table)))
8754 (defun org-make-org-heading-search-string (&optional string heading)
8755 "Make search string for STRING or current headline."
8756 (interactive)
8757 (let ((s (or string (org-get-heading)))
8758 (lines org-context-in-file-links))
8759 (unless (and string (not heading))
8760 ;; We are using a headline, clean up garbage in there.
8761 (if (string-match org-todo-regexp s)
8762 (setq s (replace-match "" t t s)))
8764 (setq s (replace-match "" t t s)))
8765 (setq s (org-trim s))
8768 (setq s (replace-match "" t t s)))
8769 (while (string-match org-ts-regexp s)
8770 (setq s (replace-match "" t t s))))
8771 (or string (setq s (concat "*" s))) ; Add * for headlines
8772 (when (and string (integerp lines) (> lines 0))
8774 (when (< lines (length slines))
8775 (setq s (mapconcat
8776 'identity
8777 (reverse (nthcdr (- (length slines) lines)
8781 (defun org-make-link (&rest strings)
8782 "Concatenate STRINGS."
8783 (apply 'concat strings))
8785 (defun org-make-link-string (link &optional description)
8786 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8788 (error "Empty link"))
8789 (when (and description
8790 (stringp description)
8792 (setq description nil))
8793 (when (stringp description)
8794 ;; Remove brackets from the description, they are fatal.
8796 (setq description (replace-match "{" t t description)))
8798 (setq description (replace-match "}" t t description))))
8799 (when (equal link description)
8800 ;; No description needed, it is identical
8801 (setq description nil))
8802 (when (and (not description)
8803 (not (string-match (org-image-file-name-regexp) link))
8804 (not (equal link (org-link-escape link))))
8805 (setq description (org-extract-attributes link)))
8806 (setq link
8807 (cond ((string-match (org-image-file-name-regexp) link) link)
8808 ((string-match org-link-types-re link)
8809 (concat (match-string 1 link)
8810 (org-link-escape (substring link (match-end 1)))))
8811 (t (org-link-escape link))))
8812 (concat "[[" link "]"
8813 (if description (concat "[" description "]") "")
8814 "]"))
8816 (defconst org-link-escape-chars
8817 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8818 "List of characters that should be escaped in link.
8819 This is the list that is used for internal purposes.")
8821 (defvar org-url-encoding-use-url-hexify nil)
8823 (defconst org-link-escape-chars-browser
8824 '(?\ )
8825 "List of escapes for characters that are problematic in links.
8826 This is the list that is used before handing over to the browser.")
8828 (defun org-link-escape (text &optional table merge)
8829 "Return percent escaped representation of TEXT.
8830 TEXT is a string with the text to escape.
8831 Optional argument TABLE is a list with characters that should be
8832 escaped. When nil, `org-link-escape-chars' is used.
8833 If optional argument MERGE is set, merge TABLE into
8834 `org-link-escape-chars'."
8835 (if (and org-url-encoding-use-url-hexify (not table))
8836 (url-hexify-string text)
8837 (cond
8838 ((and table merge)
8839 (mapc (lambda (defchr)
8840 (unless (member defchr table)
8841 (setq table (cons defchr table)))) org-link-escape-chars))
8842 ((null table)
8843 (setq table org-link-escape-chars)))
8844 (mapconcat
8845 (lambda (char)
8846 (if (or (member char table)
8847 (< char 32) (= char 37) (> char 126))
8848 (mapconcat (lambda (sequence-element)
8849 (format "%%%.2X" sequence-element))
8850 (or (encode-coding-char char 'utf-8)
8851 (error "Unable to percent escape character: %s"
8852 (char-to-string char))) "")
8853 (char-to-string char))) text "")))
8855 (defun org-link-unescape (str)
8856 "Unhex hexified unicode strings as returned from the JavaScript function
8857 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8858 (unless (and (null str) (string= "" str))
8859 (let ((pos 0) (case-fold-search t) unhexed)
8861 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8862 (setq str (replace-match unhexed t t str))
8863 (setq pos (+ pos (length unhexed))))))
8864 str)
8866 (defun org-link-unescape-compound (hex)
8867 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8868 Note: this function also decodes single byte encodings like
8870 (save-match-data
8871 (let* ((bytes (cdr (split-string hex "%")))
8872 (ret "")
8873 (eat 0)
8874 (sum 0))
8875 (while bytes
8876 (let* ((val (string-to-number (pop bytes) 16))
8877 (shift-xor
8878 (if (= 0 eat)
8879 (cond
8880 ((>= val 252) (cons 6 252))
8881 ((>= val 248) (cons 5 248))
8882 ((>= val 240) (cons 4 240))
8883 ((>= val 224) (cons 3 224))
8884 ((>= val 192) (cons 2 192))
8885 (t (cons 0 0)))
8886 (cons 6 128))))
8887 (if (>= val 192) (setq eat (car shift-xor)))
8888 (setq val (logxor val (cdr shift-xor)))
8889 (setq sum (+ (lsh sum (car shift-xor)) val))
8890 (if (> eat 0) (setq eat (- eat 1)))
8891 (cond
8892 ((= 0 eat) ;multi byte
8893 (setq ret (concat ret (org-char-to-string sum)))
8894 (setq sum 0))
8895 ((not bytes) ; single byte(s)
8896 (setq ret (org-link-unescape-single-byte-sequence hex))))
8897 )) ;; end (while bytes
8898 ret )))
8900 (defun org-link-unescape-single-byte-sequence (hex)
8901 "Unhexify hex-encoded single byte character sequences."
8902 (mapconcat (lambda (byte)
8903 (char-to-string (string-to-number byte 16)))
8904 (cdr (split-string hex "%")) ""))
8906 (defun org-xor (a b)
8907 "Exclusive or."
8908 (if a (not b) b))
8910 (defun org-fixup-message-id-for-http (s)
8911 "Replace special characters in a message id, so it can be used in an http query."
8912 (when (string-match "%" s)
8913 (setq s (mapconcat (lambda (c)
8914 (if (eq c ?%)
8915 "%25"
8916 (char-to-string c)))
8917 s "")))
8918 (while (string-match "<" s)
8919 (setq s (replace-match "%3C" t t s)))
8920 (while (string-match ">" s)
8921 (setq s (replace-match "%3E" t t s)))
8922 (while (string-match "@" s)
8923 (setq s (replace-match "%40" t t s)))
8924 s)
8926 ;;;###autoload
8927 (defun org-insert-link-global ()
8928 "Insert a link like Org-mode does.
8929 This command can be called in any mode to insert a link in Org-mode syntax."
8930 (interactive)
8931 (org-load-modules-maybe)
8932 (org-run-like-in-org-mode 'org-insert-link))
8934 (defun org-insert-link (&optional complete-file link-location)
8935 "Insert a link. At the prompt, enter the link.
8937 Completion can be used to insert any of the link protocol prefixes like
8938 http or ftp in use.
8940 The history can be used to select a link previously stored with
8941 `org-store-link'. When the empty string is entered (i.e. if you just
8942 press RET at the prompt), the link defaults to the most recently
8943 stored link. As SPC triggers completion in the minibuffer, you need to
8944 use M-SPC or C-q SPC to force the insertion of a space character.
8946 You will also be prompted for a description, and if one is given, it will
8947 be displayed in the buffer instead of the link.
8949 If there is already a link at point, this command will allow you to edit link
8950 and description parts.
8953 be selected using completion. The path to the file will be relative to the
8954 current directory if the file is in the current directory or a subdirectory.
8955 Otherwise, the link will be the absolute path as completed in the minibuffer
8956 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8957 option `org-link-file-path-type'.
8960 the current directory or below.
8963 `org-keep-stored-link-after-insertion'.
8965 If `org-make-link-description-function' is non-nil, this function will be
8966 called with the link target, and the result will be the default
8967 link description.
8969 If the LINK-LOCATION parameter is non-nil, this value will be
8970 used as the link location instead of reading one interactively."
8971 (interactive "P")
8972 (let* ((wcf (current-window-configuration))
8973 (region (if (org-region-active-p)
8974 (buffer-substring (region-beginning) (region-end))))
8975 (remove (and region (list (region-beginning) (region-end))))
8976 (desc region)
8977 tmphist ; byte-compile incorrectly complains about this
8978 (link link-location)
8979 entry file all-prefixes)
8980 (cond
8981 (link-location) ; specified by arg, just use it.
8982 ((org-in-regexp org-bracket-link-regexp 1)
8983 ;; We do have a link at point, and we are going to edit it.
8984 (setq remove (list (match-beginning 0) (match-end 0)))
8985 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8986 (setq link (read-string "Link: "
8987 (org-link-unescape
8988 (org-match-string-no-properties 1)))))
8989 ((or (org-in-regexp org-angle-link-re)
8990 (org-in-regexp org-plain-link-re))
8991 ;; Convert to bracket link
8992 (setq remove (list (match-beginning 0) (match-end 0))
8993 link (read-string "Link: "
8994 (org-remove-angle-brackets (match-string 0)))))
8995 ((member complete-file '((4) (16)))
8996 ;; Completing read for file names.
8997 (setq link (org-file-complete-link complete-file)))
8998 (t
8999 ;; Read link, with completion for stored links.
9000 (with-output-to-temp-buffer "*Org Links*"
9001 (princ "Insert a link.
9003 (when org-stored-links
9005 (princ (mapconcat
9006 (lambda (x)
9007 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9009 (let ((cw (selected-window)))
9010 (select-window (get-buffer-window "*Org Links*" 'visible))
9011 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
9012 (unless (pos-visible-in-window-p (point-max))
9013 (org-fit-window-to-buffer))
9014 (and (window-live-p cw) (select-window cw)))
9015 ;; Fake a link history, containing the stored links.
9016 (setq tmphist (append (mapcar 'car org-stored-links)
9017 org-insert-link-history))
9018 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9019 (mapcar 'car org-link-abbrev-alist)
9020 org-link-types))
9021 (unwind-protect
9022 (progn
9023 (setq link
9024 (let ((org-completion-use-ido nil)
9025 (org-completion-use-iswitchb nil))
9026 (org-completing-read
9027 "Link: "
9028 (append
9029 (mapcar (lambda (x) (list (concat x ":")))
9030 all-prefixes)
9031 (mapcar 'car org-stored-links))
9032 nil nil nil
9033 'tmphist
9034 (car (car org-stored-links)))))
9036 (error "No link selected"))
9037 (if (or (member link all-prefixes)
9038 (and (equal ":" (substring link -1))
9039 (member (substring link 0 -1) all-prefixes)
9040 (setq link (substring link 0 -1))))
9041 (setq link (org-link-try-special-completion link))))
9042 (set-window-configuration wcf)
9043 (kill-buffer "*Org Links*"))
9044 (setq entry (assoc link org-stored-links))
9045 (or entry (push link org-insert-link-history))
9046 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9047 (not org-keep-stored-link-after-insertion))
9048 (setq org-stored-links (delq (assoc link org-stored-links)
9049 org-stored-links)))
9050 (setq desc (or desc (nth 1 entry)))))
9052 (if (string-match org-plain-link-re link)
9053 ;; URL-like link, normalize the use of angular brackets.
9054 (setq link (org-make-link (org-remove-angle-brackets link))))
9056 ;; Check if we are linking to the current file with a search option
9057 ;; If yes, simplify the link by using only the search option.
9058 (when (and buffer-file-name
9060 (let* ((path (match-string 1 link))
9061 (case-fold-search nil)
9062 (search (match-string 2 link)))
9063 (save-match-data
9064 (if (equal (file-truename buffer-file-name) (file-truename path))
9065 ;; We are linking to this same file, with a search option
9066 (setq link search)))))
9068 ;; Check if we can/should use a relative path. If yes, simplify the link
9070 (let* ((type (match-string 1 link))
9071 (path (match-string 2 link))
9072 (origpath path)
9073 (case-fold-search nil))
9074 (cond
9075 ((or (eq org-link-file-path-type 'absolute)
9076 (equal complete-file '(16)))
9077 (setq path (abbreviate-file-name (expand-file-name path))))
9078 ((eq org-link-file-path-type 'noabbrev)
9079 (setq path (expand-file-name path)))
9080 ((eq org-link-file-path-type 'relative)
9081 (setq path (file-relative-name path)))
9082 (t
9083 (save-match-data
9084 (if (string-match (concat "^" (regexp-quote
9085 (expand-file-name
9086 (file-name-as-directory
9087 default-directory))))
9088 (expand-file-name path))
9089 ;; We are linking a file with relative path name.
9090 (setq path (substring (expand-file-name path)
9091 (match-end 0)))
9092 (setq path (abbreviate-file-name (expand-file-name path)))))))
9093 (setq link (concat type path))
9094 (if (equal desc origpath)
9095 (setq desc path))))
9097 (if org-make-link-description-function
9098 (setq desc (funcall org-make-link-description-function link desc)))
9100 (setq desc (read-string "Description: " desc))
9102 (if remove (apply 'delete-region remove))
9103 (insert (org-make-link-string link desc))))
9105 (defun org-link-try-special-completion (type)
9106 "If there is completion support for link type TYPE, offer it."
9107 (let ((fun (intern (concat "org-" type "-complete-link"))))
9108 (if (functionp fun)
9109 (funcall fun)
9110 (read-string "Link (no completion support): " (concat type ":")))))
9112 (defun org-file-complete-link (&optional arg)
9113 "Create a file link using completion."
9114 (let (file link)
9115 (setq file (read-file-name "File: "))
9116 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9117 (pwd1 (file-name-as-directory (abbreviate-file-name
9118 (expand-file-name ".")))))
9119 (cond
9120 ((equal arg '(16))
9121 (setq link (org-make-link
9122 "file:"
9123 (abbreviate-file-name (expand-file-name file)))))
9125 (setq link (org-make-link "file:" (match-string 1 file))))
9127 (expand-file-name file))
9128 (setq link (org-make-link
9129 "file:" (match-string 1 (expand-file-name file)))))
9130 (t (setq link (org-make-link "file:" file)))))
9131 link))
9133 (defun org-completing-read (&rest args)
9134 "Completing-read with SPACE being a normal character."
9135 (let ((minibuffer-local-completion-map
9136 (copy-keymap minibuffer-local-completion-map)))
9137 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9138 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9139 (apply 'org-icompleting-read args)))
9141 (defun org-completing-read-no-i (&rest args)
9142 (let (org-completion-use-ido org-completion-use-iswitchb)
9143 (apply 'org-completing-read args)))
9145 (defun org-iswitchb-completing-read (prompt choices &rest args)
9146 "Use iswitch as a completing-read replacement to choose from choices.
9147 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9148 from."
9149 (let* ((iswitchb-use-virtual-buffers nil)
9150 (iswitchb-make-buflist-hook
9151 (lambda ()
9152 (setq iswitchb-temp-buflist choices))))
9153 (iswitchb-read-buffer prompt)))
9155 (defun org-icompleting-read (&rest args)
9156 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9157 (org-without-partial-completion
9158 (if (and org-completion-use-ido
9159 (fboundp 'ido-completing-read)
9160 (boundp 'ido-mode) ido-mode
9161 (listp (second args)))
9162 (let ((ido-enter-matching-directory nil))
9163 (apply 'ido-completing-read (concat (car args))
9164 (if (consp (car (nth 1 args)))
9165 (mapcar 'car (nth 1 args))
9166 (nth 1 args))
9167 (cddr args)))
9168 (if (and org-completion-use-iswitchb
9169 (boundp 'iswitchb-mode) iswitchb-mode
9170 (listp (second args)))
9171 (apply 'org-iswitchb-completing-read (concat (car args))
9172 (if (consp (car (nth 1 args)))
9173 (mapcar 'car (nth 1 args))
9174 (nth 1 args))
9175 (cddr args))
9176 (apply 'completing-read args)))))
9178 (defun org-extract-attributes (s)
9179 "Extract the attributes cookie from a string and set as text property."
9180 (let (a attr (start 0) key value)
9181 (save-match-data
9183 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9185 (setq key (match-string 1 a) value (match-string 2 a)
9186 start (match-end 0)
9187 attr (plist-put attr (intern key) value))))
9188 (org-add-props s nil 'org-attr attr))
9189 s))
9191 (defun org-extract-attributes-from-string (tag)
9192 (let (key value attr)
9194 (setq key (match-string 1 tag) value (match-string 2 tag)
9195 tag (replace-match "" t t tag)
9196 attr (plist-put attr (intern key) value)))
9197 (cons tag attr)))
9199 (defun org-attributes-to-string (plist)
9200 "Format a property list into an HTML attribute list."
9201 (let ((s "") key value)
9202 (while plist
9203 (setq key (pop plist) value (pop plist))
9204 (and value
9206 s))
9208 ;;; Opening/following a link
9210 (defvar org-link-search-failed nil)
9212 (defvar org-open-link-functions nil
9213 "Hook for functions finding a plain text link.
9214 These functions must take a single argument, the link content.
9215 They will be called for links that look like [[link text][description]]
9219 These functions will be called *before* Org attempts to resolve the
9220 link by doing text searches in the current buffer - so if you want a
9222 handle this as a special case.
9224 When the function does handle the link, it must return a non-nil value.
9225 If it decides that it is not responsible for this link, it must return
9226 nil to indicate that that Org-mode can continue with other options
9227 like exact and fuzzy text search.")
9229 (defun org-next-link ()
9230 "Move forward to the next link.
9231 If the link is in hidden text, expose it."
9232 (interactive)
9233 (when (and org-link-search-failed (eq this-command last-command))
9234 (goto-char (point-min))
9235 (message "Link search wrapped back to beginning of buffer"))
9236 (setq org-link-search-failed nil)
9237 (let* ((pos (point))
9238 (ct (org-context))
9239 (a (assoc :link ct)))
9240 (if a (goto-char (nth 2 a)))
9241 (if (re-search-forward org-any-link-re nil t)
9242 (progn
9243 (goto-char (match-beginning 0))
9244 (if (outline-invisible-p) (org-show-context)))
9245 (goto-char pos)
9246 (setq org-link-search-failed t)
9247 (error "No further link found"))))
9249 (defun org-previous-link ()
9250 "Move backward to the previous link.
9251 If the link is in hidden text, expose it."
9252 (interactive)
9253 (when (and org-link-search-failed (eq this-command last-command))
9254 (goto-char (point-max))
9255 (message "Link search wrapped back to end of buffer"))
9256 (setq org-link-search-failed nil)
9257 (let* ((pos (point))
9258 (ct (org-context))
9259 (a (assoc :link ct)))
9260 (if a (goto-char (nth 1 a)))
9261 (if (re-search-backward org-any-link-re nil t)
9262 (progn
9263 (goto-char (match-beginning 0))
9264 (if (outline-invisible-p) (org-show-context)))
9265 (goto-char pos)
9266 (setq org-link-search-failed t)
9267 (error "No further link found"))))
9269 (defun org-translate-link (s)
9270 "Translate a link string if a translation function has been defined."
9271 (if (and org-link-translation-function
9272 (fboundp org-link-translation-function)
9274 (progn
9275 (setq s (funcall org-link-translation-function
9276 (match-string 1) (match-string 2)))
9277 (concat (car s) ":" (cdr s)))
9278 s))
9280 (defun org-translate-link-from-planner (type path)
9281 "Translate a link from Emacs Planner syntax so that Org can follow it.
9282 This is still an experimental function, your mileage may vary."
9283 (cond
9284 ((member type '("http" "https" "news" "ftp"))
9285 ;; standard Internet links are the same.
9286 nil)
9287 ((and (equal type "irc") (string-match "^//" path))
9288 ;; Planner has two / at the beginning of an irc link, we have 1.
9289 ;; We should have zero, actually....
9290 (setq path (substring path 1)))
9291 ((and (equal type "lisp") (string-match "^/" path))
9292 ;; Planner has a slash, we do not.
9293 (setq type "elisp" path (substring path 1)))
9295 ;; A typical message link. Planner has the id after the final slash,
9296 ;; we separate it with a hash mark
9297 (setq path (concat (match-string 1 path) "#"
9298 (org-remove-angle-brackets (match-string 2 path)))))
9299 )
9300 (cons type path))
9302 (defun org-find-file-at-mouse (ev)
9303 "Open file link or URL at mouse."
9304 (interactive "e")
9305 (mouse-set-point ev)
9306 (org-open-at-point 'in-emacs))
9308 (defun org-open-at-mouse (ev)
9309 "Open file link or URL at mouse.
9310 See the docstring of `org-open-file' for details."
9311 (interactive "e")
9312 (mouse-set-point ev)
9313 (if (eq major-mode 'org-agenda-mode)
9314 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9315 (org-open-at-point))
9317 (defvar org-window-config-before-follow-link nil
9318 "The window configuration before following a link.
9319 This is saved in case the need arises to restore it.")
9321 (defvar org-open-link-marker (make-marker)
9322 "Marker pointing to the location where `org-open-at-point; was called.")
9324 ;;;###autoload
9325 (defun org-open-at-point-global ()
9326 "Follow a link like Org-mode does.
9327 This command can be called in any mode to follow a link that has
9328 Org-mode syntax."
9329 (interactive)
9330 (org-run-like-in-org-mode 'org-open-at-point))
9332 ;;;###autoload
9333 (defun org-open-link-from-string (s &optional arg reference-buffer)
9334 "Open a link in the string S, as if it was in Org-mode."
9336 (let ((reference-buffer (or reference-buffer (current-buffer))))
9337 (with-temp-buffer
9338 (let ((org-inhibit-startup t))
9339 (org-mode)
9340 (insert s)
9341 (goto-char (point-min))
9342 (when reference-buffer
9343 (setq org-link-abbrev-alist-local
9344 (with-current-buffer reference-buffer
9345 org-link-abbrev-alist-local)))
9346 (org-open-at-point arg reference-buffer)))))
9348 (defvar org-open-at-point-functions nil
9349 "Hook that is run when following a link at point.
9351 Functions in this hook must return t if they identify and follow
9352 a link at point. If they don't find anything interesting at point,
9353 they must return nil.")
9355 (defun org-open-at-point (&optional arg reference-buffer)
9356 "Open link at or after point.
9357 If there is no link at point, this function will search forward up to
9358 the end of the current line.
9359 Normally, files will be opened by an appropriate application. If the
9360 optional prefix argument ARG is non-nil, Emacs will visit the file.
9361 With a double prefix argument, try to open outside of Emacs, in the
9362 application the system uses for this file type."
9363 (interactive "P")
9364 ;; if in a code block, then open the block's results
9365 (unless (call-interactively #'org-babel-open-src-block-result)
9366 (org-load-modules-maybe)
9367 (move-marker org-open-link-marker (point))
9368 (setq org-window-config-before-follow-link (current-window-configuration))
9369 (org-remove-occur-highlights nil nil t)
9370 (cond
9371 ((and (org-on-heading-p)
9372 (not (org-in-regexp
9377 (not (get-text-property (point) 'org-linked-text)))
9378 (or (org-offer-links-in-entry arg)
9379 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9380 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9381 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9382 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9383 (not (org-in-regexp org-bracket-link-regexp)))
9384 (org-footnote-action))
9385 (t
9386 (let (type path link line search (pos (point)))
9387 (catch 'match
9388 (save-excursion
9390 (when (org-in-regexp org-bracket-link-regexp 1)
9391 (setq link (org-extract-attributes
9392 (org-link-unescape (org-match-string-no-properties 1))))
9394 (setq link (replace-match " " t t link)))
9395 (setq link (org-link-expand-abbrev link))
9396 (cond
9397 ((or (file-name-absolute-p link)
9399 (setq type "file" path link))
9400 ((string-match org-link-re-with-space3 link)
9401 (setq type (match-string 1 link) path (match-string 2 link)))
9402 (t (setq type "thisfile" path link)))
9403 (throw 'match t)))
9405 (when (get-text-property (point) 'org-linked-text)
9406 (setq type "thisfile"
9407 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9408 (1+ (point)) (point))
9409 path (buffer-substring
9410 (or (previous-single-property-change pos 'org-linked-text)
9411 (point-min))
9412 (or (next-single-property-change pos 'org-linked-text)
9413 (point-max))))
9414 (throw 'match t))
9416 (save-excursion
9417 (when (or (org-in-regexp org-angle-link-re)
9418 (org-in-regexp org-plain-link-re))
9419 (setq type (match-string 1) path (match-string 2))
9420 (throw 'match t)))
9421 (save-excursion
9423 (setq type "tags"
9424 path (match-string 1))
9425 (while (string-match ":" path)
9426 (setq path (replace-match "+" t t path)))
9427 (throw 'match t)))
9429 (setq type "tree-match"
9430 path (match-string 1))
9431 (throw 'match t)))
9432 (unless path
9433 (error "No link found"))
9435 ;; switch back to reference buffer
9436 ;; needed when if called in a temporary buffer through
9437 ;; org-open-link-from-string
9438 (with-current-buffer (or reference-buffer (current-buffer))
9440 ;; Remove any trailing spaces in path
9442 (setq path (replace-match "" t t path)))
9443 (if (and org-link-translation-function
9444 (fboundp org-link-translation-function))
9445 ;; Check if we need to translate the link
9446 (let ((tmp (funcall org-link-translation-function type path)))
9447 (setq type (car tmp) path (cdr tmp))))
9449 (cond
9451 ((assoc type org-link-protocols)
9452 (funcall (nth 1 (assoc type org-link-protocols)) path))
9454 ((equal type "mailto")
9455 (let ((cmd (car org-link-mailto-program))
9456 (args (cdr org-link-mailto-program)) args1
9457 (address path) (subject "") a)
9459 (setq address (match-string 1 path)
9460 subject (org-link-escape (match-string 2 path))))
9461 (while args
9462 (cond
9463 ((not (stringp (car args))) (push (pop args) args1))
9464 (t (setq a (pop args))
9465 (if (string-match "%a" a)
9466 (setq a (replace-match address t t a)))
9467 (if (string-match "%s" a)
9468 (setq a (replace-match subject t t a)))
9469 (push a args1))))
9470 (apply cmd (nreverse args1))))
9472 ((member type '("http" "https" "ftp" "news"))
9473 (browse-url (concat type ":" (org-link-escape
9474 path org-link-escape-chars-browser))))
9476 ((string= type "doi")
9477 (browse-url (concat "http://dx.doi.org/"
9478 (org-link-escape
9479 path org-link-escape-chars-browser))))
9481 ((member type '("message"))
9482 (browse-url (concat type ":" path)))
9484 ((string= type "tags")
9485 (org-tags-view arg path))
9487 ((string= type "tree-match")
9490 ((string= type "file")
9492 (setq line (string-to-number (match-string 1 path))
9493 path (substring path 0 (match-beginning 0)))
9495 (setq search (match-string 1 path)
9496 path (substring path 0 (match-beginning 0)))))
9497 (if (string-match "[*?{]" (file-name-nondirectory path))
9498 (dired path)
9499 (org-open-file path arg line search)))
9501 ((string= type "shell")
9502 (let ((cmd path))
9503 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9504 (string-match org-confirm-shell-link-not-regexp cmd))
9505 (not org-confirm-shell-link-function)
9506 (funcall org-confirm-shell-link-function
9508 (org-add-props cmd nil
9509 'face 'org-warning))))
9510 (progn
9511 (message "Executing %s" cmd)
9512 (shell-command cmd))
9513 (error "Abort"))))
9515 ((string= type "elisp")
9516 (let ((cmd path))
9517 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9518 (string-match org-confirm-elisp-link-not-regexp cmd))
9519 (not org-confirm-elisp-link-function)
9520 (funcall org-confirm-elisp-link-function
9522 (org-add-props cmd nil
9523 'face 'org-warning))))
9524 (message "%s => %s" cmd
9525 (if (equal (string-to-char cmd) ?\()
9526 (eval (read cmd))
9527 (call-interactively (read cmd))))
9528 (error "Abort"))))
9530 ((and (string= type "thisfile")
9531 (run-hook-with-args-until-success
9532 'org-open-link-functions path)))
9534 ((string= type "thisfile")
9535 (if arg
9536 (switch-to-buffer-other-window
9537 (org-get-buffer-for-internal-link (current-buffer)))
9538 (org-mark-ring-push))
9539 (let ((cmd `(org-link-search
9540 ,path
9541 ,(cond ((equal arg '(4)) ''occur)
9542 ((equal arg '(16)) ''org-occur)
9543 (t nil))
9544 ,pos)))
9545 (condition-case nil (eval cmd)
9546 (error (progn (widen) (eval cmd))))))
9548 (t
9549 (browse-url-at-point)))))))
9550 (move-marker org-open-link-marker nil)
9551 (run-hook-with-args 'org-follow-link-hook)))
9553 (defun org-offer-links-in-entry (&optional nth zero)
9554 "Offer links in the current entry and follow the selected link.
9555 If there is only one link, follow it immediately as well.
9556 If NTH is an integer, immediately pick the NTH link found.
9557 If ZERO is a string, check also this string for a link, and if
9558 there is one, offer it as link number zero."
9562 (cnt ?0)
9563 (in-emacs (if (integerp nth) nil nth))
9564 have-zero end links link c)
9565 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9566 (push (match-string 0 zero) links)
9567 (setq cnt (1- cnt) have-zero t))
9568 (save-excursion
9569 (org-back-to-heading t)
9570 (setq end (save-excursion (outline-next-heading) (point)))
9571 (while (re-search-forward re end t)
9572 (push (match-string 0) links))
9573 (setq links (org-uniquify (reverse links))))
9575 (cond
9576 ((null links)
9577 (message "No links"))
9578 ((equal (length links) 1)
9579 (setq link (list (car links))))
9580 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9581 (setq link (nth (if have-zero nth (1- nth)) links)))
9582 (t ; we have to select a link
9583 (save-excursion
9584 (save-window-excursion
9585 (delete-other-windows)
9586 (with-output-to-temp-buffer "*Select Link*"
9587 (mapc (lambda (l)
9588 (if (not (string-match org-bracket-link-regexp l))
9590 (org-remove-angle-brackets l)))
9591 (if (match-end 3)
9593 (match-string 3 l) (match-string 1 l)))
9595 (match-string 1 l))))))
9596 links))
9597 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9598 (message "Select link to open, RET to open all:")
9599 (setq c (read-char-exclusive))
9600 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9601 (when (equal c ?q) (error "Abort"))
9602 (if (equal c ?\C-m)
9603 (setq link links)
9604 (setq nth (- c ?0))
9605 (if have-zero (setq nth (1+ nth)))
9606 (unless (and (integerp nth) (>= (length links) nth))
9607 (error "Invalid link selection"))
9608 (setq link (list (nth (1- nth) links))))))
9609 (if link
9610 (let ((buf (current-buffer)))
9611 (dolist (l link)
9612 (org-open-link-from-string l in-emacs buf))
9613 t)
9614 nil)))
9616 ;; Add special file links that specify the way of opening
9618 (org-add-link-type "file+sys" 'org-open-file-with-system)
9619 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9620 (defun org-open-file-with-system (path)
9621 "Open file at PATH using the system way of opening it."
9622 (org-open-file path 'system))
9623 (defun org-open-file-with-emacs (path)
9624 "Open file at PATH in Emacs."
9625 (org-open-file path 'emacs))
9626 (defun org-remove-file-link-modifiers ()
9627 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9628 (goto-char (point-min))
9630 (org-if-unprotected
9631 (replace-match "file:" t t))))
9632 (eval-after-load "org-exp"
9633 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9634 'org-remove-file-link-modifiers))
9636 ;;;; Time estimates
9638 (defun org-get-effort (&optional pom)
9639 "Get the effort estimate for the current entry."
9640 (org-entry-get pom org-effort-property))
9642 ;;; File search
9644 (defvar org-create-file-search-functions nil
9645 "List of functions to construct the right search string for a file link.
9646 These functions are called in turn with point at the location to
9647 which the link should point.
9649 A function in the hook should first test if it would like to
9650 handle this file type, for example by checking the `major-mode'
9651 or the file extension. If it decides not to handle this file, it
9652 should just return nil to give other functions a chance. If it
9653 does handle the file, it must return the search string to be used
9654 when following the link. The search string will be part of the
9655 file link, given after a double colon, and `org-open-at-point'
9656 will automatically search for it. If special measures must be
9657 taken to make the search successful, another function should be
9658 added to the companion hook `org-execute-file-search-functions',
9659 which see.
9661 A function in this hook may also use `setq' to set the variable
9662 `description' to provide a suggestion for the descriptive text to
9663 be used for this link when it gets inserted into an Org-mode
9666 (defvar org-execute-file-search-functions nil
9667 "List of functions to execute a file search triggered by a link.
9669 Functions added to this hook must accept a single argument, the
9670 search string that was part of the file link, the part after the
9671 double colon. The function must first check if it would like to
9672 handle this search, for example by checking the `major-mode' or
9673 the file extension. If it decides not to handle this search, it
9674 should just return nil to give other functions a chance. If it
9675 does handle the search, it must return a non-nil value to keep
9676 other functions from trying.
9678 Each function can access the current prefix argument through the
9679 variable `current-prefix-argument'. Note that a single prefix is
9680 used to force opening a link in Emacs, so it may be good to only
9681 use a numeric or double prefix to guide the search function.
9683 In case this is needed, a function in this hook can also restore
9684 the window configuration before `org-open-at-point' was called using:
9686 (set-window-configuration org-window-config-before-follow-link)")
9688 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9689 (defun org-link-search (s &optional type avoid-pos)
9690 "Search for a link search option.
9691 If S is surrounded by forward slashes, it is interpreted as a
9692 regular expression. In org-mode files, this will create an `org-occur'
9693 sparse tree. In ordinary files, `occur' will be used to list matches.
9694 If the current buffer is in `dired-mode', grep will be used to search
9695 in all files. If AVOID-POS is given, ignore matches near that position."
9696 (let ((case-fold-search t)
9700 org-emphasis-alist)
9702 (pos (point))
9703 (pre nil) (post nil)
9704 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9705 (cond
9706 ;; First check if there are any special search functions
9707 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9708 ;; Now try the builtin stuff
9709 ((and (equal (string-to-char s0) ?#)
9710 (> (length s0) 1)
9711 (save-excursion
9712 (goto-char (point-min))
9713 (and
9714 (re-search-forward
9716 (setq type 'dedicated
9717 pos (match-beginning 0))))
9718 ;; There is an exact target for this
9719 (goto-char pos)
9720 (org-back-to-heading t)))
9721 ((save-excursion
9722 (goto-char (point-min))
9723 (and
9724 (re-search-forward
9725 (concat "<<" (regexp-quote s0) ">>") nil t)
9726 (setq type 'dedicated
9727 pos (match-beginning 0))))
9728 ;; There is an exact target for this
9729 (goto-char pos))
9731 (save-excursion
9732 (goto-char (point-min))
9733 (and
9734 (re-search-forward
9735 (concat "[^[]" (regexp-quote
9736 (format org-coderef-label-format
9737 (match-string 1 s0))))
9738 nil t)
9739 (setq type 'dedicated
9740 pos (1+ (match-beginning 0))))))
9741 ;; There is a coderef target for this
9742 (goto-char pos))
9744 ;; A regular expression
9745 (cond
9746 ((org-mode-p)
9747 (org-occur (match-string 1 s)))
9748 ;;((eq major-mode 'dired-mode)
9749 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9750 (t (org-do-occur (match-string 1 s)))))
9751 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9752 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9753 (goto-char (point-min))
9754 (cond
9755 ((let (case-fold-search)
9756 (re-search-forward (format org-complex-heading-regexp-format
9757 (regexp-quote s))
9758 nil t))
9759 ;; OK, found a match
9760 (setq type 'dedicated)
9761 (goto-char (match-beginning 0)))
9762 ((and (not org-link-search-inhibit-query)
9763 (eq org-link-search-must-match-exact-headline 'query-to-create)
9764 (y-or-n-p "No match - create this as a new heading? "))
9765 (goto-char (point-max))
9766 (or (bolp) (newline))
9768 (beginning-of-line 0))
9769 (t
9770 (goto-char pos)
9771 (error "No match"))))
9772 (t
9773 ;; A normal search string
9774 (when (equal (string-to-char s) ?*)
9775 ;; Anchor on headlines, post may include tags.
9778 s (substring s 1)))
9779 (remove-text-properties
9780 0 (length s)
9781 '(face nil mouse-face nil keymap nil fontified nil) s)
9782 ;; Make a series of regular expressions to find a match
9791 re4 (concat "[^a-zA-Z_]" re4_)
9793 re1 (concat pre re2 post)
9794 re3 (concat pre (if pre re4_ re4) post)
9795 re5 (concat pre ".*" re4)
9796 re2 (concat pre re2)
9797 re2a (concat pre (if pre re2a_ re2a))
9798 re4 (concat pre (if pre re4_ re4))
9802 ))
9803 (cond
9804 ((eq type 'org-occur) (org-occur reall))
9805 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9806 (t (goto-char (point-min))
9807 (setq type 'fuzzy)
9808 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9809 (org-search-not-self 1 re1 nil t)
9810 (org-search-not-self 1 re2 nil t)
9811 (org-search-not-self 1 re2a nil t)
9812 (org-search-not-self 1 re3 nil t)
9813 (org-search-not-self 1 re4 nil t)
9814 (org-search-not-self 1 re5 nil t)
9815 )
9816 (goto-char (match-beginning 1))
9817 (goto-char pos)
9818 (error "No match"))))))
9819 (and (org-mode-p) (org-show-context 'link-search))
9820 type))
9822 (defun org-search-not-self (group &rest args)
9823 "Execute `re-search-forward', but only accept matches that do not
9824 enclose the position of `org-open-link-marker'."
9825 (let ((m org-open-link-marker))
9826 (catch 'exit
9827 (while (apply 're-search-forward args)
9828 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9829 (goto-char (match-end group))
9830 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9831 (> (match-beginning 0) (marker-position m))
9832 (< (match-end 0) (marker-position m)))
9833 (save-match-data
9834 (or (not (org-in-regexp
9835 org-bracket-link-analytic-regexp 1))
9836 (not (match-end 4)) ; no description
9837 (and (<= (match-beginning 4) (point))
9838 (>= (match-end 4) (point))))))
9839 (throw 'exit (point))))))))
9841 (defun org-get-buffer-for-internal-link (buffer)
9842 "Return a buffer to be used for displaying the link target of internal links."
9843 (cond
9844 ((not org-display-internal-link-with-indirect-buffer)
9845 buffer)
9846 ((string-match "(Clone)$" (buffer-name buffer))
9847 (message "Buffer is already a clone, not making another one")
9848 ;; we also do not modify visibility in this case
9849 buffer)
9850 (t ; make a new indirect buffer for displaying the link
9851 (let* ((bn (buffer-name buffer))
9852 (ibn (concat bn "(Clone)"))
9853 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9854 (with-current-buffer ib (org-overview))
9855 ib))))
9857 (defun org-do-occur (regexp &optional cleanup)
9858 "Call the Emacs command `occur'.
9859 If CLEANUP is non-nil, remove the printout of the regular expression
9860 in the *Occur* buffer. This is useful if the regex is long and not useful
9861 to read."
9862 (occur regexp)
9863 (when cleanup
9864 (let ((cwin (selected-window)) win beg end)
9865 (when (setq win (get-buffer-window "*Occur*"))
9866 (select-window win))
9867 (goto-char (point-min))
9868 (when (re-search-forward "match[a-z]+" nil t)
9869 (setq beg (match-end 0))
9871 (setq end (1- (match-beginning 0)))))
9872 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9873 (goto-char (point-min))
9874 (select-window cwin))))
9876 ;;; The mark ring for links jumps
9878 (defvar org-mark-ring nil
9879 "Mark ring for positions before jumps in Org-mode.")
9880 (defvar org-mark-ring-last-goto nil
9881 "Last position in the mark ring used to go back.")
9882 ;; Fill and close the ring
9883 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9884 (loop for i from 1 to org-mark-ring-length do
9885 (push (make-marker) org-mark-ring))
9886 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9887 org-mark-ring)
9889 (defun org-mark-ring-push (&optional pos buffer)
9890 "Put the current position or POS into the mark ring and rotate it."
9891 (interactive)
9892 (setq pos (or pos (point)))
9893 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9894 (move-marker (car org-mark-ring)
9895 (or pos (point))
9896 (or buffer (current-buffer)))
9897 (message "%s"
9898 (substitute-command-keys
9901 (defun org-mark-ring-goto (&optional n)
9902 "Jump to the previous position in the mark ring.
9903 With prefix arg N, jump back that many stored positions. When
9904 called several times in succession, walk through the entire ring.
9905 Org-mode commands jumping to a different position in the current file,
9906 or to another Org-mode file, automatically push the old position
9907 onto the ring."
9908 (interactive "p")
9909 (let (p m)
9910 (if (eq last-command this-command)
9911 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9912 (setq p org-mark-ring))
9913 (setq org-mark-ring-last-goto p)
9914 (setq m (car p))
9915 (org-pop-to-buffer-same-window (marker-buffer m))
9916 (goto-char m)
9917 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9919 (defun org-remove-angle-brackets (s)
9920 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9921 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9922 s)
9923 (defun org-add-angle-brackets (s)
9924 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9925 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9926 s)
9927 (defun org-remove-double-quotes (s)
9930 s)
9932 ;;; Following specific links
9934 (defun org-follow-timestamp-link ()
9935 (cond
9936 ((org-at-date-range-p t)
9937 (let ((org-agenda-start-on-weekday)
9938 (t1 (match-string 1))
9939 (t2 (match-string 2)))
9940 (setq t1 (time-to-days (org-time-string-to-time t1))
9941 t2 (time-to-days (org-time-string-to-time t2)))
9942 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9943 ((org-at-timestamp-p t)
9944 (org-agenda-list nil (time-to-days (org-time-string-to-time
9945 (substring (match-string 1) 0 10)))
9946 1))
9947 (t (error "This should not happen"))))
9950 ;;; Following file links
9951 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9952 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9953 (declare-function mailcap-mime-info
9954 "mailcap" (string &optional request no-decode))
9955 (defvar org-wait nil)
9956 (defun org-open-file (path &optional in-emacs line search)
9957 "Open the file at PATH.
9958 First, this expands any special file name abbreviations. Then the
9959 configuration variable `org-file-apps' is checked if it contains an
9960 entry for this file type, and if yes, the corresponding command is launched.
9962 If no application is found, Emacs simply visits the file.
9964 With optional prefix argument IN-EMACS, Emacs will visit the file.
9966 prefix arg, Org tries to avoid opening in Emacs
9967 and to use an external application to visit the file.
9969 Optional LINE specifies a line to go to, optional SEARCH a string
9970 to search for. If LINE or SEARCH is given, the file will be
9971 opened in Emacs, unless an entry from org-file-apps that makes
9972 use of groups in a regexp matches.
9974 If you want to change the way frames are used when following a
9975 link, please customize `org-link-frame-setup'.
9977 If the file does not exist, an error is thrown."
9978 (let* ((file (if (equal path "")
9979 buffer-file-name
9980 (substitute-in-file-name (expand-file-name path))))
9981 (file-apps (append org-file-apps (org-default-apps)))
9982 (apps (org-remove-if
9983 'org-file-apps-entry-match-against-dlink-p file-apps))
9984 (apps-dlink (org-remove-if-not
9985 'org-file-apps-entry-match-against-dlink-p file-apps))
9986 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9987 (dirp (if remp nil (file-directory-p file)))
9988 (file (if (and dirp org-open-directory-means-index-dot-org)
9989 (concat (file-name-as-directory file) "index.org")
9990 file))
9991 (a-m-a-p (assq 'auto-mode apps))
9992 (dfile (downcase file))
9993 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9994 (link (cond ((and (eq line nil)
9995 (eq search nil))
9996 file)
9997 (line
9998 (concat file "::" (number-to-string line)))
9999 (search
10000 (concat file "::" search))))
10001 (dlink (downcase link))
10002 (old-buffer (current-buffer))
10003 (old-pos (point))
10004 (old-mode major-mode)
10005 ext cmd link-match-data)
10007 (setq ext (match-string 1 dfile))
10009 (setq ext (match-string 1 dfile))))
10010 (cond
10011 ((member in-emacs '((16) system))
10012 (setq cmd (cdr (assoc 'system apps))))
10013 (in-emacs (setq cmd 'emacs))
10014 (t
10015 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10016 (and dirp (cdr (assoc 'directory apps)))
10017 ; first, try matching against apps-dlink
10018 ; if we get a match here, store the match data for later
10019 (let ((match (assoc-default dlink apps-dlink
10020 'string-match)))
10021 (if match
10022 (progn (setq link-match-data (match-data))
10023 match)
10024 (progn (setq in-emacs (or in-emacs line search))
10025 nil))) ; if we have no match in apps-dlink,
10026 ; always open the file in emacs if line or search
10027 ; is given (for backwards compatibility)
10028 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10029 'string-match)
10030 (cdr (assoc ext apps))
10031 (cdr (assoc t apps))))))
10032 (when (eq cmd 'system)
10033 (setq cmd (cdr (assoc 'system apps))))
10034 (when (eq cmd 'default)
10035 (setq cmd (cdr (assoc t apps))))
10036 (when (eq cmd 'mailcap)
10037 (require 'mailcap)
10038 (mailcap-parse-mailcaps)
10039 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10040 (command (mailcap-mime-info mime-type)))
10041 (if (stringp command)
10042 (setq cmd command)
10043 (setq cmd 'emacs))))
10044 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10045 (not (file-exists-p file))
10046 (not org-open-non-existing-files))
10047 (error "No such file: %s" file))
10048 (cond
10050 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10052 (setq cmd (replace-match "%s" t t cmd)))
10053 (while (string-match "%s" cmd)
10054 (setq cmd (replace-match
10055 (save-match-data
10056 (shell-quote-argument
10057 (convert-standard-filename file)))
10058 t t cmd)))
10060 ;; Replace "%1", "%2" etc. in command with group matches from regex
10061 (save-match-data
10062 (let ((match-index 1)
10063 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10064 (set-match-data link-match-data)
10065 (while (<= match-index number-of-groups)
10066 (let ((regex (concat "%" (number-to-string match-index)))
10067 (replace-with (match-string match-index dlink)))
10068 (while (string-match regex cmd)
10069 (setq cmd (replace-match replace-with t t cmd))))
10070 (setq match-index (+ match-index 1)))))
10072 (save-window-excursion
10073 (start-process-shell-command cmd nil cmd)
10074 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10075 ))
10076 ((or (stringp cmd)
10077 (eq cmd 'emacs))
10078 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10079 (widen)
10080 (if line (org-goto-line line)
10081 (if search (org-link-search search))))
10082 ((consp cmd)
10083 (let ((file (convert-standard-filename file)))
10084 (save-match-data
10085 (set-match-data link-match-data)
10086 (eval cmd))))
10087 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10088 (and (org-mode-p) (eq old-mode 'org-mode)
10089 (or (not (equal old-buffer (current-buffer)))
10090 (not (equal old-pos (point))))
10091 (org-mark-ring-push old-pos old-buffer))))
10093 (defun org-file-apps-entry-match-against-dlink-p (entry)
10094 "This function returns non-nil if `entry' uses a regular
10095 expression which should be matched against the whole link by
10096 org-open-file.
10098 It assumes that is the case when the entry uses a regular
10099 expression which has at least one grouping construct and the
10100 action is either a lisp form or a command string containing
10101 '%1', i.e. using at least one subexpression match as a
10102 parameter."
10103 (let ((selector (car entry))
10104 (action (cdr entry)))
10105 (if (stringp selector)
10106 (and (> (regexp-opt-depth selector) 0)
10107 (or (and (stringp action)
10108 (string-match "%[0-9]" action))
10109 (consp action)))
10110 nil)))
10112 (defun org-default-apps ()
10113 "Return the default applications for this operating system."
10114 (cond
10115 ((eq system-type 'darwin)
10116 org-file-apps-defaults-macosx)
10117 ((eq system-type 'windows-nt)
10118 org-file-apps-defaults-windowsnt)
10119 (t org-file-apps-defaults-gnu)))
10121 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10122 "Convert extensions to regular expressions in the cars of LIST.
10123 Also, weed out any non-string entries, because the return value is used
10124 only for regexp matching.
10125 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10126 point to the symbol `emacs', indicating that the file should
10127 be opened in Emacs."
10128 (append
10129 (delq nil
10130 (mapcar (lambda (x)
10131 (if (not (stringp (car x)))
10132 nil
10134 x
10136 list))
10137 (if add-auto-mode
10138 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10140 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10141 (defun org-file-remote-p (file)
10142 "Test whether FILE specifies a location on a remote system.
10143 Return non-nil if the location is indeed remote.
10147 (cond ((fboundp 'file-remote-p)
10148 (file-remote-p file))
10149 ((fboundp 'tramp-handle-file-remote-p)
10150 (tramp-handle-file-remote-p file))
10151 ((and (boundp 'ange-ftp-name-format)
10152 (string-match (car ange-ftp-name-format) file))
10153 t)
10154 (t nil)))
10157 ;;;; Refiling
10159 (defun org-get-org-file ()
10160 "Read a filename, with default directory `org-directory'."
10161 (let ((default (or org-default-notes-file remember-data-file)))
10162 (read-file-name (format "File name [%s]: " default)
10163 (file-name-as-directory org-directory)
10164 default)))
10166 (defun org-notes-order-reversed-p ()
10167 "Check if the current file should receive notes in reversed order."
10168 (cond
10169 ((not org-reverse-note-order) nil)
10170 ((eq t org-reverse-note-order) t)
10171 ((not (listp org-reverse-note-order)) nil)
10172 (t (catch 'exit
10173 (let ((all org-reverse-note-order)
10174 entry)
10175 (while (setq entry (pop all))
10176 (if (string-match (car entry) buffer-file-name)
10177 (throw 'exit (cdr entry))))
10178 nil)))))
10180 (defvar org-refile-target-table nil
10181 "The list of refile targets, created by `org-refile'.")
10183 (defvar org-agenda-new-buffers nil
10184 "Buffers created to visit agenda files.")
10186 (defvar org-refile-cache nil
10187 "Cache for refile targets.")
10189 (defvar org-refile-markers nil
10190 "All the markers used for caching refile locations.")
10192 (defun org-refile-marker (pos)
10193 "Get a new refile marker, but only if caching is in use."
10194 (if (not org-refile-use-cache)
10195 pos
10196 (let ((m (make-marker)))
10197 (move-marker m pos)
10198 (push m org-refile-markers)
10199 m)))
10201 (defun org-refile-cache-clear ()
10202 "Clear the refile cache and disable all the markers."
10203 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10204 (setq org-refile-markers nil)
10205 (setq org-refile-cache nil)
10206 (message "Refile cache has been cleared"))
10208 (defun org-refile-cache-check-set (set)
10209 "Check if all the markers in the cache still have live buffers."
10210 (let (marker)
10211 (catch 'exit
10212 (while (and set (setq marker (nth 3 (pop set))))
10213 ;; if org-refile-use-outline-path is 'file, marker may be nil
10214 (when (and marker (null (marker-buffer marker)))
10215 (message "not found") (sit-for 3)
10216 (throw 'exit nil)))
10217 t)))
10219 (defun org-refile-cache-put (set &rest identifiers)
10220 "Push the refile targets SET into the cache, under IDENTIFIERS."
10221 (let* ((key (sha1 (prin1-to-string identifiers)))
10222 (entry (assoc key org-refile-cache)))
10223 (if entry
10224 (setcdr entry set)
10225 (push (cons key set) org-refile-cache))))
10227 (defun org-refile-cache-get (&rest identifiers)
10228 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10229 (cond
10230 ((not org-refile-cache) nil)
10231 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10232 (t
10233 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10234 org-refile-cache))))
10235 (and set (org-refile-cache-check-set set) set)))))
10237 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10238 "Produce a table with refile targets."
10239 (let ((case-fold-search nil)
10240 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10241 (entries (or org-refile-targets '((nil . (:level . 1)))))
10242 targets tgs txt re files f desc descre fast-path-p level pos0)
10243 (message "Getting targets...")
10244 (with-current-buffer (or default-buffer (current-buffer))
10245 (while (setq entry (pop entries))
10246 (setq files (car entry) desc (cdr entry))
10247 (setq fast-path-p nil)
10248 (cond
10249 ((null files) (setq files (list (current-buffer))))
10250 ((eq files 'org-agenda-files)
10251 (setq files (org-agenda-files 'unrestricted)))
10252 ((and (symbolp files) (fboundp files))
10253 (setq files (funcall files)))
10254 ((and (symbolp files) (boundp files))
10255 (setq files (symbol-value files))))
10256 (if (stringp files) (setq files (list files)))
10257 (cond
10258 ((eq (car desc) :tag)
10260 ((eq (car desc) :todo)
10262 ((eq (car desc) :regexp)
10263 (setq descre (cdr desc)))
10264 ((eq (car desc) :level)
10266 (if org-odd-levels-only
10267 (1- (* 2 (cdr desc)))
10268 (cdr desc)))
10270 ((eq (car desc) :maxlevel)
10271 (setq fast-path-p t)
10273 (if org-odd-levels-only
10274 (1- (* 2 (cdr desc)))
10275 (cdr desc)))
10277 (t (error "Bad refiling target description %s" desc)))
10278 (while (setq f (pop files))
10279 (with-current-buffer
10280 (if (bufferp f) f (org-get-agenda-file-buffer f))
10281 (or
10282 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10283 (progn
10284 (if (bufferp f) (setq f (buffer-file-name
10285 (buffer-base-buffer f))))
10286 (setq f (and f (expand-file-name f)))
10287 (if (eq org-refile-use-outline-path 'file)
10288 (push (list (file-name-nondirectory f) f nil nil) tgs))
10289 (save-excursion
10290 (save-restriction
10291 (widen)
10292 (goto-char (point-min))
10293 (while (re-search-forward descre nil t)
10294 (goto-char (setq pos0 (point-at-bol)))
10295 (catch 'next
10296 (when org-refile-target-verify-function
10297 (save-match-data
10298 (or (funcall org-refile-target-verify-function)
10299 (throw 'next t))))
10300 (when (and (looking-at org-complex-heading-regexp)
10301 (not (member (match-string 4) excluded-entries)))
10302 (setq level (org-reduced-level
10303 (- (match-end 1) (match-beginning 1)))
10304 txt (org-link-display-format (match-string 4))
10306 re (format org-complex-heading-regexp-format
10307 (regexp-quote (match-string 4))))
10308 (when org-refile-use-outline-path
10309 (setq txt (mapconcat
10310 'org-protect-slash
10311 (append
10312 (if (eq org-refile-use-outline-path
10313 'file)
10314 (list (file-name-nondirectory
10315 (buffer-file-name
10316 (buffer-base-buffer))))
10317 (if (eq org-refile-use-outline-path
10318 'full-file-path)
10319 (list (buffer-file-name
10320 (buffer-base-buffer)))))
10321 (org-get-outline-path fast-path-p
10322 level txt)
10323 (list txt))
10324 "/")))
10325 (push (list txt f re (org-refile-marker (point)))
10326 tgs)))
10327 (when (= (point) pos0)
10328 ;; verification function has not moved point
10329 (goto-char (point-at-eol))))))))
10330 (when org-refile-use-cache
10331 (org-refile-cache-put tgs (buffer-file-name) descre))
10332 (setq targets (append tgs targets))
10333 ))))
10334 (message "Getting targets...done")
10335 (nreverse targets)))
10337 (defun org-protect-slash (s)
10338 (while (string-match "/" s)
10340 s)
10342 (defvar org-olpa (make-vector 20 nil))
10344 (defun org-get-outline-path (&optional fastp level heading)
10345 "Return the outline path to the current entry, as a list.
10347 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10348 routine which makes outline path derivations for an entire file,
10349 avoiding backtracing. Refile target collection makes use of that."
10350 (if fastp
10351 (progn
10352 (if (> level 19)
10353 (error "Outline path failure, more than 19 levels"))
10354 (loop for i from level upto 19 do
10355 (aset org-olpa i nil))
10356 (prog1
10357 (delq nil (append org-olpa nil))
10358 (aset org-olpa level heading)))
10359 (let (rtn case-fold-search)
10360 (save-excursion
10361 (save-restriction
10362 (widen)
10363 (while (org-up-heading-safe)
10364 (when (looking-at org-complex-heading-regexp)
10365 (push (org-match-string-no-properties 4) rtn)))
10366 rtn)))))
10368 (defun org-format-outline-path (path &optional width prefix)
10369 "Format the outline path PATH for display.
10370 Width is the maximum number of characters that is available.
10371 Prefix is a prefix to be included in the returned string,
10372 such as the file name."
10373 (setq width (or width 79))
10374 (if prefix (setq width (- width (length prefix))))
10375 (if (not path)
10376 (or prefix "")
10377 (let* ((nsteps (length path))
10378 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10379 (maxwidth (if (<= total-width width)
10380 10000 ;; everything fits
10381 ;; we need to shorten the level headings
10382 (/ (- width nsteps) nsteps)))
10383 (org-odd-levels-only nil)
10384 (n 0)
10385 (total (1+ (length prefix))))
10386 (setq maxwidth (max maxwidth 10))
10387 (concat prefix
10388 (mapconcat
10389 (lambda (h)
10390 (setq n (1+ n))
10391 (if (and (= n nsteps) (< maxwidth 10000))
10392 (setq maxwidth (- total-width total)))
10393 (if (< (length h) maxwidth)
10394 (progn (setq total (+ total (length h) 1)) h)
10395 (setq h (substring h 0 (- maxwidth 2))
10396 total (+ total maxwidth 1))
10398 (setq h (substring h 0 (match-beginning 0))))
10399 (setq h (concat h "..")))
10400 (org-add-props h nil 'face
10401 (nth (% (1- n) org-n-level-faces)
10402 org-level-faces))
10403 h)
10404 path "/")))))
10406 (defun org-display-outline-path (&optional file current)
10407 "Display the current outline path in the echo area."
10408 (interactive "P")
10409 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10410 (case-fold-search nil)
10411 (path (and (org-mode-p) (org-get-outline-path))))
10412 (if current (setq path (append path
10413 (save-excursion
10414 (org-back-to-heading t)
10415 (if (looking-at org-complex-heading-regexp)
10416 (list (match-string 4)))))))
10417 (message "%s"
10418 (org-format-outline-path
10419 path
10420 (1- (frame-width))
10421 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10423 (defvar org-refile-history nil
10424 "History for refiling operations.")
10426 (defvar org-after-refile-insert-hook nil
10427 "Hook run after `org-refile' has inserted its stuff at the new location.
10428 Note that this is still *before* the stuff will be removed from
10429 the *old* location.")
10431 (defvar org-capture-last-stored-marker)
10432 (defun org-refile (&optional goto default-buffer rfloc)
10433 "Move the entry or entries at point to another heading.
10434 The list of target headings is compiled using the information in
10435 `org-refile-targets', which see.
10437 At the target location, the entry is filed as a subitem of the target
10438 heading. Depending on `org-reverse-note-order', the new subitem will
10439 either be the first or the last subitem.
10441 If there is an active region, all entries in that region will be moved.
10442 However, the region must fulfill the requirement that the first heading
10443 is the first one sets the top-level of the moved text - at most siblings
10444 below it are allowed.
10446 With prefix arg GOTO, the command will only visit the target location
10447 and not actually move anything.
10450 go to the location where the last refiling operation has put the subtree.
10451 With a prefix argument of `2', refile to the running clock.
10453 RFLOC can be a refile location obtained in a different way.
10455 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10457 If you are using target caching (see `org-refile-use-cache'),
10458 You have to clear the target cache in order to find new targets.
10459 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10460 prefix argument (`C-u C-u C-u C-c C-w')."
10462 (interactive "P")
10463 (if (member goto '(0 (64)))
10464 (org-refile-cache-clear)
10465 (let* ((cbuf (current-buffer))
10466 (regionp (org-region-active-p))
10467 (region-start (and regionp (region-beginning)))
10468 (region-end (and regionp (region-end)))
10469 (region-length (and regionp (- region-end region-start)))
10470 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10471 pos it nbuf file re level reversed)
10472 (setq last-command nil)
10473 (when regionp
10474 (goto-char region-start)
10475 (or (bolp) (goto-char (point-at-bol)))
10476 (setq region-start (point))
10477 (unless (or (org-kill-is-subtree-p
10478 (buffer-substring region-start region-end))
10479 (prog1 org-refile-active-region-within-subtree
10480 (org-toggle-heading)))
10481 (error "The region is not a (sequence of) subtree(s)")))
10482 (if (equal goto '(16))
10483 (org-refile-goto-last-stored)
10484 (when (or
10485 (and (equal goto 2)
10486 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10487 (prog1
10488 (setq it (list (or org-clock-heading "running clock")
10489 (buffer-file-name
10490 (marker-buffer org-clock-hd-marker))
10491 ""
10492 (marker-position org-clock-hd-marker)))
10493 (setq goto nil)))
10494 (setq it (or rfloc
10495 (save-excursion
10496 (org-back-to-heading t)
10497 (org-refile-get-location
10498 (cond (goto "Goto")
10499 (regionp "Refile region to")
10500 (t "Refile subtree to")) default-buffer
10501 org-refile-allow-creating-parent-nodes)))))
10502 (setq file (nth 1 it)
10503 re (nth 2 it)
10504 pos (nth 3 it))
10505 (if (and (not goto)
10506 pos
10507 (equal (buffer-file-name) file)
10508 (if regionp
10509 (and (>= pos region-start)
10510 (<= pos region-end))
10511 (and (>= pos (point))
10512 (< pos (save-excursion
10513 (org-end-of-subtree t t))))))
10514 (error "Cannot refile to position inside the tree or region"))
10516 (setq nbuf (or (find-buffer-visiting file)
10517 (find-file-noselect file)))
10518 (if goto
10519 (progn
10520 (org-pop-to-buffer-same-window nbuf)
10521 (goto-char pos)
10522 (org-show-context 'org-goto))
10523 (if regionp
10524 (progn
10525 (org-kill-new (buffer-substring region-start region-end))
10526 (org-save-markers-in-region region-start region-end))
10527 (org-copy-subtree 1 nil t))
10528 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10529 (find-file-noselect file)))
10530 (setq reversed (org-notes-order-reversed-p))
10531 (save-excursion
10532 (save-restriction
10533 (widen)
10534 (if pos
10535 (progn
10536 (goto-char pos)
10537 (looking-at org-outline-regexp)
10538 (setq level (org-get-valid-level (funcall outline-level) 1))
10539 (goto-char
10540 (if reversed
10541 (or (outline-next-heading) (point-max))
10542 (or (save-excursion (org-get-next-sibling))
10543 (org-end-of-subtree t t)
10544 (point-max)))))
10545 (setq level 1)
10546 (if (not reversed)
10547 (goto-char (point-max))
10548 (goto-char (point-min))
10549 (or (outline-next-heading) (goto-char (point-max)))))
10550 (if (not (bolp)) (newline))
10551 (org-paste-subtree level)
10552 (when org-log-refile
10553 (org-add-log-setup 'refile nil nil 'findpos
10554 org-log-refile)
10555 (unless (eq org-log-refile 'note)
10556 (save-excursion (org-add-log-note))))
10557 (and org-auto-align-tags (org-set-tags nil t))
10558 (bookmark-set "org-refile-last-stored")
10559 ;; If we are refiling for capture, make sure that the
10560 ;; last-capture pointers point here
10561 (when (org-bound-and-true-p org-refile-for-capture)
10562 (bookmark-set "org-capture-last-stored-marker")
10563 (move-marker org-capture-last-stored-marker (point)))
10564 (if (fboundp 'deactivate-mark) (deactivate-mark))
10565 (run-hooks 'org-after-refile-insert-hook))))
10566 (if regionp
10567 (delete-region (point) (+ (point) region-length))
10568 (org-cut-subtree))
10569 (when (featurep 'org-inlinetask)
10570 (org-inlinetask-remove-END-maybe))
10571 (setq org-markers-to-move nil)
10574 (defun org-refile-goto-last-stored ()
10575 "Go to the location where the last refile was stored."
10576 (interactive)
10577 (bookmark-jump "org-refile-last-stored")
10578 (message "This is the location of the last refile"))
10580 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10581 "Prompt the user for a refile location, using PROMPT.
10582 PROMPT should not be suffixed with a colon and a space, because
10583 this function appends the default value from
10584 `org-refile-history' automatically, if that is not empty."
10585 (let ((org-refile-targets org-refile-targets)
10586 (org-refile-use-outline-path org-refile-use-outline-path)
10587 excluded-entries)
10588 (when (and (eq major-mode 'org-mode)
10589 (not org-refile-use-cache))
10590 (org-map-tree
10591 (lambda()
10592 (setq excluded-entries
10593 (append excluded-entries (list (org-get-heading t t)))))))
10594 (setq org-refile-target-table
10595 (org-refile-get-targets default-buffer excluded-entries)))
10596 (unless org-refile-target-table
10597 (error "No refile targets"))
10598 (let* ((prompt (concat prompt
10599 (and (car org-refile-history)
10600 (concat " (default " (car org-refile-history) ")"))
10601 ": "))
10602 (cbuf (current-buffer))
10603 (partial-completion-mode nil)
10604 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10605 (cfunc (if (and org-refile-use-outline-path
10606 org-outline-path-complete-in-steps)
10607 'org-olpath-completing-read
10608 'org-icompleting-read))
10609 (extra (if org-refile-use-outline-path "/" ""))
10610 (filename (and cfn (expand-file-name cfn)))
10611 (tbl (mapcar
10612 (lambda (x)
10613 (if (and (not (member org-refile-use-outline-path
10614 '(file full-file-path)))
10615 (not (equal filename (nth 1 x))))
10616 (cons (concat (car x) extra " ("
10617 (file-name-nondirectory (nth 1 x)) ")")
10618 (cdr x))
10619 (cons (concat (car x) extra) (cdr x))))
10620 org-refile-target-table))
10621 (completion-ignore-case t)
10622 pa answ parent-target child parent old-hist)
10623 (setq old-hist org-refile-history)
10624 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10625 nil 'org-refile-history (car org-refile-history)))
10626 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10627 (org-refile-check-position pa)
10628 (if pa
10629 (progn
10630 (when (or (not org-refile-history)
10631 (not (eq old-hist org-refile-history))
10632 (not (equal (car pa) (car org-refile-history))))
10633 (setq org-refile-history
10634 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10635 org-refile-history
10636 (cdr org-refile-history))))
10637 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10638 (pop org-refile-history)))
10639 pa)
10641 (progn
10642 (setq parent (match-string 1 answ)
10643 child (match-string 2 answ))
10644 (setq parent-target (or (assoc parent tbl)
10645 (assoc (concat parent "/") tbl)))
10646 (when (and parent-target
10647 (or (eq new-nodes t)
10648 (and (eq new-nodes 'confirm)
10650 child)))))
10651 (org-refile-new-child parent-target child)))
10652 (error "Invalid target location")))))
10654 (defun org-refile-check-position (refile-pointer)
10655 "Check if the refile pointer matches the readline to which it points."
10656 (let* ((file (nth 1 refile-pointer))
10657 (re (nth 2 refile-pointer))
10658 (pos (nth 3 refile-pointer))
10659 buffer)
10660 (when (org-string-nw-p re)
10661 (setq buffer (if (markerp pos)
10662 (marker-buffer pos)
10663 (or (find-buffer-visiting file)
10664 (find-file-noselect file))))
10665 (with-current-buffer buffer
10666 (save-excursion
10667 (save-restriction
10668 (widen)
10669 (goto-char pos)
10670 (beginning-of-line 1)
10671 (unless (org-looking-at-p re)
10672 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10674 (defun org-refile-new-child (parent-target child)
10675 "Use refile target PARENT-TARGET to add new CHILD below it."
10676 (unless parent-target
10677 (error "Cannot find parent for new node"))
10678 (let ((file (nth 1 parent-target))
10679 (pos (nth 3 parent-target))
10680 level)
10681 (with-current-buffer (or (find-buffer-visiting file)
10682 (find-file-noselect file))
10683 (save-excursion
10684 (save-restriction
10685 (widen)
10686 (if pos
10687 (goto-char pos)
10688 (goto-char (point-max))
10689 (if (not (bolp)) (newline)))
10690 (when (looking-at org-outline-regexp)
10691 (setq level (funcall outline-level))
10692 (org-end-of-subtree t t))
10693 (org-back-over-empty-lines)
10695 (if pos (org-get-valid-level level 1) 1) ?*)
10697 (beginning-of-line 0)
10698 (list (concat (car parent-target) "/" child) file "" (point)))))))
10700 (defun org-olpath-completing-read (prompt collection &rest args)
10701 "Read an outline path like a file name."
10702 (let ((thetable collection)
10703 (org-completion-use-ido nil) ; does not work with ido.
10704 (org-completion-use-iswitchb nil)) ; or iswitchb
10705 (apply
10706 'org-icompleting-read prompt
10707 (lambda (string predicate &optional flag)
10708 (let (rtn r f (l (length string)))
10709 (cond
10710 ((eq flag nil)
10711 ;; try completion
10712 (try-completion string thetable))
10713 ((eq flag t)
10714 ;; all-completions
10715 (setq rtn (all-completions string thetable predicate))
10716 (mapcar
10717 (lambda (x)
10718 (setq r (substring x l))
10719 (if (string-match " ([^)]*)$" x)
10720 (setq f (match-string 0 x))
10721 (setq f ""))
10722 (if (string-match "/" r)
10723 (concat string (substring r 0 (match-end 0)) f)
10724 x))
10725 rtn))
10726 ((eq flag 'lambda)
10727 ;; exact match?
10728 (assoc string thetable)))
10729 ))
10730 args)))
10732 ;;;; Dynamic blocks
10734 (defun org-find-dblock (name)
10735 "Find the first dynamic block with name NAME in the buffer.
10736 If not found, stay at current position and return nil."
10737 (let (pos)
10738 (save-excursion
10739 (goto-char (point-min))
10741 nil t)
10742 (match-beginning 0))))
10743 (if pos (goto-char pos))
10744 pos))
10746 (defconst org-dblock-start-re
10748 "Matches the start line of a dynamic block, with parameters.")
10751 "Matches the end of a dynamic block.")
10753 (defun org-create-dblock (plist)
10754 "Create a dynamic block section, with parameters taken from PLIST.
10755 PLIST must contain a :name entry which is used as name of the block."
10757 (end-of-line 1)
10758 (newline))
10759 (let ((col (current-column))
10760 (name (plist-get plist :name)))
10761 (insert "#+BEGIN: " name)
10762 (while plist
10763 (if (eq (car plist) :name)
10764 (setq plist (cddr plist))
10765 (insert " " (prin1-to-string (pop plist)))))
10767 (beginning-of-line -2)))
10769 (defun org-prepare-dblock ()
10770 "Prepare dynamic block for refresh.
10771 This empties the block, puts the cursor at the insert position and returns
10772 the property list including an extra property :name with the block name."
10773 (unless (looking-at org-dblock-start-re)
10774 (error "Not at a dynamic block"))
10775 (let* ((begdel (1+ (match-end 0)))
10776 (name (org-no-properties (match-string 1)))
10777 (params (append (list :name name)
10778 (read (concat "(" (match-string 3) ")")))))
10779 (save-excursion
10780 (beginning-of-line 1)
10782 (setq params (plist-put params :indentation-column (current-column))))
10783 (unless (re-search-forward org-dblock-end-re nil t)
10784 (error "Dynamic block not terminated"))
10785 (setq params
10786 (append params
10787 (list :content (buffer-substring
10788 begdel (match-beginning 0)))))
10789 (delete-region begdel (match-beginning 0))
10790 (goto-char begdel)
10791 (open-line 1)
10792 params))
10794 (defun org-map-dblocks (&optional command)
10795 "Apply COMMAND to all dynamic blocks in the current buffer.
10796 If COMMAND is not given, use `org-update-dblock'."
10797 (let ((cmd (or command 'org-update-dblock)))
10798 (save-excursion
10799 (goto-char (point-min))
10800 (while (re-search-forward org-dblock-start-re nil t)
10801 (goto-char (match-beginning 0))
10802 (save-excursion
10803 (condition-case nil
10804 (funcall cmd)
10805 (error (message "Error during update of dynamic block"))))
10806 (unless (re-search-forward org-dblock-end-re nil t)
10807 (error "Dynamic block not terminated"))))))
10809 (defun org-dblock-update (&optional arg)
10810 "User command for updating dynamic blocks.
10811 Update the dynamic block at point. With prefix ARG, update all dynamic
10812 blocks in the buffer."
10813 (interactive "P")
10814 (if arg
10815 (org-update-all-dblocks)
10816 (or (looking-at org-dblock-start-re)
10817 (org-beginning-of-dblock))
10818 (org-update-dblock)))
10820 (defun org-update-dblock ()
10821 "Update the dynamic block at point.
10822 This means to empty the block, parse for parameters and then call
10823 the correct writing function."
10824 (interactive)
10825 (save-window-excursion
10826 (let* ((pos (point))
10827 (line (org-current-line))
10828 (params (org-prepare-dblock))
10829 (name (plist-get params :name))
10830 (indent (plist-get params :indentation-column))
10831 (cmd (intern (concat "org-dblock-write:" name))))
10832 (message "Updating dynamic block `%s' at line %d..." name line)
10833 (funcall cmd params)
10834 (message "Updating dynamic block `%s' at line %d...done" name line)
10835 (goto-char pos)
10836 (when (and indent (> indent 0))
10837 (setq indent (make-string indent ?\ ))
10838 (save-excursion
10839 (org-beginning-of-dblock)
10840 (forward-line 1)
10841 (while (not (looking-at org-dblock-end-re))
10842 (insert indent)
10843 (beginning-of-line 2))
10844 (when (looking-at org-dblock-end-re)
10846 (replace-match ""))
10847 (insert indent)))))))
10849 (defun org-beginning-of-dblock ()
10850 "Find the beginning of the dynamic block at point.
10851 Error if there is no such block at point."
10852 (let ((pos (point))
10853 beg)
10854 (end-of-line 1)
10855 (if (and (re-search-backward org-dblock-start-re nil t)
10856 (setq beg (match-beginning 0))
10857 (re-search-forward org-dblock-end-re nil t)
10858 (> (match-end 0) pos))
10859 (goto-char beg)
10860 (goto-char pos)
10861 (error "Not in a dynamic block"))))
10863 (defun org-update-all-dblocks ()
10864 "Update all dynamic blocks in the buffer.
10865 This function can be used in a hook."
10866 (interactive)
10867 (when (org-mode-p)
10868 (org-map-dblocks 'org-update-dblock)))
10871 ;;;; Completion
10873 (defconst org-additional-option-like-keywords
10874 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10875 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10876 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10877 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10878 "BEGIN:" "END:"
10879 "ORGTBL" "TBLFM:" "TBLNAME:"
10880 "BEGIN_EXAMPLE" "END_EXAMPLE"
10881 "BEGIN_QUOTE" "END_QUOTE"
10882 "BEGIN_VERSE" "END_VERSE"
10883 "BEGIN_CENTER" "END_CENTER"
10884 "BEGIN_SRC" "END_SRC"
10885 "BEGIN_RESULT" "END_RESULT"
10886 "SOURCE:" "SRCNAME:" "FUNCTION:"
10887 "RESULTS:" "DATA:"
10888 "HEADER:" "HEADERS:"
10889 "BABEL:"
10890 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10891 "CAPTION:" "LABEL:"
10892 "SETUPFILE:"
10893 "INCLUDE:"
10894 "BIND:"
10895 "MACRO:"))
10897 (defcustom org-structure-template-alist
10898 '(
10911 ("L" "#+latex: "
10915 ("H" "#+html: "
10918 ("A" "#+ascii: ")
10919 ("i" "#+index: ?"
10920 "#+index: ?")
10921 ("I" "#+include %file ?"
10923 )
10924 "Structure completion elements.
10925 This is a list of abbreviation keys and values. The value gets inserted
10926 if you type `<' followed by the key and then press the completion key,
10927 usually `M-TAB'. %file will be replaced by a file name after prompting
10928 for the file using completion. The cursor will be placed at the position
10929 of the `?` in the template.
10930 There are two templates for each key, the first uses the original Org syntax,
10931 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10932 the default when the /org-mtags.el/ module has been loaded. See also the
10933 variable `org-mtags-prefer-muse-templates'.
10934 This is an experimental feature, it is undecided if it is going to stay in."
10935 :group 'org-completion
10936 :type '(repeat
10937 (string :tag "Key")
10938 (string :tag "Template")
10939 (string :tag "Muse Template")))
10941 (defun org-try-structure-completion ()
10942 "Try to complete a structure template before point.
10944 expands them."
10945 (let ((l (buffer-substring (point-at-bol) (point)))
10946 a)
10949 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10950 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10951 (match-beginning 1)) a)
10952 t)))
10954 (defun org-complete-expand-structure-template (start cell)
10955 "Expand a structure template."
10956 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10957 (rpl (nth (if musep 2 1) cell))
10958 (ind ""))
10959 (delete-region start (point))
10961 (cond
10962 ((bolp))
10964 (setq ind (buffer-substring (point-at-bol) (point))))
10965 (t (newline))))
10966 (setq start (point))
10967 (if (string-match "%file" rpl)
10968 (setq rpl (replace-match
10969 (concat
10971 (save-match-data
10972 (abbreviate-file-name (read-file-name "Include file: ")))
10974 t t rpl)))
10977 (insert rpl)
10980 ;;;; TODO, DEADLINE, Comments
10982 (defun org-toggle-comment ()
10983 "Change the COMMENT state of an entry."
10984 (interactive)
10985 (save-excursion
10986 (org-back-to-heading)
10987 (let (case-fold-search)
10988 (if (looking-at (concat org-outline-regexp
10990 (replace-match "" t t nil 1)
10991 (if (looking-at org-outline-regexp)
10992 (progn
10993 (goto-char (match-end 0))
10994 (insert org-comment-string " ")))))))
10996 (defvar org-last-todo-state-is-todo nil
10997 "This is non-nil when the last TODO state change led to a TODO state.
10998 If the last change removed the TODO tag or switched to DONE, then
10999 this is nil.")
11001 (defvar org-setting-tags nil) ; dynamically skipped
11003 (defvar org-todo-setup-filter-hook nil
11004 "Hook for functions that pre-filter todo specs.
11005 Each function takes a todo spec and returns either nil or the spec
11006 transformed into canonical form." )
11008 (defvar org-todo-get-default-hook nil
11009 "Hook for functions that get a default item for todo.
11010 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11011 nil or a string to be used for the todo mark." )
11013 (defvar org-agenda-headline-snapshot-before-repeat)
11015 (defun org-current-effective-time ()
11016 "Return current time adjusted for `org-extend-today-until' variable"
11017 (let* ((ct (org-current-time))
11018 (dct (decode-time ct))
11019 (ct1
11020 (if (and org-use-effective-time
11021 (< (nth 2 dct) org-extend-today-until))
11022 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11023 ct)))
11024 ct1))
11026 (defun org-todo-yesterday (&optional arg)
11027 "Like `org-todo' but the time of change will be 23:59 of yesterday"
11028 (interactive "P")
11029 (let* ((hour (third (decode-time
11030 (org-current-time))))
11031 (org-extend-today-until (1+ hour)))
11032 (org-todo arg)))
11034 (defun org-todo (&optional arg)
11035 "Change the TODO state of an item.
11036 The state of an item is given by a keyword at the start of the heading,
11037 like
11038 *** TODO Write paper
11039 *** DONE Call mom
11041 The different keywords are specified in the variable `org-todo-keywords'.
11043 So for this example: when the item starts with TODO, it is changed to DONE.
11044 When it starts with DONE, the DONE is removed. And when neither TODO nor
11045 DONE are present, add TODO at the beginning of the heading.
11048 state.
11049 With numeric prefix arg, switch to that state.
11051 keywords (nextset).
11054 For calling through lisp, arg is also interpreted in the following way:
11055 'none -> empty state
11057 'done -> switch to DONE
11058 'nextset -> switch to the next set of keywords
11059 'previousset -> switch to the previous set of keywords
11061 really is a member of `org-todo-keywords'."
11062 (interactive "P")
11063 (if (equal arg '(16)) (setq arg 'nextset))
11064 (let ((org-blocker-hook org-blocker-hook)
11065 (case-fold-search nil))
11066 (when (equal arg '(64))
11067 (setq arg nil org-blocker-hook nil))
11068 (when (and org-blocker-hook
11069 (or org-inhibit-blocking
11070 (org-entry-get nil "NOBLOCKING")))
11071 (setq org-blocker-hook nil))
11072 (save-excursion
11073 (catch 'exit
11074 (org-back-to-heading t)
11075 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11077 (looking-at " *"))
11078 (let* ((match-data (match-data))
11079 (startpos (point-at-bol))
11080 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11081 (org-log-done org-log-done)
11082 (org-log-repeat org-log-repeat)
11083 (org-todo-log-states org-todo-log-states)
11084 (this (match-string 1))
11085 (hl-pos (match-beginning 0))
11086 (head (org-get-todo-sequence-head this))
11087 (ass (assoc head org-todo-kwd-alist))
11088 (interpret (nth 1 ass))
11089 (done-word (nth 3 ass))
11090 (final-done-word (nth 4 ass))
11091 (last-state (or this ""))
11092 (completion-ignore-case t)
11093 (member (member this org-todo-keywords-1))
11094 (tail (cdr member))
11095 (state (cond
11096 ((and org-todo-key-trigger
11097 (or (and (equal arg '(4))
11098 (eq org-use-fast-todo-selection 'prefix))
11099 (and (not arg) org-use-fast-todo-selection
11100 (not (eq org-use-fast-todo-selection
11101 'prefix)))))
11102 ;; Use fast selection
11103 (org-fast-todo-selection))
11104 ((and (equal arg '(4))
11105 (or (not org-use-fast-todo-selection)
11106 (not org-todo-key-trigger)))
11107 ;; Read a state with completion
11108 (org-icompleting-read
11109 "State: " (mapcar (lambda(x) (list x))
11110 org-todo-keywords-1)
11111 nil t))
11112 ((eq arg 'right)
11113 (if this
11114 (if tail (car tail) nil)
11115 (car org-todo-keywords-1)))
11116 ((eq arg 'left)
11117 (if (equal member org-todo-keywords-1)
11118 nil
11119 (if this
11120 (nth (- (length org-todo-keywords-1)
11121 (length tail) 2)
11122 org-todo-keywords-1)
11123 (org-last org-todo-keywords-1))))
11124 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11125 (setq arg nil))) ; hack to fall back to cycling
11126 (arg
11127 ;; user or caller requests a specific state
11128 (cond
11129 ((equal arg "") nil)
11130 ((eq arg 'none) nil)
11131 ((eq arg 'done) (or done-word (car org-done-keywords)))
11132 ((eq arg 'nextset)
11133 (or (car (cdr (member head org-todo-heads)))
11134 (car org-todo-heads)))
11135 ((eq arg 'previousset)
11136 (let ((org-todo-heads (reverse org-todo-heads)))
11137 (or (car (cdr (member head org-todo-heads)))
11138 (car org-todo-heads))))
11139 ((car (member arg org-todo-keywords-1)))
11140 ((stringp arg)
11141 (error "State `%s' not valid in this file" arg))
11142 ((nth (1- (prefix-numeric-value arg))
11143 org-todo-keywords-1))))
11144 ((null member) (or head (car org-todo-keywords-1)))
11145 ((equal this final-done-word) nil) ;; -> make empty
11146 ((null tail) nil) ;; -> first entry
11147 ((memq interpret '(type priority))
11148 (if (eq this-command last-command)
11149 (car tail)
11150 (if (> (length tail) 0)
11151 (or done-word (car org-done-keywords))
11152 nil)))
11153 (t
11154 (car tail))))
11155 (state (or
11156 (run-hook-with-args-until-success
11157 'org-todo-get-default-hook state last-state)
11158 state))
11159 (next (if state (concat " " state " ") " "))
11160 (change-plist (list :type 'todo-state-change :from this :to state
11161 :position startpos))
11162 dolog now-done-p)
11163 (when org-blocker-hook
11164 (setq org-last-todo-state-is-todo
11165 (not (member this org-done-keywords)))
11166 (unless (save-excursion
11167 (save-match-data
11168 (org-with-wide-buffer
11169 (run-hook-with-args-until-failure
11170 'org-blocker-hook change-plist))))
11171 (if (org-called-interactively-p 'interactive)
11172 (error "TODO state change from %s to %s blocked" this state)
11173 ;; fail silently
11174 (message "TODO state change from %s to %s blocked" this state)
11175 (throw 'exit nil))))
11176 (store-match-data match-data)
11177 (replace-match next t t)
11178 (unless (pos-visible-in-window-p hl-pos)
11179 (message "TODO state changed to %s" (org-trim next)))
11180 (unless head
11181 (setq head (org-get-todo-sequence-head state)
11182 ass (assoc head org-todo-kwd-alist)
11183 interpret (nth 1 ass)
11184 done-word (nth 3 ass)
11185 final-done-word (nth 4 ass)))
11186 (when (memq arg '(nextset previousset))
11187 (message "Keyword-Set %d/%d: %s"
11188 (- (length org-todo-sets) -1
11189 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11190 (length org-todo-sets)
11191 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11192 (setq org-last-todo-state-is-todo
11193 (not (member state org-done-keywords)))
11194 (setq now-done-p (and (member state org-done-keywords)
11195 (not (member this org-done-keywords))))
11196 (and logging (org-local-logging logging))
11197 (when (and (or org-todo-log-states org-log-done)
11198 (not (eq org-inhibit-logging t))
11199 (not (memq arg '(nextset previousset))))
11200 ;; we need to look at recording a time and note
11201 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11202 (nth 2 (assoc this org-todo-log-states))))
11203 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11204 (setq dolog 'time))
11205 (when (and state
11206 (member state org-not-done-keywords)
11207 (not (member this org-not-done-keywords)))
11208 ;; This is now a todo state and was not one before
11209 ;; If there was a CLOSED time stamp, get rid of it.
11210 (org-add-planning-info nil nil 'closed))
11211 (when (and now-done-p org-log-done)
11212 ;; It is now done, and it was not done before
11213 (org-add-planning-info 'closed (org-current-effective-time))
11214 (if (and (not dolog) (eq 'note org-log-done))
11215 (org-add-log-setup 'done state this 'findpos 'note)))
11216 (when (and state dolog)
11217 ;; This is a non-nil state, and we need to log it
11218 (org-add-log-setup 'state state this 'findpos dolog)))
11219 ;; Fixup tag positioning
11220 (org-todo-trigger-tag-changes state)
11221 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11222 (when org-provide-todo-statistics
11223 (org-update-parent-todo-statistics))
11224 (run-hooks 'org-after-todo-state-change-hook)
11225 (if (and arg (not (member state org-done-keywords)))
11226 (setq head (org-get-todo-sequence-head state)))
11227 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11228 ;; Do we need to trigger a repeat?
11229 (when now-done-p
11230 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11231 ;; This is for the agenda, take a snapshot of the headline.
11232 (save-match-data
11233 (setq org-agenda-headline-snapshot-before-repeat
11234 (org-get-heading))))
11235 (org-auto-repeat-maybe state))
11236 ;; Fixup cursor location if close to the keyword
11237 (if (and (outline-on-heading-p)
11238 (not (bolp))
11239 (save-excursion (beginning-of-line 1)
11240 (looking-at org-todo-line-regexp))
11241 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11242 (progn
11243 (goto-char (or (match-end 2) (match-end 1)))
11244 (and (looking-at " ") (just-one-space))))
11245 (when org-trigger-hook
11246 (save-excursion
11247 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11249 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11250 "Block turning an entry into a TODO, using the hierarchy.
11251 This checks whether the current task should be blocked from state
11252 changes. Such blocking occurs when:
11254 1. The task has children which are not all in a completed state.
11256 2. A task has a parent with the property :ORDERED:, and there
11257 are siblings prior to the current task with incomplete
11258 status.
11260 3. The parent of the task is blocked because it has siblings that should
11261 be done first, or is child of a block grandparent TODO entry."
11263 (if (not org-enforce-todo-dependencies)
11264 t ; if locally turned off don't block
11265 (catch 'dont-block
11266 ;; If this is not a todo state change, or if this entry is already DONE,
11267 ;; do not block
11268 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11269 (member (plist-get change-plist :from)
11270 (cons 'done org-done-keywords))
11271 (member (plist-get change-plist :to)
11272 (cons 'todo org-not-done-keywords))
11273 (not (plist-get change-plist :to)))
11274 (throw 'dont-block t))
11275 ;; If this task has children, and any are undone, it's blocked
11276 (save-excursion
11277 (org-back-to-heading t)
11278 (let ((this-level (funcall outline-level)))
11279 (outline-next-heading)
11280 (let ((child-level (funcall outline-level)))
11281 (while (and (not (eobp))
11282 (> child-level this-level))
11283 ;; this todo has children, check whether they are all
11284 ;; completed
11285 (if (and (not (org-entry-is-done-p))
11286 (org-entry-is-todo-p))
11287 (throw 'dont-block nil))
11288 (outline-next-heading)
11289 (setq child-level (funcall outline-level))))))
11290 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11291 ;; any previous siblings are undone, it's blocked
11292 (save-excursion
11293 (org-back-to-heading t)
11294 (let* ((pos (point))
11295 (parent-pos (and (org-up-heading-safe) (point))))
11296 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11297 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11298 (forward-line 1)
11299 (re-search-forward org-not-done-heading-regexp pos t))
11300 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11301 ;; Search further up the hierarchy, to see if an anchestor is blocked
11302 (while t
11303 (goto-char parent-pos)
11304 (if (not (looking-at org-not-done-heading-regexp))
11305 (throw 'dont-block t)) ; do not block, parent is not a TODO
11306 (setq pos (point))
11307 (setq parent-pos (and (org-up-heading-safe) (point)))
11308 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11309 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11310 (forward-line 1)
11311 (re-search-forward org-not-done-heading-regexp pos t))
11312 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11314 (defcustom org-track-ordered-property-with-tag nil
11315 "Should the ORDERED property also be shown as a tag?
11316 The ORDERED property decides if an entry should require subtasks to be
11317 completed in sequence. Since a property is not very visible, setting
11318 this option means that toggling the ORDERED property with the command
11319 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11320 not relevant for the behavior, but it makes things more visible.
11322 Note that toggling the tag with tags commands will not change the property
11323 and therefore not influence behavior!
11325 This can be t, meaning the tag ORDERED should be used, It can also be a
11326 string to select a different tag for this task."
11327 :group 'org-todo
11328 :type '(choice
11329 (const :tag "No tracking" nil)
11330 (const :tag "Track with ORDERED tag" t)
11331 (string :tag "Use other tag")))
11333 (defun org-toggle-ordered-property ()
11334 "Toggle the ORDERED property of the current entry.
11335 For better visibility, you can track the value of this property with a tag.
11336 See variable `org-track-ordered-property-with-tag'."
11337 (interactive)
11338 (let* ((t1 org-track-ordered-property-with-tag)
11339 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11340 (save-excursion
11341 (org-back-to-heading)
11342 (if (org-entry-get nil "ORDERED")
11343 (progn
11344 (org-delete-property "ORDERED")
11345 (and tag (org-toggle-tag tag 'off))
11346 (message "Subtasks can be completed in arbitrary order"))
11347 (org-entry-put nil "ORDERED" "t")
11348 (and tag (org-toggle-tag tag 'on))
11349 (message "Subtasks must be completed in sequence")))))
11351 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11352 (defun org-block-todo-from-checkboxes (change-plist)
11353 "Block turning an entry into a TODO, using checkboxes.
11354 This checks whether the current task should be blocked from state
11355 changes because there are unchecked boxes in this entry."
11356 (if (not org-enforce-todo-checkbox-dependencies)
11357 t ; if locally turned off don't block
11358 (catch 'dont-block
11359 ;; If this is not a todo state change, or if this entry is already DONE,
11360 ;; do not block
11361 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11362 (member (plist-get change-plist :from)
11363 (cons 'done org-done-keywords))
11364 (member (plist-get change-plist :to)
11365 (cons 'todo org-not-done-keywords))
11366 (not (plist-get change-plist :to)))
11367 (throw 'dont-block t))
11368 ;; If this task has checkboxes that are not checked, it's blocked
11369 (save-excursion
11370 (org-back-to-heading t)
11371 (let ((beg (point)) end)
11372 (outline-next-heading)
11373 (setq end (point))
11374 (goto-char beg)
11376 end t)
11377 (progn
11378 (if (boundp 'org-blocked-by-checkboxes)
11379 (setq org-blocked-by-checkboxes t))
11380 (throw 'dont-block nil)))))
11381 t))) ; do not block
11383 (defun org-entry-blocked-p ()
11384 "Is the current entry blocked?"
11385 (if (org-entry-get nil "NOBLOCKING")
11386 nil ;; Never block this entry
11387 (not
11388 (run-hook-with-args-until-failure
11389 'org-blocker-hook
11390 (list :type 'todo-state-change
11391 :position (point)
11392 :from 'todo
11393 :to 'done)))))
11395 (defun org-update-statistics-cookies (all)
11396 "Update the statistics cookie, either from TODO or from checkboxes.
11397 This should be called with the cursor in a line with a statistics cookie."
11398 (interactive "P")
11399 (if all
11400 (progn
11401 (org-update-checkbox-count 'all)
11402 (org-map-entries 'org-update-parent-todo-statistics))
11403 (if (not (org-on-heading-p))
11404 (org-update-checkbox-count)
11405 (let ((pos (move-marker (make-marker) (point)))
11406 end l1 l2)
11407 (ignore-errors (org-back-to-heading t))
11408 (if (not (org-on-heading-p))
11409 (org-update-checkbox-count)
11410 (setq l1 (org-outline-level))
11411 (setq end (save-excursion
11412 (outline-next-heading)
11413 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11414 (point)))
11415 (if (and (save-excursion
11416 (re-search-forward
11418 (not (save-excursion (re-search-forward
11420 (org-update-checkbox-count)
11421 (if (and l2 (> l2 l1))
11422 (progn
11423 (goto-char end)
11424 (org-update-parent-todo-statistics))
11425 (goto-char pos)
11426 (beginning-of-line 1)
11427 (while (re-search-forward
11429 (point-at-eol) t)
11430 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11431 (goto-char pos)
11432 (move-marker pos nil)))))
11434 (defvar org-entry-property-inherited-from) ;; defined below
11435 (defun org-update-parent-todo-statistics ()
11436 "Update any statistics cookie in the parent of the current headline.
11437 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11438 the entire subtree and this will travel up the hierarchy and update
11439 statistics everywhere."
11440 (let* ((prop (save-excursion (org-up-heading-safe)
11441 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11442 (recursive (or (not org-hierarchical-todo-statistics)
11444 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11445 0))
11446 (first t)
11448 level ltoggle l1 new ndel
11449 (cnt-all 0) (cnt-done 0) is-percent kwd
11450 checkbox-beg ov ovs ove cookie-present)
11451 (catch 'exit
11452 (save-excursion
11453 (beginning-of-line 1)
11454 (setq ltoggle (funcall outline-level))
11455 ;; Three situations are to consider:
11457 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11458 ;; to the top-level ancestor on the headline;
11460 ;; 2. If parent has "recursive" property, repeat up to the
11461 ;; headline setting that property, taking inheritance into
11462 ;; account;
11464 ;; 3. Else, move up to direct parent and proceed only once.
11465 (while (and (setq level (org-up-heading-safe))
11466 (or recursive first)
11467 (>= (point) lim))
11468 (setq first nil cookie-present nil)
11469 (unless (and level
11470 (not (string-match
11472 (downcase (or (org-entry-get nil "COOKIE_DATA")
11473 "")))))
11474 (throw 'exit nil))
11475 (while (re-search-forward box-re (point-at-eol) t)
11476 (setq cnt-all 0 cnt-done 0 cookie-present t)
11477 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11478 (save-match-data
11479 (unless (outline-next-heading) (throw 'exit nil))
11480 (while (and (looking-at org-complex-heading-regexp)
11481 (> (setq l1 (length (match-string 1))) level))
11482 (setq kwd (and (or recursive (= l1 ltoggle))
11483 (match-string 2)))
11484 (if (or (eq org-provide-todo-statistics 'all-headlines)
11485 (and (listp org-provide-todo-statistics)
11486 (or (member kwd org-provide-todo-statistics)
11487 (member kwd org-done-keywords))))
11488 (setq cnt-all (1+ cnt-all))
11489 (if (eq org-provide-todo-statistics t)
11490 (and kwd (setq cnt-all (1+ cnt-all)))))
11491 (and (member kwd org-done-keywords)
11492 (setq cnt-done (1+ cnt-done)))
11493 (outline-next-heading)))
11494 (setq new
11495 (if is-percent
11496 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11497 (format "[%d/%d]" cnt-done cnt-all))
11498 ndel (- (match-end 0) checkbox-beg))
11499 ;; handle overlays when updating cookie from column view
11500 (when (setq ov (car (overlays-at checkbox-beg)))
11501 (setq ovs (overlay-start ov) ove (overlay-end ov))
11502 (delete-overlay ov))
11503 (goto-char checkbox-beg)
11504 (insert new)
11505 (delete-region (point) (+ (point) ndel))
11506 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11507 (when ov (move-overlay ov ovs ove)))
11508 (when cookie-present
11509 (run-hook-with-args 'org-after-todo-statistics-hook
11510 cnt-done (- cnt-all cnt-done))))))
11511 (run-hooks 'org-todo-statistics-hook)))
11513 (defvar org-after-todo-statistics-hook nil
11514 "Hook that is called after a TODO statistics cookie has been updated.
11515 Each function is called with two arguments: the number of not-done entries
11516 and the number of done entries.
11518 For example, the following function, when added to this hook, will switch
11519 an entry to DONE when all children are done, and back to TODO when new
11520 entries are set to a TODO status. Note that this hook is only called
11521 when there is a statistics cookie in the headline!
11523 (defun org-summary-todo (n-done n-not-done)
11525 (let (org-log-done org-log-states) ; turn off logging
11527 ")
11529 (defvar org-todo-statistics-hook nil
11530 "Hook that is run whenever Org thinks TODO statistics should be updated.
11531 This hook runs even if there is no statistics cookie present, in which case
11532 `org-after-todo-statistics-hook' would not run.")
11534 (defun org-todo-trigger-tag-changes (state)
11535 "Apply the changes defined in `org-todo-state-tags-triggers'."
11536 (let ((l org-todo-state-tags-triggers)
11537 changes)
11538 (when (or (not state) (equal state ""))
11539 (setq changes (append changes (cdr (assoc "" l)))))
11540 (when (and (stringp state) (> (length state) 0))
11541 (setq changes (append changes (cdr (assoc state l)))))
11542 (when (member state org-not-done-keywords)
11543 (setq changes (append changes (cdr (assoc 'todo l)))))
11544 (when (member state org-done-keywords)
11545 (setq changes (append changes (cdr (assoc 'done l)))))
11546 (dolist (c changes)
11547 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11549 (defun org-local-logging (value)
11550 "Get logging settings from a property VALUE."
11551 (let* (words w a)
11552 ;; directly set the variables, they are already local.
11553 (setq org-log-done nil
11554 org-log-repeat nil
11555 org-todo-log-states nil)
11556 (setq words (org-split-string value))
11557 (while (setq w (pop words))
11558 (cond
11559 ((setq a (assoc w org-startup-options))
11560 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11561 (set (nth 1 a) (nth 2 a))))
11562 ((setq a (org-extract-log-state-settings w))
11563 (and (member (car a) org-todo-keywords-1)
11564 (push a org-todo-log-states)))))))
11566 (defun org-get-todo-sequence-head (kwd)
11567 "Return the head of the TODO sequence to which KWD belongs.
11568 If KWD is not set, check if there is a text property remembering the
11569 right sequence."
11570 (let (p)
11571 (cond
11572 ((not kwd)
11573 (or (get-text-property (point-at-bol) 'org-todo-head)
11574 (progn
11575 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11576 nil (point-at-eol)))
11577 (get-text-property p 'org-todo-head))))
11578 ((not (member kwd org-todo-keywords-1))
11579 (car org-todo-keywords-1))
11580 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11582 (defun org-fast-todo-selection ()
11583 "Fast TODO keyword selection with single keys.
11584 Returns the new TODO keyword, or nil if no state change should occur."
11585 (let* ((fulltable org-todo-key-alist)
11586 (done-keywords org-done-keywords) ;; needed for the faces.
11587 (maxlen (apply 'max (mapcar
11588 (lambda (x)
11589 (if (stringp (car x)) (string-width (car x)) 0))
11590 fulltable)))
11591 (expert nil)
11592 (fwidth (+ maxlen 3 1 3))
11593 (ncol (/ (- (window-width) 4) fwidth))
11594 tg cnt e c tbl
11595 groups ingroup)
11596 (save-excursion
11597 (save-window-excursion
11598 (if expert
11599 (set-buffer (get-buffer-create " *Org todo*"))
11600 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11601 (erase-buffer)
11602 (org-set-local 'org-done-keywords done-keywords)
11603 (setq tbl fulltable cnt 0)
11604 (while (setq e (pop tbl))
11605 (cond
11606 ((equal e '(:startgroup))
11607 (push '() groups) (setq ingroup t)
11608 (when (not (= cnt 0))
11609 (setq cnt 0)
11611 (insert "{ "))
11612 ((equal e '(:endgroup))
11613 (setq ingroup nil cnt 0)
11615 ((equal e '(:newline))
11616 (when (not (= cnt 0))
11617 (setq cnt 0)
11619 (setq e (car tbl))
11620 (while (equal (car tbl) '(:newline))
11622 (setq tbl (cdr tbl)))))
11623 (t
11624 (setq tg (car e) c (cdr e))
11625 (if ingroup (push tg (car groups)))
11626 (setq tg (org-add-props tg nil 'face
11627 (org-get-todo-face tg)))
11628 (if (and (= cnt 0) (not ingroup)) (insert " "))
11629 (insert "[" c "] " tg (make-string
11630 (- fwidth 4 (length tg)) ?\ ))
11631 (when (= (setq cnt (1+ cnt)) ncol)
11633 (if ingroup (insert " "))
11634 (setq cnt 0)))))
11636 (goto-char (point-min))
11637 (if (not expert) (org-fit-window-to-buffer))
11638 (message "[a-z..]:Set [SPC]:clear")
11639 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11640 (cond
11641 ((or (= c ?\C-g)
11642 (and (= c ?q) (not (rassoc c fulltable))))
11643 (setq quit-flag t))
11644 ((= c ?\ ) nil)
11645 ((setq e (rassoc c fulltable) tg (car e))
11646 tg)
11647 (t (setq quit-flag t)))))))
11649 (defun org-entry-is-todo-p ()
11650 (member (org-get-todo-state) org-not-done-keywords))
11652 (defun org-entry-is-done-p ()
11653 (member (org-get-todo-state) org-done-keywords))
11655 (defun org-get-todo-state ()
11656 (save-excursion
11657 (org-back-to-heading t)
11658 (and (looking-at org-todo-line-regexp)
11659 (match-end 2)
11660 (match-string 2))))
11662 (defun org-at-date-range-p (&optional inactive-ok)
11663 "Is the cursor inside a date range?"
11664 (interactive)
11665 (save-excursion
11666 (catch 'exit
11667 (let ((pos (point)))
11669 (skip-chars-backward "<[")
11670 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11671 (>= (match-end 0) pos)
11672 (throw 'exit t))
11674 (skip-chars-backward "<[")
11675 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11676 (>= (match-end 0) pos)
11677 (throw 'exit t)))
11678 nil)))
11680 (defun org-get-repeat (&optional tagline)
11681 "Check if there is a deadline/schedule with repeater in this entry."
11682 (save-match-data
11683 (save-excursion
11684 (org-back-to-heading t)
11685 (and (re-search-forward (if tagline
11687 org-repeat-re)
11688 (org-entry-end-position) t)
11689 (match-string-no-properties 1)))))
11691 (defvar org-last-changed-timestamp)
11692 (defvar org-last-inserted-timestamp)
11693 (defvar org-log-post-message)
11694 (defvar org-log-note-purpose)
11695 (defvar org-log-note-how)
11696 (defvar org-log-note-extra)
11697 (defun org-auto-repeat-maybe (done-word)
11698 "Check if the current headline contains a repeated deadline/schedule.
11699 If yes, set TODO state back to what it was and change the base date
11700 of repeating deadline/scheduled time stamps to new date.
11701 This function is run automatically after each state change to a DONE state."
11702 ;; last-state is dynamically scoped into this function
11703 (let* ((repeat (org-get-repeat))
11704 (aa (assoc last-state org-todo-kwd-alist))
11705 (interpret (nth 1 aa))
11706 (head (nth 2 aa))
11707 (whata '(("d" . day) ("m" . month) ("y" . year)))
11708 (msg "Entry repeats: ")
11709 (org-log-done nil)
11710 (org-todo-log-states nil)
11711 re type n what ts time to-state)
11712 (when repeat
11713 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11714 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11715 org-todo-repeat-to-state))
11716 (unless (and to-state (member to-state org-todo-keywords-1))
11717 (setq to-state (if (eq interpret 'type) last-state head)))
11718 (org-todo to-state)
11719 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11720 (org-entry-put nil "LAST_REPEAT" (format-time-string
11721 (org-time-stamp-format t t))))
11722 (when org-log-repeat
11723 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11724 (memq 'org-add-log-note post-command-hook))
11725 ;; OK, we are already setup for some record
11726 (if (eq org-log-repeat 'note)
11727 ;; make sure we take a note, not only a time stamp
11728 (setq org-log-note-how 'note))
11729 ;; Set up for taking a record
11730 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11731 last-state
11732 'findpos org-log-repeat)))
11733 (org-back-to-heading t)
11734 (org-add-planning-info nil nil 'closed)
11738 (while (re-search-forward
11739 re (save-excursion (outline-next-heading) (point)) t)
11740 (setq type (if (match-end 1) org-scheduled-string
11741 (if (match-end 3) org-deadline-string "Plain:"))
11742 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11744 (setq n (string-to-number (match-string 2 ts))
11745 what (match-string 3 ts))
11746 (if (equal what "w") (setq n (* n 7) what "d"))
11747 ;; Preparation, see if we need to modify the start date for the change
11748 (when (match-end 1)
11749 (setq time (save-match-data (org-time-string-to-time ts)))
11750 (cond
11751 ((equal (match-string 1 ts) ".")
11752 ;; Shift starting date to today
11753 (org-timestamp-change
11754 (- (org-today) (time-to-days time))
11755 'day))
11756 ((equal (match-string 1 ts) "+")
11757 (let ((nshiftmax 10) (nshift 0))
11758 (while (or (= nshift 0)
11759 (<= (time-to-days time)
11760 (time-to-days (current-time))))
11761 (when (= (incf nshift) nshiftmax)
11762 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11763 (error "Abort")))
11764 (org-timestamp-change n (cdr (assoc what whata)))
11765 (org-at-timestamp-p t)
11766 (setq ts (match-string 1))
11767 (setq time (save-match-data (org-time-string-to-time ts)))))
11768 (org-timestamp-change (- n) (cdr (assoc what whata)))
11769 ;; rematch, so that we have everything in place for the real shift
11770 (org-at-timestamp-p t)
11771 (setq ts (match-string 1))
11773 (org-timestamp-change n (cdr (assoc what whata)))
11774 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11775 (setq org-log-post-message msg)
11776 (message "%s" msg))))
11778 (defun org-show-todo-tree (arg)
11779 "Make a compact tree which shows all headlines marked with TODO.
11780 The tree will show the lines where the regexp matches, and all higher
11781 headlines above the match.
11783 With a numeric prefix N, construct a sparse tree for the Nth element
11784 of `org-todo-keywords-1'."
11785 (interactive "P")
11786 (let ((case-fold-search nil)
11787 (kwd-re
11788 (cond ((null arg) org-not-done-regexp)
11789 ((equal arg '(4))
11790 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11791 (mapcar 'list org-todo-keywords-1))))
11795 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11796 (regexp-quote (nth (1- (prefix-numeric-value arg))
11797 org-todo-keywords-1)))
11798 (t (error "Invalid prefix argument: %s" arg)))))
11799 (message "%d TODO entries found"
11800 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11802 (defun org-deadline (&optional remove time)
11804 With argument REMOVE, remove any deadline from the item.
11805 With argument TIME, set the deadline at the corresponding date. TIME
11807 (interactive "P")
11808 (let* ((old-date (org-entry-get nil "DEADLINE"))
11809 (repeater (and old-date
11810 (string-match
11812 old-date)
11813 (match-string 1 old-date))))
11814 (if remove
11815 (progn
11816 (when (and old-date org-log-redeadline)
11817 (org-add-log-setup 'deldeadline nil old-date 'findpos
11818 org-log-redeadline))
11819 (org-remove-timestamp-with-keyword org-deadline-string)
11820 (message "Item no longer has a deadline."))
11821 (org-add-planning-info 'deadline time 'closed)
11822 (when (and old-date org-log-redeadline
11823 (not (equal old-date
11824 (substring org-last-inserted-timestamp 1 -1))))
11825 (org-add-log-setup 'redeadline nil old-date 'findpos
11826 org-log-redeadline))
11827 (when repeater
11828 (save-excursion
11829 (org-back-to-heading t)
11830 (when (re-search-forward (concat org-deadline-string " "
11831 org-last-inserted-timestamp)
11832 (save-excursion
11833 (outline-next-heading) (point)) t)
11834 (goto-char (1- (match-end 0)))
11835 (insert " " repeater)
11836 (setq org-last-inserted-timestamp
11837 (concat (substring org-last-inserted-timestamp 0 -1)
11838 " " repeater
11839 (substring org-last-inserted-timestamp -1))))))
11840 (message "Deadline on %s" org-last-inserted-timestamp))))
11842 (defun org-schedule (&optional remove time)
11843 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11844 With argument REMOVE, remove any scheduling date from the item.
11845 With argument TIME, scheduled at the corresponding date. TIME can
11847 (interactive "P")
11848 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11849 (repeater (and old-date
11850 (string-match
11852 old-date)
11853 (match-string 1 old-date))))
11854 (if remove
11855 (progn
11856 (when (and old-date org-log-reschedule)
11857 (org-add-log-setup 'delschedule nil old-date 'findpos
11858 org-log-reschedule))
11859 (org-remove-timestamp-with-keyword org-scheduled-string)
11860 (message "Item is no longer scheduled."))
11861 (org-add-planning-info 'scheduled time 'closed)
11862 (when (and old-date org-log-reschedule
11863 (not (equal old-date
11864 (substring org-last-inserted-timestamp 1 -1))))
11865 (org-add-log-setup 'reschedule nil old-date 'findpos
11866 org-log-reschedule))
11867 (when repeater
11868 (save-excursion
11869 (org-back-to-heading t)
11870 (when (re-search-forward (concat org-scheduled-string " "
11871 org-last-inserted-timestamp)
11872 (save-excursion
11873 (outline-next-heading) (point)) t)
11874 (goto-char (1- (match-end 0)))
11875 (insert " " repeater)
11876 (setq org-last-inserted-timestamp
11877 (concat (substring org-last-inserted-timestamp 0 -1)
11878 " " repeater
11879 (substring org-last-inserted-timestamp -1))))))
11880 (message "Scheduled to %s" org-last-inserted-timestamp))))
11882 (defun org-get-scheduled-time (pom &optional inherit)
11883 "Get the scheduled time as a time tuple, of a format suitable
11884 for calling org-schedule with, or if there is no scheduling,
11885 returns nil."
11886 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11887 (when time
11888 (apply 'encode-time (org-parse-time-string time)))))
11890 (defun org-get-deadline-time (pom &optional inherit)
11891 "Get the deadline as a time tuple, of a format suitable for
11892 calling org-deadline with, or if there is no scheduling, returns
11893 nil."
11894 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11895 (when time
11896 (apply 'encode-time (org-parse-time-string time)))))
11898 (defun org-remove-timestamp-with-keyword (keyword)
11899 "Remove all time stamps with KEYWORD in the current entry."
11901 beg)
11902 (save-excursion
11903 (org-back-to-heading t)
11904 (setq beg (point))
11905 (outline-next-heading)
11906 (while (re-search-backward re beg t)
11907 (replace-match "")
11909 (equal (char-before) ?\ ))
11910 (backward-delete-char 1)
11912 (point-at-bol) (point-at-eol)))
11913 (delete-region (point-at-bol)
11914 (min (point-max) (1+ (point-at-eol))))))))))
11916 (defun org-add-planning-info (what &optional time &rest remove)
11917 "Insert new timestamp with keyword in the line directly after the headline.
11918 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11919 If non is given, the user is prompted for a date.
11920 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11921 be removed."
11922 (interactive)
11923 (let (org-time-was-given org-end-time-was-given ts
11924 end default-time default-input)
11926 (catch 'exit
11927 (when (and (memq what '(scheduled deadline))
11928 (or (not time)
11929 (and (stringp time)
11930 (string-match "^[-+]+[0-9]" time))))
11931 ;; Try to get a default date/time from existing timestamp
11932 (save-excursion
11933 (org-back-to-heading t)
11934 (setq end (save-excursion (outline-next-heading) (point)))
11935 (when (re-search-forward (if (eq what 'scheduled)
11936 org-scheduled-time-regexp
11937 org-deadline-time-regexp)
11938 end t)
11939 (setq ts (match-string 1)
11940 default-time
11941 (apply 'encode-time (org-parse-time-string ts))
11942 default-input (and ts (org-get-compact-tod ts))))))
11943 (when what
11944 (setq time
11945 (if (and (stringp time)
11946 (string-match "^[-+]+[0-9]" time))
11947 ;; This is a relative time, set the proper date
11948 (apply 'encode-time
11949 (org-read-date-analyze
11950 time default-time (decode-time default-time)))
11951 ;; If necessary, get the time from the user
11952 (or time (org-read-date nil 'to-time nil nil
11953 default-time default-input)))))
11955 (when (and org-insert-labeled-timestamps-at-point
11956 (member what '(scheduled deadline)))
11957 (insert
11958 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11959 (org-insert-time-stamp time org-time-was-given
11960 nil nil nil (list org-end-time-was-given))
11961 (setq what nil))
11962 (save-excursion
11963 (save-restriction
11964 (let (col list elt ts buffer-invisibility-spec)
11965 (org-back-to-heading t)
11967 (goto-char (match-end 1))
11968 (setq col (current-column))
11969 (goto-char (match-end 0))
11971 (when (and (not what)
11972 (not (looking-at
11974 org-keyword-time-not-clock-regexp))))
11975 ;; Nothing to add, nothing to remove...... :-)
11976 (throw 'exit nil))
11977 (if (and (not (looking-at org-outline-regexp))
11980 (not (equal (match-string 1) org-clock-string)))
11981 (narrow-to-region (match-beginning 0) (match-end 0))
11983 (backward-char 1)
11984 (narrow-to-region (point) (point))
11985 (and org-adapt-indentation (org-indent-to-column col)))
11986 ;; Check if we have to remove something.
11987 (setq list (cons what remove))
11988 (while list
11989 (setq elt (pop list))
11990 (when (or (and (eq elt 'scheduled)
11991 (re-search-forward org-scheduled-time-regexp nil t))
11992 (and (eq elt 'deadline)
11993 (re-search-forward org-deadline-time-regexp nil t))
11994 (and (eq elt 'closed)
11995 (re-search-forward org-closed-time-regexp nil t)))
11996 (replace-match "")
11997 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11999 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12000 (when what
12001 (insert
12002 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12003 (cond ((eq what 'scheduled) org-scheduled-string)
12004 ((eq what 'deadline) org-deadline-string)
12005 ((eq what 'closed) org-closed-string))
12006 " ")
12007 (setq ts (org-insert-time-stamp
12008 time
12009 (or org-time-was-given
12010 (and (eq what 'closed) org-log-done-with-time))
12011 (eq what 'closed)
12012 nil nil (list org-end-time-was-given)))
12013 (insert
12014 (if (not (or (bolp) (eq (char-before) ?\ )
12015 (memq (char-after) '(32 10))
12016 (eobp))) " " ""))
12017 (end-of-line 1))
12018 (goto-char (point-min))
12019 (widen)
12022 (delete-region (1- (point)) (point-at-eol)))
12023 ts))))))
12025 (defvar org-log-note-marker (make-marker))
12026 (defvar org-log-note-purpose nil)
12027 (defvar org-log-note-state nil)
12028 (defvar org-log-note-previous-state nil)
12029 (defvar org-log-note-how nil)
12030 (defvar org-log-note-extra nil)
12031 (defvar org-log-note-window-configuration nil)
12032 (defvar org-log-note-return-to (make-marker))
12033 (defvar org-log-note-effective-time nil
12034 "Remembered current time so that dynamically scoped
12035 `org-extend-today-until' affects tha timestamps in state change
12036 log")
12038 (defvar org-log-post-message nil
12039 "Message to be displayed after a log note has been stored.
12040 The auto-repeater uses this.")
12042 (defun org-add-note ()
12043 "Add a note to the current entry.
12044 This is done in the same way as adding a state change note."
12045 (interactive)
12046 (org-add-log-setup 'note nil nil 'findpos nil))
12048 (defvar org-property-end-re)
12049 (defun org-add-log-setup (&optional purpose state prev-state
12050 findpos how extra)
12051 "Set up the post command hook to take a note.
12052 If this is about to TODO state change, the new state is expected in STATE.
12053 When FINDPOS is non-nil, find the correct position for the note in
12054 the current entry. If not, assume that it can be inserted at point.
12055 HOW is an indicator what kind of note should be created.
12056 EXTRA is additional text that will be inserted into the notes buffer."
12057 (let* ((org-log-into-drawer (org-log-into-drawer))
12058 (drawer (cond ((stringp org-log-into-drawer)
12059 org-log-into-drawer)
12060 (org-log-into-drawer "LOGBOOK")
12061 (t nil))))
12062 (save-restriction
12063 (save-excursion
12064 (when findpos
12065 (org-back-to-heading t)
12066 (narrow-to-region (point) (save-excursion
12067 (outline-next-heading) (point)))
12071 (goto-char (match-end 0))
12072 (cond
12073 (drawer
12075 nil t)
12076 (progn
12077 (goto-char (match-end 0))
12078 (or org-log-states-order-reversed
12079 (and (re-search-forward org-property-end-re nil t)
12080 (goto-char (1- (match-beginning 0))))))
12082 (beginning-of-line 0)
12083 (org-indent-line-function)
12084 (beginning-of-line 2)
12085 (org-indent-line-function)
12086 (end-of-line 0)))
12087 ((and org-log-state-notes-insert-after-drawers
12088 (save-excursion
12089 (forward-line) (looking-at org-drawer-regexp)))
12090 (forward-line)
12091 (while (looking-at org-drawer-regexp)
12092 (goto-char (match-end 0))
12093 (re-search-forward org-property-end-re (point-max) t)
12094 (forward-line))
12095 (forward-line -1)))
12096 (unless org-log-states-order-reversed
12098 (org-skip-over-state-notes)
12100 (move-marker org-log-note-marker (point))
12101 (setq org-log-note-purpose purpose
12102 org-log-note-state state
12103 org-log-note-previous-state prev-state
12104 org-log-note-how how
12105 org-log-note-extra extra
12106 org-log-note-effective-time (org-current-effective-time))
12107 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12109 (defun org-skip-over-state-notes ()
12110 "Skip past the list of State notes in an entry."
12112 (when (ignore-errors (goto-char (org-in-item-p)))
12113 (let* ((struct (org-list-struct))
12114 (prevs (org-list-prevs-alist struct)))
12116 (goto-char (or (org-list-get-next-item (point) struct prevs)
12117 (org-list-get-item-end (point) struct)))))))
12119 (defun org-add-log-note (&optional purpose)
12120 "Pop up a window for taking a note, and add this note later at point."
12121 (remove-hook 'post-command-hook 'org-add-log-note)
12122 (setq org-log-note-window-configuration (current-window-configuration))
12123 (delete-other-windows)
12124 (move-marker org-log-note-return-to (point))
12125 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12126 (goto-char org-log-note-marker)
12127 (org-switch-to-buffer-other-window "*Org Note*")
12128 (erase-buffer)
12129 (if (memq org-log-note-how '(time state))
12130 (let (current-prefix-arg) (org-store-log-note))
12131 (let ((org-inhibit-startup t)) (org-mode))
12132 (insert (format "# Insert note for %s.
12134 (cond
12135 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12136 ((eq org-log-note-purpose 'done) "closed todo item")
12137 ((eq org-log-note-purpose 'state)
12139 (or org-log-note-previous-state "")
12140 (or org-log-note-state "")))
12141 ((eq org-log-note-purpose 'reschedule)
12142 "rescheduling")
12143 ((eq org-log-note-purpose 'delschedule)
12144 "no longer scheduled")
12145 ((eq org-log-note-purpose 'redeadline)
12146 "changing deadline")
12147 ((eq org-log-note-purpose 'deldeadline)
12148 "removing deadline")
12149 ((eq org-log-note-purpose 'refile)
12150 "refiling")
12151 ((eq org-log-note-purpose 'note)
12152 "this entry")
12153 (t (error "This should not happen")))))
12154 (if org-log-note-extra (insert org-log-note-extra))
12155 (org-set-local 'org-finish-function 'org-store-log-note)
12156 (run-hooks 'org-log-buffer-setup-hook)))
12158 (defvar org-note-abort nil) ; dynamically scoped
12159 (defun org-store-log-note ()
12160 "Finish taking a log note, and insert it to where it belongs."
12161 (let ((txt (buffer-string))
12162 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12163 lines ind bul)
12164 (kill-buffer (current-buffer))
12166 (setq txt (replace-match "" t t txt)))
12168 (setq txt (replace-match "" t t txt)))
12171 (setq note
12172 (org-replace-escapes
12173 note
12174 (list (cons "%u" (user-login-name))
12175 (cons "%U" user-full-name)
12176 (cons "%t" (format-time-string
12177 (org-time-stamp-format 'long 'inactive)
12178 org-log-note-effective-time))
12179 (cons "%T" (format-time-string
12180 (org-time-stamp-format 'long nil)
12181 org-log-note-effective-time))
12182 (cons "%s" (if org-log-note-state
12184 ""))
12185 (cons "%S" (if org-log-note-previous-state
12189 (push note lines))
12190 (when (or current-prefix-arg org-note-abort)
12191 (when org-log-into-drawer
12192 (org-remove-empty-drawer-at
12193 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12194 org-log-note-marker))
12195 (setq lines nil))
12196 (when lines
12197 (with-current-buffer (marker-buffer org-log-note-marker)
12198 (save-excursion
12199 (goto-char org-log-note-marker)
12200 (move-marker org-log-note-marker nil)
12201 (end-of-line 1)
12203 (setq ind (save-excursion
12204 (if (ignore-errors (goto-char (org-in-item-p)))
12205 (let ((struct (org-list-struct)))
12206 (org-list-get-ind
12207 (org-list-get-top-point struct) struct))
12209 (cond
12210 ((and (org-at-heading-p)
12211 org-adapt-indentation)
12212 (1+ (org-current-level)))
12213 ((org-at-heading-p) 0)
12214 (t (org-get-indentation))))))
12215 (setq bul (org-list-bullet-string "-"))
12216 (org-indent-line-to ind)
12217 (insert bul (pop lines))
12218 (let ((ind-body (+ (length bul) ind)))
12219 (while lines
12221 (org-indent-line-to ind-body)
12222 (insert (pop lines))))
12223 (message "Note stored")
12224 (org-back-to-heading t)
12225 (org-cycle-hide-drawers 'children)))))
12226 (set-window-configuration org-log-note-window-configuration)
12227 (with-current-buffer (marker-buffer org-log-note-return-to)
12228 (goto-char org-log-note-return-to))
12229 (move-marker org-log-note-return-to nil)
12230 (and org-log-post-message (message "%s" org-log-post-message)))
12232 (defun org-remove-empty-drawer-at (drawer pos)
12233 "Remove an empty drawer DRAWER at position POS.
12234 POS may also be a marker."
12235 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12236 (save-excursion
12237 (save-restriction
12238 (widen)
12239 (goto-char pos)
12240 (if (org-in-regexp
12242 (replace-match ""))))))
12244 (defun org-sparse-tree (&optional arg)
12245 "Create a sparse tree, prompt for the details.
12246 This command can create sparse trees. You first need to select the type
12247 of match used to create the tree:
12249 t Show all TODO entries.
12250 T Show entries with a specific TODO keyword.
12251 m Show entries selected by a tags/property match.
12252 p Enter a property name and its value (both with completion on existing
12253 names/values) and show entries with that property.
12254 r Show entries matching a regular expression (`/' can be used as well)
12255 d Show deadlines due within `org-deadline-warning-days'.
12256 b Show deadlines and scheduled items before a date.
12257 a Show deadlines and scheduled items after a date."
12258 (interactive "P")
12259 (let (ans kwd value)
12260 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12261 (setq ans (read-char-exclusive))
12262 (cond
12263 ((equal ans ?d)
12264 (call-interactively 'org-check-deadlines))
12265 ((equal ans ?b)
12266 (call-interactively 'org-check-before-date))
12267 ((equal ans ?a)
12268 (call-interactively 'org-check-after-date))
12269 ((equal ans ?t)
12270 (org-show-todo-tree nil))
12271 ((equal ans ?T)
12272 (org-show-todo-tree '(4)))
12273 ((member ans '(?T ?m))
12274 (call-interactively 'org-match-sparse-tree))
12275 ((member ans '(?p ?P))
12276 (setq kwd (org-icompleting-read "Property: "
12277 (mapcar 'list (org-buffer-property-keys))))
12278 (setq value (org-icompleting-read "Value: "
12279 (mapcar 'list (org-property-values kwd))))
12282 (org-match-sparse-tree arg (concat kwd "=" value)))
12283 ((member ans '(?r ?R ?/))
12284 (call-interactively 'org-occur))
12287 (defvar org-occur-highlights nil
12288 "List of overlays used for occur matches.")
12289 (make-variable-buffer-local 'org-occur-highlights)
12290 (defvar org-occur-parameters nil
12291 "Parameters of the active org-occur calls.
12292 This is a list, each call to org-occur pushes as cons cell,
12293 containing the regular expression and the callback, onto the list.
12294 The list can contain several entries if `org-occur' has been called
12295 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12296 will only contain one set of parameters. When the highlights are
12297 removed (for example with `C-c C-c', or with the next edit (depending
12298 on `org-remove-highlights-with-change'), this variable is emptied
12299 as well.")
12300 (make-variable-buffer-local 'org-occur-parameters)
12302 (defun org-occur (regexp &optional keep-previous callback)
12303 "Make a compact tree which shows all matches of REGEXP.
12304 The tree will show the lines where the regexp matches, and all higher
12305 headlines above the match. It will also show the heading after the match,
12306 to make sure editing the matching entry is easy.
12307 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12308 call to `org-occur' will be kept, to allow stacking of calls to this
12309 command.
12310 If CALLBACK is non-nil, it is a function which is called to confirm
12311 that the match should indeed be shown."
12313 (when (equal regexp "")
12314 (error "Regexp cannot be empty"))
12315 (unless keep-previous
12316 (org-remove-occur-highlights nil nil t))
12317 (push (cons regexp callback) org-occur-parameters)
12318 (let ((cnt 0))
12319 (save-excursion
12320 (goto-char (point-min))
12321 (if (or (not keep-previous) ; do not want to keep
12322 (not org-occur-highlights)) ; no previous matches
12323 ;; hide everything
12324 (org-overview))
12325 (while (re-search-forward regexp nil t)
12326 (when (or (not callback)
12327 (save-match-data (funcall callback)))
12328 (setq cnt (1+ cnt))
12329 (when org-highlight-sparse-tree-matches
12330 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12331 (org-show-context 'occur-tree))))
12332 (when org-remove-highlights-with-change
12333 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12334 nil 'local))
12335 (unless org-sparse-tree-open-archived-trees
12336 (org-hide-archived-subtrees (point-min) (point-max)))
12337 (run-hooks 'org-occur-hook)
12338 (if (org-called-interactively-p 'interactive)
12339 (message "%d match(es) for regexp %s" cnt regexp))
12340 cnt))
12342 (defun org-occur-next-match (&optional n reset)
12343 "Function for `next-error-function' to find sparse tree matches.
12344 N is the number of matches to move, when negative move backwards.
12345 RESET is entirely ignored - this function always goes back to the
12346 starting point when no match is found."
12347 (let* ((limit (if (< n 0) (point-min) (point-max)))
12348 (search-func (if (< n 0)
12349 'previous-single-char-property-change
12350 'next-single-char-property-change))
12351 (n (abs n))
12352 (pos (point))
12353 p1)
12354 (catch 'exit
12355 (while (setq p1 (funcall search-func (point) 'org-type))
12356 (when (equal p1 limit)
12357 (goto-char pos)
12358 (error "No more matches"))
12359 (when (equal (get-char-property p1 'org-type) 'org-occur)
12360 (setq n (1- n))
12361 (when (= n 0)
12362 (goto-char p1)
12363 (throw 'exit (point))))
12364 (goto-char p1))
12365 (goto-char p1)
12366 (error "No more matches"))))
12368 (defun org-show-context (&optional key)
12369 "Make sure point and context are visible.
12370 How much context is shown depends upon the variables
12371 `org-show-hierarchy-above', `org-show-following-heading'. and
12372 `org-show-siblings'."
12373 (let ((heading-p (org-on-heading-p t))
12374 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12375 (following-p (org-get-alist-option org-show-following-heading key))
12376 (entry-p (org-get-alist-option org-show-entry-below key))
12377 (siblings-p (org-get-alist-option org-show-siblings key)))
12378 (catch 'exit
12379 ;; Show heading or entry text
12380 (if (and heading-p (not entry-p))
12381 (org-flag-heading nil) ; only show the heading
12382 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12383 (org-show-hidden-entry))) ; show entire entry
12384 (when following-p
12385 ;; Show next sibling, or heading below text
12386 (save-excursion
12387 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12388 (org-flag-heading nil))))
12389 (when siblings-p (org-show-siblings))
12390 (when hierarchy-p
12391 ;; show all higher headings, possibly with siblings
12392 (save-excursion
12393 (while (and (condition-case nil
12394 (progn (org-up-heading-all 1) t)
12395 (error nil))
12396 (not (bobp)))
12397 (org-flag-heading nil)
12398 (when siblings-p (org-show-siblings))))))))
12400 (defvar org-reveal-start-hook nil
12401 "Hook run before revealing a location.")
12403 (defun org-reveal (&optional siblings)
12404 "Show current entry, hierarchy above it, and the following headline.
12405 This can be used to show a consistent set of context around locations
12406 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12407 not t for the search context.
12409 With optional argument SIBLINGS, on each level of the hierarchy all
12410 siblings are shown. This repairs the tree structure to what it would
12411 look like when opened with hierarchical calls to `org-cycle'.
12413 go to the parent and show the
12414 entire tree."
12415 (interactive "P")
12416 (run-hooks 'org-reveal-start-hook)
12417 (let ((org-show-hierarchy-above t)
12418 (org-show-following-heading t)
12419 (org-show-siblings (if siblings t org-show-siblings)))
12420 (org-show-context nil))
12421 (when (equal siblings '(16))
12422 (save-excursion
12423 (when (org-up-heading-safe)
12424 (org-show-subtree)
12425 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12427 (defun org-highlight-new-match (beg end)
12428 "Highlight from BEG to END and mark the highlight is an occur headline."
12429 (let ((ov (make-overlay beg end)))
12430 (overlay-put ov 'face 'secondary-selection)
12431 (overlay-put ov 'org-type 'org-occur)
12432 (push ov org-occur-highlights)))
12434 (defun org-remove-occur-highlights (&optional beg end noremove)
12435 "Remove the occur highlights from the buffer.
12436 BEG and END are ignored. If NOREMOVE is nil, remove this function
12437 from the `before-change-functions' in the current buffer."
12438 (interactive)
12439 (unless org-inhibit-highlight-removal
12440 (mapc 'delete-overlay org-occur-highlights)
12441 (setq org-occur-highlights nil)
12442 (setq org-occur-parameters nil)
12443 (unless noremove
12444 (remove-hook 'before-change-functions
12445 'org-remove-occur-highlights 'local))))
12447 ;;;; Priorities
12450 "Regular expression matching the priority indicator.")
12452 (defvar org-remove-priority-next-time nil)
12454 (defun org-priority-up ()
12455 "Increase the priority of the current item."
12456 (interactive)
12457 (org-priority 'up))
12459 (defun org-priority-down ()
12460 "Decrease the priority of the current item."
12461 (interactive)
12462 (org-priority 'down))
12464 (defun org-priority (&optional action)
12465 "Change the priority of an item by ARG.
12466 ACTION can be `set', `up', `down', or a character."
12467 (interactive)
12468 (unless org-enable-priority-commands
12469 (error "Priority commands are disabled"))
12470 (setq action (or action 'set))
12471 (let (current new news have remove)
12472 (save-excursion
12473 (org-back-to-heading t)
12474 (if (looking-at org-priority-regexp)
12475 (setq current (string-to-char (match-string 2))
12476 have t))
12477 (cond
12478 ((eq action 'remove)
12479 (setq remove t new ?\ ))
12480 ((or (eq action 'set)
12481 (if (featurep 'xemacs) (characterp action) (integerp action)))
12482 (if (not (eq action 'set))
12483 (setq new action)
12484 (message "Priority %c-%c, SPC to remove: "
12485 org-highest-priority org-lowest-priority)
12486 (save-match-data
12487 (setq new (read-char-exclusive))))
12488 (if (and (= (upcase org-highest-priority) org-highest-priority)
12489 (= (upcase org-lowest-priority) org-lowest-priority))
12490 (setq new (upcase new)))
12491 (cond ((equal new ?\ ) (setq remove t))
12492 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12493 (error "Priority must be between `%c' and `%c'"
12494 org-highest-priority org-lowest-priority))))
12495 ((eq action 'up)
12496 (setq new (if have
12497 (1- current) ; normal cycling
12498 ;; last priority was empty
12499 (if (eq last-command this-command)
12500 org-lowest-priority ; wrap around empty to lowest
12501 ;; default
12502 (if org-priority-start-cycle-with-default
12503 org-default-priority
12504 (1- org-default-priority))))))
12505 ((eq action 'down)
12506 (setq new (if have
12507 (1+ current) ; normal cycling
12508 ;; last priority was empty
12509 (if (eq last-command this-command)
12510 org-highest-priority ; wrap around empty to highest
12511 ;; default
12512 (if org-priority-start-cycle-with-default
12513 org-default-priority
12514 (1+ org-default-priority))))))
12515 (t (error "Invalid action")))
12516 (if (or (< (upcase new) org-highest-priority)
12517 (> (upcase new) org-lowest-priority))
12518 (if (and (memq action '(up down))
12519 (not have) (not (eq last-command this-command)))
12520 ;; `new' is from default priority
12521 (error
12522 "The default can not be set, see `org-default-priority' why")
12523 ;; normal cycling: `new' is beyond highest/lowest priority
12524 ;; and is wrapped around to the empty priority
12525 (setq remove t)))
12526 (setq news (format "%c" new))
12527 (if have
12528 (if remove
12529 (replace-match "" t t nil 1)
12530 (replace-match news t t nil 2))
12531 (if remove
12532 (error "No priority cookie found in line")
12533 (let ((case-fold-search nil))
12534 (looking-at org-todo-line-regexp))
12535 (if (match-end 2)
12536 (progn
12537 (goto-char (match-end 2))
12538 (insert " [#" news "]"))
12539 (goto-char (match-beginning 3))
12540 (insert "[#" news "] "))))
12541 (org-preserve-lc (org-set-tags nil 'align)))
12542 (if remove
12543 (message "Priority removed")
12544 (message "Priority of current item set to %s" news))))
12546 (defun org-get-priority (s)
12547 "Find priority cookie and return priority."
12548 (if (functionp org-get-priority-function)
12549 (funcall org-get-priority-function)
12550 (save-match-data
12551 (if (not (string-match org-priority-regexp s))
12552 (* 1000 (- org-lowest-priority org-default-priority))
12553 (* 1000 (- org-lowest-priority
12554 (string-to-char (match-string 2 s))))))))
12556 ;;;; Tags
12558 (defvar org-agenda-archives-mode)
12559 (defvar org-map-continue-from nil
12560 "Position from where mapping should continue.
12561 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12563 (defvar org-scanner-tags nil
12564 "The current tag list while the tags scanner is running.")
12565 (defvar org-trust-scanner-tags nil
12566 "Should `org-get-tags-at' use the tags for the scanner.
12567 This is for internal dynamical scoping only.
12568 When this is non-nil, the function `org-get-tags-at' will return the value
12569 of `org-scanner-tags' instead of building the list by itself. This
12570 can lead to large speed-ups when the tags scanner is used in a file with
12571 many entries, and when the list of tags is retrieved, for example to
12572 obtain a list of properties. Building the tags list for each entry in such
12573 a file becomes an N^2 operation - but with this variable set, it scales
12574 as N.")
12576 (defun org-scan-tags (action matcher &optional todo-only)
12577 "Scan headline tags with inheritance and produce output ACTION.
12579 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12580 or `agenda' to produce an entry list for an agenda view. It can also be
12581 a Lisp form or a function that should be called at each matched headline, in
12582 this case the return value is a list of all return values from these calls.
12584 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12585 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12586 only lines with a TODO keyword are included in the output."
12587 (require 'org-agenda)
12590 (org-re
12592 (props (list 'face 'default
12593 'done-face 'org-agenda-done
12594 'undone-face 'default
12595 'mouse-face 'highlight
12596 'org-not-done-regexp org-not-done-regexp
12597 'org-todo-regexp org-todo-regexp
12598 'help-echo
12599 (format "mouse-2 or RET jump to org file %s"
12600 (abbreviate-file-name
12601 (or (buffer-file-name (buffer-base-buffer))
12602 (buffer-name (buffer-base-buffer)))))))
12603 (case-fold-search nil)
12604 (org-map-continue-from nil)
12605 lspos tags tags-list
12606 (tags-alist (list (cons 0 org-file-tags)))
12607 (llast 0) rtn rtn1 level category i txt
12608 todo marker entry priority)
12609 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12610 (setq action (list 'lambda nil action)))
12611 (save-excursion
12612 (goto-char (point-min))
12613 (when (eq action 'sparse-tree)
12614 (org-overview)
12615 (org-remove-occur-highlights))
12616 (while (re-search-forward re nil t)
12617 (catch :skip
12618 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12619 tags (if (match-end 4) (org-match-string-no-properties 4)))
12620 (goto-char (setq lspos (match-beginning 0)))
12621 (setq level (org-reduced-level (funcall outline-level))
12622 category (org-get-category))
12623 (setq i llast llast level)
12624 ;; remove tag lists from same and sublevels
12625 (while (>= i level)
12626 (when (setq entry (assoc i tags-alist))
12627 (setq tags-alist (delete entry tags-alist)))
12628 (setq i (1- i)))
12629 ;; add the next tags
12630 (when tags
12631 (setq tags (org-split-string tags ":")
12632 tags-alist
12633 (cons (cons level tags) tags-alist)))
12634 ;; compile tags for current headline
12635 (setq tags-list
12636 (if org-use-tag-inheritance
12637 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12638 tags)
12639 org-scanner-tags tags-list)
12640 (when org-use-tag-inheritance
12641 (setcdr (car tags-alist)
12642 (mapcar (lambda (x)
12643 (setq x (copy-sequence x))
12644 (org-add-prop-inherited x))
12645 (cdar tags-alist))))
12646 (when (and tags org-use-tag-inheritance
12647 (or (not (eq t org-use-tag-inheritance))
12648 org-tags-exclude-from-inheritance))
12649 ;; selective inheritance, remove uninherited ones
12650 (setcdr (car tags-alist)
12651 (org-remove-uninherited-tags (cdar tags-alist))))
12652 (when (and
12654 ;; eval matcher only when the todo condition is OK
12655 (and (or (not todo-only) (member todo org-not-done-keywords))
12656 (let ((case-fold-search t)) (eval matcher)))
12658 ;; Call the skipper, but return t if it does not skip,
12659 ;; so that the `and' form continues evaluating
12660 (progn
12661 (unless (eq action 'sparse-tree) (org-agenda-skip))
12662 t)
12664 ;; Check if timestamps are deselecting this entry
12665 (or (not todo-only)
12666 (and (member todo org-not-done-keywords)
12667 (or (not org-agenda-tags-todo-honor-ignore-options)
12668 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12670 ;; Extra check for the archive tag
12671 ;; FIXME: Does the skipper already do this????
12672 (or
12673 (not (member org-archive-tag tags-list))
12674 ;; we have an archive tag, should we use this anyway?
12675 (or (not org-agenda-skip-archived-trees)
12676 (and (eq action 'agenda) org-agenda-archives-mode))))
12678 ;; select this headline
12680 (cond
12681 ((eq action 'sparse-tree)
12682 (and org-highlight-sparse-tree-matches
12683 (org-get-heading) (match-end 0)
12684 (org-highlight-new-match
12685 (match-beginning 0) (match-beginning 1)))
12686 (org-show-context 'tags-tree))
12687 ((eq action 'agenda)
12688 (setq txt (org-format-agenda-item
12689 ""
12690 (concat
12691 (if (eq org-tags-match-list-sublevels 'indented)
12692 (make-string (1- level) ?.) "")
12693 (org-get-heading))
12694 category
12695 tags-list
12696 )
12697 priority (org-get-priority txt))
12698 (goto-char lspos)
12699 (setq marker (org-agenda-new-marker))
12700 (org-add-props txt props
12701 'org-marker marker 'org-hd-marker marker 'org-category category
12702 'todo-state todo
12703 'priority priority 'type "tagsmatch")
12704 (push txt rtn))
12705 ((functionp action)
12706 (setq org-map-continue-from nil)
12707 (save-excursion
12708 (setq rtn1 (funcall action))
12709 (push rtn1 rtn)))
12710 (t (error "Invalid action")))
12712 ;; if we are to skip sublevels, jump to end of subtree
12713 (unless org-tags-match-list-sublevels
12714 (org-end-of-subtree t)
12715 (backward-char 1))))
12716 ;; Get the correct position from where to continue
12717 (if org-map-continue-from
12718 (goto-char org-map-continue-from)
12719 (and (= (point) lspos) (end-of-line 1)))))
12720 (when (and (eq action 'sparse-tree)
12721 (not org-sparse-tree-open-archived-trees))
12722 (org-hide-archived-subtrees (point-min) (point-max)))
12723 (nreverse rtn)))
12725 (defun org-remove-uninherited-tags (tags)
12726 "Remove all tags that are not inherited from the list TAGS."
12727 (cond
12728 ((eq org-use-tag-inheritance t)
12729 (if org-tags-exclude-from-inheritance
12730 (org-delete-all org-tags-exclude-from-inheritance tags)
12731 tags))
12732 ((not org-use-tag-inheritance) nil)
12733 ((stringp org-use-tag-inheritance)
12734 (delq nil (mapcar
12735 (lambda (x)
12736 (if (and (string-match org-use-tag-inheritance x)
12737 (not (member x org-tags-exclude-from-inheritance)))
12738 x nil))
12739 tags)))
12740 ((listp org-use-tag-inheritance)
12741 (delq nil (mapcar
12742 (lambda (x)
12743 (if (member x org-use-tag-inheritance) x nil))
12744 tags)))))
12746 (defvar todo-only) ;; dynamically scoped
12748 (defun org-match-sparse-tree (&optional todo-only match)
12749 "Create a sparse tree according to tags string MATCH.
12750 MATCH can contain positive and negative selection of tags, like
12752 If optional argument TODO-ONLY is non-nil, only select lines that are
12753 also TODO lines."
12754 (interactive "P")
12755 (org-prepare-agenda-buffers (list (current-buffer)))
12756 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12758 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12760 (defvar org-cached-props nil)
12761 (defun org-cached-entry-get (pom property)
12762 (if (or (eq t org-use-property-inheritance)
12763 (and (stringp org-use-property-inheritance)
12764 (string-match org-use-property-inheritance property))
12765 (and (listp org-use-property-inheritance)
12766 (member property org-use-property-inheritance)))
12767 ;; Caching is not possible, check it directly
12768 (org-entry-get pom property 'inherit)
12769 ;; Get all properties, so that we can do complicated checks easily
12770 (cdr (assoc property (or org-cached-props
12771 (setq org-cached-props
12772 (org-entry-properties pom)))))))
12774 (defun org-global-tags-completion-table (&optional files)
12775 "Return the list of all tags in all agenda buffer/files.
12776 Optional FILES argument is a list of files to which can be used
12777 instead of the agenda files."
12778 (save-excursion
12779 (org-uniquify
12780 (delq nil
12781 (apply 'append
12782 (mapcar
12783 (lambda (file)
12784 (set-buffer (find-file-noselect file))
12785 (append (org-get-buffer-tags)
12786 (mapcar (lambda (x) (if (stringp (car-safe x))
12787 (list (car-safe x)) nil))
12788 org-tag-alist)))
12789 (if (and files (car files))
12790 files
12791 (org-agenda-files))))))))
12793 (defun org-make-tags-matcher (match)
12794 "Create the TAGS/TODO matcher form for the selection string MATCH."
12795 ;; todo-only is scoped dynamically into this function, and the function
12796 ;; may change it if the matcher asks for it.
12797 (unless match
12798 ;; Get a new match request, with completion
12799 (let ((org-last-tags-completion-table
12800 (org-global-tags-completion-table)))
12801 (setq match (org-completing-read-no-i
12802 "Match: " 'org-tags-completion-function nil nil nil
12803 'org-tags-history))))
12805 ;; Parse the string and create a lisp form
12806 (let ((match0 match)
12807 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12808 minus tag mm
12809 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12810 orterms term orlist re-p str-p level-p level-op time-p
12811 prop-p pn pv po gv rest)
12812 (if (string-match "/+" match)
12813 ;; match contains also a todo-matching request
12814 (progn
12815 (setq tagsmatch (substring match 0 (match-beginning 0))
12816 todomatch (substring match (match-end 0)))
12817 (if (string-match "^!" todomatch)
12818 (setq todo-only t todomatch (substring todomatch 1)))
12820 (setq todomatch nil)))
12821 ;; only matching tags
12822 (setq tagsmatch match todomatch nil))
12824 ;; Make the tags matcher
12826 (setq tagsmatcher t)
12827 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12828 (while (setq term (pop orterms))
12830 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12831 (while (string-match re term)
12832 (setq rest (substring term (match-end 0))
12833 minus (and (match-end 1)
12834 (equal (match-string 1 term) "-"))
12835 tag (save-match-data (replace-regexp-in-string
12837 (match-string 2 term)))
12838 re-p (equal (string-to-char tag) ?{)
12839 level-p (match-end 4)
12840 prop-p (match-end 5)
12841 mm (cond
12842 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12843 (level-p
12844 (setq level-op (org-op-to-function (match-string 3 term)))
12845 `(,level-op level ,(string-to-number
12846 (match-string 4 term))))
12847 (prop-p
12848 (setq pn (match-string 5 term)
12849 po (match-string 6 term)
12850 pv (match-string 7 term)
12851 re-p (equal (string-to-char pv) ?{)
12853 time-p (save-match-data
12855 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12856 (if time-p (setq pv (org-matcher-time pv)))
12857 (setq po (org-op-to-function po (if time-p 'time str-p)))
12858 (cond
12859 ((equal pn "CATEGORY")
12860 (setq gv '(get-text-property (point) 'org-category)))
12861 ((equal pn "TODO")
12862 (setq gv 'todo))
12863 (t
12864 (setq gv `(org-cached-entry-get nil ,pn))))
12865 (if re-p
12866 (if (eq po 'org<>)
12867 `(not (string-match ,pv (or ,gv "")))
12868 `(string-match ,pv (or ,gv "")))
12869 (if str-p
12870 `(,po (or ,gv "") ,pv)
12871 `(,po (string-to-number (or ,gv ""))
12872 ,(string-to-number pv) ))))
12873 (t `(member ,tag tags-list)))
12874 mm (if minus (list 'not mm) mm)
12875 term rest)
12876 (push mm tagsmatcher))
12877 (push (if (> (length tagsmatcher) 1)
12878 (cons 'and tagsmatcher)
12879 (car tagsmatcher))
12880 orlist)
12881 (setq tagsmatcher nil))
12882 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12883 (setq tagsmatcher
12884 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12885 ;; Make the todo matcher
12887 (setq todomatcher t)
12888 (setq orterms (org-split-string todomatch "|") orlist nil)
12889 (while (setq term (pop orterms))
12890 (while (string-match re term)
12891 (setq minus (and (match-end 1)
12892 (equal (match-string 1 term) "-"))
12893 kwd (match-string 2 term)
12894 re-p (equal (string-to-char kwd) ?{)
12895 term (substring term (match-end 0))
12896 mm (if re-p
12897 `(string-match ,(substring kwd 1 -1) todo)
12898 (list 'equal 'todo kwd))
12899 mm (if minus (list 'not mm) mm))
12900 (push mm todomatcher))
12901 (push (if (> (length todomatcher) 1)
12902 (cons 'and todomatcher)
12903 (car todomatcher))
12904 orlist)
12905 (setq todomatcher nil))
12906 (setq todomatcher (if (> (length orlist) 1)
12907 (cons 'or orlist) (car orlist))))
12909 ;; Return the string and lisp forms of the matcher
12910 (setq matcher (if todomatcher
12911 (list 'and tagsmatcher todomatcher)
12912 tagsmatcher))
12913 (cons match0 matcher)))
12915 (defun org-op-to-function (op &optional stringp)
12916 "Turn an operator into the appropriate function."
12917 (setq op
12918 (cond
12919 ((equal op "<" ) '(< string< org-time<))
12920 ((equal op ">" ) '(> org-string> org-time>))
12921 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12922 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12923 ((member op '("=" "==")) '(= string= org-time=))
12924 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12925 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12927 (defun org<> (a b) (not (= a b)))
12928 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12929 (defun org-string>= (a b) (not (string< a b)))
12930 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12931 (defun org-string<> (a b) (not (string= a b)))
12932 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12933 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12934 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12935 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12936 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12937 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12938 (defun org-2ft (s)
12939 "Convert S to a floating point time.
12940 If S is already a number, just return it. If it is a string, parse
12941 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12942 (cond
12943 ((numberp s) s)
12944 ((stringp s)
12945 (condition-case nil
12946 (float-time (apply 'encode-time (org-parse-time-string s)))
12947 (error 0.)))
12948 (t 0.)))
12950 (defun org-time-today ()
12951 "Time in seconds today at 0:00.
12952 Returns the float number of seconds since the beginning of the
12953 epoch to the beginning of today (00:00)."
12954 (float-time (apply 'encode-time
12955 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12957 (defun org-matcher-time (s)
12958 "Interpret a time comparison value."
12959 (save-match-data
12960 (cond
12961 ((string= s "<now>") (float-time))
12962 ((string= s "<today>") (org-time-today))
12963 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12964 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12966 (+ (org-time-today)
12967 (* (string-to-number (match-string 1 s))
12968 (cdr (assoc (match-string 2 s)
12969 '(("d" . 86400.0) ("w" . 604800.0)
12970 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12971 (t (org-2ft s)))))
12973 (defun org-match-any-p (re list)
12974 "Does re match any element of list?"
12975 (setq list (mapcar (lambda (x) (string-match re x)) list))
12976 (delq nil list))
12978 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12979 (defvar org-tags-overlay (make-overlay 1 1))
12980 (org-detach-overlay org-tags-overlay)
12982 (defun org-get-local-tags-at (&optional pos)
12983 "Get a list of tags defined in the current headline."
12984 (org-get-tags-at pos 'local))
12986 (defun org-get-local-tags ()
12987 "Get a list of tags defined in the current headline."
12988 (org-get-tags-at nil 'local))
12990 (defun org-get-tags-at (&optional pos local)
12991 "Get a list of all headline tags applicable at POS.
12992 POS defaults to point. If tags are inherited, the list contains
12993 the targets in the same sequence as the headlines appear, i.e.
12994 the tags of the current headline come last.
12995 When LOCAL is non-nil, only return tags from the current headline,
12996 ignore inherited ones."
12997 (interactive)
12998 (if (and org-trust-scanner-tags
12999 (or (not pos) (equal pos (point)))
13000 (not local))
13001 org-scanner-tags
13002 (let (tags ltags lastpos parent)
13003 (save-excursion
13004 (save-restriction
13005 (widen)
13006 (goto-char (or pos (point)))
13007 (save-match-data
13008 (catch 'done
13009 (condition-case nil
13010 (progn
13011 (org-back-to-heading t)
13012 (while (not (equal lastpos (point)))
13013 (setq lastpos (point))
13014 (when (looking-at
13016 (setq ltags (org-split-string
13017 (org-match-string-no-properties 1) ":"))
13018 (when parent
13019 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13020 (setq tags (append
13021 (if parent
13022 (org-remove-uninherited-tags ltags)
13023 ltags)
13024 tags)))
13025 (or org-use-tag-inheritance (throw 'done t))
13026 (if local (throw 'done t))
13027 (or (org-up-heading-safe) (error nil))
13028 (setq parent t)))
13029 (error nil)))))
13030 (if local
13031 tags
13032 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13034 (defun org-add-prop-inherited (s)
13035 (add-text-properties 0 (length s) '(inherited t) s)
13036 s)
13038 (defun org-toggle-tag (tag &optional onoff)
13039 "Toggle the tag TAG for the current line.
13040 If ONOFF is `on' or `off', don't toggle but set to this state."
13041 (let (res current)
13042 (save-excursion
13043 (org-back-to-heading t)
13045 (point-at-eol) t)
13046 (progn
13047 (setq current (match-string 1))
13048 (replace-match ""))
13049 (setq current ""))
13050 (setq current (nreverse (org-split-string current ":")))
13051 (cond
13052 ((eq onoff 'on)
13053 (setq res t)
13054 (or (member tag current) (push tag current)))
13055 ((eq onoff 'off)
13056 (or (not (member tag current)) (setq current (delete tag current))))
13057 (t (if (member tag current)
13058 (setq current (delete tag current))
13059 (setq res t)
13060 (push tag current))))
13061 (end-of-line 1)
13062 (if current
13063 (progn
13064 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13065 (org-set-tags nil t))
13066 (delete-horizontal-space))
13067 (run-hooks 'org-after-tags-change-hook))
13068 res))
13070 (defun org-align-tags-here (to-col)
13071 ;; Assumes that this is a headline
13072 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13073 (beginning-of-line 1)
13075 (< pos (match-beginning 2)))
13076 (progn
13077 (setq tags-l (- (match-end 2) (match-beginning 2)))
13078 (goto-char (match-beginning 1))
13079 (insert " ")
13080 (delete-region (point) (1+ (match-beginning 2)))
13081 (setq ncol (max (1+ (current-column))
13082 (1+ col)
13083 (if (> to-col 0)
13084 to-col
13085 (- (abs to-col) tags-l))))
13086 (setq p (point))
13087 (insert (make-string (- ncol (current-column)) ?\ ))
13088 (setq ncol (current-column))
13089 (when indent-tabs-mode (tabify p (point-at-eol)))
13090 (org-move-to-column (min ncol col) t))
13091 (goto-char pos))))
13093 (defun org-set-tags-command (&optional arg just-align)
13094 "Call the set-tags command for the current entry."
13095 (interactive "P")
13096 (if (org-on-heading-p)
13097 (org-set-tags arg just-align)
13098 (save-excursion
13099 (org-back-to-heading t)
13100 (org-set-tags arg just-align))))
13102 (defun org-set-tags-to (data)
13103 "Set the tags of the current entry to DATA, replacing the current tags.
13104 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13105 If DATA is nil or the empty string, any tags will be removed."
13106 (interactive "sTags: ")
13107 (setq data
13108 (cond
13109 ((eq data nil) "")
13110 ((equal data "") "")
13111 ((stringp data)
13112 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13113 ":"))
13114 ((listp data)
13115 (concat ":" (mapconcat 'identity data ":") ":"))
13116 (t nil)))
13117 (when data
13118 (save-excursion
13119 (org-back-to-heading t)
13120 (when (looking-at org-complex-heading-regexp)
13121 (if (match-end 5)
13122 (progn
13123 (goto-char (match-beginning 5))
13124 (insert data)
13125 (delete-region (point) (point-at-eol))
13126 (org-set-tags nil 'align))
13127 (goto-char (point-at-eol))
13128 (insert " " data)
13129 (org-set-tags nil 'align)))
13130 (beginning-of-line 1)
13132 (delete-region (match-beginning 1) (match-end 1))))))
13134 (defun org-align-all-tags ()
13135 "Align the tags i all headings."
13136 (interactive)
13137 (save-excursion
13138 (or (ignore-errors (org-back-to-heading t))
13139 (outline-next-heading))
13140 (if (org-on-heading-p)
13141 (org-set-tags t)
13142 (message "No headings"))))
13144 (defvar org-indent-indentation-per-level)
13145 (defun org-set-tags (&optional arg just-align)
13146 "Set the tags for the current headline.
13147 With prefix ARG, realign all tags in headings in the current buffer."
13148 (interactive "P")
13149 (let* ((re org-outline-regexp-bol)
13150 (current (org-get-tags-string))
13151 (col (current-column))
13152 (org-setting-tags t)
13153 table current-tags inherited-tags ; computed below when needed
13154 tags p0 c0 c1 rpl di tc level)
13155 (if arg
13156 (save-excursion
13157 (goto-char (point-min))
13158 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13159 (while (re-search-forward re nil t)
13160 (org-set-tags nil t)
13161 (end-of-line 1)))
13162 (message "All tags realigned to column %d" org-tags-column))
13163 (if just-align
13164 (setq tags current)
13165 ;; Get a new set of tags from the user
13166 (save-excursion
13167 (setq table (append org-tag-persistent-alist
13168 (or org-tag-alist (org-get-buffer-tags))
13169 (and
13170 org-complete-tags-always-offer-all-agenda-tags
13171 (org-global-tags-completion-table
13172 (org-agenda-files))))
13173 org-last-tags-completion-table table
13174 current-tags (org-split-string current ":")
13175 inherited-tags (nreverse
13176 (nthcdr (length current-tags)
13177 (nreverse (org-get-tags-at))))
13178 tags
13179 (if (or (eq t org-use-fast-tag-selection)
13180 (and org-use-fast-tag-selection
13181 (delq nil (mapcar 'cdr table))))
13182 (org-fast-tag-selection
13183 current-tags inherited-tags table
13184 (if org-fast-tag-selection-include-todo
13185 org-todo-key-alist))
13186 (let ((org-add-colon-after-tag-completion t))
13187 (org-trim
13188 (org-icompleting-read "Tags: "
13189 'org-tags-completion-function
13190 nil nil current 'org-tags-history))))))
13191 (while (string-match "[-+&]+" tags)
13192 ;; No boolean logic, just a list
13193 (setq tags (replace-match ":" t t tags))))
13195 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13197 (if org-tags-sort-function
13198 (setq tags (mapconcat 'identity
13199 (sort (org-split-string
13200 tags (org-re "[^[:alnum:]_@#%]+"))
13201 org-tags-sort-function) ":")))
13204 (setq tags "")
13205 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13206 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13208 ;; Insert new tags at the correct column
13209 (beginning-of-line 1)
13210 (setq level (or (and (looking-at org-outline-regexp)
13211 (- (match-end 0) (point) 1))
13212 1))
13213 (cond
13214 ((and (equal current "") (equal tags "")))
13215 ((re-search-forward
13217 (point-at-eol) t)
13218 (if (equal tags "")
13219 (setq rpl "")
13220 (goto-char (match-beginning 0))
13221 (setq c0 (current-column)
13222 ;; compute offset for the case of org-indent-mode active
13223 di (if org-indent-mode
13224 (* (1- org-indent-indentation-per-level) (1- level))
13225 0)
13226 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13227 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13228 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13229 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13230 (replace-match rpl t t)
13231 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13232 tags)
13233 (t (error "Tags alignment failed")))
13234 (org-move-to-column col)
13235 (unless just-align
13236 (run-hooks 'org-after-tags-change-hook)))))
13238 (defun org-change-tag-in-region (beg end tag off)
13239 "Add or remove TAG for each entry in the region.
13240 This works in the agenda, and also in an org-mode buffer."
13241 (interactive
13242 (list (region-beginning) (region-end)
13243 (let ((org-last-tags-completion-table
13244 (if (org-mode-p)
13245 (org-get-buffer-tags)
13246 (org-global-tags-completion-table))))
13247 (org-icompleting-read
13248 "Tag: " 'org-tags-completion-function nil nil nil
13249 'org-tags-history))
13250 (progn
13252 (equal (read-char-exclusive) ?r))))
13253 (if (fboundp 'deactivate-mark) (deactivate-mark))
13254 (let ((agendap (equal major-mode 'org-agenda-mode))
13255 l1 l2 m buf pos newhead (cnt 0))
13256 (goto-char end)
13257 (setq l2 (1- (org-current-line)))
13258 (goto-char beg)
13259 (setq l1 (org-current-line))
13260 (loop for l from l1 to l2 do
13261 (org-goto-line l)
13262 (setq m (get-text-property (point) 'org-hd-marker))
13263 (when (or (and (org-mode-p) (org-on-heading-p))
13264 (and agendap m))
13265 (setq buf (if agendap (marker-buffer m) (current-buffer))
13266 pos (if agendap m (point)))
13267 (with-current-buffer buf
13268 (save-excursion
13269 (save-restriction
13270 (goto-char pos)
13271 (setq cnt (1+ cnt))
13272 (org-toggle-tag tag (if off 'off 'on))
13273 (setq newhead (org-get-heading)))))
13274 (and agendap (org-agenda-change-all-lines newhead m))))
13275 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13277 (defun org-tags-completion-function (string predicate &optional flag)
13278 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13279 (confirm (lambda (x) (stringp (car x)))))
13281 (setq s1 (match-string 1 string)
13282 s2 (match-string 2 string))
13283 (setq s1 "" s2 string))
13284 (cond
13285 ((eq flag nil)
13286 ;; try completion
13287 (setq rtn (try-completion s2 ctable confirm))
13288 (if (stringp rtn)
13289 (setq rtn
13290 (concat s1 s2 (substring rtn (length s2))
13291 (if (and org-add-colon-after-tag-completion
13292 (assoc rtn ctable))
13293 ":" ""))))
13294 rtn)
13295 ((eq flag t)
13296 ;; all-completions
13297 (all-completions s2 ctable confirm)
13298 )
13299 ((eq flag 'lambda)
13300 ;; exact match?
13301 (assoc s2 ctable)))
13302 ))
13304 (defun org-fast-tag-insert (kwd tags face &optional end)
13305 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13306 (insert (format "%-12s" (concat kwd ":"))
13307 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13308 (or end "")))
13310 (defun org-fast-tag-show-exit (flag)
13311 (save-excursion
13312 (org-goto-line 3)
13314 (replace-match ""))
13315 (when flag
13316 (end-of-line 1)
13317 (org-move-to-column (- (window-width) 19) t)
13318 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13320 (defun org-set-current-tags-overlay (current prefix)
13321 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13322 (if (featurep 'xemacs)
13323 (org-overlay-display org-tags-overlay (concat prefix s)
13324 'secondary-selection)
13325 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13326 (org-overlay-display org-tags-overlay (concat prefix s)))))
13328 (defvar org-last-tag-selection-key nil)
13329 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13330 "Fast tag selection with single keys.
13331 CURRENT is the current list of tags in the headline, INHERITED is the
13332 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13333 possibly with grouping information. TODO-TABLE is a similar table with
13334 TODO keywords, should these have keys assigned to them.
13335 If the keys are nil, a-z are automatically assigned.
13336 Returns the new tags string, or nil to not change the current settings."
13337 (let* ((fulltable (append table todo-table))
13338 (maxlen (apply 'max (mapcar
13339 (lambda (x)
13340 (if (stringp (car x)) (string-width (car x)) 0))
13341 fulltable)))
13342 (buf (current-buffer))
13343 (expert (eq org-fast-tag-selection-single-key 'expert))
13344 (buffer-tags nil)
13345 (fwidth (+ maxlen 3 1 3))
13346 (ncol (/ (- (window-width) 4) fwidth))
13347 (i-face 'org-done)
13348 (c-face 'org-todo)
13349 tg cnt e c char c1 c2 ntable tbl rtn
13350 ov-start ov-end ov-prefix
13351 (exit-after-next org-fast-tag-selection-single-key)
13352 (done-keywords org-done-keywords)
13353 groups ingroup)
13354 (save-excursion
13355 (beginning-of-line 1)
13356 (if (looking-at
13358 (setq ov-start (match-beginning 1)
13359 ov-end (match-end 1)
13360 ov-prefix "")
13361 (setq ov-start (1- (point-at-eol))
13362 ov-end (1+ ov-start))
13364 (setq ov-prefix
13365 (concat
13366 (buffer-substring (1- (point)) (point))
13367 (if (> (current-column) org-tags-column)
13368 " "
13369 (make-string (- org-tags-column (current-column)) ?\ ))))))
13370 (move-overlay org-tags-overlay ov-start ov-end)
13371 (save-window-excursion
13372 (if expert
13373 (set-buffer (get-buffer-create " *Org tags*"))
13374 (delete-other-windows)
13375 (split-window-vertically)
13376 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13377 (erase-buffer)
13378 (org-set-local 'org-done-keywords done-keywords)
13381 (org-fast-tag-show-exit exit-after-next)
13382 (org-set-current-tags-overlay current ov-prefix)
13383 (setq tbl fulltable char ?a cnt 0)
13384 (while (setq e (pop tbl))
13385 (cond
13386 ((equal (car e) :startgroup)
13387 (push '() groups) (setq ingroup t)
13388 (when (not (= cnt 0))
13389 (setq cnt 0)
13391 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13392 ((equal (car e) :endgroup)
13393 (setq ingroup nil cnt 0)
13395 ((equal e '(:newline))
13396 (when (not (= cnt 0))
13397 (setq cnt 0)
13399 (setq e (car tbl))
13400 (while (equal (car tbl) '(:newline))
13402 (setq tbl (cdr tbl)))))
13403 (t
13404 (setq tg (copy-sequence (car e)) c2 nil)
13405 (if (cdr e)
13406 (setq c (cdr e))
13407 ;; automatically assign a character.
13408 (setq c1 (string-to-char
13409 (downcase (substring
13410 tg (if (= (string-to-char tg) ?@) 1 0)))))
13411 (if (or (rassoc c1 ntable) (rassoc c1 table))
13412 (while (or (rassoc char ntable) (rassoc char table))
13413 (setq char (1+ char)))
13414 (setq c2 c1))
13415 (setq c (or c2 char)))
13416 (if ingroup (push tg (car groups)))
13417 (setq tg (org-add-props tg nil 'face
13418 (cond
13419 ((not (assoc tg table))
13420 (org-get-todo-face tg))
13421 ((member tg current) c-face)
13422 ((member tg inherited) i-face)
13423 (t nil))))
13424 (if (and (= cnt 0) (not ingroup)) (insert " "))
13425 (insert "[" c "] " tg (make-string
13426 (- fwidth 4 (length tg)) ?\ ))
13427 (push (cons tg c) ntable)
13428 (when (= (setq cnt (1+ cnt)) ncol)
13430 (if ingroup (insert " "))
13431 (setq cnt 0)))))
13432 (setq ntable (nreverse ntable))
13434 (goto-char (point-min))
13435 (if (not expert) (org-fit-window-to-buffer))
13436 (setq rtn
13437 (catch 'exit
13438 (while t
13439 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13440 (if (not groups) "no " "")
13441 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13442 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13443 (setq org-last-tag-selection-key c)
13444 (cond
13446 ((= c ?!)
13447 (setq groups (not groups))
13448 (goto-char (point-min))
13449 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13450 ((= c ?\C-c)
13451 (if (not expert)
13452 (org-fast-tag-show-exit
13453 (setq exit-after-next (not exit-after-next)))
13454 (setq expert nil)
13455 (delete-other-windows)
13456 (set-window-buffer (split-window-vertically) " *Org tags*")
13457 (org-switch-to-buffer-other-window " *Org tags*")
13458 (org-fit-window-to-buffer)))
13459 ((or (= c ?\C-g)
13460 (and (= c ?q) (not (rassoc c ntable))))
13461 (org-detach-overlay org-tags-overlay)
13462 (setq quit-flag t))
13463 ((= c ?\ )
13464 (setq current nil)
13465 (if exit-after-next (setq exit-after-next 'now)))
13467 (condition-case nil
13468 (setq tg (org-icompleting-read
13469 "Tag: "
13470 (or buffer-tags
13471 (with-current-buffer buf
13472 (org-get-buffer-tags)))))
13473 (quit (setq tg "")))
13475 (add-to-list 'buffer-tags (list tg))
13476 (if (member tg current)
13477 (setq current (delete tg current))
13478 (push tg current)))
13479 (if exit-after-next (setq exit-after-next 'now)))
13480 ((setq e (rassoc c todo-table) tg (car e))
13481 (with-current-buffer buf
13482 (save-excursion (org-todo tg)))
13483 (if exit-after-next (setq exit-after-next 'now)))
13484 ((setq e (rassoc c ntable) tg (car e))
13485 (if (member tg current)
13486 (setq current (delete tg current))
13487 (loop for g in groups do
13488 (if (member tg g)
13489 (mapc (lambda (x)
13490 (setq current (delete x current)))
13491 g)))
13492 (push tg current))
13493 (if exit-after-next (setq exit-after-next 'now))))
13495 ;; Create a sorted list
13496 (setq current
13497 (sort current
13498 (lambda (a b)
13499 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13500 (if (eq exit-after-next 'now) (throw 'exit t))
13501 (goto-char (point-min))
13502 (beginning-of-line 2)
13503 (delete-region (point) (point-at-eol))
13504 (org-fast-tag-insert "Current" current c-face)
13505 (org-set-current-tags-overlay current ov-prefix)
13506 (while (re-search-forward
13508 (setq tg (match-string 1))
13509 (add-text-properties
13510 (match-beginning 1) (match-end 1)
13511 (list 'face
13512 (cond
13513 ((member tg current) c-face)
13514 ((member tg inherited) i-face)
13515 (t (get-text-property (match-beginning 1) 'face))))))
13516 (goto-char (point-min)))))
13517 (org-detach-overlay org-tags-overlay)
13518 (if rtn
13519 (mapconcat 'identity current ":")
13520 nil))))
13522 (defun org-get-tags-string ()
13523 "Get the TAGS string in the current headline."
13524 (unless (org-on-heading-p t)
13525 (error "Not on a heading"))
13526 (save-excursion
13527 (beginning-of-line 1)
13529 (org-match-string-no-properties 1)
13530 "")))
13532 (defun org-get-tags ()
13533 "Get the list of tags specified in the current headline."
13534 (org-split-string (org-get-tags-string) ":"))
13536 (defun org-get-buffer-tags ()
13537 "Get a table of all tags used in the buffer, for completion."
13538 (let (tags)
13539 (save-excursion
13540 (goto-char (point-min))
13541 (while (re-search-forward
13543 (when (equal (char-after (point-at-bol 0)) ?*)
13544 (mapc (lambda (x) (add-to-list 'tags x))
13545 (org-split-string (org-match-string-no-properties 1) ":")))))
13546 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13547 (mapcar 'list tags)))
13549 ;;;; The mapping API
13551 ;;;###autoload
13552 (defun org-map-entries (func &optional match scope &rest skip)
13553 "Call FUNC at each headline selected by MATCH in SCOPE.
13555 FUNC is a function or a lisp form. The function will be called without
13556 arguments, with the cursor positioned at the beginning of the headline.
13557 The return values of all calls to the function will be collected and
13558 returned as a list.
13560 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13561 does not need to preserve point. After evaluation, the cursor will be
13562 moved to the end of the line (presumably of the headline of the
13563 processed entry) and search continues from there. Under some
13564 circumstances, this may not produce the wanted results. For example,
13565 if you have removed (e.g. archived) the current (sub)tree it could
13566 mean that the next entry will be skipped entirely. In such cases, you
13567 can specify the position from where search should continue by making
13568 FUNC set the variable `org-map-continue-from' to the desired buffer
13569 position.
13571 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13572 Only headlines that are matched by this query will be considered during
13573 the iteration. When MATCH is nil or t, all headlines will be
13574 visited by the iteration.
13576 SCOPE determines the scope of this command. It can be any of:
13578 nil The current buffer, respecting the restriction if any
13579 tree The subtree started with the entry at point
13580 region The entries within the active region, if any
13581 file The current buffer, without restriction
13582 file-with-archives
13583 The current buffer, and any archives associated with it
13584 agenda All agenda files
13585 agenda-with-archives
13586 All agenda files with any archive files associated with them
13587 \(file1 file2 ...)
13588 If this is a list, all files in the list will be scanned
13590 The remaining args are treated as settings for the skipping facilities of
13591 the scanner. The following items can be given here:
13593 archive skip trees with the archive tag.
13594 comment skip trees with the COMMENT keyword
13595 function or Emacs Lisp form:
13596 will be used as value for `org-agenda-skip-function', so whenever
13597 the function returns t, FUNC will not be called for that
13598 entry and search will continue from the point where the
13599 function leaves it.
13601 If your function needs to retrieve the tags including inherited tags
13602 at the *current* entry, you can use the value of the variable
13603 `org-scanner-tags' which will be much faster than getting the value
13604 with `org-get-tags-at'. If your function gets properties with
13605 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13606 to t around the call to `org-entry-properties' to get the same speedup.
13607 Note that if your function moves around to retrieve tags and properties at
13608 a *different* entry, you cannot use these techniques."
13609 (let* ((org-agenda-archives-mode nil) ; just to make sure
13610 (org-agenda-skip-archived-trees (memq 'archive skip))
13611 (org-agenda-skip-comment-trees (memq 'comment skip))
13612 (org-agenda-skip-function
13613 (car (org-delete-all '(comment archive) skip)))
13614 (org-tags-match-list-sublevels t)
13615 matcher file res
13616 org-todo-keywords-for-agenda
13617 org-done-keywords-for-agenda
13618 org-todo-keyword-alist-for-agenda
13619 org-drawers-for-agenda
13620 org-tag-alist-for-agenda)
13622 (cond
13623 ((eq match t) (setq matcher t))
13624 ((eq match nil) (setq matcher t))
13625 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13627 (save-excursion
13628 (save-restriction
13629 (cond ((eq scope 'tree)
13630 (org-back-to-heading t)
13631 (org-narrow-to-subtree)
13632 (setq scope nil))
13633 ((and (eq scope 'region) (org-region-active-p))
13634 (narrow-to-region (region-beginning) (region-end))
13635 (setq scope nil)))
13637 (if (not scope)
13638 (progn
13639 (org-prepare-agenda-buffers
13640 (list (buffer-file-name (current-buffer))))
13641 (setq res (org-scan-tags func matcher)))
13642 ;; Get the right scope
13643 (cond
13644 ((and scope (listp scope) (symbolp (car scope)))
13645 (setq scope (eval scope)))
13646 ((eq scope 'agenda)
13647 (setq scope (org-agenda-files t)))
13648 ((eq scope 'agenda-with-archives)
13649 (setq scope (org-agenda-files t))
13650 (setq scope (org-add-archive-files scope)))
13651 ((eq scope 'file)
13652 (setq scope (list (buffer-file-name))))
13653 ((eq scope 'file-with-archives)
13654 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13655 (org-prepare-agenda-buffers scope)
13656 (while (setq file (pop scope))
13657 (with-current-buffer (org-find-base-buffer-visiting file)
13658 (save-excursion
13659 (save-restriction
13660 (widen)
13661 (goto-char (point-min))
13662 (setq res (append res (org-scan-tags func matcher))))))))))
13663 res))
13665 ;;;; Properties
13667 ;;; Setting and retrieving properties
13669 (defconst org-special-properties
13670 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13671 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13672 "The special properties valid in Org-mode.
13674 These are properties that are not defined in the property drawer,
13675 but in some other way.")
13677 (defconst org-default-properties
13678 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13679 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13680 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13681 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13682 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13683 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13684 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13685 "Some properties that are used by Org-mode for various purposes.
13686 Being in this list makes sure that they are offered for completion.")
13689 "Regular expression matching the first line of a property drawer.")
13692 "Regular expression matching the last line of a property drawer.")
13695 "Regular expression matching the first line of a property drawer.")
13698 "Regular expression matching the first line of a property drawer.")
13700 (defconst org-property-drawer-re
13703 "Matches an entire property drawer.")
13705 (defconst org-clock-drawer-re
13708 "Matches an entire clock drawer.")
13710 (defsubst org-re-property (property)
13711 "Return a regexp matching PROPERTY.
13712 Match group 1 will be set to the value of the property."
13715 (defun org-property-action ()
13716 "Do an action on properties."
13717 (interactive)
13718 (let (c)
13719 (org-at-property-p)
13720 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13721 (setq c (read-char-exclusive))
13722 (cond
13723 ((equal c ?s)
13724 (call-interactively 'org-set-property))
13725 ((equal c ?d)
13726 (call-interactively 'org-delete-property))
13727 ((equal c ?D)
13728 (call-interactively 'org-delete-property-globally))
13729 ((equal c ?c)
13730 (call-interactively 'org-compute-property-at-point))
13731 (t (error "No such property action %c" c)))))
13733 (defun org-set-effort (&optional value)
13734 "Set the effort property of the current entry.
13735 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13736 allowed value."
13737 (interactive "P")
13738 (if (equal value 0) (setq value 10))
13739 (let* ((completion-ignore-case t)
13740 (prop org-effort-property)
13741 (cur (org-entry-get nil prop))
13742 (allowed (org-property-get-allowed-values nil prop 'table))
13743 (existing (mapcar 'list (org-property-values prop)))
13744 rpl
13745 (val (cond
13746 ((stringp value) value)
13747 ((and allowed (integerp value))
13748 (or (car (nth (1- value) allowed))
13749 (car (org-last allowed))))
13750 (allowed
13751 (message "Select 1-9,0, [RET%s]: %s"
13752 (if cur (concat "=" cur) "")
13753 (mapconcat 'car allowed " "))
13754 (setq rpl (read-char-exclusive))
13756 cur
13757 (setq rpl (- rpl ?0))
13758 (if (equal rpl 0) (setq rpl 10))
13759 (if (and (> rpl 0) (<= rpl (length allowed)))
13760 (car (nth (1- rpl) allowed))
13761 (org-completing-read "Effort: " allowed nil))))
13762 (t
13763 (let (org-completion-use-ido org-completion-use-iswitchb)
13764 (org-completing-read
13766 (concat "[" cur "]") "")
13767 ": ")
13768 existing nil nil "" nil cur))))))
13769 (unless (equal (org-entry-get nil prop) val)
13770 (org-entry-put nil prop val))
13771 (message "%s is now %s" prop val)))
13773 (defun org-at-property-p ()
13774 "Is cursor inside a property drawer?"
13775 (save-excursion
13776 (beginning-of-line 1)
13778 (save-match-data ;; Used by calling procedures
13779 (let ((p (point))
13780 (range (unless (org-before-first-heading-p)
13781 (org-get-property-block))))
13782 (and range (<= (car range) p) (< p (cdr range))))))))
13784 (defun org-get-property-block (&optional beg end force)
13785 "Return the (beg . end) range of the body of the property drawer.
13786 BEG and END can be beginning and end of subtree, if not given
13787 they will be found.
13788 If the drawer does not exist and FORCE is non-nil, create the drawer."
13789 (catch 'exit
13790 (save-excursion
13791 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13792 (end (or end (progn (outline-next-heading) (point)))))
13793 (goto-char beg)
13794 (if (re-search-forward org-property-start-re end t)
13795 (setq beg (1+ (match-end 0)))
13796 (if force
13797 (save-excursion
13798 (org-insert-property-drawer)
13799 (setq end (progn (outline-next-heading) (point))))
13800 (throw 'exit nil))
13801 (goto-char beg)
13802 (if (re-search-forward org-property-start-re end t)
13803 (setq beg (1+ (match-end 0)))))
13804 (if (re-search-forward org-property-end-re end t)
13805 (setq end (match-beginning 0))
13806 (or force (throw 'exit nil))
13807 (goto-char beg)
13808 (setq end beg)
13809 (org-indent-line-function)
13811 (cons beg end)))))
13813 (defun org-entry-properties (&optional pom which specific)
13814 "Get all properties of the entry at point-or-marker POM.
13815 This includes the TODO keyword, the tags, time strings for deadline,
13816 scheduled, and clocking, and any additional properties defined in the
13817 entry. The return value is an alist, keys may occur multiple times
13818 if the property key was used several times.
13819 POM may also be nil, in which case the current entry is used.
13820 If WHICH is nil or `all', get all properties. If WHICH is
13821 `special' or `standard', only get that subclass. If WHICH
13822 is a string only get exactly this property. SPECIFIC can be a string, the
13823 specific property we are interested in. Specifying it can speed
13824 things up because then unnecessary parsing is avoided."
13825 (setq which (or which 'all))
13826 (org-with-point-at pom
13827 (let ((clockstr (substring org-clock-string 0 -1))
13828 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13829 (case-fold-search nil)
13830 beg end range props sum-props key key1 value string clocksum)
13831 (save-excursion
13832 (when (condition-case nil
13833 (and (org-mode-p) (org-back-to-heading t))
13834 (error nil))
13835 (setq beg (point))
13836 (setq sum-props (get-text-property (point) 'org-summaries))
13837 (setq clocksum (get-text-property (point) :org-clock-minutes))
13838 (outline-next-heading)
13839 (setq end (point))
13840 (when (memq which '(all special))
13841 ;; Get the special properties, like TODO and tags
13842 (goto-char beg)
13843 (when (and (or (not specific) (string= specific "TODO"))
13844 (looking-at org-todo-line-regexp) (match-end 2))
13845 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13846 (when (and (or (not specific) (string= specific "PRIORITY"))
13847 (looking-at org-priority-regexp))
13848 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13849 (when (or (not specific) (string= specific "FILE"))
13850 (push (cons "FILE" buffer-file-name) props))
13851 (when (and (or (not specific) (string= specific "TAGS"))
13852 (setq value (org-get-tags-string))
13854 (push (cons "TAGS" value) props))
13855 (when (and (or (not specific) (string= specific "ALLTAGS"))
13856 (setq value (org-get-tags-at)))
13857 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13858 ":"))
13859 props))
13860 (when (or (not specific) (string= specific "BLOCKED"))
13861 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13862 (when (or (not specific)
13863 (member specific
13864 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13865 "TIMESTAMP" "TIMESTAMP_IA")))
13866 (catch 'match
13867 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13868 (setq key (if (match-end 1)
13869 (substring (org-match-string-no-properties 1)
13870 0 -1))
13871 string (if (equal key clockstr)
13872 (org-no-properties
13873 (org-trim
13874 (buffer-substring
13875 (match-beginning 3) (goto-char
13876 (point-at-eol)))))
13877 (substring (org-match-string-no-properties 3)
13878 1 -1)))
13879 ;; Get the correct property name from the key. This is
13880 ;; necessary if the user has configured time keywords.
13881 (setq key1 (concat key ":"))
13882 (cond
13883 ((not key)
13884 (setq key
13885 (if (= (char-after (match-beginning 3)) ?\[)
13886 "TIMESTAMP_IA" "TIMESTAMP")))
13887 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13888 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13889 ((equal key1 org-closed-string) (setq key "CLOSED"))
13890 ((equal key1 org-clock-string) (setq key "CLOCK")))
13891 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13892 (progn
13893 (push (cons key string) props)
13894 ;; no need to search further if match is found
13895 (throw 'match t))
13896 (when (or (equal key "CLOCK") (not (assoc key props)))
13897 (push (cons key string) props))))))
13898 )
13900 (when (memq which '(all standard))
13901 ;; Get the standard properties, like :PROP: ...
13902 (setq range (org-get-property-block beg end))
13903 (when range
13904 (goto-char (car range))
13905 (while (re-search-forward
13907 (cdr range) t)
13908 (setq key (org-match-string-no-properties 1)
13909 value (org-trim (or (org-match-string-no-properties 2) "")))
13910 (unless (member key excluded)
13911 (push (cons key (or value "")) props)))))
13912 (if clocksum
13913 (push (cons "CLOCKSUM"
13914 (org-columns-number-to-string (/ (float clocksum) 60.)
13915 'add_times))
13916 props))
13917 (unless (assoc "CATEGORY" props)
13918 (push (cons "CATEGORY" (org-get-category)) props))
13919 (append sum-props (nreverse props)))))))
13921 (defun org-entry-get (pom property &optional inherit literal-nil)
13922 "Get value of PROPERTY for entry at point-or-marker POM.
13923 If INHERIT is non-nil and the entry does not have the property,
13924 then also check higher levels of the hierarchy.
13925 If INHERIT is the symbol `selective', use inheritance only if the setting
13926 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13927 If the property is present but empty, the return value is the empty string.
13928 If the property is not present at all, nil is returned.
13931 do not interpret it as the list atom nil. This is used for inheritance
13933 (org-with-point-at pom
13934 (if (and inherit (if (eq inherit 'selective)
13935 (org-property-inherit-p property)
13936 t))
13937 (org-entry-get-with-inheritance property literal-nil)
13938 (if (member property org-special-properties)
13939 ;; We need a special property. Use `org-entry-properties' to
13940 ;; retrieve it, but specify the wanted property
13941 (cdr (assoc property (org-entry-properties nil 'special property)))
13942 (let ((range (unless (org-before-first-heading-p)
13943 (org-get-property-block))))
13944 (if (and range
13945 (goto-char (car range))
13946 (re-search-forward
13947 (org-re-property property)
13948 (cdr range) t))
13949 ;; Found the property, return it.
13950 (if (match-end 1)
13951 (if literal-nil
13952 (org-match-string-no-properties 1)
13953 (org-not-nil (org-match-string-no-properties 1)))
13954 "")))))))
13956 (defun org-property-or-variable-value (var &optional inherit)
13957 "Check if there is a property fixing the value of VAR.
13958 If yes, return this value. If not, return the current value of the variable."
13959 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13961 (read prop)
13962 (symbol-value var))))
13964 (defun org-entry-delete (pom property)
13965 "Delete the property PROPERTY from entry at point-or-marker POM."
13966 (org-with-point-at pom
13967 (if (member property org-special-properties)
13968 nil ; cannot delete these properties.
13969 (let ((range (org-get-property-block)))
13970 (if (and range
13971 (goto-char (car range))
13972 (re-search-forward
13973 (org-re-property property)
13974 (cdr range) t))
13975 (progn
13976 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13977 t)
13978 nil)))))
13980 ;; Multi-values properties are properties that contain multiple values
13981 ;; These values are assumed to be single words, separated by whitespace.
13982 (defun org-entry-add-to-multivalued-property (pom property value)
13983 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13984 (let* ((old (org-entry-get pom property))
13986 (setq value (org-entry-protect-space value))
13987 (unless (member value values)
13988 (setq values (cons value values))
13989 (org-entry-put pom property
13990 (mapconcat 'identity values " ")))))
13992 (defun org-entry-remove-from-multivalued-property (pom property value)
13993 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13994 (let* ((old (org-entry-get pom property))
13996 (setq value (org-entry-protect-space value))
13997 (when (member value values)
13998 (setq values (delete value values))
13999 (org-entry-put pom property
14000 (mapconcat 'identity values " ")))))
14002 (defun org-entry-member-in-multivalued-property (pom property value)
14003 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14004 (let* ((old (org-entry-get pom property))
14006 (setq value (org-entry-protect-space value))
14007 (member value values)))
14009 (defun org-entry-get-multivalued-property (pom property)
14010 "Return a list of values in a multivalued property."
14011 (let* ((value (org-entry-get pom property))
14013 (mapcar 'org-entry-restore-space values)))
14015 (defun org-entry-put-multivalued-property (pom property &rest values)
14016 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14017 VALUES should be a list of strings. Spaces will be protected."
14018 (org-entry-put pom property
14019 (mapconcat 'org-entry-protect-space values " "))
14020 (let* ((value (org-entry-get pom property))
14022 (mapcar 'org-entry-restore-space values)))
14024 (defun org-entry-protect-space (s)
14025 "Protect spaces and newline in string S."
14026 (while (string-match " " s)
14027 (setq s (replace-match "%20" t t s)))
14029 (setq s (replace-match "%0A" t t s)))
14030 s)
14032 (defun org-entry-restore-space (s)
14033 "Restore spaces and newline in string S."
14034 (while (string-match "%20" s)
14035 (setq s (replace-match " " t t s)))
14036 (while (string-match "%0A" s)
14038 s)
14040 (defvar org-entry-property-inherited-from (make-marker)
14041 "Marker pointing to the entry from where a property was inherited.
14042 Each call to `org-entry-get-with-inheritance' will set this marker to the
14043 location of the entry where the inheritance search matched. If there was
14044 no match, the marker will point nowhere.
14045 Note that also `org-entry-get' calls this function, if the INHERIT flag
14046 is set.")
14048 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14049 "Get entry property, and search higher levels if not present.
14050 The search will stop at the first ancestor which has the property defined.
14052 should be considered as undefined (this is the meaning of nil here).
14054 (move-marker org-entry-property-inherited-from nil)
14055 (let (tmp)
14056 (unless (org-before-first-heading-p)
14057 (save-excursion
14058 (save-restriction
14059 (widen)
14060 (catch 'ex
14061 (while t
14062 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14063 (org-back-to-heading t)
14064 (move-marker org-entry-property-inherited-from (point))
14065 (throw 'ex tmp))
14066 (or (org-up-heading-safe) (throw 'ex nil)))))))
14067 (setq tmp (or tmp
14068 (cdr (assoc property org-file-properties))
14069 (cdr (assoc property org-global-properties))
14070 (cdr (assoc property org-global-properties-fixed))))
14071 (if literal-nil tmp (org-not-nil tmp))))
14073 (defvar org-property-changed-functions nil
14074 "Hook called when the value of a property has changed.
14075 Each hook function should accept two arguments, the name of the property
14076 and the new value.")
14078 (defun org-entry-put (pom property value)
14079 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14080 (org-with-point-at pom
14081 (org-back-to-heading t)
14082 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14083 range)
14084 (cond
14085 ((equal property "TODO")
14087 (not (member value org-todo-keywords-1)))
14089 (if (or (not value)
14091 (setq value 'none))
14092 (org-todo value)
14093 (org-set-tags nil 'align))
14094 ((equal property "PRIORITY")
14096 (string-to-char value) ?\ ))
14097 (org-set-tags nil 'align))
14098 ((equal property "SCHEDULED")
14099 (if (re-search-forward org-scheduled-time-regexp end t)
14100 (cond
14101 ((eq value 'earlier) (org-timestamp-change -1 'day))
14102 ((eq value 'later) (org-timestamp-change 1 'day))
14103 (t (call-interactively 'org-schedule)))
14104 (call-interactively 'org-schedule)))
14105 ((equal property "DEADLINE")
14106 (if (re-search-forward org-deadline-time-regexp end t)
14107 (cond
14108 ((eq value 'earlier) (org-timestamp-change -1 'day))
14109 ((eq value 'later) (org-timestamp-change 1 'day))
14110 (t (call-interactively 'org-deadline)))
14111 (call-interactively 'org-deadline)))
14112 ((member property org-special-properties)
14113 (error "The %s property can not yet be set with `org-entry-put'"
14114 property))
14115 (t ; a non-special property
14116 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14117 (setq range (org-get-property-block beg end 'force))
14118 (goto-char (car range))
14119 (if (re-search-forward
14120 (org-re-property property) (cdr range) t)
14121 (progn
14122 (delete-region (match-beginning 0) (match-end 0))
14123 (goto-char (match-beginning 0)))
14124 (goto-char (cdr range))
14126 (backward-char 1)
14127 (org-indent-line-function))
14128 (insert ":" property ":")
14129 (and value (insert " " value))
14130 (org-indent-line-function)))))
14131 (run-hook-with-args 'org-property-changed-functions property value)))
14133 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14134 "Get all property keys in the current buffer.
14135 With INCLUDE-SPECIALS, also list the special properties that reflect things
14136 like tags and TODO state.
14137 With INCLUDE-DEFAULTS, also include properties that has special meaning
14138 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14139 and others.
14140 With INCLUDE-COLUMNS, also include property names given in COLUMN
14141 formats in the current buffer."
14142 (let (rtn range cfmt s p)
14143 (save-excursion
14144 (save-restriction
14145 (widen)
14146 (goto-char (point-min))
14147 (while (re-search-forward org-property-start-re nil t)
14148 (setq range (org-get-property-block))
14149 (goto-char (car range))
14150 (while (re-search-forward
14152 (cdr range) t)
14153 (add-to-list 'rtn (org-match-string-no-properties 1)))
14154 (outline-next-heading))))
14156 (when include-specials
14157 (setq rtn (append org-special-properties rtn)))
14159 (when include-defaults
14160 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14161 (add-to-list 'rtn org-effort-property))
14163 (when include-columns
14164 (save-excursion
14165 (save-restriction
14166 (widen)
14167 (goto-char (point-min))
14168 (while (re-search-forward
14170 nil t)
14171 (setq cfmt (match-string 2) s 0)
14173 cfmt s)
14174 (setq s (match-end 0)
14175 p (match-string 1 cfmt))
14176 (unless (or (equal p "ITEM")
14177 (member p org-special-properties))
14178 (add-to-list 'rtn (match-string 1 cfmt))))))))
14180 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14182 (defun org-property-values (key)
14183 "Return a list of all values of property KEY in the current buffer."
14184 (save-excursion
14185 (save-restriction
14186 (widen)
14187 (goto-char (point-min))
14188 (let ((re (org-re-property key))
14189 values)
14190 (while (re-search-forward re nil t)
14191 (add-to-list 'values (org-trim (match-string 1))))
14192 (delete "" values)))))
14194 (defun org-insert-property-drawer ()
14195 "Insert a property drawer into the current entry."
14196 (interactive)
14197 (org-back-to-heading t)
14198 (looking-at org-outline-regexp)
14199 (let ((indent (if org-adapt-indentation
14200 (- (match-end 0)(match-beginning 0))
14201 0))
14202 (beg (point))
14204 end hiddenp)
14205 (outline-next-heading)
14206 (setq end (point))
14207 (goto-char beg)
14208 (while (re-search-forward re end t))
14209 (setq hiddenp (outline-invisible-p))
14210 (end-of-line 1)
14213 (if (member (match-string 1) '("CLOCK:" ":END:"))
14214 ;; just skip this line
14215 (beginning-of-line 2)
14216 ;; Drawer start, find the end
14218 (beginning-of-line 1)))
14219 (org-skip-over-state-notes)
14221 (if (eq (char-before) ?*) (forward-char 1))
14223 (beginning-of-line 0)
14224 (org-indent-to-column indent)
14225 (beginning-of-line 2)
14226 (org-indent-to-column indent)
14227 (beginning-of-line 0)
14228 (if hiddenp
14229 (save-excursion
14230 (org-back-to-heading t)
14231 (hide-entry))
14232 (org-flag-drawer t))))
14234 (defvar org-property-set-functions-alist nil
14235 "Property set function alist.
14236 Each entry should have the following format:
14238 (PROPERTY . READ-FUNCTION)
14240 The read function will be called with the same argument as
14241 `org-completing-read'.")
14243 (defun org-set-property-function (property)
14244 "Get the function that should be used to set PROPERTY.
14245 This is computed according to `org-property-set-functions-alist'."
14246 (or (cdr (assoc property org-property-set-functions-alist))
14247 'org-completing-read))
14249 (defun org-read-property-value (property)
14250 "Read PROPERTY value from user."
14251 (let* ((completion-ignore-case t)
14252 (allowed (org-property-get-allowed-values nil property 'table))
14253 (cur (org-entry-get nil property))
14254 (prompt (concat property " value"
14256 (concat " [" cur "]") "") ": "))
14257 (set-function (org-set-property-function property))
14258 (val (if allowed
14259 (funcall set-function prompt allowed nil
14260 (not (get-text-property 0 'org-unrestricted
14261 (caar allowed))))
14262 (let (org-completion-use-ido org-completion-use-iswitchb)
14263 (funcall set-function prompt
14264 (mapcar 'list (org-property-values property))
14265 nil nil "" nil cur)))))
14266 (if (equal val "")
14267 cur
14268 val)))
14270 (defvar org-last-set-property nil)
14271 (defun org-read-property-name ()
14272 "Read a property name."
14273 (let* ((completion-ignore-case t)
14274 (keys (org-buffer-property-keys nil t t))
14275 (default-prop (or (save-excursion
14276 (save-match-data
14277 (beginning-of-line)
14279 (null (string= (match-string 1) "END"))
14280 (match-string 1))))
14281 org-last-set-property))
14282 (property (org-icompleting-read
14283 (concat "Property"
14284 (if default-prop (concat " [" default-prop "]") "")
14285 ": ")
14286 (mapcar 'list keys)
14287 nil nil nil nil
14288 default-prop
14289 )))
14290 (if (member property keys)
14291 property
14292 (or (cdr (assoc (downcase property)
14293 (mapcar (lambda (x) (cons (downcase x) x))
14294 keys)))
14295 property))))
14297 (defun org-set-property (property value)
14298 "In the current entry, set PROPERTY to VALUE.
14299 When called interactively, this will prompt for a property name, offering
14300 completion on existing and default properties. And then it will prompt
14301 for a value, offering completion either on allowed values (via an inherited
14302 xxx_ALL property) or on existing values in other instances of this property
14303 in the current file."
14304 (interactive (list nil nil))
14305 (let* ((property (or property (org-read-property-name)))
14306 (value (or value (org-read-property-value property))))
14307 (setq org-last-set-property property)
14308 ;; Possibly postprocess the inserted value:
14309 (when (assoc property org-properties-postprocess-alist)
14310 (setq value (funcall (cadr fn) value)))
14311 (unless (equal (org-entry-get nil property) value)
14312 (org-entry-put nil property value))))
14314 (defun org-delete-property (property)
14315 "In the current entry, delete PROPERTY."
14316 (interactive
14317 (let* ((completion-ignore-case t)
14318 (prop (org-icompleting-read "Property: "
14319 (org-entry-properties nil 'standard))))
14320 (list prop)))
14321 (message "Property %s %s" property
14322 (if (org-entry-delete nil property)
14323 "deleted"
14324 "was not present in the entry")))
14326 (defun org-delete-property-globally (property)
14327 "Remove PROPERTY globally, from all entries."
14328 (interactive
14329 (let* ((completion-ignore-case t)
14330 (prop (org-icompleting-read
14331 "Globally remove property: "
14332 (mapcar 'list (org-buffer-property-keys)))))
14333 (list prop)))
14334 (save-excursion
14335 (save-restriction
14336 (widen)
14337 (goto-char (point-min))
14338 (let ((cnt 0))
14339 (while (re-search-forward
14340 (org-re-property property)
14341 nil t)
14342 (setq cnt (1+ cnt))
14343 (replace-match ""))
14346 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14348 (defun org-compute-property-at-point ()
14349 "Compute the property at point.
14350 This looks for an enclosing column format, extracts the operator and
14351 then applies it to the property in the column format's scope."
14352 (interactive)
14353 (unless (org-at-property-p)
14354 (error "Not at a property"))
14355 (let ((prop (org-match-string-no-properties 2)))
14356 (org-columns-get-format-and-top-level)
14357 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14358 (error "No operator defined for property %s" prop))
14359 (org-columns-compute prop)))
14361 (defvar org-property-allowed-value-functions nil
14362 "Hook for functions supplying allowed values for a specific property.
14363 The functions must take a single argument, the name of the property, and
14365 the values, this means that these values are intended as defaults for
14366 completion, but that other values should be allowed too.
14367 The functions must return nil if they are not responsible for this
14368 property.")
14370 (defun org-property-get-allowed-values (pom property &optional table)
14371 "Get allowed values for the property PROPERTY.
14372 When TABLE is non-nil, return an alist that can directly be used for
14373 completion."
14374 (let (vals)
14375 (cond
14376 ((equal property "TODO")
14377 (setq vals (org-with-point-at pom
14378 (append org-todo-keywords-1 '("")))))
14379 ((equal property "PRIORITY")
14380 (let ((n org-lowest-priority))
14381 (while (>= n org-highest-priority)
14382 (push (char-to-string n) vals)
14383 (setq n (1- n)))))
14384 ((member property org-special-properties))
14385 ((setq vals (run-hook-with-args-until-success
14386 'org-property-allowed-value-functions property)))
14387 (t
14388 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14390 (setq vals (car (read-from-string (concat "(" vals ")"))))
14391 (setq vals (mapcar (lambda (x)
14392 (cond ((stringp x) x)
14393 ((numberp x) (number-to-string x))
14394 ((symbolp x) (symbol-name x))
14395 (t "???")))
14396 vals)))))
14397 (when (member ":ETC" vals)
14398 (setq vals (remove ":ETC" vals))
14399 (org-add-props (car vals) '(org-unrestricted t)))
14400 (if table (mapcar 'list vals) vals)))
14402 (defun org-property-previous-allowed-value (&optional previous)
14403 "Switch to the next allowed value for this property."
14404 (interactive)
14405 (org-property-next-allowed-value t))
14407 (defun org-property-next-allowed-value (&optional previous)
14408 "Switch to the next allowed value for this property."
14409 (interactive)
14410 (unless (org-at-property-p)
14411 (error "Not at a property"))
14412 (let* ((key (match-string 2))
14413 (value (match-string 3))
14414 (allowed (or (org-property-get-allowed-values (point) key)
14415 (and (member value '("[ ]" "[-]" "[X]"))
14416 '("[ ]" "[X]"))))
14417 nval)
14418 (unless allowed
14419 (error "Allowed values for this property have not been defined"))
14420 (if previous (setq allowed (reverse allowed)))
14421 (if (member value allowed)
14422 (setq nval (car (cdr (member value allowed)))))
14423 (setq nval (or nval (car allowed)))
14424 (if (equal nval value)
14425 (error "Only one allowed value for this property"))
14426 (org-at-property-p)
14427 (replace-match (concat " :" key ": " nval) t t)
14428 (org-indent-line-function)
14429 (beginning-of-line 1)
14431 (run-hook-with-args 'org-property-changed-functions key nval)))
14433 (defun org-find-olp (path &optional this-buffer)
14434 "Return a marker pointing to the entry at outline path OLP.
14435 If anything goes wrong, throw an error.
14436 You can wrap this call to catch the error like this:
14438 (condition-case msg
14439 (org-mobile-locate-entry (match-string 4))
14440 (error (nth 1 msg)))
14442 The return value will then be either a string with the error message,
14443 or a marker if everything is OK.
14445 If THIS-BUFFER is set, the outline path does not contain a file,
14446 only headings."
14447 (let* ((file (if this-buffer buffer-file-name (pop path)))
14448 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14449 (level 1)
14450 (lmin 1)
14451 (lmax 1)
14452 limit re end found pos heading cnt flevel)
14453 (unless buffer (error "File not found :%s" file))
14454 (with-current-buffer buffer
14455 (save-excursion
14456 (save-restriction
14457 (widen)
14458 (setq limit (point-max))
14459 (goto-char (point-min))
14460 (while (setq heading (pop path))
14461 (setq re (format org-complex-heading-regexp-format
14462 (regexp-quote heading)))
14463 (setq cnt 0 pos (point))
14464 (while (re-search-forward re end t)
14465 (setq level (- (match-end 1) (match-beginning 1)))
14466 (if (and (>= level lmin) (<= level lmax))
14467 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14468 (when (= cnt 0) (error "Heading not found on level %d: %s"
14469 lmax heading))
14470 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14471 lmax heading))
14472 (goto-char found)
14473 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14474 (setq end (save-excursion (org-end-of-subtree t t))))
14475 (when (org-on-heading-p)
14476 (move-marker (make-marker) (point))))))))
14478 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14479 "Find node HEADING in BUFFER.
14480 Return a marker to the heading if it was found, or nil if not.
14481 If POS-ONLY is set, return just the position instead of a marker.
14483 The heading text must match exact, but it may have a TODO keyword,
14484 a priority cookie and tags in the standard locations."
14485 (with-current-buffer (or buffer (current-buffer))
14486 (save-excursion
14487 (save-restriction
14488 (widen)
14489 (goto-char (point-min))
14490 (let (case-fold-search)
14491 (if (re-search-forward
14492 (format org-complex-heading-regexp-format
14493 (regexp-quote heading)) nil t)
14494 (if pos-only
14495 (match-beginning 0)
14496 (move-marker (make-marker) (match-beginning 0)))))))))
14498 (defun org-find-exact-heading-in-directory (heading &optional dir)
14499 "Find Org node headline HEADING in all .org files in directory DIR.
14500 When the target headline is found, return a marker to this location."
14501 (let ((files (directory-files (or dir default-directory)
14503 file visiting m buffer)
14504 (catch 'found
14505 (while (setq file (pop files))
14506 (message "trying %s" file)
14507 (setq visiting (org-find-base-buffer-visiting file))
14508 (setq buffer (or visiting (find-file-noselect file)))
14509 (setq m (org-find-exact-headline-in-buffer
14510 heading buffer))
14511 (when (and (not m) (not visiting)) (kill-buffer buffer))
14512 (and m (throw 'found m))))))
14514 (defun org-find-entry-with-id (ident)
14515 "Locate the entry that contains the ID property with exact value IDENT.
14516 IDENT can be a string, a symbol or a number, this function will search for
14517 the string representation of it.
14518 Return the position where this entry starts, or nil if there is no such entry."
14519 (interactive "sID: ")
14520 (let ((id (cond
14521 ((stringp ident) ident)
14522 ((symbol-name ident) (symbol-name ident))
14523 ((numberp ident) (number-to-string ident))
14524 (t (error "IDENT %s must be a string, symbol or number" ident))))
14525 (case-fold-search nil))
14526 (save-excursion
14527 (save-restriction
14528 (widen)
14529 (goto-char (point-min))
14530 (when (re-search-forward
14532 nil t)
14533 (org-back-to-heading t)
14534 (point))))))
14536 ;;;; Timestamps
14538 (defvar org-last-changed-timestamp nil)
14539 (defvar org-last-inserted-timestamp nil
14540 "The last time stamp inserted with `org-insert-time-stamp'.")
14541 (defvar org-time-was-given) ; dynamically scoped parameter
14542 (defvar org-end-time-was-given) ; dynamically scoped parameter
14543 (defvar org-ts-what) ; dynamically scoped parameter
14545 (defun org-time-stamp (arg &optional inactive)
14546 "Prompt for a date/time and insert a time stamp.
14547 If the user specifies a time like HH:MM, or if this command is called
14548 with a prefix argument, the time stamp will contain date and time.
14549 Otherwise, only the date will be included. All parts of a date not
14550 specified by the user will be filled in from the current date/time.
14551 So if you press just return without typing anything, the time stamp
14552 will represent the current date/time. If there is already a timestamp
14553 at the cursor, it will be modified."
14554 (interactive "P")
14555 (let* ((ts nil)
14556 (default-time
14557 ;; Default time is either today, or, when entering a range,
14558 ;; the range start.
14559 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14560 (save-excursion
14561 (re-search-backward
14563 (- (point) 20) t)))
14564 (apply 'encode-time (org-parse-time-string (match-string 1)))
14565 (current-time)))
14566 (default-input (and ts (org-get-compact-tod ts)))
14567 (repeater (save-excursion
14568 (save-match-data
14569 (beginning-of-line)
14570 (when (re-search-forward
14572 (save-excursion (progn (end-of-line) (point))) t)
14573 (match-string 0)))))
14574 org-time-was-given org-end-time-was-given time)
14575 (cond
14576 ((and (org-at-timestamp-p t)
14577 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14578 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14579 (insert "--")
14580 (setq time (let ((this-command this-command))
14581 (org-read-date arg 'totime nil nil
14582 default-time default-input)))
14583 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14584 ((org-at-timestamp-p t)
14585 (setq time (let ((this-command this-command))
14586 (org-read-date arg 'totime nil nil default-time default-input)))
14587 (when (org-at-timestamp-p t) ; just to get the match data
14588 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14589 (replace-match "")
14590 (setq org-last-changed-timestamp
14591 (org-insert-time-stamp
14592 time (or org-time-was-given arg)
14593 inactive nil nil (list org-end-time-was-given)))
14594 (when repeater (goto-char (1- (point))) (insert " " repeater)
14595 (setq org-last-changed-timestamp
14596 (concat (substring org-last-inserted-timestamp 0 -1)
14597 " " repeater ">"))))
14598 (message "Timestamp updated"))
14599 (t
14600 (setq time (let ((this-command this-command))
14601 (org-read-date arg 'totime nil nil default-time default-input)))
14602 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14603 nil nil (list org-end-time-was-given))))))
14605 ;; FIXME: can we use this for something else, like computing time differences?
14606 (defun org-get-compact-tod (s)
14607 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14608 (let* ((t1 (match-string 1 s))
14609 (h1 (string-to-number (match-string 2 s)))
14610 (m1 (string-to-number (match-string 3 s)))
14611 (t2 (and (match-end 4) (match-string 5 s)))
14612 (h2 (and t2 (string-to-number (match-string 6 s))))
14613 (m2 (and t2 (string-to-number (match-string 7 s))))
14614 dh dm)
14615 (if (not t2)
14616 t1
14617 (setq dh (- h2 h1) dm (- m2 m1))
14618 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14619 (concat t1 "+" (number-to-string dh)
14620 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14622 (defun org-time-stamp-inactive (&optional arg)
14623 "Insert an inactive time stamp.
14624 An inactive time stamp is enclosed in square brackets instead of angle
14625 brackets. It is inactive in the sense that it does not trigger agenda entries,
14626 does not link to the calendar and cannot be changed with the S-cursor keys.
14627 So these are more for recording a certain time/date."
14628 (interactive "P")
14629 (org-time-stamp arg 'inactive))
14631 (defvar org-date-ovl (make-overlay 1 1))
14632 (overlay-put org-date-ovl 'face 'org-warning)
14633 (org-detach-overlay org-date-ovl)
14635 (defvar org-ans1) ; dynamically scoped parameter
14636 (defvar org-ans2) ; dynamically scoped parameter
14638 (defvar org-plain-time-of-day-regexp) ; defined below
14640 (defvar org-overriding-default-time nil) ; dynamically scoped
14641 (defvar org-read-date-overlay nil)
14642 (defvar org-dcst nil) ; dynamically scoped
14643 (defvar org-read-date-history nil)
14644 (defvar org-read-date-final-answer nil)
14645 (defvar org-read-date-analyze-futurep nil)
14646 (defvar org-read-date-analyze-forced-year nil)
14648 (defun org-read-date (&optional with-time to-time from-string prompt
14649 default-time default-input)
14650 "Read a date, possibly a time, and make things smooth for the user.
14651 The prompt will suggest to enter an ISO date, but you can also enter anything
14652 which will at least partially be understood by `parse-time-string'.
14653 Unrecognized parts of the date will default to the current day, month, year,
14654 hour and minute. If this command is called to replace a timestamp at point,
14655 of to enter the second timestamp of a range, the default time is taken
14656 from the existing stamp. Furthermore, the command prefers the future,
14657 so if you are giving a date where the year is not given, and the day-month
14658 combination is already past in the current year, it will assume you
14659 mean next year. For details, see the manual. A few examples:
14661 3-2-5 --> 2003-02-05
14662 feb 15 --> currentyear-02-15
14663 2/15 --> currentyear-02-15
14664 sep 12 9 --> 2009-09-12
14665 12:45 --> today 12:45
14666 22 sept 0:34 --> currentyear-09-22 0:34
14667 12 --> currentyear-currentmonth-12
14668 Fri --> nearest Friday (today or later)
14669 etc.
14671 Furthermore you can specify a relative date by giving, as the *first* thing
14672 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14673 change in days weeks, months, years.
14674 With a single plus or minus, the date is relative to today. With a double
14675 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14676 +4d --> four days from today
14677 +4 --> same as above
14678 +2w --> two weeks from today
14679 ++5 --> five days from default date
14681 The function understands only English month and weekday abbreviations,
14682 but this can be configured with the variables `parse-time-months' and
14683 `parse-time-weekdays'.
14685 While prompting, a calendar is popped up - you can also select the
14686 date with the mouse (button 1). The calendar shows a period of three
14687 months. To scroll it to other months, use the keys `>' and `<'.
14688 If you don't like the calendar, turn it off with
14689 \(setq org-read-date-popup-calendar nil)
14691 With optional argument TO-TIME, the date will immediately be converted
14692 to an internal time.
14693 With an optional argument WITH-TIME, the prompt will suggest to also
14694 insert a time. Note that when WITH-TIME is not set, you can still
14695 enter a time, and this function will inform the calling routine about
14696 this change. The calling routine may then choose to change the format
14697 used to insert the time stamp into the buffer to include the time.
14698 With optional argument FROM-STRING, read from this string instead from
14699 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14700 the time/date that is used for everything that is not specified by the
14701 user."
14702 (require 'parse-time)
14703 (let* ((org-time-stamp-rounding-minutes
14704 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14705 (org-dcst org-display-custom-times)
14706 (ct (org-current-time))
14707 (def (or org-overriding-default-time default-time ct))
14708 (defdecode (decode-time def))
14709 (dummy (progn
14710 (when (< (nth 2 defdecode) org-extend-today-until)
14711 (setcar (nthcdr 2 defdecode) -1)
14712 (setcar (nthcdr 1 defdecode) 59)
14713 (setq def (apply 'encode-time defdecode)
14714 defdecode (decode-time def)))))
14715 (calendar-frame-setup nil)
14716 (calendar-setup nil)
14717 (calendar-move-hook nil)
14718 (calendar-view-diary-initially-flag nil)
14719 (calendar-view-holidays-initially-flag nil)
14720 (timestr (format-time-string
14721 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14722 (prompt (concat (if prompt (concat prompt " ") "")
14723 (format "Date+time [%s]: " timestr)))
14724 ans (org-ans0 "") org-ans1 org-ans2 final)
14726 (cond
14727 (from-string (setq ans from-string))
14728 (org-read-date-popup-calendar
14729 (save-excursion
14730 (save-window-excursion
14731 (calendar)
14732 (unwind-protect
14733 (progn
14734 (calendar-forward-day (- (time-to-days def)
14735 (calendar-absolute-from-gregorian
14736 (calendar-current-date))))
14737 (org-eval-in-calendar nil t)
14738 (let* ((old-map (current-local-map))
14739 (map (copy-keymap calendar-mode-map))
14740 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14741 (org-defkey map (kbd "RET") 'org-calendar-select)
14742 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14743 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14744 (org-defkey minibuffer-local-map [(meta shift left)]
14745 (lambda () (interactive)
14746 (org-eval-in-calendar '(calendar-backward-month 1))))
14747 (org-defkey minibuffer-local-map [(meta shift right)]
14748 (lambda () (interactive)
14749 (org-eval-in-calendar '(calendar-forward-month 1))))
14750 (org-defkey minibuffer-local-map [(meta shift up)]
14751 (lambda () (interactive)
14752 (org-eval-in-calendar '(calendar-backward-year 1))))
14753 (org-defkey minibuffer-local-map [(meta shift down)]
14754 (lambda () (interactive)
14755 (org-eval-in-calendar '(calendar-forward-year 1))))
14756 (org-defkey minibuffer-local-map [?\e (shift left)]
14757 (lambda () (interactive)
14758 (org-eval-in-calendar '(calendar-backward-month 1))))
14759 (org-defkey minibuffer-local-map [?\e (shift right)]
14760 (lambda () (interactive)
14761 (org-eval-in-calendar '(calendar-forward-month 1))))
14762 (org-defkey minibuffer-local-map [?\e (shift up)]
14763 (lambda () (interactive)
14764 (org-eval-in-calendar '(calendar-backward-year 1))))
14765 (org-defkey minibuffer-local-map [?\e (shift down)]
14766 (lambda () (interactive)
14767 (org-eval-in-calendar '(calendar-forward-year 1))))
14768 (org-defkey minibuffer-local-map [(shift up)]
14769 (lambda () (interactive)
14770 (org-eval-in-calendar '(calendar-backward-week 1))))
14771 (org-defkey minibuffer-local-map [(shift down)]
14772 (lambda () (interactive)
14773 (org-eval-in-calendar '(calendar-forward-week 1))))
14774 (org-defkey minibuffer-local-map [(shift left)]
14775 (lambda () (interactive)
14776 (org-eval-in-calendar '(calendar-backward-day 1))))
14777 (org-defkey minibuffer-local-map [(shift right)]
14778 (lambda () (interactive)
14779 (org-eval-in-calendar '(calendar-forward-day 1))))
14780 (org-defkey minibuffer-local-map ">"
14781 (lambda () (interactive)
14782 (org-eval-in-calendar '(scroll-calendar-left 1))))
14783 (org-defkey minibuffer-local-map "<"
14784 (lambda () (interactive)
14785 (org-eval-in-calendar '(scroll-calendar-right 1))))
14786 (org-defkey minibuffer-local-map "\C-v"
14787 (lambda () (interactive)
14788 (org-eval-in-calendar
14789 '(calendar-scroll-left-three-months 1))))
14790 (org-defkey minibuffer-local-map "\M-v"
14791 (lambda () (interactive)
14792 (org-eval-in-calendar
14793 '(calendar-scroll-right-three-months 1))))
14794 (run-hooks 'org-read-date-minibuffer-setup-hook)
14795 (unwind-protect
14796 (progn
14797 (use-local-map map)
14798 (add-hook 'post-command-hook 'org-read-date-display)
14799 (setq org-ans0 (read-string prompt default-input
14800 'org-read-date-history nil))
14801 ;; org-ans0: from prompt
14802 ;; org-ans1: from mouse click
14803 ;; org-ans2: from calendar motion
14804 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14805 (remove-hook 'post-command-hook 'org-read-date-display)
14806 (use-local-map old-map)
14807 (when org-read-date-overlay
14808 (delete-overlay org-read-date-overlay)
14809 (setq org-read-date-overlay nil)))))
14810 (bury-buffer "*Calendar*")))))
14812 (t ; Naked prompt only
14813 (unwind-protect
14814 (setq ans (read-string prompt default-input
14815 'org-read-date-history timestr))
14816 (when org-read-date-overlay
14817 (delete-overlay org-read-date-overlay)
14818 (setq org-read-date-overlay nil)))))
14820 (setq final (org-read-date-analyze ans def defdecode))
14822 (when org-read-date-analyze-forced-year
14823 (message "Year was forced into %s"
14824 (if org-read-date-force-compatible-dates
14825 "compatible range (1970-2037)"
14826 "range representable on this machine"))
14827 (ding))
14829 ;; One round trip to get rid of 34th of August and stuff like that....
14830 (setq final (decode-time (apply 'encode-time final)))
14832 (setq org-read-date-final-answer ans)
14834 (if to-time
14835 (apply 'encode-time final)
14836 (if (and (boundp 'org-time-was-given) org-time-was-given)
14837 (format "%04d-%02d-%02d %02d:%02d"
14838 (nth 5 final) (nth 4 final) (nth 3 final)
14839 (nth 2 final) (nth 1 final))
14840 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14842 (defvar def)
14843 (defvar defdecode)
14844 (defvar with-time)
14845 (defun org-read-date-display ()
14846 "Display the current date prompt interpretation in the minibuffer."
14847 (when org-read-date-display-live
14848 (when org-read-date-overlay
14849 (delete-overlay org-read-date-overlay))
14850 (let ((p (point)))
14851 (end-of-line 1)
14852 (while (not (equal (buffer-substring
14853 (max (point-min) (- (point) 4)) (point))
14854 " "))
14855 (insert " "))
14856 (goto-char p))
14857 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14858 " " (or org-ans1 org-ans2)))
14859 (org-end-time-was-given nil)
14860 (f (org-read-date-analyze ans def defdecode))
14861 (fmts (if org-dcst
14862 org-time-stamp-custom-formats
14863 org-time-stamp-formats))
14864 (fmt (if (or with-time
14865 (and (boundp 'org-time-was-given) org-time-was-given))
14866 (cdr fmts)
14867 (car fmts)))
14868 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14869 (when (and org-end-time-was-given
14870 (string-match org-plain-time-of-day-regexp txt))
14871 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14872 org-end-time-was-given
14873 (substring txt (match-end 0)))))
14874 (when org-read-date-analyze-futurep
14875 (setq txt (concat txt " (=>F)")))
14876 (setq org-read-date-overlay
14877 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14878 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14880 (defun org-read-date-analyze (ans def defdecode)
14881 "Analyze the combined answer of the date prompt."
14882 ;; FIXME: cleanup and comment
14883 (let ((nowdecode (decode-time (current-time)))
14884 delta deltan deltaw deltadef year month day
14885 hour minute second wday pm h2 m2 tl wday1
14886 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14887 (setq org-read-date-analyze-futurep nil
14888 org-read-date-analyze-forced-year nil)
14890 (setq ans "+0"))
14892 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14893 (setq ans (replace-match "" t t ans)
14894 deltan (car delta)
14895 deltaw (nth 1 delta)
14896 deltadef (nth 2 delta)))
14898 ;; Check if there is an iso week date in there
14899 ;; If yes, store the info and postpone interpreting it until the rest
14900 ;; of the parsing is done
14901 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14902 (setq iso-year (if (match-end 1)
14903 (org-small-year-to-year
14904 (string-to-number (match-string 1 ans))))
14905 iso-weekday (if (match-end 3)
14906 (string-to-number (match-string 3 ans)))
14907 iso-week (string-to-number (match-string 2 ans)))
14908 (setq ans (replace-match "" t t ans)))
14910 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14911 (when (string-match
14913 (setq year (if (match-end 2)
14914 (string-to-number (match-string 2 ans))
14915 (progn (setq kill-year t)
14916 (string-to-number (format-time-string "%Y"))))
14917 month (string-to-number (match-string 3 ans))
14918 day (string-to-number (match-string 4 ans)))
14919 (if (< year 100) (setq year (+ 2000 year)))
14921 t nil ans)))
14923 ;; Help matching dottet european dates
14924 (when (string-match
14925 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14926 (setq year (if (match-end 3)
14927 (string-to-number (match-string 3 ans))
14928 (progn (setq kill-year t)
14929 (string-to-number (format-time-string "%Y"))))
14930 day (string-to-number (match-string 1 ans))
14931 month (string-to-number (match-string 2 ans))
14933 t nil ans)))
14935 ;; Help matching american dates, like 5/30 or 5/30/7
14936 (when (string-match
14937 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14938 (setq year (if (match-end 4)
14939 (string-to-number (match-string 4 ans))
14940 (progn (setq kill-year t)
14941 (string-to-number (format-time-string "%Y"))))
14942 month (string-to-number (match-string 1 ans))
14943 day (string-to-number (match-string 2 ans)))
14944 (if (< year 100) (setq year (+ 2000 year)))
14946 t nil ans)))
14947 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14948 ;; If there is a time with am/pm, and *no* time without it, we convert
14949 ;; so that matching will be successful.
14950 (loop for i from 1 to 2 do ; twice, for end time as well
14953 (setq hour (string-to-number (match-string 1 ans))
14954 minute (if (match-end 3)
14955 (string-to-number (match-string 3 ans))
14956 0)
14957 pm (equal ?p
14958 (string-to-char (downcase (match-string 4 ans)))))
14959 (if (and (= hour 12) (not pm))
14960 (setq hour 0)
14961 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14962 (setq ans (replace-match (format "%02d:%02d" hour minute)
14963 t t ans))))
14965 ;; Check if a time range is given as a duration
14966 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14967 (setq hour (string-to-number (match-string 1 ans))
14968 h2 (+ hour (string-to-number (match-string 3 ans)))
14969 minute (string-to-number (match-string 2 ans))
14970 m2 (+ minute (if (match-end 5) (string-to-number
14971 (match-string 5 ans))0)))
14972 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14973 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14974 t t ans)))
14976 ;; Check if there is a time range
14977 (when (boundp 'org-end-time-was-given)
14978 (setq org-time-was-given nil)
14979 (when (and (string-match org-plain-time-of-day-regexp ans)
14980 (match-end 8))
14981 (setq org-end-time-was-given (match-string 8 ans))
14982 (setq ans (concat (substring ans 0 (match-beginning 7))
14983 (substring ans (match-end 7))))))
14985 (setq tl (parse-time-string ans)
14986 day (or (nth 3 tl) (nth 3 defdecode))
14987 month (or (nth 4 tl)
14988 (if (and org-read-date-prefer-future
14989 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14990 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14991 (nth 4 defdecode)))
14992 year (or (and (not kill-year) (nth 5 tl))
14993 (if (and org-read-date-prefer-future
14994 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14995 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14996 (nth 5 defdecode)))
14997 hour (or (nth 2 tl) (nth 2 defdecode))
14998 minute (or (nth 1 tl) (nth 1 defdecode))
14999 second (or (nth 0 tl) 0)
15000 wday (nth 6 tl))
15002 (when (and (eq org-read-date-prefer-future 'time)
15003 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15004 (equal day (nth 3 nowdecode))
15005 (equal month (nth 4 nowdecode))
15006 (equal year (nth 5 nowdecode))
15007 (nth 2 tl)
15008 (or (< (nth 2 tl) (nth 2 nowdecode))
15009 (and (= (nth 2 tl) (nth 2 nowdecode))
15010 (nth 1 tl)
15011 (< (nth 1 tl) (nth 1 nowdecode)))))
15012 (setq day (1+ day)
15013 futurep t))
15015 ;; Special date definitions below
15016 (cond
15017 (iso-week
15018 ;; There was an iso week
15019 (require 'cal-iso)
15020 (setq futurep nil)
15021 (setq year (or iso-year year)
15022 day (or iso-weekday wday 1)
15023 wday nil ; to make sure that the trigger below does not match
15024 iso-date (calendar-gregorian-from-absolute
15025 (calendar-absolute-from-iso
15026 (list iso-week day year))))
15027 ; FIXME: Should we also push ISO weeks into the future?
15028 ; (when (and org-read-date-prefer-future
15029 ; (not iso-year)
15030 ; (< (calendar-absolute-from-gregorian iso-date)
15031 ; (time-to-days (current-time))))
15032 ; (setq year (1+ year)
15033 ; iso-date (calendar-gregorian-from-absolute
15034 ; (calendar-absolute-from-iso
15035 ; (list iso-week day year)))))
15036 (setq month (car iso-date)
15037 year (nth 2 iso-date)
15038 day (nth 1 iso-date)))
15039 (deltan
15040 (setq futurep nil)
15041 (unless deltadef
15042 (let ((now (decode-time (current-time))))
15043 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15044 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15045 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15046 ((equal deltaw "m") (setq month (+ month deltan)))
15047 ((equal deltaw "y") (setq year (+ year deltan)))))
15048 ((and wday (not (nth 3 tl)))
15049 (setq futurep nil)
15050 ;; Weekday was given, but no day, so pick that day in the week
15051 ;; on or after the derived date.
15052 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15053 (unless (equal wday wday1)
15054 (setq day (+ day (% (- wday wday1 -7) 7))))))
15055 (if (and (boundp 'org-time-was-given)
15056 (nth 2 tl))
15057 (setq org-time-was-given t))
15058 (if (< year 100) (setq year (+ 2000 year)))
15059 ;; Check of the date is representable
15060 (if org-read-date-force-compatible-dates
15061 (progn
15062 (if (< year 1970)
15063 (setq year 1970 org-read-date-analyze-forced-year t))
15064 (if (> year 2037)
15065 (setq year 2037 org-read-date-analyze-forced-year t)))
15066 (condition-case nil
15067 (ignore (encode-time second minute hour day month year))
15068 (error
15069 (setq year (nth 5 defdecode))
15070 (setq org-read-date-analyze-forced-year t))))
15071 (setq org-read-date-analyze-futurep futurep)
15072 (list second minute hour day month year)))
15074 (defvar parse-time-weekdays)
15076 (defun org-read-date-get-relative (s today default)
15077 "Check string S for special relative date string.
15078 TODAY and DEFAULT are internal times, for today and for a default.
15079 Return shift list (N what def-flag)
15081 N is the number of WHATs to shift.
15082 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15083 the DEFAULT date rather than TODAY."
15084 (when (and
15085 (string-match
15086 (concat
15091 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15092 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15093 (string-to-char (substring (match-string 1 s) -1))
15094 ?+))
15095 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15096 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15097 (what (if (match-end 3) (match-string 3 s) "d"))
15098 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15099 (date (if rel default today))
15100 (wday (nth 6 (decode-time date)))
15101 delta)
15102 (if wday1
15103 (progn
15104 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15105 (if (= dir ?-) (setq delta (- delta 7)))
15106 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15107 (list delta "d" rel))
15108 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15110 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15111 "Turn a user-specified date into the internal representation.
15112 The internal representation needed by the calendar is (month day year).
15113 This is a wrapper to handle the brain-dead convention in calendar that
15114 user function argument order change dependent on argument order."
15115 (if (boundp 'calendar-date-style)
15116 (cond
15117 ((eq calendar-date-style 'american)
15118 (list arg1 arg2 arg3))
15119 ((eq calendar-date-style 'european)
15120 (list arg2 arg1 arg3))
15121 ((eq calendar-date-style 'iso)
15122 (list arg2 arg3 arg1)))
15123 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15124 (if (org-bound-and-true-p european-calendar-style)
15125 (list arg2 arg1 arg3)
15126 (list arg1 arg2 arg3)))))
15128 (defun org-eval-in-calendar (form &optional keepdate)
15129 "Eval FORM in the calendar window and return to current window.
15130 Also, store the cursor date in variable org-ans2."
15131 (let ((sf (selected-frame))
15132 (sw (selected-window)))
15133 (select-window (get-buffer-window "*Calendar*" t))
15134 (eval form)
15135 (when (and (not keepdate) (calendar-cursor-to-date))
15136 (let* ((date (calendar-cursor-to-date))
15137 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15138 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15139 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15140 (select-window sw)
15141 (org-select-frame-set-input-focus sf)))
15143 (defun org-calendar-select ()
15144 "Return to `org-read-date' with the date currently selected.
15145 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15146 (interactive)
15147 (when (calendar-cursor-to-date)
15148 (let* ((date (calendar-cursor-to-date))
15149 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15150 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15151 (if (active-minibuffer-window) (exit-minibuffer))))
15153 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15154 "Insert a date stamp for the date given by the internal TIME.
15155 WITH-HM means use the stamp format that includes the time of the day.
15156 INACTIVE means use square brackets instead of angular ones, so that the
15157 stamp will not contribute to the agenda.
15158 PRE and POST are optional strings to be inserted before and after the
15159 stamp.
15160 The command returns the inserted time stamp."
15161 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15162 stamp)
15163 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15164 (insert-before-markers (or pre ""))
15165 (when (listp extra)
15166 (setq extra (car extra))
15167 (if (and (stringp extra)
15169 (setq extra (format "-%02d:%02d"
15170 (string-to-number (match-string 1 extra))
15171 (string-to-number (match-string 2 extra))))
15172 (setq extra nil)))
15173 (when extra
15174 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15175 (insert-before-markers (setq stamp (format-time-string fmt time)))
15176 (insert-before-markers (or post ""))
15177 (setq org-last-inserted-timestamp stamp)))
15179 (defun org-toggle-time-stamp-overlays ()
15180 "Toggle the use of custom time stamp formats."
15181 (interactive)
15182 (setq org-display-custom-times (not org-display-custom-times))
15183 (unless org-display-custom-times
15184 (let ((p (point-min)) (bmp (buffer-modified-p)))
15185 (while (setq p (next-single-property-change p 'display))
15186 (if (and (get-text-property p 'display)
15187 (eq (get-text-property p 'face) 'org-date))
15188 (remove-text-properties
15189 p (setq p (next-single-property-change p 'display))
15190 '(display t))))
15191 (set-buffer-modified-p bmp)))
15192 (if (featurep 'xemacs)
15193 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15194 (org-restart-font-lock)
15195 (setq org-table-may-need-update t)
15196 (if org-display-custom-times
15197 (message "Time stamps are overlayed with custom format")
15198 (message "Time stamp overlays removed")))
15200 (defun org-display-custom-time (beg end)
15201 "Overlay modified time stamp format over timestamp between BEG and END."
15202 (let* ((ts (buffer-substring beg end))
15203 t1 w1 with-hm tf time str w2 (off 0))
15204 (save-match-data
15205 (setq t1 (org-parse-time-string ts t))
15206 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15207 (setq off (- (match-end 0) (match-beginning 0)))))
15208 (setq end (- end off))
15209 (setq w1 (- end beg)
15210 with-hm (and (nth 1 t1) (nth 2 t1))
15211 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15212 time (org-fix-decoded-time t1)
15213 str (org-add-props
15214 (format-time-string
15215 (substring tf 1 -1) (apply 'encode-time time))
15216 nil 'mouse-face 'highlight)
15217 w2 (length str))
15218 (if (not (= w2 w1))
15219 (add-text-properties (1+ beg) (+ 2 beg)
15220 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15221 (if (featurep 'xemacs)
15222 (progn
15223 (put-text-property beg end 'invisible t)
15224 (put-text-property beg end 'end-glyph (make-glyph str)))
15225 (put-text-property beg end 'display str))))
15227 (defun org-translate-time (string)
15228 "Translate all timestamps in STRING to custom format.
15229 But do this only if the variable `org-display-custom-times' is set."
15230 (when org-display-custom-times
15231 (save-match-data
15232 (let* ((start 0)
15233 (re org-ts-regexp-both)
15234 t1 with-hm inactive tf time str beg end)
15235 (while (setq start (string-match re string start))
15236 (setq beg (match-beginning 0)
15237 end (match-end 0)
15238 t1 (save-match-data
15239 (org-parse-time-string (substring string beg end) t))
15240 with-hm (and (nth 1 t1) (nth 2 t1))
15241 inactive (equal (substring string beg (1+ beg)) "[")
15242 tf (funcall (if with-hm 'cdr 'car)
15243 org-time-stamp-custom-formats)
15244 time (org-fix-decoded-time t1)
15245 str (format-time-string
15246 (concat
15247 (if inactive "[" "<") (substring tf 1 -1)
15248 (if inactive "]" ">"))
15249 (apply 'encode-time time))
15250 string (replace-match str t t string)
15251 start (+ start (length str)))))))
15252 string)
15254 (defun org-fix-decoded-time (time)
15255 "Set 0 instead of nil for the first 6 elements of time.
15256 Don't touch the rest."
15257 (let ((n 0))
15258 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15260 (defun org-days-to-time (timestamp-string)
15261 "Difference between TIMESTAMP-STRING and now in days."
15262 (- (time-to-days (org-time-string-to-time timestamp-string))
15263 (time-to-days (current-time))))
15265 (defun org-deadline-close (timestamp-string &optional ndays)
15266 "Is the time in TIMESTAMP-STRING close to the current date?"
15267 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15268 (and (< (org-days-to-time timestamp-string) ndays)
15269 (not (org-entry-is-done-p))))
15271 (defun org-get-wdays (ts)
15272 "Get the deadline lead time appropriate for timestring TS."
15273 (cond
15274 ((<= org-deadline-warning-days 0)
15275 ;; 0 or negative, enforce this value no matter what
15276 (- org-deadline-warning-days))
15278 ;; lead time is specified.
15279 (floor (* (string-to-number (match-string 1 ts))
15280 (cdr (assoc (match-string 2 ts)
15281 '(("d" . 1) ("w" . 7)
15282 ("m" . 30.4) ("y" . 365.25)))))))
15283 ;; go for the default.
15284 (t org-deadline-warning-days)))
15286 (defun org-calendar-select-mouse (ev)
15287 "Return to `org-read-date' with the date currently selected.
15288 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15289 (interactive "e")
15290 (mouse-set-point ev)
15291 (when (calendar-cursor-to-date)
15292 (let* ((date (calendar-cursor-to-date))
15293 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15294 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15295 (if (active-minibuffer-window) (exit-minibuffer))))
15297 (defun org-check-deadlines (ndays)
15298 "Check if there are any deadlines due or past due.
15299 A deadline is considered due if it happens within `org-deadline-warning-days'
15300 days from today's date. If the deadline appears in an entry marked DONE,
15301 it is not shown. The prefix arg NDAYS can be used to test that many
15303 (interactive "P")
15304 (let* ((org-warn-days
15305 (cond
15306 ((equal ndays '(4)) 100000)
15307 (ndays (prefix-numeric-value ndays))
15308 (t (abs org-deadline-warning-days))))
15309 (case-fold-search nil)
15311 (callback
15312 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15314 (message "%d deadlines past-due or due within %d days"
15315 (org-occur regexp nil callback)
15316 org-warn-days)))
15318 (defun org-check-before-date (date)
15319 "Check if there are deadlines or scheduled entries before DATE."
15320 (interactive (list (org-read-date)))
15321 (let ((case-fold-search nil)
15325 (callback
15326 (lambda () (time-less-p
15327 (org-time-string-to-time (match-string 2))
15328 (org-time-string-to-time date)))))
15329 (message "%d entries before %s"
15330 (org-occur regexp nil callback) date)))
15332 (defun org-check-after-date (date)
15333 "Check if there are deadlines or scheduled entries after DATE."
15334 (interactive (list (org-read-date)))
15335 (let ((case-fold-search nil)
15339 (callback
15340 (lambda () (not
15341 (time-less-p
15342 (org-time-string-to-time (match-string 2))
15343 (org-time-string-to-time date))))))
15344 (message "%d entries after %s"
15345 (org-occur regexp nil callback) date)))
15347 (defun org-evaluate-time-range (&optional to-buffer)
15348 "Evaluate a time range by computing the difference between start and end.
15349 Normally the result is just printed in the echo area, but with prefix arg
15350 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15351 If the time range is actually in a table, the result is inserted into the
15352 next column.
15353 For time difference computation, a year is assumed to be exactly 365
15354 days in order to avoid rounding problems."
15355 (interactive "P")
15356 (or
15357 (org-clock-update-time-maybe)
15358 (save-excursion
15359 (unless (org-at-date-range-p t)
15360 (goto-char (point-at-bol))
15361 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15362 (if (not (org-at-date-range-p t))
15363 (error "Not at a time-stamp range, and none found in current line")))
15364 (let* ((ts1 (match-string 1))
15365 (ts2 (match-string 2))
15366 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15367 (match-end (match-end 0))
15368 (time1 (org-time-string-to-time ts1))
15369 (time2 (org-time-string-to-time ts2))
15370 (t1 (org-float-time time1))
15371 (t2 (org-float-time time2))
15372 (diff (abs (- t2 t1)))
15373 (negative (< (- t2 t1) 0))
15374 ;; (ys (floor (* 365 24 60 60)))
15375 (ds (* 24 60 60))
15376 (hs (* 60 60))
15377 (fy "%dy %dd %02d:%02d")
15378 (fy1 "%dy %dd")
15379 (fd "%dd %02d:%02d")
15380 (fd1 "%dd")
15381 (fh "%02d:%02d")
15382 y d h m align)
15383 (if havetime
15384 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15385 y 0
15386 d (floor (/ diff ds)) diff (mod diff ds)
15387 h (floor (/ diff hs)) diff (mod diff hs)
15388 m (floor (/ diff 60)))
15389 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15390 y 0
15391 d (floor (+ (/ diff ds) 0.5))
15392 h 0 m 0))
15393 (if (not to-buffer)
15394 (message "%s" (org-make-tdiff-string y d h m))
15395 (if (org-at-table-p)
15396 (progn
15397 (goto-char match-end)
15398 (setq align t)
15399 (and (looking-at " *|") (goto-char (match-end 0))))
15400 (goto-char match-end))
15401 (if (looking-at
15403 (replace-match ""))
15404 (if negative (insert " -"))
15405 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15406 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15407 (insert " " (format fh h m))))
15408 (if align (org-table-align))
15409 (message "Time difference inserted")))))
15411 (defun org-make-tdiff-string (y d h m)
15412 (let ((fmt "")
15413 (l nil))
15414 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15415 l (push y l)))
15416 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15417 l (push d l)))
15418 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15419 l (push h l)))
15420 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15421 l (push m l)))
15422 (apply 'format fmt (nreverse l))))
15424 (defun org-time-string-to-time (s)
15425 (apply 'encode-time (org-parse-time-string s)))
15426 (defun org-time-string-to-seconds (s)
15427 (org-float-time (org-time-string-to-time s)))
15429 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15430 "Convert a time stamp to an absolute day number.
15431 If there is a specifier for a cyclic time stamp, get the closest date to
15432 DAYNR.
15433 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15434 The variable date is bound by the calendar when this is called."
15435 (cond
15437 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15438 daynr
15439 (+ daynr 1000)))
15441 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15442 (time-to-days (current-time))) (match-string 0 s)
15443 prefer show-all))
15444 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15446 (defun org-days-to-iso-week (days)
15447 "Return the iso week number."
15448 (require 'cal-iso)
15449 (car (calendar-iso-from-absolute days)))
15451 (defun org-small-year-to-year (year)
15452 "Convert 2-digit years into 4-digit years.
15453 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15454 The year 2000 cannot be abbreviated. Any year larger than 99
15455 is returned unchanged."
15456 (if (< year 38)
15457 (setq year (+ 2000 year))
15458 (if (< year 100)
15459 (setq year (+ 1900 year))))
15460 year)
15462 (defun org-time-from-absolute (d)
15463 "Return the time corresponding to date D.
15464 D may be an absolute day number, or a calendar-type list (month day year)."
15465 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15466 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15468 (defun org-calendar-holiday ()
15469 "List of holidays, for Diary display in Org-mode."
15470 (require 'holidays)
15471 (let ((hl (funcall
15472 (if (fboundp 'calendar-check-holidays)
15473 'calendar-check-holidays 'check-calendar-holidays) date)))
15474 (if hl (mapconcat 'identity hl "; "))))
15476 (defun org-diary-sexp-entry (sexp entry date)
15477 "Process a SEXP diary ENTRY for DATE."
15478 (require 'diary-lib)
15479 (let ((result (if calendar-debug-sexp
15480 (let ((stack-trace-on-error t))
15481 (eval (car (read-from-string sexp))))
15482 (condition-case nil
15483 (eval (car (read-from-string sexp)))
15484 (error
15485 (beep)
15486 (message "Bad sexp at line %d in %s: %s"
15487 (org-current-line)
15488 (buffer-file-name) sexp)
15489 (sleep-for 2))))))
15490 (cond ((stringp result) (split-string result "; "))
15491 ((and (consp result)
15492 (not (consp (cdr result)))
15493 (stringp (cdr result))) (cdr result))
15494 ((and (consp result)
15495 (stringp (car result))) result)
15496 (result entry)
15497 (t nil))))
15499 (defun org-diary-to-ical-string (frombuf)
15500 "Get iCalendar entries from diary entries in buffer FROMBUF.
15501 This uses the icalendar.el library."
15502 (let* ((tmpdir (if (featurep 'xemacs)
15503 (temp-directory)
15504 temporary-file-directory))
15505 (tmpfile (make-temp-name
15506 (expand-file-name "orgics" tmpdir)))
15507 buf rtn b e)
15508 (with-current-buffer frombuf
15509 (icalendar-export-region (point-min) (point-max) tmpfile)
15510 (setq buf (find-buffer-visiting tmpfile))
15511 (set-buffer buf)
15512 (goto-char (point-min))
15513 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15514 (setq b (match-beginning 0)))
15515 (goto-char (point-max))
15516 (if (re-search-backward "^END:VEVENT" nil t)
15517 (setq e (match-end 0)))
15519 (kill-buffer buf)
15520 (delete-file tmpfile)
15521 rtn))
15523 (defun org-closest-date (start current change prefer show-all)
15524 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15525 When PREFER is `past', return a date that is either CURRENT or past.
15526 When PREFER is `future', return a date that is either CURRENT or future.
15527 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15528 ;; Make the proper lists from the dates
15529 (catch 'exit
15530 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15531 dn dw sday cday n1 n2 n0
15532 d m y y1 y2 date1 date2 nmonths nm ny m2)
15534 (setq start (org-date-to-gregorian start)
15535 current (org-date-to-gregorian
15536 (if show-all
15537 current
15538 (time-to-days (current-time))))
15539 sday (calendar-absolute-from-gregorian start)
15540 cday (calendar-absolute-from-gregorian current))
15542 (if (<= cday sday) (throw 'exit sday))
15545 (setq dn (string-to-number (match-string 1 change))
15546 dw (cdr (assoc (match-string 2 change) a1)))
15547 (error "Invalid change specifier: %s" change))
15548 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15549 (cond
15550 ((eq dw 'day)
15551 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15552 n2 (+ n1 dn)))
15553 ((eq dw 'year)
15554 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15555 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15556 (setq date1 (list m d y1)
15557 n1 (calendar-absolute-from-gregorian date1)
15558 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15559 n2 (calendar-absolute-from-gregorian date2)))
15560 ((eq dw 'month)
15561 ;; approx number of month between the two dates
15562 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15563 ;; How often does dn fit in there?
15564 (setq d (nth 1 start) m (car start) y (nth 2 start)
15565 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15566 m (+ m nm)
15567 ny (floor (/ m 12))
15568 y (+ y ny)
15569 m (- m (* ny 12)))
15570 (while (> m 12) (setq m (- m 12) y (1+ y)))
15571 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15572 (setq m2 (+ m dn) y2 y)
15573 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15574 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15575 (while (<= n2 cday)
15576 (setq n1 n2 m m2 y y2)
15577 (setq m2 (+ m dn) y2 y)
15578 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15579 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15580 ;; Make sure n1 is the earlier date
15581 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15582 (if show-all
15583 (cond
15584 ((eq prefer 'past) (if (= cday n2) n2 n1))
15585 ((eq prefer 'future) (if (= cday n1) n1 n2))
15586 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15587 (cond
15588 ((eq prefer 'past) (if (= cday n2) n2 n1))
15589 ((eq prefer 'future) (if (= cday n1) n1 n2))
15590 (t (if (= cday n1) n1 n2)))))))
15592 (defun org-date-to-gregorian (date)
15593 "Turn any specification of DATE into a Gregorian date for the calendar."
15594 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15595 ((and (listp date) (= (length date) 3)) date)
15596 ((stringp date)
15597 (setq date (org-parse-time-string date))
15598 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15599 ((listp date)
15600 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15602 (defun org-parse-time-string (s &optional nodefault)
15603 "Parse the standard Org-mode time string.
15604 This should be a lot faster than the normal `parse-time-string'.
15605 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15606 hour and minute fields will be nil if not given."
15607 (if (string-match org-ts-regexp0 s)
15608 (list 0
15609 (if (or (match-beginning 8) (not nodefault))
15610 (string-to-number (or (match-string 8 s) "0")))
15611 (if (or (match-beginning 7) (not nodefault))
15612 (string-to-number (or (match-string 7 s) "0")))
15613 (string-to-number (match-string 4 s))
15614 (string-to-number (match-string 3 s))
15615 (string-to-number (match-string 2 s))
15616 nil nil nil)
15617 (error "Not a standard Org-mode time string: %s" s)))
15619 (defun org-timestamp-up (&optional arg)
15620 "Increase the date item at the cursor by one.
15621 If the cursor is on the year, change the year. If it is on the month,
15622 the day or the time, change that.
15623 With prefix ARG, change by that many units."
15624 (interactive "p")
15625 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15627 (defun org-timestamp-down (&optional arg)
15628 "Decrease the date item at the cursor by one.
15629 If the cursor is on the year, change the year. If it is on the month,
15630 the day or the time, change that.
15631 With prefix ARG, change by that many units."
15632 (interactive "p")
15633 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15635 (defun org-timestamp-up-day (&optional arg)
15636 "Increase the date in the time stamp by one day.
15637 With prefix ARG, change that many days."
15638 (interactive "p")
15639 (if (and (not (org-at-timestamp-p t))
15640 (org-on-heading-p))
15641 (org-todo 'up)
15642 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15644 (defun org-timestamp-down-day (&optional arg)
15645 "Decrease the date in the time stamp by one day.
15646 With prefix ARG, change that many days."
15647 (interactive "p")
15648 (if (and (not (org-at-timestamp-p t))
15649 (org-on-heading-p))
15650 (org-todo 'down)
15651 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15653 (defun org-at-timestamp-p (&optional inactive-ok)
15654 "Determine if the cursor is in or at a timestamp."
15655 (interactive)
15656 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15657 (pos (point))
15658 (ans (or (looking-at tsr)
15659 (save-excursion
15661 (if (> (point) (point-min)) (backward-char 1))
15662 (and (looking-at tsr)
15663 (> (- (match-end 0) pos) -1))))))
15664 (and ans
15665 (boundp 'org-ts-what)
15666 (setq org-ts-what
15667 (cond
15668 ((= pos (match-beginning 0)) 'bracket)
15669 ;; Point is considered to be "on the bracket" whether
15670 ;; it's really on it or right after it.
15671 ((or (= pos (1- (match-end 0)))
15672 (= pos (match-end 0))) 'bracket)
15673 ((org-pos-in-match-range pos 2) 'year)
15674 ((org-pos-in-match-range pos 3) 'month)
15675 ((org-pos-in-match-range pos 7) 'hour)
15676 ((org-pos-in-match-range pos 8) 'minute)
15677 ((or (org-pos-in-match-range pos 4)
15678 (org-pos-in-match-range pos 5)) 'day)
15679 ((and (> pos (or (match-end 8) (match-end 5)))
15680 (< pos (match-end 0)))
15681 (- pos (or (match-end 8) (match-end 5))))
15682 (t 'day))))
15683 ans))
15685 (defun org-toggle-timestamp-type ()
15686 "Toggle the type (<active> or [inactive]) of a time stamp."
15687 (interactive)
15688 (when (org-at-timestamp-p t)
15689 (let ((beg (match-beginning 0)) (end (match-end 0))
15690 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15691 (save-excursion
15692 (goto-char beg)
15693 (while (re-search-forward "[][<>]" end t)
15694 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15695 t t)))
15696 (message "Timestamp is now %sactive"
15697 (if (equal (char-after beg) ?<) "" "in")))))
15699 (defun org-timestamp-change (n &optional what updown)
15700 "Change the date in the time stamp at point.
15701 The date will be changed by N times WHAT. WHAT can be `day', `month',
15702 `year', `minute', `second'. If WHAT is not given, the cursor position
15703 in the timestamp determines what will be changed."
15704 (let ((origin (point)) origin-cat
15705 with-hm inactive
15706 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15707 org-ts-what
15708 extra rem
15709 ts time time0)
15710 (if (not (org-at-timestamp-p t))
15711 (error "Not at a timestamp"))
15712 (if (and (not what) (eq org-ts-what 'bracket))
15713 (org-toggle-timestamp-type)
15714 ;; Point isn't on brackets. Remember the part of the time-stamp
15715 ;; the point was in. Indeed, size of time-stamps may change,
15716 ;; but point must be kept in the same category nonetheless.
15717 (setq origin-cat org-ts-what)
15718 (if (and (not what) (not (eq org-ts-what 'day))
15719 org-display-custom-times
15720 (get-text-property (point) 'display)
15721 (not (get-text-property (1- (point)) 'display)))
15722 (setq org-ts-what 'day))
15723 (setq org-ts-what (or what org-ts-what)
15724 inactive (= (char-after (match-beginning 0)) ?\[)
15725 ts (match-string 0))
15726 (replace-match "")
15727 (if (string-match
15729 ts)
15730 (setq extra (match-string 1 ts)))
15732 (setq with-hm t))
15733 (setq time0 (org-parse-time-string ts))
15734 (when (and updown
15735 (eq org-ts-what 'minute)
15736 (not current-prefix-arg))
15737 ;; This looks like s-up and s-down. Change by one rounding step.
15738 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15739 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15740 (setcar (cdr time0) (+ (nth 1 time0)
15741 (if (> n 0) (- rem) (- dm rem))))))
15742 (setq time
15743 (encode-time (or (car time0) 0)
15744 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15745 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15746 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15747 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15748 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15749 (nthcdr 6 time0)))
15750 (when (and (member org-ts-what '(hour minute))
15751 extra
15753 (setq extra (org-modify-ts-extra
15754 extra
15755 (if (eq org-ts-what 'hour) 2 5)
15756 n dm)))
15757 (when (integerp org-ts-what)
15758 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15759 (if (eq what 'calendar)
15760 (let ((cal-date (org-get-date-from-calendar)))
15761 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15762 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15763 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15764 (setcar time0 (or (car time0) 0))
15765 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15766 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15767 (setq time (apply 'encode-time time0))))
15768 ;; Insert the new time-stamp, and ensure point stays in the same
15769 ;; category as before (i.e. not after the last position in that
15770 ;; category).
15771 (let ((pos (point)))
15772 ;; Stay before inserted string. `save-excursion' is of no use.
15773 (setq org-last-changed-timestamp
15774 (org-insert-time-stamp time with-hm inactive nil nil extra))
15775 (goto-char pos))
15776 (save-match-data
15777 (looking-at org-ts-regexp3)
15778 (goto-char (cond
15779 ;; `day' category ends before `hour' if any, or at
15780 ;; the end of the day name.
15781 ((eq origin-cat 'day)
15782 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15783 ((eq origin-cat 'hour) (min (match-end 7) origin))
15784 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15785 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15786 ;; `year' and `month' have both fixed size: point
15787 ;; couldn't have moved into another part.
15788 (t origin))))
15789 ;; Update clock if on a CLOCK line.
15790 (org-clock-update-time-maybe)
15791 ;; Try to recenter the calendar window, if any.
15792 (if (and org-calendar-follow-timestamp-change
15793 (get-buffer-window "*Calendar*" t)
15794 (memq org-ts-what '(day month year)))
15795 (org-recenter-calendar (time-to-days time))))))
15797 (defun org-modify-ts-extra (s pos n dm)
15798 "Change the different parts of the lead-time and repeat fields in timestamp."
15799 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15800 ng h m new rem)
15801 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15802 (cond
15803 ((or (org-pos-in-match-range pos 2)
15804 (org-pos-in-match-range pos 3))
15805 (setq m (string-to-number (match-string 3 s))
15806 h (string-to-number (match-string 2 s)))
15807 (if (org-pos-in-match-range pos 2)
15808 (setq h (+ h n))
15809 (setq n (* dm (org-no-warnings (signum n))))
15810 (when (not (= 0 (setq rem (% m dm))))
15811 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15812 (setq m (+ m n)))
15813 (if (< m 0) (setq m (+ m 60) h (1- h)))
15814 (if (> m 59) (setq m (- m 60) h (1+ h)))
15815 (setq h (min 24 (max 0 h)))
15816 (setq ng 1 new (format "-%02d:%02d" h m)))
15817 ((org-pos-in-match-range pos 6)
15818 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15819 ((org-pos-in-match-range pos 5)
15820 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15822 ((org-pos-in-match-range pos 9)
15823 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15824 ((org-pos-in-match-range pos 8)
15825 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15827 (when ng
15828 (setq s (concat
15829 (substring s 0 (match-beginning ng))
15830 new
15831 (substring s (match-end ng))))))
15832 s))
15834 (defun org-recenter-calendar (date)
15835 "If the calendar is visible, recenter it to DATE."
15836 (let* ((win (selected-window))
15837 (cwin (get-buffer-window "*Calendar*" t))
15838 (calendar-move-hook nil))
15839 (when cwin
15840 (select-window cwin)
15841 (calendar-goto-date (if (listp date) date
15842 (calendar-gregorian-from-absolute date)))
15843 (select-window win))))
15845 (defun org-goto-calendar (&optional arg)
15846 "Go to the Emacs calendar at the current date.
15847 If there is a time stamp in the current line, go to that date.
15848 A prefix ARG can be used to force the current date."
15849 (interactive "P")
15850 (let ((tsr org-ts-regexp) diff
15851 (calendar-move-hook nil)
15852 (calendar-view-holidays-initially-flag nil)
15853 (calendar-view-diary-initially-flag nil))
15854 (if (or (org-at-timestamp-p)
15855 (save-excursion
15856 (beginning-of-line 1)
15857 (looking-at (concat ".*" tsr))))
15858 (let ((d1 (time-to-days (current-time)))
15859 (d2 (time-to-days
15860 (org-time-string-to-time (match-string 1)))))
15861 (setq diff (- d2 d1))))
15862 (calendar)
15863 (calendar-goto-today)
15864 (if (and diff (not arg)) (calendar-forward-day diff))))
15866 (defun org-get-date-from-calendar ()
15867 "Return a list (month day year) of date at point in calendar."
15868 (with-current-buffer "*Calendar*"
15869 (save-match-data
15870 (calendar-cursor-to-date))))
15872 (defun org-date-from-calendar ()
15873 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15874 If there is already a time stamp at the cursor position, update it."
15875 (interactive)
15876 (if (org-at-timestamp-p t)
15877 (org-timestamp-change 0 'calendar)
15878 (let ((cal-date (org-get-date-from-calendar)))
15879 (org-insert-time-stamp
15880 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15882 (defcustom org-effort-durations
15883 `(("h" . 60)
15884 ("d" . ,(* 60 8))
15885 ("w" . ,(* 60 8 5))
15886 ("m" . ,(* 60 8 5 4))
15887 ("y" . ,(* 60 8 5 40)))
15888 "Conversion factor to minutes for an effort modifier.
15890 Each entry has the form (MODIFIER . MINUTES).
15892 In an effort string, a number followed by MODIFIER is multiplied
15893 by the specified number of MINUTES to obtain an effort in
15894 minutes.
15898 :group 'org-agenda
15899 :type '(alist :key-type (string :tag "Modifier")
15900 :value-type (number :tag "Minutes")))
15902 ;;;; Files
15904 (defun org-save-all-org-buffers ()
15905 "Save all Org-mode buffers without user confirmation."
15906 (interactive)
15907 (message "Saving all Org-mode buffers...")
15908 (save-some-buffers t 'org-mode-p)
15909 (when (featurep 'org-id) (org-id-locations-save))
15910 (message "Saving all Org-mode buffers... done"))
15912 (defun org-revert-all-org-buffers ()
15913 "Revert all Org-mode buffers.
15914 Prompt for confirmation when there are unsaved changes.
15915 Be sure you know what you are doing before letting this function
15916 overwrite your changes.
15918 This function is useful in a setup where one tracks org files
15919 with a version control system, to revert on one machine after pulling
15920 changes from another. I believe the procedure must be like this:
15922 1. M-x org-save-all-org-buffers
15923 2. Pull changes from the other machine, resolve conflicts
15924 3. M-x org-revert-all-org-buffers"
15925 (interactive)
15926 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15927 (error "Abort"))
15928 (save-excursion
15929 (save-window-excursion
15930 (mapc
15931 (lambda (b)
15932 (when (and (with-current-buffer b (org-mode-p))
15933 (with-current-buffer b buffer-file-name))
15934 (org-pop-to-buffer-same-window b)
15935 (revert-buffer t 'no-confirm)))
15936 (buffer-list))
15937 (when (and (featurep 'org-id) org-id-track-globally)
15938 (org-id-locations-load)))))
15940 ;;;; Agenda files
15942 ;;;###autoload
15943 (defun org-switchb (&optional arg)
15944 "Switch between Org buffers.
15945 With a prefix argument, restrict available to files.
15946 With two prefix arguments, restrict available buffers to agenda files.
15948 Defaults to `iswitchb' for buffer name completion.
15949 Set `org-completion-use-ido' to make it use ido instead."
15950 (interactive "P")
15951 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15952 ((equal arg '(16)) (org-buffer-list 'agenda))
15953 (t (org-buffer-list))))
15954 (org-completion-use-iswitchb org-completion-use-iswitchb)
15955 (org-completion-use-ido org-completion-use-ido))
15956 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15957 (setq org-completion-use-iswitchb t))
15958 (org-pop-to-buffer-same-window
15959 (org-icompleting-read "Org buffer: "
15960 (mapcar 'list (mapcar 'buffer-name blist))
15961 nil t))))
15963 ;;; Define some older names previously used for this functionality
15964 ;;;###autoload
15965 (defalias 'org-ido-switchb 'org-switchb)
15966 ;;;###autoload
15967 (defalias 'org-iswitchb 'org-switchb)
15969 (defun org-buffer-list (&optional predicate exclude-tmp)
15970 "Return a list of Org buffers.
15971 PREDICATE can be `export', `files' or `agenda'.
15973 export restrict the list to Export buffers.
15974 files restrict the list to buffers visiting Org files.
15975 agenda restrict the list to buffers visiting agenda files.
15977 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15978 (let* ((bfn nil)
15979 (agenda-files (and (eq predicate 'agenda)
15980 (mapcar 'file-truename (org-agenda-files t))))
15981 (filter
15982 (cond
15983 ((eq predicate 'files)
15984 (lambda (b) (with-current-buffer b (org-mode-p))))
15985 ((eq predicate 'export)
15986 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15987 ((eq predicate 'agenda)
15988 (lambda (b)
15989 (with-current-buffer b
15990 (and (org-mode-p)
15991 (setq bfn (buffer-file-name b))
15992 (member (file-truename bfn) agenda-files)))))
15993 (t (lambda (b) (with-current-buffer b
15994 (or (org-mode-p)
15995 (string-match "\*Org .*Export"
15996 (buffer-name b)))))))))
15997 (delq nil
15998 (mapcar
15999 (lambda(b)
16000 (if (and (funcall filter b)
16001 (or (not exclude-tmp)
16002 (not (string-match "tmp" (buffer-name b)))))
16003 b
16004 nil))
16005 (buffer-list)))))
16007 (defun org-agenda-files (&optional unrestricted archives)
16008 "Get the list of agenda files.
16009 Optional UNRESTRICTED means return the full list even if a restriction
16010 is currently in place.
16011 When ARCHIVES is t, include all archive files that are really being
16012 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16013 `org-agenda-archives-mode' is t."
16014 (let ((files
16015 (cond
16016 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16017 ((stringp org-agenda-files) (org-read-agenda-file-list))
16018 ((listp org-agenda-files) org-agenda-files)
16019 (t (error "Invalid value of `org-agenda-files'")))))
16020 (setq files (apply 'append
16021 (mapcar (lambda (f)
16022 (if (file-directory-p f)
16023 (directory-files
16024 f t org-agenda-file-regexp)
16025 (list f)))
16026 files)))
16027 (when org-agenda-skip-unavailable-files
16028 (setq files (delq nil
16029 (mapcar (function
16030 (lambda (file)
16031 (and (file-readable-p file) file)))
16032 files))))
16033 (when (or (eq archives t)
16034 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16035 (setq files (org-add-archive-files files)))
16036 files))
16038 (defun org-agenda-file-p (&optional file)
16039 "Return non-nil, if FILE is an agenda file.
16040 If FILE is omitted, use the file associated with the current
16041 buffer."
16042 (member (or file (buffer-file-name))
16043 (org-agenda-files t)))
16045 (defun org-edit-agenda-file-list ()
16046 "Edit the list of agenda files.
16047 Depending on setup, this either uses customize to edit the variable
16048 `org-agenda-files', or it visits the file that is holding the list. In the
16049 latter case, the buffer is set up in a way that saving it automatically kills
16050 the buffer and restores the previous window configuration."
16051 (interactive)
16052 (if (stringp org-agenda-files)
16053 (let ((cw (current-window-configuration)))
16054 (find-file org-agenda-files)
16055 (org-set-local 'org-window-configuration cw)
16056 (org-add-hook 'after-save-hook
16057 (lambda ()
16058 (set-window-configuration
16059 (prog1 org-window-configuration
16060 (kill-buffer (current-buffer))))
16061 (org-install-agenda-files-menu)
16062 (message "New agenda file list installed"))
16063 nil 'local)
16064 (message "%s" (substitute-command-keys
16066 (customize-variable 'org-agenda-files)))
16068 (defun org-store-new-agenda-file-list (list)
16069 "Set new value for the agenda file list and save it correctly."
16070 (if (stringp org-agenda-files)
16071 (let ((fe (org-read-agenda-file-list t)) b u)
16072 (while (setq b (find-buffer-visiting org-agenda-files))
16073 (kill-buffer b))
16074 (with-temp-file org-agenda-files
16075 (insert
16076 (mapconcat
16077 (lambda (f) ;; Keep un-expanded entries.
16078 (if (setq u (assoc f fe))
16079 (cdr u)
16080 f))
16083 (let ((org-mode-hook nil) (org-inhibit-startup t)
16084 (org-insert-mode-line-in-empty-file nil))
16085 (setq org-agenda-files list)
16086 (customize-save-variable 'org-agenda-files org-agenda-files))))
16088 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16089 "Read the list of agenda files from a file.
16090 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16091 filenames, used by `org-store-new-agenda-file-list' to write back
16092 un-expanded file names."
16093 (when (file-directory-p org-agenda-files)
16094 (error "`org-agenda-files' cannot be a single directory"))
16095 (when (stringp org-agenda-files)
16096 (with-temp-buffer
16097 (insert-file-contents org-agenda-files)
16098 (mapcar
16099 (lambda (f)
16100 (let ((e (expand-file-name (substitute-in-file-name f)
16101 org-directory)))
16102 (if pair-with-expansion
16103 (cons e f)
16104 e)))
16107 ;;;###autoload
16108 (defun org-cycle-agenda-files ()
16109 "Cycle through the files in `org-agenda-files'.
16110 If the current buffer visits an agenda file, find the next one in the list.
16111 If the current buffer does not, find the first agenda file."
16112 (interactive)
16113 (let* ((fs (org-agenda-files t))
16114 (files (append fs (list (car fs))))
16115 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16116 file)
16117 (unless files (error "No agenda files"))
16118 (catch 'exit
16119 (while (setq file (pop files))
16120 (if (equal (file-truename file) tcf)
16121 (when (car files)
16122 (find-file (car files))
16123 (throw 'exit t))))
16124 (find-file (car fs)))
16125 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16127 (defun org-agenda-file-to-front (&optional to-end)
16128 "Move/add the current file to the top of the agenda file list.
16129 If the file is not present in the list, it is added to the front. If it is
16130 present, it is moved there. With optional argument TO-END, add/move to the
16131 end of the list."
16132 (interactive "P")
16133 (let ((org-agenda-skip-unavailable-files nil)
16134 (file-alist (mapcar (lambda (x)
16135 (cons (file-truename x) x))
16136 (org-agenda-files t)))
16137 (ctf (file-truename buffer-file-name))
16138 x had)
16139 (setq x (assoc ctf file-alist) had x)
16141 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16142 (if to-end
16143 (setq file-alist (append (delq x file-alist) (list x)))
16144 (setq file-alist (cons x (delq x file-alist))))
16145 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16146 (org-install-agenda-files-menu)
16147 (message "File %s to %s of agenda file list"
16148 (if had "moved" "added") (if to-end "end" "front"))))
16150 (defun org-remove-file (&optional file)
16151 "Remove current file from the list of files in variable `org-agenda-files'.
16152 These are the files which are being checked for agenda entries.
16153 Optional argument FILE means use this file instead of the current."
16154 (interactive)
16155 (let* ((org-agenda-skip-unavailable-files nil)
16156 (file (or file buffer-file-name))
16157 (true-file (file-truename file))
16158 (afile (abbreviate-file-name file))
16159 (files (delq nil (mapcar
16160 (lambda (x)
16161 (if (equal true-file
16162 (file-truename x))
16163 nil x))
16164 (org-agenda-files t)))))
16165 (if (not (= (length files) (length (org-agenda-files t))))
16166 (progn
16167 (org-store-new-agenda-file-list files)
16168 (org-install-agenda-files-menu)
16169 (message "Removed file: %s" afile))
16170 (message "File was not in list: %s (not removed)" afile))))
16172 (defun org-file-menu-entry (file)
16173 (vector file (list 'find-file file) t))
16175 (defun org-check-agenda-file (file)
16176 "Make sure FILE exists. If not, ask user what to do."
16177 (when (not (file-exists-p file))
16178 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16179 (abbreviate-file-name file))
16180 (let ((r (downcase (read-char-exclusive))))
16181 (cond
16182 ((equal r ?r)
16183 (org-remove-file file)
16184 (throw 'nextfile t))
16185 (t (error "Abort"))))))
16187 (defun org-get-agenda-file-buffer (file)
16188 "Get a buffer visiting FILE. If the buffer needs to be created, add
16189 it to the list of buffers which might be released later."
16190 (let ((buf (org-find-base-buffer-visiting file)))
16191 (if buf
16192 buf ; just return it
16193 ;; Make a new buffer and remember it
16194 (setq buf (find-file-noselect file))
16195 (if buf (push buf org-agenda-new-buffers))
16196 buf)))
16198 (defun org-release-buffers (blist)
16199 "Release all buffers in list, asking the user for confirmation when needed.
16200 When a buffer is unmodified, it is just killed. When modified, it is saved
16201 \(if the user agrees) and then killed."
16202 (let (buf file)
16203 (while (setq buf (pop blist))
16204 (setq file (buffer-file-name buf))
16205 (when (and (buffer-modified-p buf)
16206 file
16207 (y-or-n-p (format "Save file %s? " file)))
16208 (with-current-buffer buf (save-buffer)))
16209 (kill-buffer buf))))
16211 (defun org-prepare-agenda-buffers (files)
16212 "Create buffers for all agenda files, protect archived trees and comments."
16213 (interactive)
16214 (let ((pa '(:org-archived t))
16215 (pc '(:org-comment t))
16216 (pall '(:org-archived t :org-comment t))
16217 (inhibit-read-only t)
16218 (rea (concat ":" org-archive-tag ":"))
16219 bmp file re)
16220 (save-excursion
16221 (save-restriction
16222 (while (setq file (pop files))
16223 (catch 'nextfile
16224 (if (bufferp file)
16225 (set-buffer file)
16226 (org-check-agenda-file file)
16227 (set-buffer (org-get-agenda-file-buffer file)))
16228 (widen)
16229 (setq bmp (buffer-modified-p))
16230 (org-refresh-category-properties)
16231 (setq org-todo-keywords-for-agenda
16232 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16233 (setq org-done-keywords-for-agenda
16234 (append org-done-keywords-for-agenda org-done-keywords))
16235 (setq org-todo-keyword-alist-for-agenda
16236 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16237 (setq org-drawers-for-agenda
16238 (append org-drawers-for-agenda org-drawers))
16239 (setq org-tag-alist-for-agenda
16240 (append org-tag-alist-for-agenda org-tag-alist))
16242 (save-excursion
16243 (remove-text-properties (point-min) (point-max) pall)
16244 (when org-agenda-skip-archived-trees
16245 (goto-char (point-min))
16246 (while (re-search-forward rea nil t)
16247 (if (org-on-heading-p t)
16248 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16249 (goto-char (point-min))
16251 (while (re-search-forward re nil t)
16252 (add-text-properties
16253 (match-beginning 0) (org-end-of-subtree t) pc)))
16254 (set-buffer-modified-p bmp)))))
16255 (setq org-todo-keywords-for-agenda
16256 (org-uniquify org-todo-keywords-for-agenda))
16257 (setq org-todo-keyword-alist-for-agenda
16258 (org-uniquify org-todo-keyword-alist-for-agenda)
16259 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16261 ;;;; Embedded LaTeX
16263 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16264 "Keymap for the minor `org-cdlatex-mode'.")
16266 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16267 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16268 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16269 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16270 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16272 (defvar org-cdlatex-texmathp-advice-is-done nil
16273 "Flag remembering if we have applied the advice to texmathp already.")
16275 (define-minor-mode org-cdlatex-mode
16276 "Toggle the minor `org-cdlatex-mode'.
16277 This mode supports entering LaTeX environment and math in LaTeX fragments
16278 in Org-mode.
16280 nil " OCDL" nil
16281 (when org-cdlatex-mode (require 'cdlatex))
16282 (unless org-cdlatex-texmathp-advice-is-done
16283 (setq org-cdlatex-texmathp-advice-is-done t)
16284 (defadvice texmathp (around org-math-always-on activate)
16285 "Always return t in org-mode buffers.
16286 This is because we want to insert math symbols without dollars even outside
16287 the LaTeX math segments. If Orgmode thinks that point is actually inside
16288 an embedded LaTeX fragment, let texmathp do its job.
16290 (interactive)
16291 (let (p)
16292 (cond
16293 ((not (org-mode-p)) ad-do-it)
16294 ((eq this-command 'cdlatex-math-symbol)
16295 (setq ad-return-value t
16296 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16297 (t
16298 (let ((p (org-inside-LaTeX-fragment-p)))
16299 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16300 (setq ad-return-value t
16301 texmathp-why '("Org-mode embedded math" . 0))
16302 (if p ad-do-it)))))))))
16304 (defun turn-on-org-cdlatex ()
16305 "Unconditionally turn on `org-cdlatex-mode'."
16306 (org-cdlatex-mode 1))
16308 (defun org-inside-LaTeX-fragment-p ()
16309 "Test if point is inside a LaTeX fragment.
16311 sequence appearing also before point.
16312 Even though the matchers for math are configurable, this function assumes
16314 delimiters are skipped when they have been removed by customization.
16315 The return value is nil, or a cons cell with the delimiter and the
16316 position of this delimiter.
16318 This function does a reasonably good job, but can locally be fooled by
16319 for example currency specifications. For example it will assume being in
16321 fragments that are properly closed, but during editing, we have to live
16322 with the uncertainty caused by missing closing delimiters. This function
16323 looks only before point, not after."
16324 (catch 'exit
16325 (let ((pos (point))
16326 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16327 (lim (progn
16329 (point)))
16330 dd-on str (start 0) m re)
16331 (goto-char pos)
16332 (when dodollar
16334 re (nth 1 (assoc "$" org-latex-regexps)))
16335 (while (string-match re str start)
16336 (cond
16337 ((= (match-end 0) (length str))
16338 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16339 ((= (match-end 0) (- (length str) 5))
16340 (throw 'exit nil))
16341 (t (setq start (match-end 0))))))
16342 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16343 (goto-char pos)
16344 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16345 (and (match-beginning 2) (throw 'exit nil))
16346 ;; count $$
16348 (setq dd-on (not dd-on)))
16349 (goto-char pos)
16350 (if dd-on (cons "$$" m))))))
16352 (defun org-inside-latex-macro-p ()
16353 "Is point inside a LaTeX macro or its arguments?"
16354 (save-match-data
16355 (org-in-regexp
16358 (defun org-try-cdlatex-tab ()
16359 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16360 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16361 - inside a LaTeX fragment, or
16362 - after the first word in a line, where an abbreviation expansion could
16363 insert a LaTeX environment."
16364 (when org-cdlatex-mode
16365 (cond
16366 ((save-excursion
16367 (skip-chars-backward "a-zA-Z0-9*")
16369 (bolp))
16370 (cdlatex-tab) t)
16371 ((org-inside-LaTeX-fragment-p)
16372 (cdlatex-tab) t)
16373 (t nil))))
16375 (defun org-cdlatex-underscore-caret (&optional arg)
16376 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16377 Revert to the normal definition outside of these fragments."
16378 (interactive "P")
16379 (if (org-inside-LaTeX-fragment-p)
16380 (call-interactively 'cdlatex-sub-superscript)
16381 (let (org-cdlatex-mode)
16382 (call-interactively (key-binding (vector last-input-event))))))
16384 (defun org-cdlatex-math-modify (&optional arg)
16385 "Execute `cdlatex-math-modify' in LaTeX fragments.
16386 Revert to the normal definition outside of these fragments."
16387 (interactive "P")
16388 (if (org-inside-LaTeX-fragment-p)
16389 (call-interactively 'cdlatex-math-modify)
16390 (let (org-cdlatex-mode)
16391 (call-interactively (key-binding (vector last-input-event))))))
16393 (defvar org-latex-fragment-image-overlays nil
16394 "List of overlays carrying the images of latex fragments.")
16395 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16397 (defun org-remove-latex-fragment-image-overlays ()
16398 "Remove all overlays with LaTeX fragment images in current buffer."
16399 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16400 (setq org-latex-fragment-image-overlays nil))
16402 (defun org-preview-latex-fragment (&optional subtree)
16403 "Preview the LaTeX fragment at point, or all locally or globally.
16404 If the cursor is in a LaTeX fragment, create the image and overlay
16405 it over the source code. If there is no fragment at point, display
16406 all fragments in the current text, from one headline to the next. With
16407 prefix SUBTREE, display all fragments in the current subtree. With a
16409 the cursor is before the first headline,
16410 display all fragments in the buffer.
16412 (interactive "P")
16413 (org-remove-latex-fragment-image-overlays)
16414 (save-excursion
16415 (save-restriction
16416 (let (beg end at msg)
16417 (cond
16418 ((or (equal subtree '(16))
16419 (not (save-excursion
16420 (re-search-backward org-outline-regexp-bol nil t))))
16421 (setq beg (point-min) end (point-max)
16422 msg "Creating images for buffer...%s"))
16423 ((equal subtree '(4))
16424 (org-back-to-heading)
16425 (setq beg (point) end (org-end-of-subtree t)
16426 msg "Creating images for subtree...%s"))
16427 (t
16428 (if (setq at (org-inside-LaTeX-fragment-p))
16429 (goto-char (max (point-min) (- (cdr at) 2)))
16430 (org-back-to-heading))
16431 (setq beg (point) end (progn (outline-next-heading) (point))
16432 msg (if at "Creating image...%s"
16433 "Creating images for entry...%s"))))
16434 (message msg "")
16435 (narrow-to-region beg end)
16436 (goto-char beg)
16437 (org-format-latex
16438 (concat "ltxpng/" (file-name-sans-extension
16439 (file-name-nondirectory
16440 buffer-file-name)))
16441 default-directory 'overlays msg at 'forbuffer 'dvipng)
16442 (message msg "done. Use `C-c C-c' to remove images.")))))
16444 (defvar org-latex-regexps
16446 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16449 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16453 "Regular expressions for matching embedded LaTeX.")
16455 (defvar org-export-have-math nil) ;; dynamic scoping
16456 (defun org-format-latex (prefix &optional dir overlays msg at
16457 forbuffer processing-type)
16458 "Replace LaTeX fragments with links to an image, and produce images.
16459 Some of the options can be changed using the variable
16460 `org-format-latex-options'."
16461 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16462 (let* ((prefixnodir (file-name-nondirectory prefix))
16463 (absprefix (expand-file-name prefix dir))
16464 (todir (file-name-directory absprefix))
16465 (opt org-format-latex-options)
16466 (matchers (plist-get opt :matchers))
16467 (re-list org-latex-regexps)
16468 (org-format-latex-header-extra
16469 (plist-get (org-infile-export-plist) :latex-header-extra))
16470 (cnt 0) txt hash link beg end re e checkdir
16471 executables-checked string
16472 m n block linkfile movefile ov)
16473 ;; Check the different regular expressions
16474 (while (setq e (pop re-list))
16475 (setq m (car e) re (nth 1 e) n (nth 2 e)
16477 (when (member m matchers)
16478 (goto-char (point-min))
16479 (while (re-search-forward re nil t)
16480 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16481 (not (get-text-property (match-beginning n)
16482 'org-protected))
16483 (or (not overlays)
16484 (not (eq (get-char-property (match-beginning n)
16485 'org-overlay-type)
16486 'org-latex-overlay))))
16487 (setq org-export-have-math t)
16488 (cond
16489 ((eq processing-type 'verbatim)
16490 ;; Leave the text verbatim, just protect it
16491 (add-text-properties (match-beginning n) (match-end n)
16492 '(org-protected t)))
16493 ((eq processing-type 'mathjax)
16494 ;; Prepare for MathJax processing
16495 (setq string (match-string n))
16496 (if (member m '("$" "$1"))
16497 (save-excursion
16498 (delete-region (match-beginning n) (match-end n))
16499 (goto-char (match-beginning n))
16502 '(org-protected t))))
16503 (add-text-properties (match-beginning n) (match-end n)
16504 '(org-protected t))))
16505 ((or (eq processing-type 'dvipng) t)
16506 ;; Process to an image
16507 (setq txt (match-string n)
16508 beg (match-beginning n) end (match-end n)
16509 cnt (1+ cnt))
16510 (let (print-length print-level) ; make sure full list is printed
16511 (setq hash (sha1 (prin1-to-string
16512 (list org-format-latex-header
16513 org-format-latex-header-extra
16514 org-export-latex-default-packages-alist
16515 org-export-latex-packages-alist
16516 org-format-latex-options
16517 forbuffer txt)))
16518 linkfile (format "%s_%s.png" prefix hash)
16519 movefile (format "%s_%s.png" absprefix hash)))
16520 (setq link (concat block "[[file:" linkfile "]]" block))
16521 (if msg (message msg cnt))
16522 (goto-char beg)
16523 (unless checkdir ; make sure the directory exists
16524 (setq checkdir t)
16525 (or (file-directory-p todir) (make-directory todir t)))
16527 (unless executables-checked
16528 (org-check-external-command
16529 "latex" "needed to convert LaTeX fragments to images")
16530 (org-check-external-command
16531 "dvipng" "needed to convert LaTeX fragments to images")
16532 (setq executables-checked t))
16534 (unless (file-exists-p movefile)
16535 (org-create-formula-image
16536 txt movefile opt forbuffer))
16537 (if overlays
16538 (progn
16539 (mapc (lambda (o)
16540 (if (eq (overlay-get o 'org-overlay-type)
16541 'org-latex-overlay)
16542 (delete-overlay o)))
16543 (overlays-in beg end))
16544 (setq ov (make-overlay beg end))
16545 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16546 (if (featurep 'xemacs)
16547 (progn
16548 (overlay-put ov 'invisible t)
16549 (overlay-put
16550 ov 'end-glyph
16551 (make-glyph (vector 'png :file movefile))))
16552 (overlay-put
16553 ov 'display
16554 (list 'image :type 'png :file movefile :ascent 'center)))
16555 (push ov org-latex-fragment-image-overlays)
16556 (goto-char end))
16557 (delete-region beg end)
16558 (insert (org-add-props link
16559 (list 'org-latex-src
16560 (replace-regexp-in-string
16563 ;; This function borrows from Ganesh Swami's latex2png.el
16564 (defun org-create-formula-image (string tofile options buffer)
16565 "This calls dvipng."
16566 (require 'org-latex)
16567 (let* ((tmpdir (if (featurep 'xemacs)
16568 (temp-directory)
16569 temporary-file-directory))
16570 (texfilebase (make-temp-name
16571 (expand-file-name "orgtex" tmpdir)))
16572 (texfile (concat texfilebase ".tex"))
16573 (dvifile (concat texfilebase ".dvi"))
16574 (pngfile (concat texfilebase ".png"))
16575 (fnh (if (featurep 'xemacs)
16576 (font-height (get-face-font 'default))
16577 (face-attribute 'default :height nil)))
16578 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16579 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16580 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16581 "Black"))
16582 (bg (or (plist-get options (if buffer :background :html-background))
16583 "Transparent")))
16584 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16585 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16586 (with-temp-file texfile
16587 (insert (org-splice-latex-header
16588 org-format-latex-header
16589 org-export-latex-default-packages-alist
16590 org-export-latex-packages-alist t
16591 org-format-latex-header-extra))
16593 (require 'org-latex)
16594 (org-export-latex-fix-inputenc))
16595 (let ((dir default-directory))
16596 (condition-case nil
16597 (progn
16598 (cd tmpdir)
16599 (call-process "latex" nil nil nil texfile))
16600 (error nil))
16601 (cd dir))
16602 (if (not (file-exists-p dvifile))
16603 (progn (message "Failed to create dvi file from %s" texfile) nil)
16604 (condition-case nil
16605 (call-process "dvipng" nil nil nil
16606 "-fg" fg "-bg" bg
16607 "-D" dpi
16608 ;;"-x" scale "-y" scale
16609 "-T" "tight"
16610 "-o" pngfile
16611 dvifile)
16612 (error nil))
16613 (if (not (file-exists-p pngfile))
16614 (if org-format-latex-signal-error
16615 (error "Failed to create png file from %s" texfile)
16616 (message "Failed to create png file from %s" texfile)
16617 nil)
16618 ;; Use the requested file name and clean up
16619 (copy-file pngfile tofile 'replace)
16620 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16621 (delete-file (concat texfilebase e)))
16622 pngfile))))
16624 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16625 "Fill a LaTeX header template TPL.
16626 In the template, the following place holders will be recognized:
16629 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16631 [NO-PACKAGES] do not include PKG
16632 [EXTRA] the string EXTRA
16633 [NO-EXTRA] do not include EXTRA
16635 For backward compatibility, if both the positive and the negative place
16637 assumed to be present at the end of the template.
16638 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16639 EXTRA is a string.
16640 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16641 (let (rpl (end ""))
16643 (setq rpl (if (or (match-end 1) (not def-pkg))
16644 "" (org-latex-packages-to-string def-pkg snippets-p t))
16645 tpl (replace-match rpl t t tpl))
16646 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16649 (setq rpl (if (or (match-end 1) (not pkg))
16650 "" (org-latex-packages-to-string pkg snippets-p t))
16651 tpl (replace-match rpl t t tpl))
16652 (if pkg (setq end
16654 (org-latex-packages-to-string pkg snippets-p)))))
16657 (setq rpl (if (or (match-end 1) (not extra))
16659 tpl (replace-match rpl t t tpl))
16665 tpl)))
16667 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16669 (setq pkg (mapconcat (lambda(p)
16670 (cond
16671 ((stringp p) p)
16672 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16673 (format "%% Package %s omitted" (cadr p)))
16674 ((equal "" (car p))
16676 (t
16678 (car p) (cadr p)))))
16679 pkg
16683 (defun org-dvipng-color (attr)
16684 "Return an rgb color specification for dvipng."
16685 (apply 'format "rgb %s %s %s"
16686 (mapcar 'org-normalize-color
16687 (color-values (face-attribute 'default attr nil)))))
16689 (defun org-normalize-color (value)
16690 "Return string to be used as color value for an RGB component."
16691 (format "%g" (/ value 65535.0)))
16693 ;; Image display
16696 (defvar org-inline-image-overlays nil)
16697 (make-variable-buffer-local 'org-inline-image-overlays)
16699 (defun org-toggle-inline-images (&optional include-linked)
16700 "Toggle the display of inline images.
16701 INCLUDE-LINKED is passed to `org-display-inline-images'."
16702 (interactive "P")
16703 (if org-inline-image-overlays
16704 (progn
16705 (org-remove-inline-images)
16706 (message "Inline image display turned off"))
16707 (org-display-inline-images include-linked)
16708 (if org-inline-image-overlays
16709 (message "%d images displayed inline"
16710 (length org-inline-image-overlays))
16711 (message "No images to display inline"))))
16713 (defun org-display-inline-images (&optional include-linked refresh beg end)
16714 "Display inline images.
16715 Normally only links without a description part are inlined, because this
16716 is how it will work for export. When INCLUDE-LINKED is set, also links
16717 with a description part will be inlined. This can be nice for a quick
16718 look at those images, but it does not reflect what exported files will look
16719 like.
16720 When REFRESH is set, refresh existing images between BEG and END.
16721 This will create new image displays only if necessary.
16722 BEG and END default to the buffer boundaries."
16723 (interactive "P")
16724 (unless refresh
16725 (org-remove-inline-images)
16726 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16727 (save-excursion
16728 (save-restriction
16729 (widen)
16730 (setq beg (or beg (point-min)) end (or end (point-max)))
16731 (goto-char (point-min))
16733 (substring (org-image-file-name-regexp) 0 -2)
16735 old file ov img)
16736 (while (re-search-forward re end t)
16737 (setq old (get-char-property-and-overlay (match-beginning 1)
16738 'org-image-overlay))
16739 (setq file (expand-file-name
16740 (concat (or (match-string 3) "") (match-string 4))))
16741 (when (file-exists-p file)
16742 (if (and (car-safe old) refresh)
16743 (image-refresh (overlay-get (cdr old) 'display))
16744 (setq img (save-match-data (create-image file)))
16745 (when img
16746 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16747 (overlay-put ov 'display img)
16748 (overlay-put ov 'face 'default)
16749 (overlay-put ov 'org-image-overlay t)
16750 (overlay-put ov 'modification-hooks
16751 (list 'org-display-inline-modification-hook))
16752 (push ov org-inline-image-overlays)))))))))
16754 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16755 "Remove inline-display overlay if a corresponding region is modified."
16756 (let ((inhibit-modification-hooks t))
16757 (when (and ov after)
16758 (delete ov org-inline-image-overlays)
16759 (delete-overlay ov))))
16761 (defun org-remove-inline-images ()
16762 "Remove inline display of images."
16763 (interactive)
16764 (mapc 'delete-overlay org-inline-image-overlays)
16765 (setq org-inline-image-overlays nil))
16767 ;;;; Key bindings
16769 ;; Make `C-c C-x' a prefix key
16770 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16772 ;; TAB key with modifiers
16773 (org-defkey org-mode-map "\C-i" 'org-cycle)
16774 (org-defkey org-mode-map [(tab)] 'org-cycle)
16775 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16776 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16778 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16779 ;; The following line is necessary under Suse GNU/Linux
16780 (unless (featurep 'xemacs)
16781 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16782 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16783 (define-key org-mode-map [backtab] 'org-shifttab)
16785 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16786 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16787 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16789 ;; Cursor keys with modifiers
16790 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16791 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16792 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16793 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16795 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16796 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16797 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16798 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16800 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16801 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16802 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16803 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16805 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16806 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16807 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16808 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16810 ;; Babel keys
16811 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16812 (mapc (lambda (pair)
16813 (define-key org-babel-map (car pair) (cdr pair)))
16814 org-babel-key-bindings)
16816 ;;; Extra keys for tty access.
16817 ;; We only set them when really needed because otherwise the
16818 ;; menus don't show the simple keys
16820 (when (or org-use-extra-keys
16821 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16822 (not window-system))
16823 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16824 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16825 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16826 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16827 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16828 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16829 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16830 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16831 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16832 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16833 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16834 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16835 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16836 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16837 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16838 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16839 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16840 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16841 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16842 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16843 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16844 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16845 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16846 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16847 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16848 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16849 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16850 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16852 ;; All the other keys
16854 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16855 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16856 (if (boundp 'narrow-map)
16857 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16858 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16859 (if (boundp 'narrow-map)
16860 (org-defkey narrow-map "b" 'org-narrow-to-block)
16861 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16862 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16863 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16864 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16865 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16866 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16867 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16868 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16869 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16870 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16871 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16872 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16873 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16874 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16875 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16876 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16877 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16879 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16880 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16881 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16882 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16883 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16884 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16885 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16886 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16887 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16888 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16889 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16890 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16891 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16892 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16893 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16894 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16895 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16896 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16897 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16898 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16900 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16901 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16902 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16903 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16904 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16905 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16906 (org-defkey org-mode-map "\C-c^" 'org-sort)
16907 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16908 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16909 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16910 (org-defkey org-mode-map "\C-m" 'org-return)
16911 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16912 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16913 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16914 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16915 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16916 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16917 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16918 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16919 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16920 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16921 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16922 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16923 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16924 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16925 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16926 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16927 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16928 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16929 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16930 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16931 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16932 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16934 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16935 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16936 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16937 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16939 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16940 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16941 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16942 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16943 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16944 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16945 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16946 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16947 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16948 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16950 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16951 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16952 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16953 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16954 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16955 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16956 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16958 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16959 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16960 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16961 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16962 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16964 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16966 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16968 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16969 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16971 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16974 (when (featurep 'xemacs)
16975 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16978 (defconst org-speed-commands-default
16979 '(
16980 ("Outline Navigation")
16981 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16982 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16983 ("f" . (org-speed-move-safe 'org-forward-same-level))
16984 ("b" . (org-speed-move-safe 'org-backward-same-level))
16985 ("u" . (org-speed-move-safe 'outline-up-heading))
16986 ("j" . org-goto)
16987 ("g" . (org-refile t))
16988 ("Outline Visibility")
16989 ("c" . org-cycle)
16990 ("C" . org-shifttab)
16991 (" " . org-display-outline-path)
16992 ("Outline Structure Editing")
16993 ("U" . org-shiftmetaup)
16994 ("D" . org-shiftmetadown)
16995 ("r" . org-metaright)
16996 ("l" . org-metaleft)
16997 ("R" . org-shiftmetaright)
16998 ("L" . org-shiftmetaleft)
16999 ("i" . (progn (forward-char 1) (call-interactively
17000 'org-insert-heading-respect-content)))
17001 ("^" . org-sort)
17002 ("w" . org-refile)
17003 ("a" . org-archive-subtree-default-with-confirmation)
17004 ("." . org-mark-subtree)
17005 ("Clock Commands")
17006 ("I" . org-clock-in)
17007 ("O" . org-clock-out)
17008 ("Meta Data Editing")
17009 ("t" . org-todo)
17010 ("0" . (org-priority ?\ ))
17011 ("1" . (org-priority ?A))
17012 ("2" . (org-priority ?B))
17013 ("3" . (org-priority ?C))
17014 (";" . org-set-tags-command)
17015 ("e" . org-set-effort)
17016 ("Agenda Views etc")
17017 ("v" . org-agenda)
17018 ("/" . org-sparse-tree)
17019 ("Misc")
17020 ("o" . org-open-at-point)
17021 ("?" . org-speed-command-help)
17022 ("<" . (org-agenda-set-restriction-lock 'subtree))
17023 (">" . (org-agenda-remove-restriction-lock))
17024 )
17025 "The default speed commands.")
17027 (defun org-print-speed-command (e)
17028 (if (> (length (car e)) 1)
17029 (progn
17031 (princ (car e))
17033 (princ (make-string (length (car e)) ?-))
17035 (princ (car e))
17036 (princ " ")
17037 (if (symbolp (cdr e))
17038 (princ (symbol-name (cdr e)))
17039 (prin1 (cdr e)))
17042 (defun org-speed-command-help ()
17043 "Show the available speed commands."
17044 (interactive)
17045 (if (not org-use-speed-commands)
17046 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17047 (with-output-to-temp-buffer "*Help*"
17049 (mapc 'org-print-speed-command org-speed-commands-user)
17052 (mapc 'org-print-speed-command org-speed-commands-default))
17053 (with-current-buffer "*Help*"
17054 (setq truncate-lines t))))
17056 (defun org-speed-move-safe (cmd)
17057 "Execute CMD, but make sure that the cursor always ends up in a headline.
17058 If not, return to the original position and throw an error."
17059 (interactive)
17060 (let ((pos (point)))
17061 (call-interactively cmd)
17062 (unless (and (bolp) (org-on-heading-p))
17063 (goto-char pos)
17064 (error "Boundary reached while executing %s" cmd))))
17066 (defvar org-self-insert-command-undo-counter 0)
17068 (defvar org-table-auto-blank-field) ; defined in org-table.el
17069 (defvar org-speed-command nil)
17071 (defun org-speed-command-default-hook (keys)
17072 "Hook for activating single-letter speed commands.
17073 `org-speed-commands-default' specifies a minimal command set.
17074 Use `org-speed-commands-user' for further customization."
17075 (when (or (and (bolp) (looking-at org-outline-regexp))
17076 (and (functionp org-use-speed-commands)
17077 (funcall org-use-speed-commands)))
17078 (cdr (assoc keys (append org-speed-commands-user
17079 org-speed-commands-default)))))
17081 (defun org-babel-speed-command-hook (keys)
17082 "Hook for activating single-letter code block commands."
17083 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17084 (cdr (assoc keys org-babel-key-bindings))))
17086 (defcustom org-speed-command-hook
17087 '(org-speed-command-default-hook org-babel-speed-command-hook)
17088 "Hook for activating speed commands at strategic locations.
17089 Hook functions are called in sequence until a valid handler is
17090 found.
17092 Each hook takes a single argument, a user-pressed command key
17093 which is also a `self-insert-command' from the global map.
17095 Within the hook, examine the cursor position and the command key
17096 and return nil or a valid handler as appropriate. Handler could
17097 be one of an interactive command, a function, or a form.
17099 Set `org-use-speed-commands' to non-nil value to enable this
17100 hook. The default setting is `org-speed-command-default-hook'."
17101 :group 'org-structure
17102 :type 'hook)
17104 (defun org-self-insert-command (N)
17105 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17106 If the cursor is in a table looking at whitespace, the whitespace is
17107 overwritten, and the table is not marked as requiring realignment."
17108 (interactive "p")
17109 (cond
17110 ((and org-use-speed-commands
17111 (setq org-speed-command
17112 (run-hook-with-args-until-success
17113 'org-speed-command-hook (this-command-keys))))
17114 (cond
17115 ((commandp org-speed-command)
17116 (setq this-command org-speed-command)
17117 (call-interactively org-speed-command))
17118 ((functionp org-speed-command)
17119 (funcall org-speed-command))
17120 ((and org-speed-command (listp org-speed-command))
17121 (eval org-speed-command))
17122 (t (let (org-use-speed-commands)
17123 (call-interactively 'org-self-insert-command)))))
17124 ((and
17125 (org-table-p)
17126 (progn
17127 ;; check if we blank the field, and if that triggers align
17128 (and (featurep 'org-table) org-table-auto-blank-field
17129 (member last-command
17130 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17132 ;; got extra space, this field does not determine column width
17133 (let (org-table-may-need-update) (org-table-blank-field))
17134 ;; no extra space, this field may determine column width
17135 (org-table-blank-field)))
17136 t)
17137 (eq N 1)
17139 (let (org-table-may-need-update)
17140 (goto-char (1- (match-end 0)))
17141 (delete-char -1)
17142 (goto-char (match-beginning 0))
17143 (self-insert-command N)))
17144 (t
17145 (setq org-table-may-need-update t)
17146 (self-insert-command N)
17147 (org-fix-tags-on-the-fly)
17148 (if org-self-insert-cluster-for-undo
17149 (if (not (eq last-command 'org-self-insert-command))
17150 (setq org-self-insert-command-undo-counter 1)
17151 (if (>= org-self-insert-command-undo-counter 20)
17152 (setq org-self-insert-command-undo-counter 1)
17153 (and (> org-self-insert-command-undo-counter 0)
17154 buffer-undo-list (listp buffer-undo-list)
17155 (not (cadr buffer-undo-list)) ; remove nil entry
17156 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17157 (setq org-self-insert-command-undo-counter
17158 (1+ org-self-insert-command-undo-counter))))))))
17160 (defun org-fix-tags-on-the-fly ()
17161 (when (and (equal (char-after (point-at-bol)) ?*)
17162 (org-on-heading-p))
17163 (org-align-tags-here org-tags-column)))
17165 (defun org-delete-backward-char (N)
17166 "Like `delete-backward-char', insert whitespace at field end in tables.
17167 When deleting backwards, in tables this function will insert whitespace in
17169 still be marked for re-alignment if the field did fill the entire column,
17170 because, in this case the deletion might narrow the column."
17171 (interactive "p")
17172 (if (and (org-table-p)
17173 (eq N 1)
17174 (string-match "|" (buffer-substring (point-at-bol) (point)))
17175 (looking-at ".*?|"))
17176 (let ((pos (point))
17178 (c org-table-may-need-update))
17179 (backward-delete-char N)
17180 (if (not overwrite-mode)
17181 (progn
17182 (skip-chars-forward "^|")
17183 (insert " ")
17184 (goto-char (1- pos))))
17185 ;; noalign: if there were two spaces at the end, this field
17186 ;; does not determine the width of the column.
17187 (if noalign (setq org-table-may-need-update c)))
17188 (backward-delete-char N)
17189 (org-fix-tags-on-the-fly)))
17191 (defun org-delete-char (N)
17192 "Like `delete-char', but insert whitespace at field end in tables.
17193 When deleting characters, in tables this function will insert whitespace in
17195 still be marked for re-alignment if the field did fill the entire column,
17196 because, in this case the deletion might narrow the column."
17197 (interactive "p")
17198 (if (and (org-table-p)
17199 (not (bolp))
17200 (not (= (char-after) ?|))
17201 (eq N 1))
17202 (if (looking-at ".*?|")
17203 (let ((pos (point))
17205 (c org-table-may-need-update))
17206 (replace-match (concat
17207 (substring (match-string 0) 1 -1)
17208 " |"))
17209 (goto-char pos)
17210 ;; noalign: if there were two spaces at the end, this field
17211 ;; does not determine the width of the column.
17212 (if noalign (setq org-table-may-need-update c)))
17213 (delete-char N))
17214 (delete-char N)
17215 (org-fix-tags-on-the-fly)))
17217 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17218 (put 'org-self-insert-command 'delete-selection t)
17219 (put 'orgtbl-self-insert-command 'delete-selection t)
17220 (put 'org-delete-char 'delete-selection 'supersede)
17221 (put 'org-delete-backward-char 'delete-selection 'supersede)
17222 (put 'org-yank 'delete-selection 'yank)
17224 ;; Make `flyspell-mode' delay after some commands
17225 (put 'org-self-insert-command 'flyspell-delayed t)
17226 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17227 (put 'org-delete-char 'flyspell-delayed t)
17228 (put 'org-delete-backward-char 'flyspell-delayed t)
17230 ;; Make pabbrev-mode expand after org-mode commands
17231 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17232 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17234 ;; How to do this: Measure non-white length of current string
17235 ;; If equal to column width, we should realign.
17237 (defun org-remap (map &rest commands)
17238 "In MAP, remap the functions given in COMMANDS.
17239 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17240 (let (new old)
17241 (while commands
17242 (setq old (pop commands) new (pop commands))
17243 (if (fboundp 'command-remapping)
17244 (org-defkey map (vector 'remap old) new)
17245 (substitute-key-definition old new map global-map)))))
17247 (when (eq org-enable-table-editor 'optimized)
17248 ;; If the user wants maximum table support, we need to hijack
17249 ;; some standard editing functions
17250 (org-remap org-mode-map
17251 'self-insert-command 'org-self-insert-command
17252 'delete-char 'org-delete-char
17253 'delete-backward-char 'org-delete-backward-char)
17254 (org-defkey org-mode-map "|" 'org-force-self-insert))
17256 (defvar org-ctrl-c-ctrl-c-hook nil
17257 "Hook for functions attaching themselves to `C-c C-c'.
17259 This can be used to add additional functionality to the C-c C-c
17260 key which executes context-dependent commands. This hook is run
17261 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17262 run after the last test.
17264 Each function will be called with no arguments. The function
17265 must check if the context is appropriate for it to act. If yes,
17266 it should do its thing and then return a non-nil value. If the
17267 context is wrong, just do nothing and return nil.")
17269 (defvar org-ctrl-c-ctrl-c-final-hook nil
17270 "Hook for functions attaching themselves to `C-c C-c'.
17272 This can be used to add additional functionality to the C-c C-c
17273 key which executes context-dependent commands. This hook is run
17274 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17275 before the first test.
17277 Each function will be called with no arguments. The function
17278 must check if the context is appropriate for it to act. If yes,
17279 it should do its thing and then return a non-nil value. If the
17280 context is wrong, just do nothing and return nil.")
17282 (defvar org-tab-first-hook nil
17283 "Hook for functions to attach themselves to TAB.
17284 See `org-ctrl-c-ctrl-c-hook' for more information.
17285 This hook runs as the first action when TAB is pressed, even before
17286 `org-cycle' messes around with the `outline-regexp' to cater for
17287 inline tasks and plain list item folding.
17288 If any function in this hook returns t, any other actions that
17289 would have been caused by TAB (such as table field motion or visibility
17290 cycling) will not occur.")
17292 (defvar org-tab-after-check-for-table-hook nil
17293 "Hook for functions to attach themselves to TAB.
17294 See `org-ctrl-c-ctrl-c-hook' for more information.
17295 This hook runs after it has been established that the cursor is not in a
17296 table, but before checking if the cursor is in a headline or if global cycling
17297 should be done.
17298 If any function in this hook returns t, not other actions like visibility
17299 cycling will be done.")
17301 (defvar org-tab-after-check-for-cycling-hook nil
17302 "Hook for functions to attach themselves to TAB.
17303 See `org-ctrl-c-ctrl-c-hook' for more information.
17304 This hook runs after it has been established that not table field motion and
17305 not visibility should be done because of current context. This is probably
17306 the place where a package like yasnippets can hook in.")
17308 (defvar org-tab-before-tab-emulation-hook nil
17309 "Hook for functions to attach themselves to TAB.
17310 See `org-ctrl-c-ctrl-c-hook' for more information.
17311 This hook runs after every other options for TAB have been exhausted, but
17314 (defvar org-metaleft-hook nil
17315 "Hook for functions attaching themselves to `M-left'.
17316 See `org-ctrl-c-ctrl-c-hook' for more information.")
17317 (defvar org-metaright-hook nil
17318 "Hook for functions attaching themselves to `M-right'.
17319 See `org-ctrl-c-ctrl-c-hook' for more information.")
17320 (defvar org-metaup-hook nil
17321 "Hook for functions attaching themselves to `M-up'.
17322 See `org-ctrl-c-ctrl-c-hook' for more information.")
17323 (defvar org-metadown-hook nil
17324 "Hook for functions attaching themselves to `M-down'.
17325 See `org-ctrl-c-ctrl-c-hook' for more information.")
17326 (defvar org-shiftmetaleft-hook nil
17327 "Hook for functions attaching themselves to `M-S-left'.
17328 See `org-ctrl-c-ctrl-c-hook' for more information.")
17329 (defvar org-shiftmetaright-hook nil
17330 "Hook for functions attaching themselves to `M-S-right'.
17331 See `org-ctrl-c-ctrl-c-hook' for more information.")
17332 (defvar org-shiftmetaup-hook nil
17333 "Hook for functions attaching themselves to `M-S-up'.
17334 See `org-ctrl-c-ctrl-c-hook' for more information.")
17335 (defvar org-shiftmetadown-hook nil
17336 "Hook for functions attaching themselves to `M-S-down'.
17337 See `org-ctrl-c-ctrl-c-hook' for more information.")
17338 (defvar org-metareturn-hook nil
17339 "Hook for functions attaching themselves to `M-RET'.
17340 See `org-ctrl-c-ctrl-c-hook' for more information.")
17341 (defvar org-shiftup-hook nil
17342 "Hook for functions attaching themselves to `S-up'.
17343 See `org-ctrl-c-ctrl-c-hook' for more information.")
17344 (defvar org-shiftup-final-hook nil
17345 "Hook for functions attaching themselves to `S-up'.
17346 This one runs after all other options except shift-select have been excluded.
17347 See `org-ctrl-c-ctrl-c-hook' for more information.")
17348 (defvar org-shiftdown-hook nil
17349 "Hook for functions attaching themselves to `S-down'.
17350 See `org-ctrl-c-ctrl-c-hook' for more information.")
17351 (defvar org-shiftdown-final-hook nil
17352 "Hook for functions attaching themselves to `S-down'.
17353 This one runs after all other options except shift-select have been excluded.
17354 See `org-ctrl-c-ctrl-c-hook' for more information.")
17355 (defvar org-shiftleft-hook nil
17356 "Hook for functions attaching themselves to `S-left'.
17357 See `org-ctrl-c-ctrl-c-hook' for more information.")
17358 (defvar org-shiftleft-final-hook nil
17359 "Hook for functions attaching themselves to `S-left'.
17360 This one runs after all other options except shift-select have been excluded.
17361 See `org-ctrl-c-ctrl-c-hook' for more information.")
17362 (defvar org-shiftright-hook nil
17363 "Hook for functions attaching themselves to `S-right'.
17364 See `org-ctrl-c-ctrl-c-hook' for more information.")
17365 (defvar org-shiftright-final-hook nil
17366 "Hook for functions attaching themselves to `S-right'.
17367 This one runs after all other options except shift-select have been excluded.
17368 See `org-ctrl-c-ctrl-c-hook' for more information.")
17370 (defun org-modifier-cursor-error ()
17371 "Throw an error, a modified cursor command was applied in wrong context."
17372 (error "This command is active in special context like tables, headlines or items"))
17374 (defun org-shiftselect-error ()
17375 "Throw an error because Shift-Cursor command was applied in wrong context."
17376 (if (and (boundp 'shift-select-mode) shift-select-mode)
17377 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17378 (error "This command works only in special context like headlines or timestamps")))
17380 (defun org-call-for-shift-select (cmd)
17381 (let ((this-command-keys-shift-translated t))
17382 (call-interactively cmd)))
17384 (defun org-shifttab (&optional arg)
17385 "Global visibility cycling or move to previous table field.
17386 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17387 on context.
17388 See the individual commands for more information."
17389 (interactive "P")
17390 (cond
17391 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17392 ((integerp arg)
17393 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17394 (message "Content view to level: %d" arg)
17395 (org-content (prefix-numeric-value arg2))
17396 (setq org-cycle-global-status 'overview)))
17397 (t (call-interactively 'org-global-cycle))))
17399 (defun org-shiftmetaleft ()
17400 "Promote subtree or delete table column.
17401 Calls `org-promote-subtree', `org-outdent-item',
17402 or `org-table-delete-column', depending on context.
17403 See the individual commands for more information."
17404 (interactive)
17405 (cond
17406 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17407 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17408 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17409 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17410 (t (org-modifier-cursor-error))))
17412 (defun org-shiftmetaright ()
17413 "Demote subtree or insert table column.
17414 Calls `org-demote-subtree', `org-indent-item',
17415 or `org-table-insert-column', depending on context.
17416 See the individual commands for more information."
17417 (interactive)
17418 (cond
17419 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17420 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17421 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17422 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17423 (t (org-modifier-cursor-error))))
17425 (defun org-shiftmetaup (&optional arg)
17426 "Move subtree up or kill table row.
17427 Calls `org-move-subtree-up' or `org-table-kill-row' or
17428 `org-move-item-up' depending on context. See the individual commands
17429 for more information."
17430 (interactive "P")
17431 (cond
17432 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17433 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17434 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17435 ((org-at-item-p) (call-interactively 'org-move-item-up))
17436 (t (org-modifier-cursor-error))))
17438 (defun org-shiftmetadown (&optional arg)
17439 "Move subtree down or insert table row.
17440 Calls `org-move-subtree-down' or `org-table-insert-row' or
17441 `org-move-item-down', depending on context. See the individual
17442 commands for more information."
17443 (interactive "P")
17444 (cond
17445 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17446 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17447 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17448 ((org-at-item-p) (call-interactively 'org-move-item-down))
17449 (t (org-modifier-cursor-error))))
17451 (defsubst org-hidden-tree-error ()
17452 (error
17453 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17455 (defun org-metaleft (&optional arg)
17456 "Promote heading or move table column to left.
17457 Calls `org-do-promote' or `org-table-move-column', depending on context.
17458 With no specific context, calls the Emacs default `backward-word'.
17459 See the individual commands for more information."
17460 (interactive "P")
17461 (cond
17462 ((run-hook-with-args-until-success 'org-metaleft-hook))
17463 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17464 ((org-with-limited-levels
17465 (or (org-on-heading-p)
17466 (and (org-region-active-p)
17467 (save-excursion
17468 (goto-char (region-beginning))
17469 (org-on-heading-p)))))
17470 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17471 (call-interactively 'org-do-promote))
17472 ;; At an inline task.
17473 ((org-on-heading-p)
17474 (call-interactively 'org-inlinetask-promote))
17475 ((or (org-at-item-p)
17476 (and (org-region-active-p)
17477 (save-excursion
17478 (goto-char (region-beginning))
17479 (org-at-item-p))))
17480 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17481 (call-interactively 'org-outdent-item))
17482 (t (call-interactively 'backward-word))))
17484 (defun org-metaright (&optional arg)
17485 "Demote subtree or move table column to right.
17486 Calls `org-do-demote' or `org-table-move-column', depending on context.
17487 With no specific context, calls the Emacs default `forward-word'.
17488 See the individual commands for more information."
17489 (interactive "P")
17490 (cond
17491 ((run-hook-with-args-until-success 'org-metaright-hook))
17492 ((org-at-table-p) (call-interactively 'org-table-move-column))
17493 ((org-with-limited-levels
17494 (or (org-on-heading-p)
17495 (and (org-region-active-p)
17496 (save-excursion
17497 (goto-char (region-beginning))
17498 (org-on-heading-p)))))
17499 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17500 (call-interactively 'org-do-demote))
17501 ;; At an inline task.
17502 ((org-on-heading-p)
17503 (call-interactively 'org-inlinetask-demote))
17504 ((or (org-at-item-p)
17505 (and (org-region-active-p)
17506 (save-excursion
17507 (goto-char (region-beginning))
17508 (org-at-item-p))))
17509 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17510 (call-interactively 'org-indent-item))
17511 (t (call-interactively 'forward-word))))
17513 (defun org-check-for-hidden (what)
17514 "Check if there are hidden headlines/items in the current visual line.
17515 WHAT can be either `headlines' or `items'. If the current line is
17516 an outline or item heading and it has a folded subtree below it,
17517 this function returns t, nil otherwise."
17518 (let ((re (cond
17519 ((eq what 'headlines) org-outline-regexp-bol)
17520 ((eq what 'items) (org-item-beginning-re))
17521 (t (error "This should not happen"))))
17522 beg end)
17523 (save-excursion
17524 (catch 'exit
17525 (unless (org-region-active-p)
17526 (setq beg (point-at-bol))
17527 (beginning-of-line 2)
17528 (while (and (not (eobp)) ;; this is like `next-line'
17529 (get-char-property (1- (point)) 'invisible))
17530 (beginning-of-line 2))
17531 (setq end (point))
17532 (goto-char beg)
17533 (goto-char (point-at-eol))
17534 (setq end (max end (point)))
17535 (while (re-search-forward re end t)
17536 (if (get-char-property (match-beginning 0) 'invisible)
17537 (throw 'exit t))))
17538 nil))))
17540 (defun org-metaup (&optional arg)
17541 "Move subtree up or move table row up.
17542 Calls `org-move-subtree-up' or `org-table-move-row' or
17543 `org-move-item-up', depending on context. See the individual commands
17544 for more information."
17545 (interactive "P")
17546 (cond
17547 ((run-hook-with-args-until-success 'org-metaup-hook))
17548 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17549 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17550 ((org-at-item-p) (call-interactively 'org-move-item-up))
17551 (t (transpose-lines 1) (beginning-of-line -1))))
17553 (defun org-metadown (&optional arg)
17554 "Move subtree down or move table row down.
17555 Calls `org-move-subtree-down' or `org-table-move-row' or
17556 `org-move-item-down', depending on context. See the individual
17557 commands for more information."
17558 (interactive "P")
17559 (cond
17560 ((run-hook-with-args-until-success 'org-metadown-hook))
17561 ((org-at-table-p) (call-interactively 'org-table-move-row))
17562 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17563 ((org-at-item-p) (call-interactively 'org-move-item-down))
17564 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17566 (defun org-shiftup (&optional arg)
17567 "Increase item in timestamp or increase priority of current headline.
17568 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17569 depending on context. See the individual commands for more information."
17570 (interactive "P")
17571 (cond
17572 ((run-hook-with-args-until-success 'org-shiftup-hook))
17573 ((and org-support-shift-select (org-region-active-p))
17574 (org-call-for-shift-select 'previous-line))
17575 ((org-at-timestamp-p t)
17576 (call-interactively (if org-edit-timestamp-down-means-later
17577 'org-timestamp-down 'org-timestamp-up)))
17578 ((and (not (eq org-support-shift-select 'always))
17579 org-enable-priority-commands
17580 (org-on-heading-p))
17581 (call-interactively 'org-priority-up))
17582 ((and (not org-support-shift-select) (org-at-item-p))
17583 (call-interactively 'org-previous-item))
17584 ((org-clocktable-try-shift 'up arg))
17585 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17586 (org-support-shift-select
17587 (org-call-for-shift-select 'previous-line))
17588 (t (org-shiftselect-error))))
17590 (defun org-shiftdown (&optional arg)
17591 "Decrease item in timestamp or decrease priority of current headline.
17592 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17593 depending on context. See the individual commands for more information."
17594 (interactive "P")
17595 (cond
17596 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17597 ((and org-support-shift-select (org-region-active-p))
17598 (org-call-for-shift-select 'next-line))
17599 ((org-at-timestamp-p t)
17600 (call-interactively (if org-edit-timestamp-down-means-later
17601 'org-timestamp-up 'org-timestamp-down)))
17602 ((and (not (eq org-support-shift-select 'always))
17603 org-enable-priority-commands
17604 (org-on-heading-p))
17605 (call-interactively 'org-priority-down))
17606 ((and (not org-support-shift-select) (org-at-item-p))
17607 (call-interactively 'org-next-item))
17608 ((org-clocktable-try-shift 'down arg))
17609 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17610 (org-support-shift-select
17611 (org-call-for-shift-select 'next-line))
17612 (t (org-shiftselect-error))))
17614 (defun org-shiftright (&optional arg)
17615 "Cycle the thing at point or in the current line, depending on context.
17616 Depending on context, this does one of the following:
17618 - switch a timestamp at point one day into the future
17619 - on a headline, switch to the next TODO keyword.
17620 - on an item, switch entire list to the next bullet type
17621 - on a property line, switch to the next allowed value
17622 - on a clocktable definition line, move time block into the future"
17623 (interactive "P")
17624 (cond
17625 ((run-hook-with-args-until-success 'org-shiftright-hook))
17626 ((and org-support-shift-select (org-region-active-p))
17627 (org-call-for-shift-select 'forward-char))
17628 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17629 ((and (not (eq org-support-shift-select 'always))
17630 (org-on-heading-p))
17631 (let ((org-inhibit-logging
17632 (not org-treat-S-cursor-todo-selection-as-state-change))
17633 (org-inhibit-blocking
17634 (not org-treat-S-cursor-todo-selection-as-state-change)))
17635 (org-call-with-arg 'org-todo 'right)))
17636 ((or (and org-support-shift-select
17637 (not (eq org-support-shift-select 'always))
17638 (org-at-item-bullet-p))
17639 (and (not org-support-shift-select) (org-at-item-p)))
17640 (org-call-with-arg 'org-cycle-list-bullet nil))
17641 ((and (not (eq org-support-shift-select 'always))
17642 (org-at-property-p))
17643 (call-interactively 'org-property-next-allowed-value))
17644 ((org-clocktable-try-shift 'right arg))
17645 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17646 (org-support-shift-select
17647 (org-call-for-shift-select 'forward-char))
17648 (t (org-shiftselect-error))))
17650 (defun org-shiftleft (&optional arg)
17651 "Cycle the thing at point or in the current line, depending on context.
17652 Depending on context, this does one of the following:
17654 - switch a timestamp at point one day into the past
17655 - on a headline, switch to the previous TODO keyword.
17656 - on an item, switch entire list to the previous bullet type
17657 - on a property line, switch to the previous allowed value
17658 - on a clocktable definition line, move time block into the past"
17659 (interactive "P")
17660 (cond
17661 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17662 ((and org-support-shift-select (org-region-active-p))
17663 (org-call-for-shift-select 'backward-char))
17664 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17665 ((and (not (eq org-support-shift-select 'always))
17666 (org-on-heading-p))
17667 (let ((org-inhibit-logging
17668 (not org-treat-S-cursor-todo-selection-as-state-change))
17669 (org-inhibit-blocking
17670 (not org-treat-S-cursor-todo-selection-as-state-change)))
17671 (org-call-with-arg 'org-todo 'left)))
17672 ((or (and org-support-shift-select
17673 (not (eq org-support-shift-select 'always))
17674 (org-at-item-bullet-p))
17675 (and (not org-support-shift-select) (org-at-item-p)))
17676 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17677 ((and (not (eq org-support-shift-select 'always))
17678 (org-at-property-p))
17679 (call-interactively 'org-property-previous-allowed-value))
17680 ((org-clocktable-try-shift 'left arg))
17681 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17682 (org-support-shift-select
17683 (org-call-for-shift-select 'backward-char))
17684 (t (org-shiftselect-error))))
17686 (defun org-shiftcontrolright ()
17687 "Switch to next TODO set."
17688 (interactive)
17689 (cond
17690 ((and org-support-shift-select (org-region-active-p))
17691 (org-call-for-shift-select 'forward-word))
17692 ((and (not (eq org-support-shift-select 'always))
17693 (org-on-heading-p))
17694 (org-call-with-arg 'org-todo 'nextset))
17695 (org-support-shift-select
17696 (org-call-for-shift-select 'forward-word))
17697 (t (org-shiftselect-error))))
17699 (defun org-shiftcontrolleft ()
17700 "Switch to previous TODO set."
17701 (interactive)
17702 (cond
17703 ((and org-support-shift-select (org-region-active-p))
17704 (org-call-for-shift-select 'backward-word))
17705 ((and (not (eq org-support-shift-select 'always))
17706 (org-on-heading-p))
17707 (org-call-with-arg 'org-todo 'previousset))
17708 (org-support-shift-select
17709 (org-call-for-shift-select 'backward-word))
17710 (t (org-shiftselect-error))))
17712 (defun org-shiftcontrolup ()
17713 "Change timestamps synchronously up in CLOCK log lines."
17714 (interactive)
17715 (cond ((and (not org-support-shift-select)
17716 (org-at-clock-log-p)
17717 (org-at-timestamp-p t))
17718 (org-clock-timestamps-up))
17719 (t (org-shiftselect-error))))
17721 (defun org-shiftcontroldown ()
17722 "Change timestamps synchronously down in CLOCK log lines."
17723 (interactive)
17724 (cond ((and (not org-support-shift-select)
17725 (org-at-clock-log-p)
17726 (org-at-timestamp-p t))
17727 (org-clock-timestamps-down))
17728 (t (org-shiftselect-error))))
17730 (defun org-ctrl-c-ret ()
17731 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17732 (interactive)
17733 (cond
17734 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17735 (t (call-interactively 'org-insert-heading))))
17737 (defun org-find-visible ()
17738 (let ((s (point)))
17739 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17740 (get-char-property s 'invisible)))
17741 s))
17742 (defun org-find-invisible ()
17743 (let ((s (point)))
17744 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17745 (not (get-char-property s 'invisible))))
17746 s))
17748 (defun org-copy-visible (beg end)
17749 "Copy the visible parts of the region."
17750 (interactive "r")
17751 (let (snippets s)
17752 (save-excursion
17753 (save-restriction
17754 (narrow-to-region beg end)
17755 (setq s (goto-char (point-min)))
17756 (while (not (= (point) (point-max)))
17757 (goto-char (org-find-invisible))
17758 (push (buffer-substring s (point)) snippets)
17759 (setq s (goto-char (org-find-visible))))))
17760 (kill-new (apply 'concat (nreverse snippets)))))
17762 (defun org-copy-special ()
17763 "Copy region in table or copy current subtree.
17764 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17765 See the individual commands for more information."
17766 (interactive)
17767 (call-interactively
17768 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17770 (defun org-cut-special ()
17771 "Cut region in table or cut current subtree.
17772 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17773 See the individual commands for more information."
17774 (interactive)
17775 (call-interactively
17776 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17778 (defun org-paste-special (arg)
17779 "Paste rectangular region into table, or past subtree relative to level.
17780 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17781 See the individual commands for more information."
17782 (interactive "P")
17783 (if (org-at-table-p)
17784 (org-table-paste-rectangle)
17785 (org-paste-subtree arg)))
17787 (defun org-edit-special (&optional arg)
17788 "Call a special editor for the stuff at point.
17789 When at a table, call the formula editor with `org-table-edit-formulas'.
17790 When at the first line of an src example, call `org-edit-src-code'.
17791 When in an #+include line, visit the include file. Otherwise call
17792 `ffap' to visit the file at point."
17793 (interactive)
17794 ;; possibly prep session before editing source
17795 (when arg
17796 (let* ((info (org-babel-get-src-block-info))
17797 (lang (nth 0 info))
17798 (params (nth 2 info))
17799 (session (cdr (assoc :session params))))
17800 (when (and info session) ;; we are in a source-code block with a session
17801 (funcall
17802 (intern (concat "org-babel-prep-session:" lang)) session params))))
17803 (cond ;; proceed with `org-edit-special'
17804 ((save-excursion
17805 (beginning-of-line 1)
17806 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17807 (find-file (org-trim (match-string 1))))
17808 ((org-edit-src-code))
17809 ((org-edit-fixed-width-region))
17810 ((org-at-table.el-p)
17811 (org-edit-src-code))
17812 ((or (org-at-table-p)
17813 (save-excursion
17814 (beginning-of-line 1)
17816 (call-interactively 'org-table-edit-formulas))
17817 (t (call-interactively 'ffap))))
17819 (defun org-ctrl-c-ctrl-c (&optional arg)
17820 "Set tags in headline, or update according to changed information at point.
17822 This command does many different things, depending on context:
17824 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17825 this is what we do.
17827 - If the cursor is on a statistics cookie, update it.
17829 - If the cursor is in a headline, prompt for tags and insert them
17830 into the current line, aligned to `org-tags-column'. When called
17831 with prefix arg, realign all tags in the current buffer.
17833 - If the cursor is in one of the special #+KEYWORD lines, this
17834 triggers scanning the buffer for these lines and updating the
17835 information.
17837 - If the cursor is inside a table, realign the table. This command
17838 works even if the automatic table editor has been turned off.
17840 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17841 the entire table.
17843 - If the cursor is at a footnote reference or definition, jump to
17844 the corresponding definition or references, respectively.
17846 - If the cursor is a the beginning of a dynamic block, update it.
17848 - If the current buffer is a capture buffer, close note and file it.
17850 - If the cursor is on a <<<target>>>, update radio targets and
17851 corresponding links in this buffer.
17853 - If the cursor is on a numbered item in a plain list, renumber the
17854 ordered list.
17856 - If the cursor is on a checkbox, toggle it.
17858 - If the cursor is on a code block, evaluate it. The variable
17859 `org-confirm-babel-evaluate' can be used to control prompting
17860 before code block evaluation, by default every code block
17861 evaluation requires confirmation. Code block evaluation can be
17862 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17863 (interactive "P")
17864 (let ((org-enable-table-editor t))
17865 (cond
17866 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17867 org-occur-highlights
17868 org-latex-fragment-image-overlays)
17869 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17870 (org-remove-occur-highlights)
17871 (org-remove-latex-fragment-image-overlays)
17872 (message "Temporary highlights/overlays removed from current buffer"))
17873 ((and (local-variable-p 'org-finish-function (current-buffer))
17874 (fboundp org-finish-function))
17875 (funcall org-finish-function))
17876 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17877 ((or (looking-at org-property-start-re)
17878 (org-at-property-p))
17879 (call-interactively 'org-property-action))
17880 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17882 (or (org-on-heading-p) (org-at-item-p)))
17883 (call-interactively 'org-update-statistics-cookies))
17884 ((org-on-heading-p) (call-interactively 'org-set-tags))
17885 ((org-at-table.el-p)
17886 (message "Use C-c ' to edit table.el tables"))
17887 ((org-at-table-p)
17888 (org-table-maybe-eval-formula)
17889 (if arg
17890 (call-interactively 'org-table-recalculate)
17891 (org-table-maybe-recalculate-line))
17892 (call-interactively 'org-table-align)
17893 (orgtbl-send-table 'maybe))
17894 ((or (org-footnote-at-reference-p)
17895 (org-footnote-at-definition-p))
17896 (call-interactively 'org-footnote-action))
17897 ((org-at-item-checkbox-p)
17898 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17899 ;; list only if at top item.
17900 (let* ((cbox (match-string 1))
17901 (struct (org-list-struct))
17902 (old-struct (copy-tree struct))
17903 (parents (org-list-parents-alist struct))
17904 (prevs (org-list-prevs-alist struct))
17905 (orderedp (org-entry-get nil "ORDERED"))
17906 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17907 block-item)
17908 ;; Use a light version of `org-toggle-checkbox' to avoid
17909 ;; computing list structure twice.
17910 (org-list-set-checkbox (point-at-bol) struct
17911 (cond
17912 ((equal arg '(16)) "[-]")
17913 ((equal arg '(4)) nil)
17914 ((equal "[X]" cbox) "[ ]")
17915 (t "[X]")))
17916 (org-list-struct-fix-ind struct parents)
17917 (org-list-struct-fix-bul struct prevs)
17918 (setq block-item
17919 (org-list-struct-fix-box struct parents prevs orderedp))
17920 (when block-item
17921 (message
17922 "Checkboxes were removed due to unchecked box at line %d"
17923 (org-current-line block-item)))
17924 (org-list-struct-apply-struct struct old-struct)
17925 (org-update-checkbox-count-maybe)
17926 (when firstp (org-list-send-list 'maybe))))
17927 ((org-at-item-p)
17928 ;; Cursor at an item: repair list. Do checkbox related actions
17929 ;; only if function was called with an argument. Send list only
17930 ;; if at top item.
17931 (let* ((struct (org-list-struct))
17932 (old-struct (copy-tree struct))
17933 (parents (org-list-parents-alist struct))
17934 (prevs (org-list-prevs-alist struct))
17935 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17936 (org-list-struct-fix-ind struct parents)
17937 (org-list-struct-fix-bul struct prevs)
17938 (when arg
17939 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17940 (org-list-struct-fix-box struct parents prevs))
17941 (org-list-struct-apply-struct struct old-struct)
17942 (when arg (org-update-checkbox-count-maybe))
17943 (when firstp (org-list-send-list 'maybe))))
17944 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17945 ;; Dynamic block
17946 (beginning-of-line 1)
17947 (save-excursion (org-update-dblock)))
17948 ((save-excursion
17949 (beginning-of-line 1)
17951 (cond
17952 ((equal (match-string 1) "TBLFM")
17953 ;; Recalculate the table before this line
17954 (save-excursion
17955 (beginning-of-line 1)
17957 (if (org-at-table-p)
17958 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17959 (t
17960 (let ((org-inhibit-startup-visibility-stuff t)
17961 (org-startup-align-all-tables nil))
17962 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17963 (message "Local setup has been refreshed"))))
17964 ((org-clock-update-time-maybe))
17965 (t
17966 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17967 (error "C-c C-c can do nothing useful at this location"))))))
17969 (defun org-mode-restart ()
17970 "Restart Org-mode, to scan again for special lines.
17971 Also updates the keyword regular expressions."
17972 (interactive)
17973 (org-mode)
17974 (message "Org-mode restarted"))
17976 (defun org-kill-note-or-show-branches ()
17977 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17978 (interactive)
17979 (if (not org-finish-function)
17980 (progn
17981 (hide-subtree)
17982 (call-interactively 'show-branches))
17983 (let ((org-note-abort t))
17984 (funcall org-finish-function))))
17986 (defun org-return (&optional indent)
17987 "Goto next table row or insert a newline.
17988 Calls `org-table-next-row' or `newline', depending on context.
17989 See the individual commands for more information."
17990 (interactive)
17991 (cond
17992 ((bobp) (if indent (newline-and-indent) (newline)))
17993 ((org-at-table-p)
17994 (org-table-justify-field-maybe)
17995 (call-interactively 'org-table-next-row))
17996 ;; when `newline-and-indent' is called within a list, make sure
17997 ;; text moved stays inside the item.
17998 ((and (org-in-item-p) indent)
17999 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18000 (progn
18001 (save-match-data (newline))
18002 (org-indent-line-to (length (match-string 0))))
18003 (let ((ind (org-get-indentation)))
18004 (newline)
18005 (if (org-looking-back org-list-end-re)
18006 (org-indent-line-function)
18007 (org-indent-line-to ind)))))
18008 ((and org-return-follows-link
18009 (eq (get-text-property (point) 'face) 'org-link))
18010 (call-interactively 'org-open-at-point))
18011 ((and (org-at-heading-p)
18012 (looking-at
18014 (org-show-entry)
18015 (end-of-line 1)
18016 (newline))
18017 (t (if indent (newline-and-indent) (newline)))))
18019 (defun org-return-indent ()
18020 "Goto next table row or insert a newline and indent.
18021 Calls `org-table-next-row' or `newline-and-indent', depending on
18022 context. See the individual commands for more information."
18023 (interactive)
18024 (org-return t))
18026 (defun org-ctrl-c-star ()
18027 "Compute table, or change heading status of lines.
18028 Calls `org-table-recalculate' or `org-toggle-heading',
18029 depending on context."
18030 (interactive)
18031 (cond
18032 ((org-at-table-p)
18033 (call-interactively 'org-table-recalculate))
18034 (t
18035 ;; Convert all lines in region to list items
18036 (call-interactively 'org-toggle-heading))))
18038 (defun org-ctrl-c-minus ()
18039 "Insert separator line in table or modify bullet status of line.
18040 Also turns a plain line or a region of lines into list items.
18041 Calls `org-table-insert-hline', `org-toggle-item', or
18042 `org-cycle-list-bullet', depending on context."
18043 (interactive)
18044 (cond
18045 ((org-at-table-p)
18046 (call-interactively 'org-table-insert-hline))
18047 ((org-region-active-p)
18048 (call-interactively 'org-toggle-item))
18049 ((org-in-item-p)
18050 (call-interactively 'org-cycle-list-bullet))
18051 (t
18052 (call-interactively 'org-toggle-item))))
18054 (defun org-toggle-item (arg)
18055 "Convert headings or normal lines to items, items to normal lines.
18056 If there is no active region, only the current line is considered.
18058 If the first non blank line in the region is an headline, convert
18059 all headlines to items, shifting text accordingly.
18061 If it is an item, convert all items to normal lines.
18063 If it is normal text, change region into an item. With a prefix
18064 argument ARG, change each line in region into an item."
18065 (interactive "P")
18066 (let ((shift-text
18067 (function
18068 ;; Shift text in current section to IND, from point to END.
18069 ;; The function leaves point to END line.
18070 (lambda (ind end)
18071 (let ((min-i 1000) (end (copy-marker end)))
18072 ;; First determine the minimum indentation (MIN-I) of
18073 ;; the text.
18074 (save-excursion
18075 (catch 'exit
18076 (while (< (point) end)
18077 (let ((i (org-get-indentation)))
18078 (cond
18079 ;; Skip blank lines and inline tasks.
18081 ((looking-at org-outline-regexp-bol))
18082 ;; We can't find less than 0 indentation.
18083 ((zerop i) (throw 'exit (setq min-i 0)))
18084 ((< i min-i) (setq min-i i))))
18085 (forward-line))))
18086 ;; Then indent each line so that a line indented to
18087 ;; MIN-I becomes indented to IND. Ignore blank lines
18088 ;; and inline tasks in the process.
18089 (let ((delta (- ind min-i)))
18090 (while (< (point) end)
18092 (looking-at org-outline-regexp-bol))
18093 (org-indent-line-to (+ (org-get-indentation) delta)))
18094 (forward-line)))))))
18095 (skip-blanks
18096 (function
18097 ;; Return beginning of first non-blank line, starting from
18098 ;; line at POS.
18099 (lambda (pos)
18100 (save-excursion
18101 (goto-char pos)
18103 (point-at-bol)))))
18104 beg end)
18105 ;; Determine boundaries of changes.
18106 (if (org-region-active-p)
18107 (setq beg (funcall skip-blanks (region-beginning))
18108 end (copy-marker (region-end)))
18109 (setq beg (funcall skip-blanks (point-at-bol))
18110 end (copy-marker (point-at-eol))))
18111 ;; Depending on the starting line, choose an action on the text
18112 ;; between BEG and END.
18113 (org-with-limited-levels
18114 (save-excursion
18115 (goto-char beg)
18116 (cond
18117 ;; Case 1. Start at an item: de-itemize. Note that it only
18118 ;; happens when a region is active: `org-ctrl-c-minus'
18119 ;; would call `org-cycle-list-bullet' otherwise.
18120 ((org-at-item-p)
18121 (while (< (point) end)
18122 (when (org-at-item-p)
18124 (delete-region (point) (match-end 0)))
18125 (forward-line)))
18126 ;; Case 2. Start at an heading: convert to items.
18127 ((org-on-heading-p)
18128 (let* ((bul (org-list-bullet-string "-"))
18129 (bul-len (length bul))
18130 ;; Indentation of the first heading. It should be
18131 ;; relative to the indentation of its parent, if any.
18132 (start-ind (save-excursion
18133 (cond
18134 ((not org-adapt-indentation) 0)
18135 ((not (outline-previous-heading)) 0)
18136 (t (length (match-string 0))))))
18137 ;; Level of first heading. Further headings will be
18138 ;; compared to it to determine hierarchy in the list.
18139 (ref-level (org-reduced-level (org-outline-level))))
18140 (while (< (point) end)
18141 (let* ((level (org-reduced-level (org-outline-level)))
18142 (delta (max 0 (- level ref-level))))
18143 ;; If current headline is less indented than the first
18144 ;; one, set it as reference, in order to preserve
18145 ;; subtrees.
18146 (when (< level ref-level) (setq ref-level level))
18147 (replace-match bul t t)
18148 (org-indent-line-to (+ start-ind (* delta bul-len)))
18149 ;; Ensure all text down to END (or SECTION-END) belongs
18150 ;; to the newly created item.
18151 (let ((section-end (save-excursion
18152 (or (outline-next-heading) (point)))))
18153 (forward-line)
18154 (funcall shift-text
18155 (+ start-ind (* (1+ delta) bul-len))
18156 (min end section-end)))))))
18157 ;; Case 3. Normal line with ARG: turn each non-item line into
18158 ;; an item.
18159 (arg
18160 (while (< (point) end)
18161 (unless (or (org-on-heading-p) (org-at-item-p))
18163 (replace-match
18165 (forward-line)))
18166 ;; Case 4. Normal line without ARG: make the first line of
18167 ;; region an item, and shift indentation of others
18168 ;; lines to set them as item's body.
18169 (t (let* ((bul (org-list-bullet-string "-"))
18170 (bul-len (length bul))
18171 (ref-ind (org-get-indentation)))
18173 (insert bul)
18174 (forward-line)
18175 (while (< (point) end)
18176 ;; Ensure that lines less indented than first one
18177 ;; still get included in item body.
18178 (funcall shift-text
18179 (+ ref-ind bul-len)
18180 (min end (save-excursion (or (outline-next-heading)
18181 (point)))))
18182 (forward-line)))))))))
18184 (defun org-toggle-heading (&optional nstars)
18185 "Convert headings to normal text, or items or text to headings.
18186 If there is no active region, only the current line is considered.
18188 If the first non blank line is an headline, remove the stars from
18189 all headlines in the region.
18191 If it is a plain list item, turn all plain list items into headings.
18193 If it is a normal line, turn each and every normal line (i.e. not
18194 an heading or an item) in the region into a heading.
18196 When converting a line into a heading, the number of stars is chosen
18197 such that the lines become children of the current entry. However,
18198 when a prefix argument is given, its value determines the number of
18199 stars to add."
18200 (interactive "P")
18201 (let ((skip-blanks
18202 (function
18203 ;; Return beginning of first non-blank line, starting from
18204 ;; line at POS.
18205 (lambda (pos)
18206 (save-excursion
18207 (goto-char pos)
18209 (point-at-bol)))))
18210 beg end)
18211 ;; Determine boundaries of changes. If region ends at a bol, do
18212 ;; not consider the last line to be in the region.
18213 (if (org-region-active-p)
18214 (setq beg (funcall skip-blanks (region-beginning))
18215 end (copy-marker (save-excursion
18216 (goto-char (region-end))
18217 (if (bolp) (point) (point-at-eol)))))
18218 (setq beg (funcall skip-blanks (point-at-bol))
18219 end (copy-marker (point-at-eol))))
18220 ;; Ensure inline tasks don't count as headings.
18221 (org-with-limited-levels
18222 (save-excursion
18223 (goto-char beg)
18224 (cond
18225 ;; Case 1. Started at an heading: de-star headings.
18226 ((org-on-heading-p)
18227 (while (< (point) end)
18228 (when (org-on-heading-p t)
18229 (looking-at org-outline-regexp) (replace-match ""))
18230 (forward-line)))
18231 ;; Case 2. Started at an item: change items into headlines.
18232 ;; One star will be added by `org-list-to-subtree'.
18233 ((org-at-item-p)
18234 (let* ((stars (make-string
18235 (if nstars
18236 ;; subtract the star that will be added again by
18237 ;; `org-list-to-subtree'
18238 (1- (prefix-numeric-value current-prefix-arg))
18239 (or (org-current-level) 0))
18240 ?*))
18241 (add-stars
18242 (cond (nstars "") ; stars from prefix only
18243 ((equal stars "") "") ; before first heading
18244 (org-odd-levels-only "*") ; inside heading, odd
18245 (t "")))) ; inside heading, oddeven
18246 (while (< (point) end)
18247 (when (org-at-item-p)
18248 ;; Pay attention to cases when region ends before list.
18249 (let* ((struct (org-list-struct))
18250 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18251 (save-restriction
18252 (narrow-to-region (point) list-end)
18253 (insert
18254 (org-list-to-subtree
18255 (org-list-parse-list t)
18256 '(:istart (concat stars add-stars (funcall get-stars depth))
18257 :icount (concat stars add-stars (funcall get-stars depth))))))))
18258 (forward-line))))
18259 ;; Case 3. Started at normal text: make every line an heading,
18260 ;; skipping headlines and items.
18261 (t (let* ((stars (make-string
18262 (if nstars
18263 (prefix-numeric-value current-prefix-arg)
18264 (or (org-current-level) 0))
18265 ?*))
18266 (add-stars
18267 (cond (nstars "") ; stars from prefix only
18268 ((equal stars "") "*") ; before first heading
18269 (org-odd-levels-only "**") ; inside heading, odd
18270 (t "*"))) ; inside heading, oddeven
18271 (rpl (concat stars add-stars " ")))
18272 (while (< (point) end)
18273 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18275 (replace-match (concat rpl (match-string 2))))
18276 (forward-line)))))))))
18278 (defun org-meta-return (&optional arg)
18279 "Insert a new heading or wrap a region in a table.
18280 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18281 See the individual commands for more information."
18282 (interactive "P")
18283 (cond
18284 ((run-hook-with-args-until-success 'org-metareturn-hook))
18285 ((org-at-table-p)
18286 (call-interactively 'org-table-wrap-region))
18287 (t (call-interactively 'org-insert-heading))))
18289 ;;; Menu entries
18291 ;; Define the Org-mode menus
18292 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18293 '("Tbl"
18294 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18295 ["Next Field" org-cycle (org-at-table-p)]
18296 ["Previous Field" org-shifttab (org-at-table-p)]
18297 ["Next Row" org-return (org-at-table-p)]
18298 "--"
18299 ["Blank Field" org-table-blank-field (org-at-table-p)]
18300 ["Edit Field" org-table-edit-field (org-at-table-p)]
18301 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18302 "--"
18303 ("Column"
18304 ["Move Column Left" org-metaleft (org-at-table-p)]
18305 ["Move Column Right" org-metaright (org-at-table-p)]
18306 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18307 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18308 ("Row"
18309 ["Move Row Up" org-metaup (org-at-table-p)]
18310 ["Move Row Down" org-metadown (org-at-table-p)]
18311 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18312 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18313 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18314 "--"
18315 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18316 ("Rectangle"
18317 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18318 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18319 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18320 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18321 "--"
18322 ("Calculate"
18323 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18324 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18325 ["Edit Formulas" org-edit-special (org-at-table-p)]
18326 "--"
18327 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18328 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18329 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18330 "--"
18331 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18332 "--"
18333 ["Sum Column/Rectangle" org-table-sum
18334 (or (org-at-table-p) (org-region-active-p))]
18335 ["Which Column?" org-table-current-column (org-at-table-p)])
18336 ["Debug Formulas"
18337 org-table-toggle-formula-debugger
18338 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18339 ["Show Col/Row Numbers"
18340 org-table-toggle-coordinate-overlays
18341 :style toggle
18342 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18343 "--"
18344 ["Create" org-table-create (and (not (org-at-table-p))
18345 org-enable-table-editor)]
18346 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18347 ["Import from File" org-table-import (not (org-at-table-p))]
18348 ["Export to File" org-table-export (org-at-table-p)]
18349 "--"
18350 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18352 (easy-menu-define org-org-menu org-mode-map "Org menu"
18353 '("Org"
18354 ("Show/Hide"
18355 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18356 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18357 ["Sparse Tree..." org-sparse-tree t]
18358 ["Reveal Context" org-reveal t]
18359 ["Show All" show-all t]
18360 "--"
18361 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18362 "--"
18363 ["New Heading" org-insert-heading t]
18364 ("Navigate Headings"
18365 ["Up" outline-up-heading t]
18366 ["Next" outline-next-visible-heading t]
18367 ["Previous" outline-previous-visible-heading t]
18368 ["Next Same Level" outline-forward-same-level t]
18369 ["Previous Same Level" outline-backward-same-level t]
18370 "--"
18371 ["Jump" org-goto t])
18372 ("Edit Structure"
18373 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18374 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18375 "--"
18376 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18377 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18378 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18379 "--"
18380 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18381 "--"
18382 ["Copy visible text" org-copy-visible t]
18383 "--"
18384 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18385 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18386 ["Demote Heading" org-metaright (not (org-at-table-p))]
18387 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18388 "--"
18389 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18390 "--"
18391 ["Convert to odd levels" org-convert-to-odd-levels t]
18392 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18393 ("Editing"
18394 ["Emphasis..." org-emphasize t]
18395 ["Edit Source Example" org-edit-special t]
18396 "--"
18397 ["Footnote new/jump" org-footnote-action t]
18398 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18399 ("Archive"
18400 ["Archive (default method)" org-archive-subtree-default t]
18401 "--"
18402 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18403 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18404 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18405 )
18406 "--"
18407 ("Hyperlinks"
18408 ["Store Link (Global)" org-store-link t]
18409 ["Find existing link to here" org-occur-link-in-agenda-files t]
18410 ["Insert Link" org-insert-link t]
18411 ["Follow Link" org-open-at-point t]
18412 "--"
18413 ["Next link" org-next-link t]
18414 ["Previous link" org-previous-link t]
18415 "--"
18416 ["Descriptive Links"
18417 org-toggle-link-display
18418 :style radio
18419 :selected org-link-display-descriptive
18420 ]
18421 ["Literal Links"
18422 org-toggle-link-display
18423 :style radio
18424 :selected (not org-link-display-descriptive)])
18425 "--"
18426 ("TODO Lists"
18427 ["TODO/DONE/-" org-todo t]
18428 ("Select keyword"
18429 ["Next keyword" org-shiftright (org-on-heading-p)]
18430 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18431 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18432 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18433 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18434 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18435 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18436 "--"
18437 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18438 :selected org-enforce-todo-dependencies :style toggle :active t]
18439 "Settings for tree at point"
18440 ["Do Children sequentially" org-toggle-ordered-property :style radio
18441 :selected (org-entry-get nil "ORDERED")
18442 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18443 ["Do Children parallel" org-toggle-ordered-property :style radio
18444 :selected (not (org-entry-get nil "ORDERED"))
18445 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18446 "--"
18447 ["Set Priority" org-priority t]
18448 ["Priority Up" org-shiftup t]
18449 ["Priority Down" org-shiftdown t]
18450 "--"
18451 ["Get news from all feeds" org-feed-update-all t]
18452 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18453 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18454 ("TAGS and Properties"
18455 ["Set Tags" org-set-tags-command t]
18456 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18457 "--"
18458 ["Set property" org-set-property t]
18459 ["Column view of properties" org-columns t]
18460 ["Insert Column View DBlock" org-insert-columns-dblock t])
18461 ("Dates and Scheduling"
18462 ["Timestamp" org-time-stamp t]
18463 ["Timestamp (inactive)" org-time-stamp-inactive t]
18464 ("Change Date"
18465 ["1 Day Later" org-shiftright t]
18466 ["1 Day Earlier" org-shiftleft t]
18467 ["1 ... Later" org-shiftup t]
18468 ["1 ... Earlier" org-shiftdown t])
18469 ["Compute Time Range" org-evaluate-time-range t]
18470 ["Schedule Item" org-schedule t]
18471 ["Deadline" org-deadline t]
18472 "--"
18473 ["Custom time format" org-toggle-time-stamp-overlays
18474 :style radio :selected org-display-custom-times]
18475 "--"
18476 ["Goto Calendar" org-goto-calendar t]
18477 ["Date from Calendar" org-date-from-calendar t]
18478 "--"
18479 ["Start/Restart Timer" org-timer-start t]
18480 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18481 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18482 ["Insert Timer String" org-timer t]
18483 ["Insert Timer Item" org-timer-item t])
18484 ("Logging work"
18485 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18486 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18487 ["Clock out" org-clock-out t]
18488 ["Clock cancel" org-clock-cancel t]
18489 "--"
18490 ["Mark as default task" org-clock-mark-default-task t]
18491 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18492 ["Goto running clock" org-clock-goto t]
18493 "--"
18494 ["Display times" org-clock-display t]
18495 ["Create clock table" org-clock-report t]
18496 "--"
18497 ["Record DONE time"
18498 (progn (setq org-log-done (not org-log-done))
18499 (message "Switching to %s will %s record a timestamp"
18500 (car org-done-keywords)
18501 (if org-log-done "automatically" "not")))
18502 :style toggle :selected org-log-done])
18503 "--"
18504 ["Agenda Command..." org-agenda t]
18505 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18506 ("File List for Agenda")
18507 ("Special views current file"
18508 ["TODO Tree" org-show-todo-tree t]
18509 ["Check Deadlines" org-check-deadlines t]
18510 ["Timeline" org-timeline t]
18511 ["Tags/Property tree" org-match-sparse-tree t])
18512 "--"
18513 ["Export/Publish..." org-export t]
18514 ("LaTeX"
18515 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18516 :selected org-cdlatex-mode]
18517 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18518 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18519 ["Modify math symbol" org-cdlatex-math-modify
18520 (org-inside-LaTeX-fragment-p)]
18521 ["Insert citation" org-reftex-citation t]
18522 "--"
18523 ["Template for BEAMER" org-insert-beamer-options-template t])
18524 "--"
18525 ("MobileOrg"
18526 ["Push Files and Views" org-mobile-push t]
18527 ["Get Captured and Flagged" org-mobile-pull t]
18528 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18529 "--"
18530 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18531 "--"
18532 ("Documentation"
18533 ["Show Version" org-version t]
18534 ["Info Documentation" org-info t])
18535 ("Customize"
18536 ["Browse Org Group" org-customize t]
18537 "--"
18538 ["Expand This Menu" org-create-customize-menu
18539 (fboundp 'customize-menu-create)])
18540 ["Send bug report" org-submit-bug-report t]
18541 "--"
18542 ("Refresh/Reload"
18543 ["Refresh setup current buffer" org-mode-restart t]
18544 ["Reload Org (after update)" org-reload t]
18545 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18546 ))
18548 (defun org-info (&optional node)
18549 "Read documentation for Org-mode in the info system.
18550 With optional NODE, go directly to that node."
18551 (interactive)
18552 (info (format "(org)%s" (or node ""))))
18554 ;;;###autoload
18555 (defun org-submit-bug-report ()
18556 "Submit a bug report on Org-mode via mail.
18558 Don't hesitate to report any problems or inaccurate documentation.
18560 If you don't have setup sending mail from (X)Emacs, please copy the
18561 output buffer into your mail program, as it gives us important
18562 information about your Org-mode version and configuration."
18563 (interactive)
18564 (require 'reporter)
18565 (org-load-modules-maybe)
18566 (org-require-autoloaded-modules)
18567 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18568 (reporter-submit-bug-report
18569 "emacs-orgmode@gnu.org"
18570 (org-version)
18571 (let (list)
18572 (save-window-excursion
18573 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18574 (delete-other-windows)
18575 (erase-buffer)
18576 (insert "You are about to submit a bug report to the Org-mode mailing list.
18578 We would like to add your full Org-mode and Outline configuration to the
18579 bug report. This greatly simplifies the work of the maintainer and
18580 other experts on the mailing list.
18582 HOWEVER, some variables you have customized may contain private
18583 information. The names of customers, colleagues, or friends, might
18584 appear in the form of file names, tags, todo states, or search strings.
18585 If you answer yes to the prompt, you might want to check and remove
18586 such private information before sending the email.")
18587 (add-text-properties (point-min) (point-max) '(face org-warning))
18588 (when (yes-or-no-p "Include your Org-mode configuration ")
18589 (mapatoms
18590 (lambda (v)
18591 (and (boundp v)
18593 (or (and (symbol-value v)
18595 (and
18596 (get v 'custom-type) (get v 'standard-value)
18597 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18598 (push v list)))))
18599 (kill-buffer (get-buffer "*Warn about privacy*"))
18600 list))
18601 nil nil
18602 "Remember to cover the basics, that is, what you expected to happen and
18603 what in fact did happen. You don't know how to make a good report? See
18605 http://orgmode.org/manual/Feedback.html#Feedback
18607 Your bug report will be posted to the Org-mode mailing list.
18608 ------------------------------------------------------------------------")
18609 (save-excursion
18614 (defun org-install-agenda-files-menu ()
18615 (let ((bl (buffer-list)))
18616 (save-excursion
18617 (while bl
18618 (set-buffer (pop bl))
18619 (if (org-mode-p) (setq bl nil)))
18620 (when (org-mode-p)
18621 (easy-menu-change
18622 '("Org") "File List for Agenda"
18623 (append
18624 (list
18625 ["Edit File List" (org-edit-agenda-file-list) t]
18626 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18627 ["Remove Current File from List" org-remove-file t]
18628 ["Cycle through agenda files" org-cycle-agenda-files t]
18629 ["Occur in all agenda files" org-occur-in-agenda-files t]
18630 "--")
18631 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18633 ;;;; Documentation
18635 ;;;###autoload
18636 (defun org-require-autoloaded-modules ()
18637 (interactive)
18638 (mapc 'require
18639 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18640 org-docbook org-exp org-html org-icalendar
18641 org-id org-latex
18642 org-publish org-remember org-table
18643 org-timer org-xoxo)))
18645 ;;;###autoload
18646 (defun org-reload (&optional uncompiled)
18647 "Reload all org lisp files.
18648 With prefix arg UNCOMPILED, load the uncompiled versions."
18649 (interactive "P")
18650 (require 'find-func)
18652 (dir-org (file-name-directory (org-find-library-name "org")))
18653 (dir-org-contrib (ignore-errors
18654 (file-name-directory
18655 (org-find-library-name "org-contribdir"))))
18656 (babel-files
18657 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18658 (append (list nil "comint" "eval" "exp" "keys"
18659 "lob" "ref" "table" "tangle")
18660 (delq nil
18661 (mapcar
18662 (lambda (lang)
18663 (when (cdr lang) (symbol-name (car lang))))
18664 org-babel-load-languages)))))
18665 (files
18666 (append (directory-files dir-org t file-re)
18667 babel-files
18668 (and dir-org-contrib
18669 (directory-files dir-org-contrib t file-re))))
18670 (remove-re (concat (if (featurep 'xemacs)
18671 "org-colview" "org-colview-xemacs")
18673 (setq files (mapcar 'file-name-sans-extension files))
18674 (setq files (mapcar
18675 (lambda (x) (if (string-match remove-re x) nil x))
18676 files))
18677 (setq files (delq nil files))
18678 (mapc
18679 (lambda (f)
18680 (when (featurep (intern (file-name-nondirectory f)))
18681 (if (and (not uncompiled)
18682 (file-exists-p (concat f ".elc")))
18683 (load (concat f ".elc") nil nil t)
18684 (load (concat f ".el") nil nil t))))
18685 files))
18686 (org-version))
18688 ;;;###autoload
18689 (defun org-customize ()
18690 "Call the customize function with org as argument."
18691 (interactive)
18692 (org-load-modules-maybe)
18693 (org-require-autoloaded-modules)
18694 (customize-browse 'org))
18696 (defun org-create-customize-menu ()
18697 "Create a full customization menu for Org-mode, insert it into the menu."
18698 (interactive)
18699 (org-load-modules-maybe)
18700 (org-require-autoloaded-modules)
18701 (if (fboundp 'customize-menu-create)
18702 (progn
18703 (easy-menu-change
18704 '("Org") "Customize"
18705 `(["Browse Org group" org-customize t]
18706 "--"
18707 ,(customize-menu-create 'org)
18708 ["Set" Custom-set t]
18709 ["Save" Custom-save t]
18710 ["Reset to Current" Custom-reset-current t]
18711 ["Reset to Saved" Custom-reset-saved t]
18712 ["Reset to Standard Settings" Custom-reset-standard t]))
18714 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18716 ;;;; Miscellaneous stuff
18718 ;;; Generally useful functions
18720 (defun org-get-at-bol (property)
18721 "Get text property PROPERTY at beginning of line."
18722 (get-text-property (point-at-bol) property))
18724 (defun org-find-text-property-in-string (prop s)
18725 "Return the first non-nil value of property PROP in string S."
18726 (or (get-text-property 0 prop s)
18727 (get-text-property (or (next-single-property-change 0 prop s) 0)
18728 prop s)))
18730 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18731 "Display the given MESSAGE as a warning."
18732 (if (fboundp 'display-warning)
18733 (display-warning 'org message
18734 (if (featurep 'xemacs) 'warning :warning))
18735 (let ((buf (get-buffer-create "*Org warnings*")))
18736 (with-current-buffer buf
18737 (goto-char (point-max))
18738 (insert "Warning (Org): " message)
18739 (unless (bolp)
18740 (newline)))
18741 (display-buffer buf)
18742 (sit-for 0))))
18744 (defun org-eval (form)
18745 "Eval FORM and return result."
18746 (condition-case error
18747 (eval form)
18748 (error (format "%%![Error: %s]" error))))
18750 (defun org-in-commented-line ()
18751 "Is point in a line starting with `#'?"
18752 (equal (char-after (point-at-bol)) ?#))
18754 (defun org-in-indented-comment-line ()
18755 "Is point in a line starting with `#' after some white space?"
18756 (save-excursion
18757 (save-match-data
18758 (goto-char (point-at-bol))
18761 (defun org-in-verbatim-emphasis ()
18762 (save-match-data
18763 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18765 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18766 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18767 (if (and marker (marker-buffer marker)
18768 (buffer-live-p (marker-buffer marker)))
18769 (progn
18770 (org-pop-to-buffer-same-window (marker-buffer marker))
18771 (if (or (> marker (point-max)) (< marker (point-min)))
18772 (widen))
18773 (goto-char marker)
18774 (org-show-context 'org-goto))
18775 (if bookmark
18776 (bookmark-jump bookmark)
18777 (error "Cannot find location"))))
18779 (defun org-quote-csv-field (s)
18780 "Quote field for inclusion in CSV material."
18783 s))
18785 (defun org-force-self-insert (N)
18786 "Needed to enforce self-insert under remapping."
18787 (interactive "p")
18788 (self-insert-command N))
18790 (defun org-string-width (s)
18791 "Compute width of string, ignoring invisible characters.
18792 This ignores character with invisibility property `org-link', and also
18793 characters with property `org-cwidth', because these will become invisible
18794 upon the next fontification round."
18795 (let (b l)
18796 (when (or (eq t buffer-invisibility-spec)
18797 (assq 'org-link buffer-invisibility-spec))
18798 (while (setq b (text-property-any 0 (length s)
18799 'invisible 'org-link s))
18800 (setq s (concat (substring s 0 b)
18801 (substring s (or (next-single-property-change
18802 b 'invisible s) (length s)))))))
18803 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18804 (setq s (concat (substring s 0 b)
18805 (substring s (or (next-single-property-change
18806 b 'org-cwidth s) (length s))))))
18807 (setq l (string-width s) b -1)
18808 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18809 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18810 l))
18812 (defun org-shorten-string (s maxlength)
18813 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18814 If the string is shorter or has length MAXLENGTH, just return the
18815 original string. If it is longer, the functions finds a space in the
18816 string, breaks this string off at that locations and adds three dots
18817 as ellipsis. Including the ellipsis, the string will not be longer
18818 than MAXLENGTH. If finding a good breaking point in the string does
18819 not work, the string is just chopped off in the middle of a word
18820 if necessary."
18821 (if (<= (length s) maxlength)
18822 s
18823 (let* ((n (max (- maxlength 4) 1))
18825 (if (string-match re s)
18826 (concat (match-string 1 s) "...")
18827 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18829 (defun org-get-indentation (&optional line)
18830 "Get the indentation of the current line, interpreting tabs.
18831 When LINE is given, assume it represents a line and compute its indentation."
18832 (if line
18833 (if (string-match "^ *" (org-remove-tabs line))
18834 (match-end 0))
18835 (save-excursion
18836 (beginning-of-line 1)
18838 (current-column))))
18840 (defun org-get-string-indentation (s)
18841 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18842 (let ((n -1) (i 0) (w tab-width) c)
18843 (catch 'exit
18844 (while (< (setq n (1+ n)) (length s))
18845 (setq c (aref s n))
18846 (cond ((= c ?\ ) (setq i (1+ i)))
18848 (t (throw 'exit t)))))
18849 i))
18851 (defun org-remove-tabs (s &optional width)
18852 "Replace tabulators in S with spaces.
18853 Assumes that s is a single line, starting in column 0."
18854 (setq width (or width tab-width))
18856 (setq s (replace-match
18857 (make-string
18858 (- (* width (/ (+ (match-beginning 0) width) width))
18859 (match-beginning 0)) ?\ )
18860 t t s)))
18861 s)
18863 (defun org-fix-indentation (line ind)
18864 "Fix indentation in LINE.
18865 IND is a cons cell with target and minimum indentation.
18866 If the current indentation in LINE is smaller than the minimum,
18867 leave it alone. If it is larger than ind, set it to the target."
18868 (let* ((l (org-remove-tabs line))
18869 (i (org-get-indentation l))
18870 (i1 (car ind)) (i2 (cdr ind)))
18871 (if (>= i i2) (setq l (substring line i2)))
18872 (if (> i1 0)
18873 (concat (make-string i1 ?\ ) l)
18874 l)))
18876 (defun org-remove-indentation (code &optional n)
18877 "Remove the maximum common indentation from the lines in CODE.
18878 N may optionally be the number of spaces to remove."
18879 (with-temp-buffer
18880 (insert code)
18881 (org-do-remove-indentation n)
18882 (buffer-string)))
18884 (defun org-do-remove-indentation (&optional n)
18885 "Remove the maximum common indentation from the buffer."
18886 (untabify (point-min) (point-max))
18887 (let ((min 10000) re)
18888 (if n
18889 (setq min n)
18890 (goto-char (point-min))
18892 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18893 (unless (or (= min 0) (= min 10000))
18895 (goto-char (point-min))
18896 (while (re-search-forward re nil t)
18897 (replace-match "")
18898 (end-of-line 1))
18899 min)))
18901 (defun org-fill-template (template alist)
18902 "Find each %key of ALIST in TEMPLATE and replace it."
18903 (let ((case-fold-search nil)
18904 entry key value)
18905 (setq alist (sort (copy-sequence alist)
18906 (lambda (a b) (< (length (car a)) (length (car b))))))
18907 (while (setq entry (pop alist))
18908 (setq template
18909 (replace-regexp-in-string
18910 (concat "%" (regexp-quote (car entry)))
18911 (cdr entry) template t t)))
18912 template))
18914 (defun org-base-buffer (buffer)
18915 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18916 (if (not buffer)
18917 buffer
18918 (or (buffer-base-buffer buffer)
18919 buffer)))
18921 (defun org-trim (s)
18922 "Remove whitespace at beginning and end of string."
18925 s)
18927 (defun org-wrap (string &optional width lines)
18928 "Wrap string to either a number of lines, or a width in characters.
18929 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18930 that costs. If there is a word longer than WIDTH, the text is actually
18931 wrapped to the length of that word.
18932 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18933 many lines, whatever width that takes.
18934 The return value is a list of lines, without newlines at the end."
18936 (maxword (apply 'max (mapcar 'org-string-width words)))
18937 w ll)
18938 (cond (width
18939 (org-do-wrap words (max maxword width)))
18940 (lines
18941 (setq w maxword)
18942 (setq ll (org-do-wrap words maxword))
18943 (if (<= (length ll) lines)
18944 ll
18945 (setq ll words)
18946 (while (> (length ll) lines)
18947 (setq w (1+ w))
18948 (setq ll (org-do-wrap words w)))
18949 ll))
18950 (t (error "Cannot wrap this")))))
18952 (defun org-do-wrap (words width)
18953 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18954 (let (lines line)
18955 (while words
18956 (setq line (pop words))
18957 (while (and words (< (+ (length line) (length (car words))) width))
18958 (setq line (concat line " " (pop words))))
18959 (setq lines (push line lines)))
18960 (nreverse lines)))
18962 (defun org-split-string (string &optional separators)
18963 "Splits STRING into substrings at SEPARATORS.
18964 No empty strings are returned if there are matches at the beginning
18965 and end of string."
18967 (start 0)
18968 notfirst
18969 (list nil))
18970 (while (and (string-match rexp string
18971 (if (and notfirst
18972 (= start (match-beginning 0))
18973 (< start (length string)))
18974 (1+ start) start))
18975 (< (match-beginning 0) (length string)))
18976 (setq notfirst t)
18977 (or (eq (match-beginning 0) 0)
18978 (and (eq (match-beginning 0) (match-end 0))
18979 (eq (match-beginning 0) start))
18980 (setq list
18981 (cons (substring string start (match-beginning 0))
18982 list)))
18983 (setq start (match-end 0)))
18984 (or (eq start (length string))
18985 (setq list
18986 (cons (substring string start)
18987 list)))
18988 (nreverse list)))
18990 (defun org-quote-vert (s)
18992 (while (string-match "|" s)
18994 s)
18996 (defun org-uuidgen-p (s)
18997 "Is S an ID created by UUIDGEN?"
18998 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19000 (defun org-context ()
19001 "Return a list of contexts of the current cursor position.
19002 If several contexts apply, all are returned.
19003 Each context entry is a list with a symbol naming the context, and
19004 two positions indicating start and end of the context. Possible
19005 contexts are:
19007 :headline anywhere in a headline
19008 :headline-stars on the leading stars in a headline
19009 :todo-keyword on a TODO keyword (including DONE) in a headline
19010 :tags on the TAGS in a headline
19011 :priority on the priority cookie in a headline
19012 :item on the first line of a plain list item
19013 :item-bullet on the bullet/number of a plain list item
19014 :checkbox on the checkbox in a plain list item
19015 :table in an org-mode table
19016 :table-special on a special filed in a table
19017 :table-table in a table.el table
19018 :link on a hyperlink
19019 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19020 :target on a <<target>>
19021 :radio-target on a <<<radio-target>>>
19022 :latex-fragment on a LaTeX fragment
19023 :latex-preview on a LaTeX fragment with overlayed preview image
19025 This function expects the position to be visible because it uses font-lock
19026 faces as a help to recognize the following contexts: :table-special, :link,
19027 and :keyword."
19028 (let* ((f (get-text-property (point) 'face))
19029 (faces (if (listp f) f (list f)))
19030 (p (point)) clist o)
19031 ;; First the large context
19032 (cond
19033 ((org-on-heading-p t)
19034 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19035 (when (progn
19036 (beginning-of-line 1)
19037 (looking-at org-todo-line-tags-regexp))
19038 (push (org-point-in-group p 1 :headline-stars) clist)
19039 (push (org-point-in-group p 2 :todo-keyword) clist)
19040 (push (org-point-in-group p 4 :tags) clist))
19041 (goto-char p)
19044 (push (org-point-in-group p 0 :priority) clist)))
19046 ((org-at-item-p)
19047 (push (org-point-in-group p 2 :item-bullet) clist)
19048 (push (list :item (point-at-bol)
19049 (save-excursion (org-end-of-item) (point)))
19050 clist)
19051 (and (org-at-item-checkbox-p)
19052 (push (org-point-in-group p 0 :checkbox) clist)))
19054 ((org-at-table-p)
19055 (push (list :table (org-table-begin) (org-table-end)) clist)
19056 (if (memq 'org-formula faces)
19057 (push (list :table-special
19058 (previous-single-property-change p 'face)
19059 (next-single-property-change p 'face)) clist)))
19060 ((org-at-table-p 'any)
19061 (push (list :table-table) clist)))
19062 (goto-char p)
19064 ;; Now the small context
19065 (cond
19066 ((org-at-timestamp-p)
19067 (push (org-point-in-group p 0 :timestamp) clist))
19068 ((memq 'org-link faces)
19069 (push (list :link
19070 (previous-single-property-change p 'face)
19071 (next-single-property-change p 'face)) clist))
19072 ((memq 'org-special-keyword faces)
19073 (push (list :keyword
19074 (previous-single-property-change p 'face)
19075 (next-single-property-change p 'face)) clist))
19076 ((org-on-target-p)
19077 (push (org-point-in-group p 0 :target) clist)
19078 (goto-char (1- (match-beginning 0)))
19079 (if (looking-at org-radio-target-regexp)
19080 (push (org-point-in-group p 0 :radio-target) clist))
19081 (goto-char p))
19082 ((setq o (car (delq nil
19083 (mapcar
19084 (lambda (x)
19085 (if (memq x org-latex-fragment-image-overlays) x))
19086 (overlays-at (point))))))
19087 (push (list :latex-fragment
19088 (overlay-start o) (overlay-end o)) clist)
19089 (push (list :latex-preview
19090 (overlay-start o) (overlay-end o)) clist))
19091 ((org-inside-LaTeX-fragment-p)
19092 ;; FIXME: positions wrong.
19093 (push (list :latex-fragment (point) (point)) clist)))
19095 (setq clist (nreverse (delq nil clist)))
19096 clist))
19098 ;; FIXME: Compare with at-regexp-p Do we need both?
19099 (defun org-in-regexp (re &optional nlines visually)
19100 "Check if point is inside a match of regexp.
19101 Normally only the current line is checked, but you can include NLINES extra
19102 lines both before and after point into the search.
19103 If VISUALLY is set, require that the cursor is not after the match but
19104 really on, so that the block visually is on the match."
19105 (catch 'exit
19106 (let ((pos (point))
19107 (eol (point-at-eol (+ 1 (or nlines 0))))
19108 (inc (if visually 1 0)))
19109 (save-excursion
19110 (beginning-of-line (- 1 (or nlines 0)))
19111 (while (re-search-forward re eol t)
19112 (if (and (<= (match-beginning 0) pos)
19113 (>= (+ inc (match-end 0)) pos))
19114 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19116 (defun org-at-regexp-p (regexp)
19117 "Is point inside a match of REGEXP in the current line?"
19118 (catch 'exit
19119 (save-excursion
19120 (let ((pos (point)) (end (point-at-eol)))
19121 (beginning-of-line 1)
19122 (while (re-search-forward regexp end t)
19123 (if (and (<= (match-beginning 0) pos)
19124 (>= (match-end 0) pos))
19125 (throw 'exit t)))
19126 nil))))
19128 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19129 "Non-nil when point is between matches of START-RE and END-RE.
19131 Also return a non-nil value when point is on one of the matches.
19133 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19134 buffer positions. Default values are the positions of headlines
19135 surrounding the point.
19137 The functions returns a cons cell whose car (resp. cdr) is the
19138 position before START-RE (resp. after END-RE)."
19139 (save-match-data
19140 (let ((pos (point))
19141 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19142 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19143 beg end)
19144 (save-excursion
19145 ;; Point is on a block when on START-RE or if START-RE can be
19146 ;; found before it...
19147 (and (or (org-at-regexp-p start-re)
19148 (re-search-backward start-re limit-up t))
19149 (setq beg (match-beginning 0))
19150 ;; ... and END-RE after it...
19151 (goto-char (match-end 0))
19152 (re-search-forward end-re limit-down t)
19153 (> (setq end (match-end 0)) pos)
19154 ;; ... without another START-RE in-between.
19155 (goto-char (match-beginning 0))
19156 (not (re-search-backward start-re (1+ beg) t))
19157 ;; Return value.
19158 (cons beg end))))))
19160 (defun org-in-block-p (names)
19161 "Is point inside any block whose name belongs to NAMES?
19163 NAMES is a list of strings containing names of blocks."
19164 (save-match-data
19165 (catch 'exit
19166 (let ((case-fold-search t)
19167 (lim-up (save-excursion (outline-previous-heading)))
19168 (lim-down (save-excursion (outline-next-heading))))
19169 (mapc (lambda (name)
19170 (let ((n (regexp-quote name)))
19171 (when (org-between-regexps-p
19174 lim-up lim-down)
19175 (throw 'exit t))))
19176 names))
19177 nil)))
19179 (defun org-occur-in-agenda-files (regexp &optional nlines)
19180 "Call `multi-occur' with buffers for all agenda files."
19182 (let* ((files (org-agenda-files))
19183 (tnames (mapcar 'file-truename files))
19184 (extra org-agenda-text-search-extra-files)
19185 f)
19186 (when (eq (car extra) 'agenda-archives)
19187 (setq extra (cdr extra))
19188 (setq files (org-add-archive-files files)))
19189 (while (setq f (pop extra))
19190 (unless (member (file-truename f) tnames)
19191 (add-to-list 'files f 'append)
19192 (add-to-list 'tnames (file-truename f) 'append)))
19193 (multi-occur
19194 (mapcar (lambda (x)
19195 (with-current-buffer
19196 (or (get-file-buffer x) (find-file-noselect x))
19197 (widen)
19198 (current-buffer)))
19199 files)
19200 regexp)))
19202 (if (boundp 'occur-mode-find-occurrence-hook)
19203 ;; Emacs 23
19204 (add-hook 'occur-mode-find-occurrence-hook
19205 (lambda ()
19206 (when (org-mode-p)
19207 (org-reveal))))
19208 ;; Emacs 22
19209 (defadvice occur-mode-goto-occurrence
19210 (after org-occur-reveal activate)
19211 (and (org-mode-p) (org-reveal)))
19212 (defadvice occur-mode-goto-occurrence-other-window
19213 (after org-occur-reveal activate)
19214 (and (org-mode-p) (org-reveal)))
19215 (defadvice occur-mode-display-occurrence
19216 (after org-occur-reveal activate)
19217 (when (org-mode-p)
19218 (let ((pos (occur-mode-find-occurrence)))
19219 (with-current-buffer (marker-buffer pos)
19220 (save-excursion
19221 (goto-char pos)
19222 (org-reveal)))))))
19224 (defun org-occur-link-in-agenda-files ()
19225 "Create a link and search for it in the agendas.
19226 The link is not stored in `org-stored-links', it is just created
19227 for the search purpose."
19228 (interactive)
19229 (let ((link (condition-case nil
19230 (org-store-link nil)
19231 (error "Unable to create a link to here"))))
19232 (org-occur-in-agenda-files (regexp-quote link))))
19234 (defun org-uniquify (list)
19235 "Remove duplicate elements from LIST."
19236 (let (res)
19237 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19238 res))
19240 (defun org-delete-all (elts list)
19241 "Remove all elements in ELTS from LIST."
19242 (while elts
19243 (setq list (delete (pop elts) list)))
19244 list)
19246 (defun org-count (cl-item cl-seq)
19247 "Count the number of occurrences of ITEM in SEQ.
19248 Taken from `count' in cl-seq.el with all keyword arguments removed."
19249 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19250 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19251 (while (< cl-start cl-end)
19252 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19253 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19254 (setq cl-start (1+ cl-start)))
19255 cl-count))
19257 (defun org-remove-if (predicate seq)
19258 "Remove everything from SEQ that fulfills PREDICATE."
19259 (let (res e)
19260 (while seq
19261 (setq e (pop seq))
19262 (if (not (funcall predicate e)) (push e res)))
19263 (nreverse res)))
19265 (defun org-remove-if-not (predicate seq)
19266 "Remove everything from SEQ that does not fulfill PREDICATE."
19267 (let (res e)
19268 (while seq
19269 (setq e (pop seq))
19270 (if (funcall predicate e) (push e res)))
19271 (nreverse res)))
19273 (defun org-back-over-empty-lines ()
19274 "Move backwards over whitespace, to the beginning of the first empty line.
19275 Returns the number of empty lines passed."
19276 (let ((pos (point)))
19277 (if (cdr (assoc 'heading org-blank-before-new-entry))
19279 (unless (eobp)
19280 (forward-line -1)))
19281 (beginning-of-line 2)
19282 (goto-char (min (point) pos))
19283 (count-lines (point) pos)))
19285 (defun org-skip-whitespace ()
19288 (defun org-point-in-group (point group &optional context)
19289 "Check if POINT is in match-group GROUP.
19290 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19291 match. If the match group does not exist or point is not inside it,
19292 return nil."
19293 (and (match-beginning group)
19294 (>= point (match-beginning group))
19295 (<= point (match-end group))
19296 (if context
19297 (list context (match-beginning group) (match-end group))
19298 t)))
19300 (defun org-switch-to-buffer-other-window (&rest args)
19301 "Switch to buffer in a second window on the current frame.
19302 In particular, do not allow pop-up frames.
19303 Returns the newly created buffer."
19304 (let (pop-up-frames special-display-buffer-names special-display-regexps
19305 special-display-function)
19306 (apply 'switch-to-buffer-other-window args)))
19308 (defun org-combine-plists (&rest plists)
19309 "Create a single property list from all plists in PLISTS.
19310 The process starts by copying the first list, and then setting properties
19311 from the other lists. Settings in the last list are the most significant
19312 ones and overrule settings in the other lists."
19313 (let ((rtn (copy-sequence (pop plists)))
19314 p v ls)
19315 (while plists
19316 (setq ls (pop plists))
19317 (while ls
19318 (setq p (pop ls) v (pop ls))
19319 (setq rtn (plist-put rtn p v))))
19320 rtn))
19322 (defun org-move-line-down (arg)
19323 "Move the current line down. With prefix argument, move it past ARG lines."
19324 (interactive "p")
19325 (let ((col (current-column))
19326 beg end pos)
19327 (beginning-of-line 1) (setq beg (point))
19328 (beginning-of-line 2) (setq end (point))
19329 (beginning-of-line (+ 1 arg))
19330 (setq pos (move-marker (make-marker) (point)))
19331 (insert (delete-and-extract-region beg end))
19332 (goto-char pos)
19333 (org-move-to-column col)))
19335 (defun org-move-line-up (arg)
19336 "Move the current line up. With prefix argument, move it past ARG lines."
19337 (interactive "p")
19338 (let ((col (current-column))
19339 beg end pos)
19340 (beginning-of-line 1) (setq beg (point))
19341 (beginning-of-line 2) (setq end (point))
19342 (beginning-of-line (- arg))
19343 (setq pos (move-marker (make-marker) (point)))
19344 (insert (delete-and-extract-region beg end))
19345 (goto-char pos)
19346 (org-move-to-column col)))
19348 (defun org-replace-escapes (string table)
19349 "Replace %-escapes in STRING with values in TABLE.
19351 The sequences in STRING may contain normal field width and padding information,
19353 so values can contain further %-escapes if they are define later in TABLE."
19354 (let ((tbl (copy-alist table))
19355 (case-fold-search nil)
19356 (pchg 0)
19357 e re rpl)
19358 (while (setq e (pop tbl))
19359 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19360 (when (and (cdr e) (string-match re (cdr e)))
19361 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19362 (safe "SREF"))
19363 (add-text-properties 0 3 (list 'sref sref) safe)
19364 (setcdr e (replace-match safe t t (cdr e)))))
19365 (while (string-match re string)
19366 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19367 (cdr e)))
19368 (setq string (replace-match rpl t t string))))
19369 (while (setq pchg (next-property-change pchg string))
19370 (let ((sref (get-text-property pchg 'sref string)))
19371 (when (and sref (string-match "SREF" string pchg))
19372 (setq string (replace-match sref t t string)))))
19373 string))
19375 (defun org-sublist (list start end)
19376 "Return a section of LIST, from START to END.
19377 Counting starts at 1."
19378 (let (rtn (c start))
19379 (setq list (nthcdr (1- start) list))
19380 (while (and list (<= c end))
19381 (push (pop list) rtn)
19382 (setq c (1+ c)))
19383 (nreverse rtn)))
19385 (defun org-find-base-buffer-visiting (file)
19386 "Like `find-buffer-visiting' but always return the base buffer and
19387 not an indirect buffer."
19388 (let ((buf (or (get-file-buffer file)
19389 (find-buffer-visiting file))))
19390 (if buf
19391 (or (buffer-base-buffer buf) buf)
19392 nil)))
19394 (defun org-image-file-name-regexp (&optional extensions)
19395 "Return regexp matching the file names of images.
19396 If EXTENSIONS is given, only match these."
19397 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19398 (image-file-name-regexp)
19399 (let ((image-file-name-extensions
19400 (or extensions
19401 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19402 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19404 (regexp-opt (nconc (mapcar 'upcase
19405 image-file-name-extensions)
19406 image-file-name-extensions)
19407 t)
19410 (defun org-file-image-p (file &optional extensions)
19411 "Return non-nil if FILE is an image."
19412 (save-match-data
19413 (string-match (org-image-file-name-regexp extensions) file)))
19415 (defun org-get-cursor-date ()
19416 "Return the date at cursor in as a time.
19417 This works in the calendar and in the agenda, anywhere else it just
19418 returns the current time."
19419 (let (date day defd)
19420 (cond
19421 ((eq major-mode 'calendar-mode)
19422 (setq date (calendar-cursor-to-date)
19423 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19424 ((eq major-mode 'org-agenda-mode)
19425 (setq day (get-text-property (point) 'day))
19426 (if day
19427 (setq date (calendar-gregorian-from-absolute day)
19428 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19429 (nth 2 date))))))
19430 (or defd (current-time))))
19432 (defvar org-agenda-action-marker (make-marker)
19433 "Marker pointing to the entry for the next agenda action.")
19435 (defun org-mark-entry-for-agenda-action ()
19436 "Mark the current entry as target of an agenda action.
19437 Agenda actions are actions executed from the agenda with the key `k',
19438 which make use of the date at the cursor."
19439 (interactive)
19440 (move-marker org-agenda-action-marker
19441 (save-excursion (org-back-to-heading t) (point))
19442 (current-buffer))
19443 (message
19444 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19446 (defun org-mark-subtree ()
19447 "Mark the current subtree.
19448 This puts point at the start of the current subtree, and mark at the end.
19450 If point is in an inline task, mark that task instead."
19451 (interactive)
19452 (let ((inline-task-p
19453 (and (featurep 'org-inlinetask)
19454 (org-inlinetask-in-task-p)))
19455 (beg))
19456 ;; Get beginning of subtree
19457 (cond
19458 (inline-task-p (org-inlinetask-goto-beginning))
19459 ((org-at-heading-p) (beginning-of-line))
19460 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19461 (setq beg (point))
19462 ;; Get end of it
19463 (if inline-task-p
19464 (org-inlinetask-goto-end)
19465 (org-end-of-subtree))
19466 ;; Mark zone
19467 (push-mark (point) nil t)
19468 (goto-char beg)))
19470 ;;; Paragraph filling stuff.
19471 ;; We want this to be just right, so use the full arsenal.
19473 (defun org-indent-line-function ()
19474 "Indent line depending on context."
19475 (interactive)
19476 (let* ((pos (point))
19477 (itemp (org-at-item-p))
19478 (case-fold-search t)
19480 (inline-task-p (and (featurep 'org-inlinetask)
19481 (org-inlinetask-in-task-p)))
19482 (inline-re (and inline-task-p
19483 (org-inlinetask-outline-regexp)))
19484 column)
19485 (beginning-of-line 1)
19486 (cond
19487 ;; Comments
19488 ((looking-at "# ") (setq column 0))
19489 ;; Headings
19490 ((looking-at org-outline-regexp) (setq column 0))
19491 ;; Included files
19493 ;; Footnote definition
19494 ((looking-at org-footnote-definition-re) (setq column 0))
19495 ;; Literal examples
19497 (setq column (org-get-indentation))) ; do nothing
19498 ;; Lists
19499 ((ignore-errors (goto-char (org-in-item-p)))
19500 (setq column (if itemp
19501 (org-get-indentation)
19502 (org-list-item-body-column (point))))
19503 (goto-char pos))
19504 ;; Drawers
19506 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19507 (save-excursion
19508 (goto-char (1- (match-beginning 1)))
19509 (setq column (current-column))))
19510 ;; Special blocks
19512 (save-excursion
19513 (re-search-backward
19515 (setq column (org-get-indentation (match-string 0))))
19518 (save-excursion
19520 (setq column
19521 (cond ((equal (downcase (match-string 1)) "src")
19522 ;; src blocks: let `org-edit-src-exit' handle them
19523 (org-get-indentation))
19524 ((equal (downcase (match-string 1)) "example")
19525 (max (org-get-indentation)
19526 (org-get-indentation (match-string 0))))
19527 (t
19528 (org-get-indentation (match-string 0))))))
19529 ;; This line has nothing special, look at the previous relevant
19530 ;; line to compute indentation
19531 (t
19532 (beginning-of-line 0)
19533 (while (and (not (bobp))
19534 (not (looking-at org-drawer-regexp))
19535 ;; When point started in an inline task, do not move
19536 ;; above task starting line.
19537 (not (and inline-task-p (looking-at inline-re)))
19538 ;; Skip drawers, blocks, empty lines, verbatim,
19539 ;; comments, tables, footnotes definitions, lists,
19540 ;; inline tasks.
19542 (re-search-backward org-drawer-regexp nil t))
19546 (looking-at org-footnote-definition-re)
19547 (and (ignore-errors (goto-char (org-in-item-p)))
19548 (goto-char
19549 (org-list-get-top-point (org-list-struct))))
19550 (and (not inline-task-p)
19551 (featurep 'org-inlinetask)
19552 (org-inlinetask-in-task-p)
19553 (or (org-inlinetask-goto-beginning) t))))
19554 (beginning-of-line 0))
19555 (cond
19556 ;; There was an heading above.
19558 (if (not org-adapt-indentation)
19559 (setq column 0)
19560 (goto-char (match-end 0))
19561 (setq column (current-column))))
19562 ;; A drawer had started and is unfinished
19563 ((looking-at org-drawer-regexp)
19564 (goto-char (1- (match-beginning 1)))
19565 (setq column (current-column)))
19566 ;; Else, nothing noticeable found: get indentation and go on.
19567 (t (setq column (org-get-indentation))))))
19568 ;; Now apply indentation and move cursor accordingly
19569 (goto-char pos)
19570 (if (<= (current-column) (current-indentation))
19571 (org-indent-line-to column)
19572 (save-excursion (org-indent-line-to column)))
19573 ;; Special polishing for properties, see `org-property-format'
19574 (setq column (current-column))
19575 (beginning-of-line 1)
19576 (if (looking-at
19578 (replace-match (concat (match-string 1)
19579 (format org-property-format
19580 (match-string 2) (match-string 3)))
19581 t t))
19582 (org-move-to-column column)))
19584 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19585 "Variable to store copy of `adaptive-fill-regexp'.
19586 Since `adaptive-fill-regexp' is set to never match, we need to
19587 store a backup of its value before entering `org-mode' so that
19588 the functionality can be provided as a fall-back.")
19590 (defun org-set-autofill-regexps ()
19591 (interactive)
19592 ;; In the paragraph separator we include headlines, because filling
19593 ;; text in a line directly attached to a headline would otherwise
19594 ;; fill the headline as well.
19597 ;; The paragraph starter includes hand-formatted lists.
19598 (org-set-local
19599 'paragraph-start
19600 (concat
19609 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19610 ;; But only if the user has not turned off tables or fixed-width regions
19611 (org-set-local
19612 'auto-fill-inhibit-regexp
19613 (concat org-outline-regexp
19616 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19617 (concat
19619 (if org-enable-table-editor "|" "")
19620 (if org-enable-fixed-width-editor ":" "")
19621 "]"))))
19622 ;; We use our own fill-paragraph function, to make sure that tables
19623 ;; and fixed-width regions are not wrapped. That function will pass
19624 ;; through to `fill-paragraph' when appropriate.
19625 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19626 ;; Prevent auto-fill from inserting unwanted new items.
19627 (org-set-local 'fill-nobreak-predicate
19628 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19629 fill-nobreak-predicate
19630 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19631 ;; Adaptive filling: To get full control, first make sure that
19632 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19633 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19634 (org-set-local 'org-adaptive-fill-regexp-backup
19635 adaptive-fill-regexp))
19637 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19638 (org-set-local 'adaptive-fill-function
19639 'org-adaptive-fill-function)
19640 (org-set-local
19641 'align-mode-rules-list
19642 '((org-in-buffer-settings
19644 (modes . '(org-mode))))))
19646 (defun org-fill-item-nobreak-p ()
19647 "Non-nil when a line break at point would insert a new item."
19648 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19650 (defun org-fill-paragraph (&optional justify)
19651 "Re-align a table, pass through to fill-paragraph if no table."
19652 (let ((table-p (org-at-table-p))
19653 (table.el-p (org-at-table.el-p))
19654 (itemp (org-in-item-p)))
19655 (cond ((and (equal (char-after (point-at-bol)) ?*)
19656 (save-excursion (goto-char (point-at-bol))
19657 (looking-at org-outline-regexp)))
19658 t) ; skip headlines
19659 (table.el-p t) ; skip table.el tables
19660 (table-p (org-table-align) t) ; align Org tables
19661 (itemp ; align text in items
19662 (let* ((struct (save-excursion (goto-char itemp)
19663 (org-list-struct)))
19664 (parents (org-list-parents-alist struct))
19665 (children (org-list-get-children itemp struct parents))
19666 beg end prev next prefix)
19667 ;; Determine in which part of item point is: before
19668 ;; first child, after last child, between two
19669 ;; sub-lists, or simply in item if there's no child.
19670 (cond
19671 ((not children)
19672 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19673 beg itemp
19674 end (org-list-get-item-end itemp struct)))
19675 ((< (point) (setq next (car children)))
19676 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19677 beg itemp
19678 end next))
19679 ((> (point) (setq prev (car (last children))))
19680 (setq beg (org-list-get-item-end prev struct)
19681 end (org-list-get-item-end itemp struct)
19682 prefix (save-excursion
19683 (goto-char beg)
19685 (make-string (current-column) ?\ ))))
19686 (t (catch 'exit
19687 (while (setq next (pop children))
19688 (if (> (point) next)
19689 (setq prev next)
19690 (setq beg (org-list-get-item-end prev struct)
19691 end next
19692 prefix (save-excursion
19693 (goto-char beg)
19695 (make-string (current-column) ?\ )))
19696 (throw 'exit nil))))))
19697 ;; Use `fill-paragraph' with buffer narrowed to item
19698 ;; without any child, and with our computed PREFIX.
19699 (flet ((fill-context-prefix (from to &optional flr) prefix))
19700 (save-restriction
19701 (narrow-to-region beg end)
19702 (save-excursion (fill-paragraph justify)))) t))
19703 ;; Special case where point is not in a list but is on
19704 ;; a paragraph adjacent to a list: make sure this paragraph
19705 ;; doesn't get merged with the end of the list by narrowing
19706 ;; buffer first.
19707 ((save-excursion (forward-paragraph -1)
19708 (setq itemp (org-in-item-p)))
19709 (let ((struct (save-excursion (goto-char itemp)
19710 (org-list-struct))))
19711 (save-restriction
19712 (narrow-to-region (org-list-get-bottom-point struct)
19713 (save-excursion (forward-paragraph 1)
19714 (point)))
19715 (fill-paragraph justify) t)))
19716 ;; Else simply call `fill-paragraph'.
19717 (t nil))))
19719 ;; For reference, this is the default value of adaptive-fill-regexp
19722 (defun org-adaptive-fill-function ()
19723 "Return a fill prefix for org-mode files."
19724 (let (itemp)
19725 (save-excursion
19726 (cond
19727 ;; Comment line
19729 (match-string-no-properties 0))
19730 ;; Plain list item
19731 ((org-at-item-p)
19732 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19733 ;; Point is in a list after `backward-paragraph': original
19734 ;; point wasn't in the list, or filling would have been taken
19735 ;; care of by `org-auto-fill-function', but the list and the
19736 ;; real paragraph are not separated by a blank line. Thus, move
19737 ;; point after the list to go back to real paragraph and
19738 ;; determine fill-prefix.
19739 ((setq itemp (org-in-item-p))
19740 (goto-char itemp)
19741 (let* ((struct (org-list-struct))
19742 (bottom (org-list-get-bottom-point struct)))
19743 (goto-char bottom)
19744 (make-string (org-get-indentation) ?\ )))
19745 ;; Other text
19746 ((looking-at org-adaptive-fill-regexp-backup)
19747 (match-string-no-properties 0))))))
19749 (defun org-auto-fill-function ()
19750 "Auto-fill function."
19751 (let (itemp prefix)
19752 ;; When in a list, compute an appropriate fill-prefix and make
19753 ;; sure it will be used by `do-auto-fill'.
19754 (if (setq itemp (org-in-item-p))
19755 (progn
19756 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19757 (flet ((fill-context-prefix (from to &optional flr) prefix))
19758 (do-auto-fill)))
19759 ;; Else just use `do-auto-fill'.
19760 (do-auto-fill))))
19762 ;;; Other stuff.
19764 (defun org-toggle-fixed-width-section (arg)
19765 "Toggle the fixed-width export.
19766 If there is no active region, the QUOTE keyword at the current headline is
19767 inserted or removed. When present, it causes the text between this headline
19768 and the next to be exported as fixed-width text, and unmodified.
19769 If there is an active region, this command adds or removes a colon as the
19770 first character of this line. If the first character of a line is a colon,
19771 this line is also exported in fixed-width font."
19772 (interactive "P")
19773 (let* ((cc 0)
19774 (regionp (org-region-active-p))
19775 (beg (if regionp (region-beginning) (point)))
19776 (end (if regionp (region-end)))
19777 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19778 (case-fold-search nil)
19780 off)
19781 (if regionp
19782 (save-excursion
19783 (goto-char beg)
19784 (setq cc (current-column))
19785 (beginning-of-line 1)
19786 (setq off (looking-at re))
19787 (while (> nlines 0)
19788 (setq nlines (1- nlines))
19789 (beginning-of-line 1)
19790 (cond
19791 (arg
19792 (org-move-to-column cc t)
19794 (forward-line -1))
19795 ((and off (looking-at re))
19796 (replace-match "" t t nil 1))
19797 ((not off) (org-move-to-column cc t) (insert ": ")))
19798 (forward-line 1)))
19799 (save-excursion
19800 (org-back-to-heading)
19801 (if (looking-at (concat org-outline-regexp
19803 (replace-match "" t t nil 1)
19804 (if (looking-at org-outline-regexp)
19805 (progn
19806 (goto-char (match-end 0))
19807 (insert org-quote-string " "))))))))
19809 (defun org-reftex-citation ()
19810 "Use reftex-citation to insert a citation into the buffer.
19811 This looks for a line like
19813 #+BIBLIOGRAPHY: foo plain option:-d
19815 and derives from it that foo.bib is the bibliography file relevant
19816 for this document. It then installs the necessary environment for RefTeX
19817 to work in this buffer and calls `reftex-citation' to insert a citation
19818 into the buffer.
19820 Export of such citations to both LaTeX and HTML is handled by the contributed
19821 package org-exp-bibtex by Taru Karttunen."
19822 (interactive)
19823 (let ((reftex-docstruct-symbol 'rds)
19825 rds bib)
19826 (save-excursion
19827 (save-restriction
19828 (widen)
19829 (let ((case-fold-search t)
19831 (if (not (save-excursion
19832 (or (re-search-forward re nil t)
19833 (re-search-backward re nil t))))
19834 (error "No bibliography defined in file")
19835 (setq bib (concat (match-string 1) ".bib")
19836 rds (list (list 'bib bib)))))))
19837 (call-interactively 'reftex-citation)))
19839 ;;;; Functions extending outline functionality
19841 (defun org-beginning-of-line (&optional arg)
19842 "Go to the beginning of the current line. If that is invisible, continue
19843 to a visible line beginning. This makes the function of C-a more intuitive.
19844 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19845 first attempt, and only move to after the tags when the cursor is already
19846 beyond the end of the headline."
19847 (interactive "P")
19848 (let ((pos (point))
19849 (special (if (consp org-special-ctrl-a/e)
19850 (car org-special-ctrl-a/e)
19851 org-special-ctrl-a/e))
19852 refpos)
19853 (if (org-bound-and-true-p line-move-visual)
19854 (beginning-of-visual-line 1)
19855 (beginning-of-line 1))
19856 (if (and arg (fboundp 'move-beginning-of-line))
19857 (call-interactively 'move-beginning-of-line)
19858 (if (bobp)
19859 nil
19860 (backward-char 1)
19861 (if (org-truely-invisible-p)
19862 (while (and (not (bobp)) (org-truely-invisible-p))
19863 (backward-char 1)
19864 (beginning-of-line 1))
19865 (forward-char 1))))
19866 (when special
19867 (cond
19868 ((and (looking-at org-complex-heading-regexp)
19869 (= (char-after (match-end 1)) ?\ ))
19870 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19871 (point-at-eol)))
19872 (goto-char
19873 (if (eq special t)
19874 (cond ((> pos refpos) refpos)
19875 ((= pos (point)) refpos)
19876 (t (point)))
19877 (cond ((> pos (point)) (point))
19878 ((not (eq last-command this-command)) (point))
19879 (t refpos)))))
19880 ((org-at-item-p)
19881 (goto-char
19882 (if (eq special t)
19883 (cond ((> pos (match-end 0)) (match-end 0))
19884 ((= pos (point)) (match-end 0))
19885 (t (point)))
19886 (cond ((> pos (point)) (point))
19887 ((not (eq last-command this-command)) (point))
19888 (t (match-end 0))))))))
19889 (org-no-warnings
19890 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19892 (defun org-end-of-line (&optional arg)
19893 "Go to the end of the line.
19894 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19895 first attempt, and only move to after the tags when the cursor is already
19896 beyond the end of the headline."
19897 (interactive "P")
19898 (let ((special (if (consp org-special-ctrl-a/e)
19899 (cdr org-special-ctrl-a/e)
19900 org-special-ctrl-a/e)))
19901 (if (or (not special)
19902 (not (org-on-heading-p))
19903 arg)
19904 (call-interactively
19905 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19906 ((fboundp 'move-end-of-line) 'move-end-of-line)
19907 (t 'end-of-line)))
19908 (let ((pos (point)))
19909 (beginning-of-line 1)
19911 (if (eq special t)
19912 (if (or (< pos (match-beginning 1))
19913 (= pos (match-end 0)))
19914 (goto-char (match-beginning 1))
19915 (goto-char (match-end 0)))
19916 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19917 (goto-char (match-end 0))
19918 (goto-char (match-beginning 1))))
19919 (call-interactively (if (fboundp 'move-end-of-line)
19920 'move-end-of-line
19921 'end-of-line)))))
19922 (org-no-warnings
19923 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19925 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19926 (define-key org-mode-map "\C-e" 'org-end-of-line)
19928 (defun org-backward-sentence (&optional arg)
19929 "Go to beginning of sentence, or beginning of table field.
19930 This will call `backward-sentence' or `org-table-beginning-of-field',
19931 depending on context."
19932 (interactive "P")
19933 (cond
19934 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19935 (t (call-interactively 'backward-sentence))))
19937 (defun org-forward-sentence (&optional arg)
19938 "Go to end of sentence, or end of table field.
19939 This will call `forward-sentence' or `org-table-end-of-field',
19940 depending on context."
19941 (interactive "P")
19942 (cond
19943 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19944 (t (call-interactively 'forward-sentence))))
19946 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19947 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19949 (defun org-kill-line (&optional arg)
19950 "Kill line, to tags or end of line."
19951 (interactive "P")
19952 (cond
19953 ((or (not org-special-ctrl-k)
19954 (bolp)
19955 (not (org-on-heading-p)))
19956 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19957 org-ctrl-k-protect-subtree)
19958 (if (or (eq org-ctrl-k-protect-subtree 'error)
19959 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19960 (error "C-k aborted - would kill hidden subtree")))
19961 (call-interactively 'kill-line))
19963 (kill-region (point) (match-beginning 1))
19964 (org-set-tags nil t))
19965 (t (kill-region (point) (point-at-eol)))))
19967 (define-key org-mode-map "\C-k" 'org-kill-line)
19969 (defun org-yank (&optional arg)
19970 "Yank. If the kill is a subtree, treat it specially.
19971 This command will look at the current kill and check if is a single
19972 subtree, or a series of subtrees[1]. If it passes the test, and if the
19973 cursor is at the beginning of a line or after the stars of a currently
19974 empty headline, then the yank is handled specially. How exactly depends
19975 on the value of the following variables, both set by default.
19977 org-yank-folded-subtrees
19978 When set, the subtree(s) will be folded after insertion, but only
19979 if doing so would now swallow text after the yanked text.
19981 org-yank-adjusted-subtrees
19982 When set, the subtree will be promoted or demoted in order to
19983 fit into the local outline tree structure, which means that the level
19984 will be adjusted so that it becomes the smaller one of the two
19985 *visible* surrounding headings.
19987 Any prefix to this command will cause `yank' to be called directly with
19989 will just
19990 plainly yank the text as it is.
19992 \[1] The test checks if the first non-white line is a heading
19993 and if there are no other headings with fewer stars."
19994 (interactive "P")
19995 (org-yank-generic 'yank arg))
19997 (defun org-yank-generic (command arg)
19998 "Perform some yank-like command.
20000 This function implements the behavior described in the `org-yank'
20001 documentation. However, it has been generalized to work for any
20002 interactive command with similar behavior."
20004 ;; pretend to be command COMMAND
20005 (setq this-command command)
20007 (if arg
20008 (call-interactively command)
20010 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20011 (and (org-kill-is-subtree-p)
20012 (or (bolp)
20014 (string-match
20016 (buffer-substring (point-at-bol) (point)))))))
20017 swallowp)
20018 (cond
20019 ((and subtreep org-yank-folded-subtrees)
20020 (let ((beg (point))
20021 end)
20022 (if (and subtreep org-yank-adjusted-subtrees)
20023 (org-paste-subtree nil nil 'for-yank)
20024 (call-interactively command))
20026 (setq end (point))
20027 (goto-char beg)
20028 (when (and (bolp) subtreep
20029 (not (setq swallowp
20030 (org-yank-folding-would-swallow-text beg end))))
20031 (org-with-limited-levels
20032 (or (looking-at org-outline-regexp)
20033 (re-search-forward org-outline-regexp-bol end t))
20034 (while (and (< (point) end) (looking-at org-outline-regexp))
20035 (hide-subtree)
20036 (org-cycle-show-empty-lines 'folded)
20037 (condition-case nil
20038 (outline-forward-same-level 1)
20039 (error (goto-char end))))))
20040 (when swallowp
20041 (message
20042 "Inserted text not folded because that would swallow text"))
20044 (goto-char end)
20046 (beginning-of-line 1)
20047 (push-mark beg 'nomsg)))
20048 ((and subtreep org-yank-adjusted-subtrees)
20049 (let ((beg (point-at-bol)))
20050 (org-paste-subtree nil nil 'for-yank)
20051 (push-mark beg 'nomsg)))
20052 (t
20053 (call-interactively command))))))
20055 (defun org-yank-folding-would-swallow-text (beg end)
20056 "Would hide-subtree at BEG swallow any text after END?"
20057 (let (level)
20058 (org-with-limited-levels
20059 (save-excursion
20060 (goto-char beg)
20061 (when (or (looking-at org-outline-regexp)
20062 (re-search-forward org-outline-regexp-bol end t))
20063 (setq level (org-outline-level)))
20064 (goto-char end)
20066 (if (or (eobp)
20067 (and (bolp) (looking-at org-outline-regexp)
20068 (<= (org-outline-level) level)))
20069 nil ; Nothing would be swallowed
20070 t))))) ; something would swallow
20072 (define-key org-mode-map "\C-y" 'org-yank)
20074 (defun org-truely-invisible-p ()
20075 "Check if point is at a character currently not visible.
20076 This version does not only check the character property, but also
20077 `visible-mode'."
20078 ;; Early versions of noutline don't have `outline-invisible-p'.
20079 (if (org-bound-and-true-p visible-mode)
20080 nil
20081 (outline-invisible-p)))
20083 (defun org-invisible-p2 ()
20084 "Check if point is at a character currently not visible."
20085 (save-excursion
20086 (if (and (eolp) (not (bobp))) (backward-char 1))
20087 ;; Early versions of noutline don't have `outline-invisible-p'.
20088 (outline-invisible-p)))
20090 (defun org-back-to-heading (&optional invisible-ok)
20091 "Call `outline-back-to-heading', but provide a better error message."
20092 (condition-case nil
20093 (outline-back-to-heading invisible-ok)
20094 (error (error "Before first headline at position %d in buffer %s"
20095 (point) (current-buffer)))))
20097 (defun org-beginning-of-defun ()
20098 "Go to the beginning of the subtree, i.e. back to the heading."
20099 (org-back-to-heading))
20100 (defun org-end-of-defun ()
20101 "Go to the end of the subtree."
20102 (org-end-of-subtree nil t))
20104 (defun org-before-first-heading-p ()
20105 "Before first heading?"
20106 (save-excursion
20107 (end-of-line)
20108 (null (re-search-backward org-outline-regexp-bol nil t))))
20110 (defun org-on-heading-p (&optional ignored)
20111 (outline-on-heading-p t))
20112 (defun org-at-heading-p (&optional ignored)
20113 (outline-on-heading-p t))
20115 (defun org-point-at-end-of-empty-headline ()
20116 "If point is at the end of an empty headline, return t, else nil.
20117 If the heading only contains a TODO keyword, it is still still considered
20118 empty."
20120 (save-excursion
20121 (beginning-of-line 1)
20122 (let ((case-fold-search nil))
20125 (defun org-at-heading-or-item-p ()
20126 (or (org-on-heading-p) (org-at-item-p)))
20128 (defun org-on-target-p ()
20129 (or (org-in-regexp org-radio-target-regexp)
20130 (org-in-regexp org-target-regexp)))
20132 (defun org-up-heading-all (arg)
20133 "Move to the heading line of which the present line is a subheading.
20134 This function considers both visible and invisible heading lines.
20135 With argument, move up ARG levels."
20136 (if (fboundp 'outline-up-heading-all)
20137 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20138 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20140 (defun org-up-heading-safe ()
20141 "Move to the heading line of which the present line is a subheading.
20142 This version will not throw an error. It will return the level of the
20143 headline found, or nil if no higher level is found.
20145 Also, this function will be a lot faster than `outline-up-heading',
20146 because it relies on stars being the outline starters. This can really
20147 make a significant difference in outlines with very many siblings."
20148 (let (start-level re)
20149 (org-back-to-heading t)
20150 (setq start-level (funcall outline-level))
20151 (if (equal start-level 1)
20152 nil
20154 (if (re-search-backward re nil t)
20155 (funcall outline-level)))))
20157 (defun org-first-sibling-p ()
20158 "Is this heading the first child of its parents?"
20159 (interactive)
20160 (let ((re org-outline-regexp-bol)
20161 level l)
20162 (unless (org-at-heading-p t)
20163 (error "Not at a heading"))
20164 (setq level (funcall outline-level))
20165 (save-excursion
20166 (if (not (re-search-backward re nil t))
20167 t
20168 (setq l (funcall outline-level))
20169 (< l level)))))
20171 (defun org-goto-sibling (&optional previous)
20172 "Goto the next sibling, even if it is invisible.
20173 When PREVIOUS is set, go to the previous sibling instead. Returns t
20174 when a sibling was found. When none is found, return nil and don't
20175 move point."
20176 (let ((fun (if previous 're-search-backward 're-search-forward))
20177 (pos (point))
20178 (re org-outline-regexp-bol)
20179 level l)
20180 (when (condition-case nil (org-back-to-heading t) (error nil))
20181 (setq level (funcall outline-level))
20182 (catch 'exit
20183 (or previous (forward-char 1))
20184 (while (funcall fun re nil t)
20185 (setq l (funcall outline-level))
20186 (when (< l level) (goto-char pos) (throw 'exit nil))
20187 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20188 (goto-char pos)
20189 nil))))
20191 (defun org-show-siblings ()
20192 "Show all siblings of the current headline."
20193 (save-excursion
20194 (while (org-goto-sibling) (org-flag-heading nil)))
20195 (save-excursion
20196 (while (org-goto-sibling 'previous)
20197 (org-flag-heading nil))))
20199 (defun org-goto-first-child ()
20200 "Goto the first child, even if it is invisible.
20201 Return t when a child was found. Otherwise don't move point and
20202 return nil."
20203 (let (level (pos (point)) (re org-outline-regexp-bol))
20204 (when (condition-case nil (org-back-to-heading t) (error nil))
20205 (setq level (outline-level))
20206 (forward-char 1)
20207 (if (and (re-search-forward re nil t) (> (outline-level) level))
20208 (progn (goto-char (match-beginning 0)) t)
20209 (goto-char pos) nil))))
20211 (defun org-show-hidden-entry ()
20212 "Show an entry where even the heading is hidden."
20213 (save-excursion
20214 (org-show-entry)))
20216 (defun org-flag-heading (flag &optional entry)
20217 "Flag the current heading. FLAG non-nil means make invisible.
20218 When ENTRY is non-nil, show the entire entry."
20219 (save-excursion
20220 (org-back-to-heading t)
20221 ;; Check if we should show the entire entry
20222 (if entry
20223 (progn
20224 (org-show-entry)
20225 (save-excursion
20226 (and (outline-next-heading)
20227 (org-flag-heading nil))))
20228 (outline-flag-region (max (point-min) (1- (point)))
20229 (save-excursion (outline-end-of-heading) (point))
20230 flag))))
20232 (defun org-get-next-sibling ()
20233 "Move to next heading of the same level, and return point.
20234 If there is no such heading, return nil.
20235 This is like outline-next-sibling, but invisible headings are ok."
20236 (let ((level (funcall outline-level)))
20237 (outline-next-heading)
20238 (while (and (not (eobp)) (> (funcall outline-level) level))
20239 (outline-next-heading))
20240 (if (or (eobp) (< (funcall outline-level) level))
20241 nil
20242 (point))))
20244 (defun org-get-last-sibling ()
20245 "Move to previous heading of the same level, and return point.
20246 If there is no such heading, return nil."
20247 (let ((opoint (point))
20248 (level (funcall outline-level)))
20249 (outline-previous-heading)
20250 (when (and (/= (point) opoint) (outline-on-heading-p t))
20251 (while (and (> (funcall outline-level) level)
20252 (not (bobp)))
20253 (outline-previous-heading))
20254 (if (< (funcall outline-level) level)
20255 nil
20256 (point)))))
20258 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20259 ;; This contains an exact copy of the original function, but it uses
20260 ;; `org-back-to-heading', to make it work also in invisible
20261 ;; trees. And is uses an invisible-OK argument.
20262 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20263 ;; Furthermore, when used inside Org, finding the end of a large subtree
20264 ;; with many children and grandchildren etc, this can be much faster
20265 ;; than the outline version.
20266 (org-back-to-heading invisible-OK)
20267 (let ((first t)
20268 (level (funcall outline-level)))
20269 (if (and (org-mode-p) (< level 1000))
20270 ;; A true heading (not a plain list item), in Org-mode
20271 ;; This means we can easily find the end by looking
20272 ;; only for the right number of stars. Using a regexp to do
20273 ;; this is so much faster than using a Lisp loop.
20275 (forward-char 1)
20276 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20277 ;; something else, do it the slow way
20278 (while (and (not (eobp))
20279 (or first (> (funcall outline-level) level)))
20280 (setq first nil)
20281 (outline-next-heading)))
20282 (unless to-heading
20284 (progn
20285 ;; Go to end of line before heading
20286 (forward-char -1)
20288 ;; leave blank line before heading
20289 (forward-char -1))))))
20290 (point))
20292 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20293 "Use Org version in org-mode, for dramatic speed-up."
20294 (if (org-mode-p)
20295 (progn
20296 (org-end-of-subtree nil t)
20297 (unless (eobp) (backward-char 1)))
20298 ad-do-it))
20300 ;; FIXME This should not match :END: for custom drawers?
20301 (defun org-end-of-meta-data-and-drawers ()
20302 "Jump to the first text after meta data and drawers in the current entry.
20303 This will move over empty lines, lines with planning time stamps,
20304 clocking lines, and drawers."
20305 (org-back-to-heading t)
20306 (let ((end (save-excursion (outline-next-heading) (point)))
20309 (forward-line 1)
20310 (while (re-search-forward re end t)
20311 (if (not (match-end 1))
20312 ;; empty or planning line
20313 (forward-line 1)
20314 ;; a drawer, find the end
20316 (forward-line 1)))
20318 (point)))
20320 (defun org-forward-same-level (arg &optional invisible-ok)
20321 "Move forward to the arg'th subheading at same level as this one.
20322 Stop at the first and last subheadings of a superior heading.
20323 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20324 it wil also look at invisible ones."
20325 (interactive "p")
20326 (org-back-to-heading invisible-ok)
20327 (org-on-heading-p)
20328 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20330 l)
20331 (forward-char 1)
20332 (while (> arg 0)
20333 (while (and (re-search-forward re nil 'move)
20334 (setq l (- (match-end 0) (match-beginning 0) 1))
20335 (= l level)
20336 (not invisible-ok)
20337 (progn (backward-char 1) (outline-invisible-p)))
20338 (if (< l level) (setq arg 1)))
20339 (setq arg (1- arg)))
20340 (beginning-of-line 1)))
20342 (defun org-backward-same-level (arg &optional invisible-ok)
20343 "Move backward to the arg'th subheading at same level as this one.
20344 Stop at the first and last subheadings of a superior heading."
20345 (interactive "p")
20346 (org-back-to-heading)
20347 (org-on-heading-p)
20348 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20350 l)
20351 (while (> arg 0)
20352 (while (and (re-search-backward re nil 'move)
20353 (setq l (- (match-end 0) (match-beginning 0) 1))
20354 (= l level)
20355 (not invisible-ok)
20356 (outline-invisible-p))
20357 (if (< l level) (setq arg 1)))
20358 (setq arg (1- arg)))))
20360 (defun org-show-subtree ()
20361 "Show everything after this heading at deeper levels."
20362 (outline-flag-region
20363 (point)
20364 (save-excursion
20365 (org-end-of-subtree t t))
20366 nil))
20368 (defun org-show-entry ()
20369 "Show the body directly following this heading.
20370 Show the heading too, if it is currently invisible."
20371 (interactive)
20372 (save-excursion
20373 (condition-case nil
20374 (progn
20375 (org-back-to-heading t)
20376 (outline-flag-region
20377 (max (point-min) (1- (point)))
20378 (save-excursion
20379 (if (re-search-forward
20381 (match-beginning 1)
20382 (point-max)))
20383 nil)
20384 (org-cycle-hide-drawers 'children))
20385 (error nil))))
20387 (defun org-make-options-regexp (kwds &optional extra)
20388 "Make a regular expression for keyword lines."
20389 (concat
20390 "^"
20397 ;; Make isearch reveal the necessary context
20398 (defun org-isearch-end ()
20399 "Reveal context after isearch exits."
20400 (when isearch-success ; only if search was successful
20401 (if (featurep 'xemacs)
20402 ;; Under XEmacs, the hook is run in the correct place,
20403 ;; we directly show the context.
20404 (org-show-context 'isearch)
20405 ;; In Emacs the hook runs *before* restoring the overlays.
20406 ;; So we have to use a one-time post-command-hook to do this.
20407 ;; (Emacs 22 has a special variable, see function `org-mode')
20408 (unless (and (boundp 'isearch-mode-end-hook-quit)
20409 isearch-mode-end-hook-quit)
20410 ;; Only when the isearch was not quitted.
20411 (org-add-hook 'post-command-hook 'org-isearch-post-command
20412 'append 'local)))))
20414 (defun org-isearch-post-command ()
20415 "Remove self from hook, and show context."
20416 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20417 (org-show-context 'isearch))
20420 ;;;; Integration with and fixes for other packages
20422 ;;; Imenu support
20424 (defvar org-imenu-markers nil
20425 "All markers currently used by Imenu.")
20426 (make-variable-buffer-local 'org-imenu-markers)
20428 (defun org-imenu-new-marker (&optional pos)
20429 "Return a new marker for use by Imenu, and remember the marker."
20430 (let ((m (make-marker)))
20431 (move-marker m (or pos (point)))
20432 (push m org-imenu-markers)
20433 m))
20435 (defun org-imenu-get-tree ()
20436 "Produce the index for Imenu."
20437 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20438 (setq org-imenu-markers nil)
20439 (let* ((n org-imenu-depth)
20440 (re (concat "^" (org-get-limited-outline-regexp)))
20441 (subs (make-vector (1+ n) nil))
20442 (last-level 0)
20443 m level head)
20444 (save-excursion
20445 (save-restriction
20446 (widen)
20447 (goto-char (point-max))
20448 (while (re-search-backward re nil t)
20449 (setq level (org-reduced-level (funcall outline-level)))
20450 (when (<= level n)
20451 (looking-at org-complex-heading-regexp)
20452 (setq head (org-link-display-format
20453 (org-match-string-no-properties 4))
20454 m (org-imenu-new-marker))
20455 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20456 (if (>= level last-level)
20457 (push (cons head m) (aref subs level))
20458 (push (cons head (aref subs (1+ level))) (aref subs level))
20459 (loop for i from (1+ level) to n do (aset subs i nil)))
20460 (setq last-level level)))))
20461 (aref subs 1)))
20463 (eval-after-load "imenu"
20464 '(progn
20465 (add-hook 'imenu-after-jump-hook
20466 (lambda ()
20467 (if (org-mode-p)
20468 (org-show-context 'org-goto))))))
20470 (defun org-link-display-format (link)
20471 "Replace a link with either the description, or the link target
20472 if no description is present"
20473 (save-match-data
20474 (if (string-match org-bracket-link-analytic-regexp link)
20475 (replace-match (if (match-end 5)
20476 (match-string 5 link)
20477 (concat (match-string 1 link)
20478 (match-string 3 link)))
20479 nil t link)
20480 link)))
20482 (defun org-toggle-link-display ()
20483 "Toggle the literal or descriptive display of links."
20484 (interactive)
20485 (if org-link-display-descriptive
20486 (progn (org-remove-from-invisibility-spec '(org-link))
20487 (org-restart-font-lock)
20488 (setq org-link-display-descriptive nil))
20489 (progn (add-to-invisibility-spec '(org-link))
20490 (org-restart-font-lock)
20491 (setq org-link-display-descriptive t))))
20493 ;; Speedbar support
20495 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20496 "Overlay marking the agenda restriction line in speedbar.")
20497 (overlay-put org-speedbar-restriction-lock-overlay
20498 'face 'org-agenda-restriction-lock)
20499 (overlay-put org-speedbar-restriction-lock-overlay
20500 'help-echo "Agendas are currently limited to this item.")
20501 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20503 (defun org-speedbar-set-agenda-restriction ()
20504 "Restrict future agenda commands to the location at point in speedbar.
20506 (interactive)
20507 (require 'org-agenda)
20508 (let (p m tp np dir txt)
20509 (cond
20510 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20511 'org-imenu t))
20512 (setq m (get-text-property p 'org-imenu-marker))
20513 (with-current-buffer (marker-buffer m)
20514 (goto-char m)
20515 (org-agenda-set-restriction-lock 'subtree)))
20516 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20517 'speedbar-function 'speedbar-find-file))
20518 (setq tp (previous-single-property-change
20519 (1+ p) 'speedbar-function)
20520 np (next-single-property-change
20521 tp 'speedbar-function)
20522 dir (speedbar-line-directory)
20523 txt (buffer-substring-no-properties (or tp (point-min))
20524 (or np (point-max))))
20525 (with-current-buffer (find-file-noselect
20526 (let ((default-directory dir))
20527 (expand-file-name txt)))
20528 (unless (org-mode-p)
20529 (error "Cannot restrict to non-Org-mode file"))
20530 (org-agenda-set-restriction-lock 'file)))
20531 (t (error "Don't know how to restrict Org-mode's agenda")))
20532 (move-overlay org-speedbar-restriction-lock-overlay
20533 (point-at-bol) (point-at-eol))
20534 (setq current-prefix-arg nil)
20535 (org-agenda-maybe-redo)))
20537 (eval-after-load "speedbar"
20538 '(progn
20539 (speedbar-add-supported-extension ".org")
20540 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20541 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20542 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20543 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20544 (add-hook 'speedbar-visiting-tag-hook
20545 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20547 ;;; Fixes and Hacks for problems with other packages
20549 ;; Make flyspell not check words in links, to not mess up our keymap
20550 (defun org-mode-flyspell-verify ()
20551 "Don't let flyspell put overlays at active buttons, or on
20552 {todo,all-time,additional-option-like}-keywords."
20553 (let ((pos (max (1- (point)) (point-min)))
20554 (word (thing-at-point 'word)))
20555 (and (not (get-text-property pos 'keymap))
20556 (not (get-text-property pos 'org-no-flyspell))
20557 (not (member word org-todo-keywords-1))
20558 (not (member word org-all-time-keywords))
20559 (not (member word org-additional-option-like-keywords)))))
20561 (defun org-remove-flyspell-overlays-in (beg end)
20562 "Remove flyspell overlays in region."
20563 (and (org-bound-and-true-p flyspell-mode)
20564 (fboundp 'flyspell-delete-region-overlays)
20565 (flyspell-delete-region-overlays beg end))
20566 (add-text-properties beg end '(org-no-flyspell t)))
20568 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20569 (eval-after-load "bookmark"
20570 '(if (boundp 'bookmark-after-jump-hook)
20571 ;; We can use the hook
20572 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20573 ;; Hook not available, use advice
20574 (defadvice bookmark-jump (after org-make-visible activate)
20575 "Make the position visible."
20576 (org-bookmark-jump-unhide))))
20578 ;; Make sure saveplace shows the location if it was hidden
20579 (eval-after-load "saveplace"
20580 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20581 "Make the position visible."
20582 (org-bookmark-jump-unhide)))
20584 ;; Make sure ecb shows the location if it was hidden
20585 (eval-after-load "ecb"
20586 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20587 "Make hierarchy visible when jumping into location from ECB tree buffer."
20588 (if (org-mode-p)
20589 (org-show-context))))
20591 (defun org-bookmark-jump-unhide ()
20592 "Unhide the current position, to show the bookmark location."
20593 (and (org-mode-p)
20594 (or (outline-invisible-p)
20595 (save-excursion (goto-char (max (point-min) (1- (point))))
20596 (outline-invisible-p)))
20597 (org-show-context 'bookmark-jump)))
20599 ;; Make session.el ignore our circular variable
20600 (eval-after-load "session"
20601 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20603 ;;;; Experimental code
20605 (defun org-closed-in-range ()
20606 "Sparse tree of items closed in a certain time range.
20607 Still experimental, may disappear in the future."
20608 (interactive)
20609 ;; Get the time interval from the user.
20610 (let* ((time1 (org-float-time
20611 (org-read-date nil 'to-time nil "Starting date: ")))
20612 (time2 (org-float-time
20613 (org-read-date nil 'to-time nil "End date:")))
20614 ;; callback function
20615 (callback (lambda ()
20616 (let ((time
20617 (org-float-time
20618 (apply 'encode-time
20619 (org-parse-time-string
20620 (match-string 1))))))
20621 ;; check if time in interval
20622 (and (>= time time1) (<= time time2))))))
20623 ;; make tree, check each match with the callback
20626 ;;;; Finish up
20628 (provide 'org)
20630 (run-hooks 'org-load-hook)
20632 ;;; org.el ends here