| blob | a4e61ccabfcf9df50541c2976ea7a20aa7fba717 |
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 (prohibit (if (> diff 0)
7360 col)
7361 (unless (save-excursion (end-of-line 1)
7362 (re-search-forward prohibit end t))
7363 (while (and (< (point) end)
7365 (goto-char (match-end 0))
7366 (setq col (current-column))
7367 (if (< diff 0) (replace-match ""))
7368 (org-indent-to-column (+ diff col))))
7369 (move-marker end nil))))
7371 (defun org-convert-to-odd-levels ()
7372 "Convert an org-mode file with all levels allowed to one with odd levels.
7373 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7374 level 5 etc."
7375 (interactive)
7376 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7377 (let ((outline-level 'org-outline-level)
7378 (org-odd-levels-only nil) n)
7379 (save-excursion
7380 (goto-char (point-min))
7382 (setq n (- (length (match-string 0)) 2))
7383 (while (>= (setq n (1- n)) 0)
7384 (org-demote))
7385 (end-of-line 1))))))
7387 (defun org-convert-to-oddeven-levels ()
7388 "Convert an org-mode file with only odd levels to one with odd/even levels.
7389 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7390 file contains a section with an even level, conversion would
7391 destroy the structure of the file. An error is signaled in this
7392 case."
7393 (interactive)
7394 (goto-char (point-min))
7395 ;; First check if there are no even levels
7397 (org-show-context t)
7398 (error "Not all levels are odd in this file. Conversion not possible"))
7399 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7400 (let ((outline-regexp org-outline-regexp)
7401 (outline-level 'org-outline-level)
7402 (org-odd-levels-only nil) n)
7403 (save-excursion
7404 (goto-char (point-min))
7406 (setq n (/ (1- (length (match-string 0))) 2))
7407 (while (>= (setq n (1- n)) 0)
7408 (org-promote))
7409 (end-of-line 1))))))
7411 (defun org-tr-level (n)
7412 "Make N odd if required."
7413 (if org-odd-levels-only (1+ (/ n 2)) n))
7415 ;;; Vertical tree motion, cutting and pasting of subtrees
7417 (defun org-move-subtree-up (&optional arg)
7418 "Move the current subtree up past ARG headlines of the same level."
7419 (interactive "p")
7420 (org-move-subtree-down (- (prefix-numeric-value arg))))
7422 (defun org-move-subtree-down (&optional arg)
7423 "Move the current subtree down past ARG headlines of the same level."
7424 (interactive "p")
7425 (setq arg (prefix-numeric-value arg))
7426 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7427 'org-get-last-sibling))
7428 (ins-point (make-marker))
7429 (cnt (abs arg))
7430 (col (current-column))
7431 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7432 ;; Select the tree
7433 (org-back-to-heading)
7434 (setq beg0 (point))
7435 (save-excursion
7436 (setq ne-beg (org-back-over-empty-lines))
7437 (setq beg (point)))
7438 (save-match-data
7439 (save-excursion (outline-end-of-heading)
7440 (setq folded (outline-invisible-p)))
7441 (outline-end-of-subtree))
7442 (outline-next-heading)
7443 (setq ne-end (org-back-over-empty-lines))
7444 (setq end (point))
7445 (goto-char beg0)
7446 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7447 ;; include less whitespace
7448 (save-excursion
7449 (goto-char beg)
7450 (forward-line (- ne-beg ne-end))
7451 (setq beg (point))))
7452 ;; Find insertion point, with error handling
7453 (while (> cnt 0)
7454 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7455 (progn (goto-char beg0)
7456 (error "Cannot move past superior level or buffer limit")))
7457 (setq cnt (1- cnt)))
7458 (if (> arg 0)
7459 ;; Moving forward - still need to move over subtree
7460 (progn (org-end-of-subtree t t)
7461 (save-excursion
7462 (org-back-over-empty-lines)
7463 (or (bolp) (newline)))))
7464 (setq ne-ins (org-back-over-empty-lines))
7465 (move-marker ins-point (point))
7466 (setq txt (buffer-substring beg end))
7467 (org-save-markers-in-region beg end)
7468 (delete-region beg end)
7469 (org-remove-empty-overlays-at beg)
7470 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7471 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7473 (let ((bbb (point)))
7474 (insert-before-markers txt)
7475 (org-reinstall-markers-in-region bbb)
7476 (move-marker ins-point bbb))
7478 (setq ins-end (point))
7479 (goto-char ins-point)
7480 (org-skip-whitespace)
7481 (when (and (< arg 0)
7482 (org-first-sibling-p)
7483 (> ne-ins ne-beg))
7484 ;; Move whitespace back to beginning
7485 (save-excursion
7486 (goto-char ins-end)
7487 (let ((kill-whole-line t))
7488 (kill-line (- ne-ins ne-beg)) (point)))
7490 (move-marker ins-point nil)
7491 (if folded
7492 (hide-subtree)
7493 (org-show-entry)
7494 (show-children)
7495 (org-cycle-hide-drawers 'children))
7496 (org-clean-visibility-after-subtree-move)
7497 ;; move back to the initial column we were at
7498 (move-to-column col)))
7500 (defvar org-subtree-clip ""
7501 "Clipboard for cut and paste of subtrees.
7502 This is actually only a copy of the kill, because we use the normal kill
7503 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7505 (defvar org-subtree-clip-folded nil
7506 "Was the last copied subtree folded?
7507 This is used to fold the tree back after pasting.")
7509 (defun org-cut-subtree (&optional n)
7510 "Cut the current subtree into the clipboard.
7511 With prefix arg N, cut this many sequential subtrees.
7512 This is a short-hand for marking the subtree and then cutting it."
7513 (interactive "p")
7514 (org-copy-subtree n 'cut))
7516 (defun org-copy-subtree (&optional n cut force-store-markers)
7517 "Cut the current subtree into the clipboard.
7518 With prefix arg N, cut this many sequential subtrees.
7519 This is a short-hand for marking the subtree and then copying it.
7520 If CUT is non-nil, actually cut the subtree.
7521 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7522 of some markers in the region, even if CUT is non-nil. This is
7523 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7524 (interactive "p")
7525 (let (beg end folded (beg0 (point)))
7526 (if (org-called-interactively-p 'any)
7527 (org-back-to-heading nil) ; take what looks like a subtree
7528 (org-back-to-heading t)) ; take what is really there
7529 (org-back-over-empty-lines)
7530 (setq beg (point))
7532 (save-match-data
7533 (save-excursion (outline-end-of-heading)
7534 (setq folded (outline-invisible-p)))
7535 (condition-case nil
7536 (org-forward-same-level (1- n) t)
7537 (error nil))
7538 (org-end-of-subtree t t))
7539 (org-back-over-empty-lines)
7540 (setq end (point))
7541 (goto-char beg0)
7542 (when (> end beg)
7543 (setq org-subtree-clip-folded folded)
7544 (when (or cut force-store-markers)
7545 (org-save-markers-in-region beg end))
7546 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7547 (setq org-subtree-clip (current-kill 0))
7548 (message "%s: Subtree(s) with %d characters"
7549 (if cut "Cut" "Copied")
7550 (length org-subtree-clip)))))
7552 (defun org-paste-subtree (&optional level tree for-yank)
7553 "Paste the clipboard as a subtree, with modification of headline level.
7554 The entire subtree is promoted or demoted in order to match a new headline
7555 level.
7557 If the cursor is at the beginning of a headline, the same level as
7558 that headline is used to paste the tree
7560 If not, the new level is derived from the *visible* headings
7561 before and after the insertion point, and taken to be the inferior headline
7562 level of the two. So if the previous visible heading is level 3 and the
7563 next is level 4 (or vice versa), level 4 will be used for insertion.
7564 This makes sure that the subtree remains an independent subtree and does
7565 not swallow low level entries.
7567 You can also force a different level, either by using a numeric prefix
7568 argument, or by inserting the heading marker by hand. For example, if the
7571 If optional TREE is given, use this text instead of the kill ring.
7573 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7574 move back over whitespace before inserting, and move point to the end of
7575 the inserted text when done."
7576 (interactive "P")
7577 (setq tree (or tree (and kill-ring (current-kill 0))))
7578 (unless (org-kill-is-subtree-p tree)
7579 (error "%s"
7580 (substitute-command-keys
7582 (org-with-limited-levels
7583 (let* ((visp (not (outline-invisible-p)))
7584 (txt tree)
7586 (old-level (if (string-match org-outline-regexp-bol txt)
7587 (- (match-end 0) (match-beginning 0) 1)
7588 -1))
7589 (force-level (cond (level (prefix-numeric-value level))
7591 (string-match
7593 (point-at-bol) (point))))
7594 (- (match-end 1) (match-beginning 1)))
7595 ((and (bolp)
7596 (looking-at org-outline-regexp))
7597 (- (match-end 0) (point) 1))
7598 (t nil)))
7599 (previous-level (save-excursion
7600 (condition-case nil
7601 (progn
7602 (outline-previous-visible-heading 1)
7603 (if (looking-at ^re_)
7604 (- (match-end 0) (match-beginning 0) 1)
7605 1))
7606 (error 1))))
7607 (next-level (save-excursion
7608 (condition-case nil
7609 (progn
7610 (or (looking-at org-outline-regexp)
7611 (outline-next-visible-heading 1))
7612 (if (looking-at ^re_)
7613 (- (match-end 0) (match-beginning 0) 1)
7614 1))
7615 (error 1))))
7616 (new-level (or force-level (max previous-level next-level)))
7617 (shift (if (or (= old-level -1)
7618 (= new-level -1)
7619 (= old-level new-level))
7620 0
7621 (- new-level old-level)))
7622 (delta (if (> shift 0) -1 1))
7623 (func (if (> shift 0) 'org-demote 'org-promote))
7624 (org-odd-levels-only nil)
7625 beg end newend)
7626 ;; Remove the forced level indicator
7627 (if force-level
7628 (delete-region (point-at-bol) (point)))
7629 ;; Paste
7630 (beginning-of-line (if (bolp) 1 2))
7631 (unless for-yank (org-back-over-empty-lines))
7632 (setq beg (point))
7633 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7634 (insert-before-markers txt)
7636 (setq newend (point))
7637 (org-reinstall-markers-in-region beg)
7638 (setq end (point))
7639 (goto-char beg)
7641 (setq beg (point))
7642 (if (and (outline-invisible-p) visp)
7643 (save-excursion (outline-show-heading)))
7644 ;; Shift if necessary
7645 (unless (= shift 0)
7646 (save-restriction
7647 (narrow-to-region beg end)
7648 (while (not (= shift 0))
7649 (org-map-region func (point-min) (point-max))
7650 (setq shift (+ delta shift)))
7651 (goto-char (point-min))
7652 (setq newend (point-max))))
7653 (when (or (org-called-interactively-p 'interactive) for-yank)
7654 (message "Clipboard pasted as level %d subtree" new-level))
7655 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7656 kill-ring
7657 (eq org-subtree-clip (current-kill 0))
7658 org-subtree-clip-folded)
7659 ;; The tree was folded before it was killed/copied
7660 (hide-subtree))
7661 (and for-yank (goto-char newend)))))
7663 (defun org-kill-is-subtree-p (&optional txt)
7664 "Check if the current kill is an outline subtree, or a set of trees.
7665 Returns nil if kill does not start with a headline, or if the first
7666 headline level is not the largest headline level in the tree.
7667 So this will actually accept several entries of equal levels as well,
7668 which is OK for `org-paste-subtree'.
7669 If optional TXT is given, check this string instead of the current kill."
7670 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7671 (re (org-get-limited-outline-regexp))
7672 (^re (concat "^" re))
7673 (start-level (and kill
7674 (string-match
7676 kill)
7677 (- (match-end 2) (match-beginning 2) 1)))
7678 (start (1+ (or (match-beginning 2) -1))))
7679 (if (not start-level)
7680 (progn
7681 nil) ;; does not even start with a heading
7682 (catch 'exit
7683 (while (setq start (string-match ^re kill (1+ start)))
7684 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7685 (throw 'exit nil)))
7686 t))))
7688 (defvar org-markers-to-move nil
7689 "Markers that should be moved with a cut-and-paste operation.
7690 Those markers are stored together with their positions relative to
7691 the start of the region.")
7693 (defun org-save-markers-in-region (beg end)
7694 "Check markers in region.
7695 If these markers are between BEG and END, record their position relative
7696 to BEG, so that after moving the block of text, we can put the markers back
7697 into place.
7698 This function gets called just before an entry or tree gets cut from the
7699 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7700 called immediately, to move the markers with the entries."
7701 (setq org-markers-to-move nil)
7702 (when (featurep 'org-clock)
7703 (org-clock-save-markers-for-cut-and-paste beg end))
7704 (when (featurep 'org-agenda)
7705 (org-agenda-save-markers-for-cut-and-paste beg end)))
7707 (defun org-check-and-save-marker (marker beg end)
7708 "Check if MARKER is between BEG and END.
7709 If yes, remember the marker and the distance to BEG."
7710 (when (and (marker-buffer marker)
7711 (equal (marker-buffer marker) (current-buffer)))
7712 (if (and (>= marker beg) (< marker end))
7713 (push (cons marker (- marker beg)) org-markers-to-move))))
7715 (defun org-reinstall-markers-in-region (beg)
7716 "Move all remembered markers to their position relative to BEG."
7717 (mapc (lambda (x)
7718 (move-marker (car x) (+ beg (cdr x))))
7719 org-markers-to-move)
7720 (setq org-markers-to-move nil))
7722 (defun org-narrow-to-subtree ()
7723 "Narrow buffer to the current subtree."
7724 (interactive)
7725 (save-excursion
7726 (save-match-data
7727 (org-with-limited-levels
7728 (narrow-to-region
7729 (progn (org-back-to-heading t) (point))
7730 (progn (org-end-of-subtree t t)
7731 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7732 (point)))))))
7734 (defun org-narrow-to-block ()
7735 "Narrow buffer to the current block."
7736 (interactive)
7737 (let* ((case-fold-search t)
7740 (if blockp
7741 (narrow-to-region (car blockp) (cdr blockp))
7742 (error "Not in a block"))))
7744 (eval-when-compile
7745 (defvar org-property-drawer-re))
7747 (defvar org-property-start-re) ;; defined below
7748 (defun org-clone-subtree-with-time-shift (n &optional shift)
7749 "Clone the task (subtree) at point N times.
7750 The clones will be inserted as siblings.
7752 In interactive use, the user will be prompted for the number of
7753 clones to be produced, and for a time SHIFT, which may be a
7754 repeater as used in time stamps, for example `+3d'.
7756 When a valid repeater is given and the entry contains any time
7757 stamps, the clones will become a sequence in time, with time
7758 stamps in the subtree shifted for each clone produced. If SHIFT
7759 is nil or the empty string, time stamps will be left alone. The
7760 ID property of the original subtree is removed.
7762 If the original subtree did contain time stamps with a repeater,
7763 the following will happen:
7764 - the repeater will be removed in each clone
7765 - an additional clone will be produced, with the current, unshifted
7766 date(s) in the entry.
7767 - the original entry will be placed *after* all the clones, with
7768 repeater intact.
7769 - the start days in the repeater in the original entry will be shifted
7770 to past the last clone.
7771 I this way you can spell out a number of instances of a repeating task,
7772 and still retain the repeater to cover future instances of the task."
7773 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7774 (let (beg end template task idprop
7775 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7776 (if (not (and (integerp n) (> n 0)))
7777 (error "Invalid number of replications %s" n))
7780 shift)))
7781 (error "Invalid shift specification %s" shift))
7782 (when doshift
7783 (setq shift-n (string-to-number (match-string 1 shift))
7784 shift-what (cdr (assoc (match-string 2 shift)
7785 '(("d" . day) ("w" . week)
7786 ("m" . month) ("y" . year))))))
7787 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7788 (setq nmin 1 nmax n)
7789 (org-back-to-heading t)
7790 (setq beg (point))
7791 (setq idprop (org-entry-get nil "ID"))
7792 (org-end-of-subtree t t)
7794 (setq end (point))
7795 (setq template (buffer-substring beg end))
7796 ;; Remove clocks and empty drawers
7797 (with-temp-buffer
7798 (insert template)
7799 (goto-char (point-min))
7800 (while (re-search-forward
7802 (replace-match "")
7803 (kill-whole-line))
7804 (goto-char (point-min))
7805 (while (re-search-forward
7807 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7808 (setq template (buffer-substring (point-min) (point-max))))
7809 (when (and doshift
7811 (delete-region beg end)
7812 (setq end beg)
7813 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7814 (goto-char end)
7815 (loop for n from nmin to nmax do
7816 ;; prepare clone
7817 (with-temp-buffer
7818 (insert template)
7819 (org-mode)
7820 (goto-char (point-min))
7821 (and idprop (if org-clone-delete-id
7822 (org-entry-delete nil "ID")
7823 (org-id-get-create t)))
7824 (while (re-search-forward org-property-start-re nil t)
7825 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7826 (goto-char (point-min))
7827 (when doshift
7828 (while (re-search-forward org-ts-regexp-both nil t)
7829 (org-timestamp-change (* n shift-n) shift-what))
7830 (unless (= n n-no-remove)
7831 (goto-char (point-min))
7832 (while (re-search-forward org-ts-regexp nil t)
7833 (save-excursion
7834 (goto-char (match-beginning 0))
7836 (delete-region (match-beginning 1) (match-end 1)))))))
7837 (setq task (buffer-string)))
7838 (insert task))
7839 (goto-char beg)))
7841 ;;; Outline Sorting
7843 (defun org-sort (with-case)
7844 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7845 Optional argument WITH-CASE means sort case-sensitively.
7846 With a double prefix argument, also remove duplicate entries."
7847 (interactive "P")
7848 (cond
7849 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7850 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7851 (t
7852 (org-call-with-arg 'org-sort-entries with-case))))
7854 (defun org-sort-remove-invisible (s)
7855 (remove-text-properties 0 (length s) org-rm-props s)
7856 (while (string-match org-bracket-link-regexp s)
7857 (setq s (replace-match (if (match-end 2)
7858 (match-string 3 s)
7859 (match-string 1 s)) t t s)))
7860 s)
7862 (defvar org-priority-regexp) ; defined later in the file
7864 (defvar org-after-sorting-entries-or-items-hook nil
7865 "Hook that is run after a bunch of entries or items have been sorted.
7866 When children are sorted, the cursor is in the parent line when this
7867 hook gets called. When a region or a plain list is sorted, the cursor
7868 will be in the first entry of the sorted region/list.")
7870 (defun org-sort-entries
7871 (&optional with-case sorting-type getkey-func compare-func property)
7872 "Sort entries on a certain level of an outline tree.
7873 If there is an active region, the entries in the region are sorted.
7874 Else, if the cursor is before the first entry, sort the top-level items.
7875 Else, the children of the entry at point are sorted.
7877 Sorting can be alphabetically, numerically, by date/time as given by
7878 a time stamp, by a property or by priority.
7880 The command prompts for the sorting type unless it has been given to the
7881 function through the SORTING-TYPE argument, which needs to be a character,
7882 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7883 precise meaning of each character:
7885 n Numerically, by converting the beginning of the entry/item to a number.
7886 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7887 t By date/time, either the first active time stamp in the entry, or, if
7888 none exist, by the first inactive one.
7889 s By the scheduled date/time.
7890 d By deadline date/time.
7891 c By creation time, which is assumed to be the first inactive time stamp
7892 at the beginning of a line.
7893 p By priority according to the cookie.
7894 r By the value of a property.
7896 Capital letters will reverse the sort order.
7898 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7899 called with point at the beginning of the record. It must return either
7900 a string or a number that should serve as the sorting key for that record.
7902 Comparing entries ignores case by default. However, with an optional argument
7903 WITH-CASE, the sorting considers case as well."
7904 (interactive "P")
7905 (let ((case-func (if with-case 'identity 'downcase))
7906 start beg end stars re re2
7907 txt what tmp)
7908 ;; Find beginning and end of region to sort
7909 (cond
7910 ((org-region-active-p)
7911 ;; we will sort the region
7912 (setq end (region-end)
7913 what "region")
7914 (goto-char (region-beginning))
7915 (if (not (org-on-heading-p)) (outline-next-heading))
7916 (setq start (point)))
7917 ((or (org-on-heading-p)
7918 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7919 ;; we will sort the children of the current headline
7920 (org-back-to-heading)
7921 (setq start (point)
7922 end (progn (org-end-of-subtree t t)
7924 (org-back-over-empty-lines)
7925 (point))
7926 what "children")
7927 (goto-char start)
7928 (show-subtree)
7929 (outline-next-heading))
7930 (t
7931 ;; we will sort the top-level entries in this file
7932 (goto-char (point-min))
7933 (or (org-on-heading-p) (outline-next-heading))
7934 (setq start (point))
7935 (goto-char (point-max))
7936 (beginning-of-line 1)
7938 ;; File ends in a non-white line
7939 (end-of-line 1)
7941 (setq end (point-max))
7942 (setq what "top-level")
7943 (goto-char start)
7944 (show-all)))
7946 (setq beg (point))
7947 (if (>= beg end) (error "Nothing to sort"))
7950 (setq stars (match-string 1)
7951 re (concat "^" (regexp-quote stars) " +")
7953 txt (buffer-substring beg end))
7955 (if (and (not (equal stars "*")) (string-match re2 txt))
7956 (error "Region to sort contains a level above the first entry"))
7958 (unless sorting-type
7959 (message
7960 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7962 A/N/T/S/D/C/P/O/F means reversed:"
7963 what)
7964 (setq sorting-type (read-char-exclusive))
7966 (and (= (downcase sorting-type) ?f)
7967 (setq getkey-func
7968 (org-icompleting-read "Sort using function: "
7969 obarray 'fboundp t nil nil))
7970 (setq getkey-func (intern getkey-func)))
7972 (and (= (downcase sorting-type) ?r)
7973 (setq property
7974 (org-icompleting-read "Property: "
7975 (mapcar 'list (org-buffer-property-keys t))
7976 nil t))))
7978 (message "Sorting entries...")
7980 (save-restriction
7981 (narrow-to-region start end)
7982 (let ((dcst (downcase sorting-type))
7983 (case-fold-search nil)
7984 (now (current-time)))
7985 (sort-subr
7986 (/= dcst sorting-type)
7987 ;; This function moves to the beginning character of the "record" to
7988 ;; be sorted.
7989 (lambda nil
7990 (if (re-search-forward re nil t)
7991 (goto-char (match-beginning 0))
7992 (goto-char (point-max))))
7993 ;; This function moves to the last character of the "record" being
7994 ;; sorted.
7995 (lambda nil
7996 (save-match-data
7997 (condition-case nil
7998 (outline-forward-same-level 1)
7999 (error
8000 (goto-char (point-max))))))
8001 ;; This function returns the value that gets sorted against.
8002 (lambda nil
8003 (cond
8004 ((= dcst ?n)
8005 (if (looking-at org-complex-heading-regexp)
8006 (string-to-number (match-string 4))
8007 nil))
8008 ((= dcst ?a)
8009 (if (looking-at org-complex-heading-regexp)
8010 (funcall case-func (match-string 4))
8011 nil))
8012 ((= dcst ?t)
8013 (let ((end (save-excursion (outline-next-heading) (point))))
8014 (if (or (re-search-forward org-ts-regexp end t)
8015 (re-search-forward org-ts-regexp-both end t))
8016 (org-time-string-to-seconds (match-string 0))
8017 (org-float-time now))))
8018 ((= dcst ?c)
8019 (let ((end (save-excursion (outline-next-heading) (point))))
8020 (if (re-search-forward
8022 end t)
8023 (org-time-string-to-seconds (match-string 0))
8024 (org-float-time now))))
8025 ((= dcst ?s)
8026 (let ((end (save-excursion (outline-next-heading) (point))))
8027 (if (re-search-forward org-scheduled-time-regexp end t)
8028 (org-time-string-to-seconds (match-string 1))
8029 (org-float-time now))))
8030 ((= dcst ?d)
8031 (let ((end (save-excursion (outline-next-heading) (point))))
8032 (if (re-search-forward org-deadline-time-regexp end t)
8033 (org-time-string-to-seconds (match-string 1))
8034 (org-float-time now))))
8035 ((= dcst ?p)
8036 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8037 (string-to-char (match-string 2))
8038 org-default-priority))
8039 ((= dcst ?r)
8040 (or (org-entry-get nil property) ""))
8041 ((= dcst ?o)
8042 (if (looking-at org-complex-heading-regexp)
8043 (- 9999 (length (member (match-string 2)
8044 org-todo-keywords-1)))))
8045 ((= dcst ?f)
8046 (if getkey-func
8047 (progn
8048 (setq tmp (funcall getkey-func))
8049 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8050 tmp)
8051 (error "Invalid key function `%s'" getkey-func)))
8052 (t (error "Invalid sorting type `%c'" sorting-type))))
8053 nil
8054 (cond
8055 ((= dcst ?a) 'string<)
8056 ((= dcst ?f) compare-func)
8057 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8058 (t nil)))))
8059 (run-hooks 'org-after-sorting-entries-or-items-hook)
8060 (message "Sorting entries...done")))
8062 (defun org-do-sort (table what &optional with-case sorting-type)
8063 "Sort TABLE of WHAT according to SORTING-TYPE.
8064 The user will be prompted for the SORTING-TYPE if the call to this
8065 function does not specify it. WHAT is only for the prompt, to indicate
8066 what is being sorted. The sorting key will be extracted from
8067 the car of the elements of the table.
8068 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8069 (unless sorting-type
8070 (message
8071 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8072 what)
8073 (setq sorting-type (read-char-exclusive)))
8074 (let ((dcst (downcase sorting-type))
8075 extractfun comparefun)
8076 ;; Define the appropriate functions
8077 (cond
8078 ((= dcst ?n)
8079 (setq extractfun 'string-to-number
8080 comparefun (if (= dcst sorting-type) '< '>)))
8081 ((= dcst ?a)
8082 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8083 (lambda(x) (downcase (org-sort-remove-invisible x))))
8084 comparefun (if (= dcst sorting-type)
8085 'string<
8086 (lambda (a b) (and (not (string< a b))
8087 (not (string= a b)))))))
8088 ((= dcst ?t)
8089 (setq extractfun
8090 (lambda (x)
8091 (if (or (string-match org-ts-regexp x)
8092 (string-match org-ts-regexp-both x))
8093 (org-float-time
8094 (org-time-string-to-time (match-string 0 x)))
8095 0))
8096 comparefun (if (= dcst sorting-type) '< '>)))
8097 (t (error "Invalid sorting type `%c'" sorting-type)))
8099 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8100 table)
8101 (lambda (a b) (funcall comparefun (car a) (car b))))))
8104 ;;; The orgstruct minor mode
8106 ;; Define a minor mode which can be used in other modes in order to
8107 ;; integrate the org-mode structure editing commands.
8109 ;; This is really a hack, because the org-mode structure commands use
8110 ;; keys which normally belong to the major mode. Here is how it
8111 ;; works: The minor mode defines all the keys necessary to operate the
8112 ;; structure commands, but wraps the commands into a function which
8113 ;; tests if the cursor is currently at a headline or a plain list
8114 ;; item. If that is the case, the structure command is used,
8115 ;; temporarily setting many Org-mode variables like regular
8116 ;; expressions for filling etc. However, when any of those keys is
8117 ;; used at a different location, function uses `key-binding' to look
8118 ;; up if the key has an associated command in another currently active
8119 ;; keymap (minor modes, major mode, global), and executes that
8120 ;; command. There might be problems if any of the keys is otherwise
8121 ;; used as a prefix key.
8123 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8124 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8125 ;; addresses this by checking explicitly for both bindings.
8127 (defvar orgstruct-mode-map (make-sparse-keymap)
8128 "Keymap for the minor `orgstruct-mode'.")
8130 (defvar org-local-vars nil
8131 "List of local variables, for use by `orgstruct-mode'.")
8133 ;;;###autoload
8134 (define-minor-mode orgstruct-mode
8135 "Toggle the minor mode `orgstruct-mode'.
8136 This mode is for using Org-mode structure commands in other
8137 modes. The following keys behave as if Org-mode were active, if
8138 the cursor is on a headline, or on a plain list item (both as
8139 defined by Org-mode).
8141 M-up Move entry/item up
8142 M-down Move entry/item down
8143 M-left Promote
8144 M-right Demote
8145 M-S-up Move entry/item up
8146 M-S-down Move entry/item down
8147 M-S-left Promote subtree
8148 M-S-right Demote subtree
8149 M-q Fill paragraph and items like in Org-mode
8150 C-c ^ Sort entries
8151 C-c - Cycle list bullet
8152 TAB Cycle item visibility
8153 M-RET Insert new heading/item
8154 S-M-RET Insert new TODO heading / Checkbox item
8155 C-c C-c Set tags / toggle checkbox"
8156 nil " OrgStruct" nil
8157 (org-load-modules-maybe)
8158 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8160 ;;;###autoload
8161 (defun turn-on-orgstruct ()
8162 "Unconditionally turn on `orgstruct-mode'."
8163 (orgstruct-mode 1))
8165 (defun orgstruct++-mode (&optional arg)
8166 "Toggle `orgstruct-mode', the enhanced version of it.
8167 In addition to setting orgstruct-mode, this also exports all indentation
8168 and autofilling variables from org-mode into the buffer. It will also
8169 recognize item context in multiline items.
8170 Note that turning off orgstruct-mode will *not* remove the
8171 indentation/paragraph settings. This can only be done by refreshing the
8173 (interactive "P")
8174 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8175 (if (< arg 1)
8176 (orgstruct-mode -1)
8177 (orgstruct-mode 1)
8178 (let (var val)
8179 (mapc
8180 (lambda (x)
8181 (when (string-match
8183 (symbol-name (car x)))
8184 (setq var (car x) val (nth 1 x))
8185 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8186 org-local-vars)
8187 (org-set-local 'orgstruct-is-++ t))))
8189 (defvar orgstruct-is-++ nil
8190 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8191 (make-variable-buffer-local 'orgstruct-is-++)
8193 ;;;###autoload
8194 (defun turn-on-orgstruct++ ()
8195 "Unconditionally turn on `orgstruct++-mode'."
8196 (orgstruct++-mode 1))
8198 (defun orgstruct-error ()
8199 "Error when there is no default binding for a structure key."
8200 (interactive)
8201 (error "This key has no function outside structure elements"))
8203 (defun orgstruct-setup ()
8204 "Setup orgstruct keymaps."
8205 (let ((nfunc 0)
8206 (bindings
8207 (list
8208 '([(meta up)] org-metaup)
8209 '([(meta down)] org-metadown)
8210 '([(meta left)] org-metaleft)
8211 '([(meta right)] org-metaright)
8212 '([(meta shift up)] org-shiftmetaup)
8213 '([(meta shift down)] org-shiftmetadown)
8214 '([(meta shift left)] org-shiftmetaleft)
8215 '([(meta shift right)] org-shiftmetaright)
8216 '([?\e (up)] org-metaup)
8217 '([?\e (down)] org-metadown)
8218 '([?\e (left)] org-metaleft)
8219 '([?\e (right)] org-metaright)
8220 '([?\e (shift up)] org-shiftmetaup)
8221 '([?\e (shift down)] org-shiftmetadown)
8222 '([?\e (shift left)] org-shiftmetaleft)
8223 '([?\e (shift right)] org-shiftmetaright)
8224 '([(shift up)] org-shiftup)
8225 '([(shift down)] org-shiftdown)
8226 '([(shift left)] org-shiftleft)
8227 '([(shift right)] org-shiftright)
8228 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8229 '("\M-q" fill-paragraph)
8230 '("\C-c^" org-sort)
8231 '("\C-c-" org-cycle-list-bullet)))
8232 elt key fun cmd)
8233 (while (setq elt (pop bindings))
8234 (setq nfunc (1+ nfunc))
8235 (setq key (org-key (car elt))
8236 fun (nth 1 elt)
8237 cmd (orgstruct-make-binding fun nfunc key))
8238 (org-defkey orgstruct-mode-map key cmd))
8240 ;; Special treatment needed for TAB and RET
8241 (org-defkey orgstruct-mode-map [(tab)]
8242 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8243 (org-defkey orgstruct-mode-map "\C-i"
8244 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8246 (org-defkey orgstruct-mode-map "\M-\C-m"
8247 (orgstruct-make-binding 'org-insert-heading 105
8248 "\M-\C-m" [(meta return)]))
8249 (org-defkey orgstruct-mode-map [(meta return)]
8250 (orgstruct-make-binding 'org-insert-heading 106
8251 [(meta return)] "\M-\C-m"))
8253 (org-defkey orgstruct-mode-map [(shift meta return)]
8254 (orgstruct-make-binding 'org-insert-todo-heading 107
8255 [(meta return)] "\M-\C-m"))
8257 (org-defkey orgstruct-mode-map "\e\C-m"
8258 (orgstruct-make-binding 'org-insert-heading 108
8259 "\e\C-m" [?\e (return)]))
8260 (org-defkey orgstruct-mode-map [?\e (return)]
8261 (orgstruct-make-binding 'org-insert-heading 109
8262 [?\e (return)] "\e\C-m"))
8263 (org-defkey orgstruct-mode-map [?\e (shift return)]
8264 (orgstruct-make-binding 'org-insert-todo-heading 110
8265 [?\e (return)] "\e\C-m"))
8267 (unless org-local-vars
8268 (setq org-local-vars (org-get-local-variables)))
8270 t))
8272 (defun orgstruct-make-binding (fun n &rest keys)
8273 "Create a function for binding in the structure minor mode.
8274 FUN is the command to call inside a table. N is used to create a unique
8275 command name. KEYS are keys that should be checked in for a command
8276 to execute outside of tables."
8277 (eval
8278 (list 'defun
8279 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8280 '(arg)
8282 "Outside of structure, run the binding of `"
8283 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8284 "'.")
8285 '(interactive "p")
8286 (list 'if
8287 `(org-context-p 'headline 'item
8288 (and orgstruct-is-++
8289 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8290 'item-body))
8291 (list 'org-run-like-in-org-mode (list 'quote fun))
8292 (list 'let '(orgstruct-mode)
8293 (list 'call-interactively
8294 (append '(or)
8295 (mapcar (lambda (k)
8296 (list 'key-binding k))
8297 keys)
8298 '('orgstruct-error))))))))
8300 (defun org-context-p (&rest contexts)
8301 "Check if local context is any of CONTEXTS.
8302 Possible values in the list of contexts are `table', `headline', and `item'."
8303 (let ((pos (point)))
8304 (goto-char (point-at-bol))
8305 (prog1 (or (and (memq 'table contexts)
8307 (and (memq 'headline contexts)
8308 (looking-at org-outline-regexp))
8309 (and (memq 'item contexts)
8311 (and (memq 'item-body contexts)
8312 (org-in-item-p)))
8313 (goto-char pos))))
8315 (defun org-get-local-variables ()
8316 "Return a list of all local variables in an org-mode buffer."
8317 (let (varlist)
8318 (with-current-buffer (get-buffer-create "*Org tmp*")
8319 (erase-buffer)
8320 (org-mode)
8321 (setq varlist (buffer-local-variables)))
8322 (kill-buffer "*Org tmp*")
8323 (delq nil
8324 (mapcar
8325 (lambda (x)
8326 (setq x
8327 (if (symbolp x)
8328 (list x)
8329 (list (car x) (list 'quote (cdr x)))))
8330 (if (string-match
8331 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8332 (symbol-name (car x)))
8333 x nil))
8334 varlist))))
8336 (defun org-clone-local-variables (from-buffer &optional regexp)
8337 "Clone local variables from FROM-BUFFER.
8338 Optional argument REGEXP selects variables to clone."
8339 (mapc
8340 (lambda (pair)
8341 (and (symbolp (car pair))
8342 (or (null regexp)
8343 (string-match regexp (symbol-name (car pair))))
8344 (set (make-local-variable (car pair))
8345 (cdr pair))))
8346 (buffer-local-variables from-buffer)))
8348 ;;;###autoload
8349 (defun org-run-like-in-org-mode (cmd)
8350 "Run a command, pretending that the current buffer is in Org-mode.
8351 This will temporarily bind local variables that are typically bound in
8352 Org-mode to the values they have in Org-mode, and then interactively
8353 call CMD."
8354 (org-load-modules-maybe)
8355 (unless org-local-vars
8356 (setq org-local-vars (org-get-local-variables)))
8357 (eval (list 'let org-local-vars
8358 (list 'call-interactively (list 'quote cmd)))))
8360 ;;;; Archiving
8362 (defun org-get-category (&optional pos force-refresh)
8363 "Get the category applying to position POS."
8364 (if force-refresh (org-refresh-category-properties))
8365 (let ((pos (or pos (point))))
8366 (or (get-text-property pos 'org-category)
8367 (progn (org-refresh-category-properties)
8368 (get-text-property pos 'org-category)))))
8370 (defun org-refresh-category-properties ()
8371 "Refresh category text properties in the buffer."
8372 (let ((def-cat (cond
8373 ((null org-category)
8374 (if buffer-file-name
8375 (file-name-sans-extension
8376 (file-name-nondirectory buffer-file-name))
8377 "???"))
8378 ((symbolp org-category) (symbol-name org-category))
8379 (t org-category)))
8380 beg end cat pos optionp)
8381 (org-unmodified
8382 (save-excursion
8383 (save-restriction
8384 (widen)
8385 (goto-char (point-min))
8386 (put-text-property (point) (point-max) 'org-category def-cat)
8387 (while (re-search-forward
8389 (setq pos (match-end 0)
8390 optionp (equal (char-after (match-beginning 0)) ?#)
8391 cat (org-trim (match-string 2)))
8392 (if optionp
8393 (setq beg (point-at-bol) end (point-max))
8394 (org-back-to-heading t)
8395 (setq beg (point) end (org-end-of-subtree t t)))
8396 (put-text-property beg end 'org-category cat)
8397 (goto-char pos)))))))
8400 ;;;; Link Stuff
8402 ;;; Link abbreviations
8404 (defun org-link-expand-abbrev (link)
8405 "Apply replacements as defined in `org-link-abbrev-alist."
8407 (let* ((key (match-string 1 link))
8408 (as (or (assoc key org-link-abbrev-alist-local)
8409 (assoc key org-link-abbrev-alist)))
8410 (tag (and (match-end 2) (match-string 3 link)))
8411 rpl)
8412 (if (not as)
8413 link
8414 (setq rpl (cdr as))
8415 (cond
8416 ((symbolp rpl) (funcall rpl tag))
8417 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8418 ((string-match "%h" rpl)
8419 (replace-match (url-hexify-string (or tag "")) t t rpl))
8420 (t (concat rpl tag)))))
8421 link))
8423 ;;; Storing and inserting links
8425 (defvar org-insert-link-history nil
8426 "Minibuffer history for links inserted with `org-insert-link'.")
8428 (defvar org-stored-links nil
8429 "Contains the links stored with `org-store-link'.")
8431 (defvar org-store-link-plist nil
8432 "Plist with info about the most recently link created with `org-store-link'.")
8434 (defvar org-link-protocols nil
8435 "Link protocols added to Org-mode using `org-add-link-type'.")
8437 (defvar org-store-link-functions nil
8438 "List of functions that are called to create and store a link.
8439 Each function will be called in turn until one returns a non-nil
8440 value. Each function should check if it is responsible for creating
8441 this link (for example by looking at the major mode).
8442 If not, it must exit and return nil.
8443 If yes, it should return a non-nil value after a calling
8444 `org-store-link-props' with a list of properties and values.
8445 Special properties are:
8449 This is obligatory as well.
8450 :description Optional default description for the second pair
8451 of brackets in an Org-mode link. The user can still change
8452 this when inserting this link into an Org-mode buffer.
8454 In addition to these, any additional properties can be specified
8455 and then used in remember templates.")
8457 (defun org-add-link-type (type &optional follow export)
8458 "Add TYPE to the list of `org-link-types'.
8459 Re-compute all regular expressions depending on `org-link-types'
8461 FOLLOW and EXPORT are two functions.
8463 FOLLOW should take the link path as the single argument and do whatever
8464 is necessary to follow the link, for example find a file or display
8465 a mail message.
8467 EXPORT should format the link path for export to one of the export formats.
8468 It should be a function accepting three arguments:
8471 desc the description of the link, if any, or a description added by
8472 org-export-normalize-links if there is none
8473 format the export format, a symbol like `html' or `latex' or `ascii'..
8475 The function may use the FORMAT information to return different values
8476 depending on the format. The return value will be put literally into
8477 the exported file. If the return value is nil, this means Org should
8478 do what it normally does with links which do not have EXPORT defined.
8480 Org-mode has a built-in default for exporting links. If you are happy with
8481 this default, there is no need to define an export function for the link
8482 type. For a simple example of an export function, see `org-bbdb.el'."
8483 (add-to-list 'org-link-types type t)
8484 (org-make-link-regexps)
8485 (if (assoc type org-link-protocols)
8486 (setcdr (assoc type org-link-protocols) (list follow export))
8487 (push (list type follow export) org-link-protocols)))
8489 (defvar org-agenda-buffer-name)
8491 ;;;###autoload
8492 (defun org-store-link (arg)
8494 This link is added to `org-stored-links' and can later be inserted
8497 For some link types, a prefix arg is interpreted:
8498 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8499 For file links, arg negates `org-context-in-file-links'."
8500 (interactive "P")
8501 (org-load-modules-maybe)
8502 (setq org-store-link-plist nil) ; reset
8503 (org-with-limited-levels
8504 (let (link cpltxt desc description search txt custom-id agenda-link)
8505 (cond
8507 ((run-hook-with-args-until-success 'org-store-link-functions)
8508 (setq link (plist-get org-store-link-plist :link)
8509 desc (or (plist-get org-store-link-plist :description) link)))
8511 ((equal (buffer-name) "*Org Edit Src Example*")
8512 (let (label gc)
8513 (while (or (not label)
8514 (save-excursion
8515 (save-restriction
8516 (widen)
8517 (goto-char (point-min))
8518 (re-search-forward
8519 (regexp-quote (format org-coderef-label-format label))
8520 nil t))))
8521 (when label (message "Label exists already") (sit-for 2))
8522 (setq label (read-string "Code line label: " label)))
8523 (end-of-line 1)
8524 (setq link (format org-coderef-label-format label))
8525 (setq gc (- 79 (length link)))
8526 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8527 (insert link)
8528 (setq link (concat "(" label ")") desc nil)))
8530 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8531 ;; We are in the agenda, link to referenced location
8532 (let ((m (or (get-text-property (point) 'org-hd-marker)
8533 (get-text-property (point) 'org-marker))))
8534 (when m
8535 (org-with-point-at m
8536 (setq agenda-link
8537 (if (org-called-interactively-p 'any)
8538 (call-interactively 'org-store-link)
8539 (org-store-link nil)))))))
8541 ((eq major-mode 'calendar-mode)
8542 (let ((cd (calendar-cursor-to-date)))
8543 (setq link
8544 (format-time-string
8545 (car org-time-stamp-formats)
8546 (apply 'encode-time
8547 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8548 nil nil nil))))
8549 (org-store-link-props :type "calendar" :date cd)))
8551 ((eq major-mode 'w3-mode)
8552 (setq cpltxt (if (and (buffer-name)
8553 (not (string-match "Untitled" (buffer-name))))
8554 (buffer-name)
8555 (url-view-url t))
8556 link (org-make-link (url-view-url t)))
8557 (org-store-link-props :type "w3" :url (url-view-url t)))
8559 ((eq major-mode 'w3m-mode)
8560 (setq cpltxt (or w3m-current-title w3m-current-url)
8561 link (org-make-link w3m-current-url))
8562 (org-store-link-props :type "w3m" :url (url-view-url t)))
8564 ((setq search (run-hook-with-args-until-success
8565 'org-create-file-search-functions))
8566 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8567 "::" search))
8568 (setq cpltxt (or description link)))
8570 ((eq major-mode 'image-mode)
8571 (setq cpltxt (concat "file:"
8572 (abbreviate-file-name buffer-file-name))
8573 link (org-make-link cpltxt))
8574 (org-store-link-props :type "image" :file buffer-file-name))
8576 ((eq major-mode 'dired-mode)
8577 ;; link to the file in the current line
8578 (let ((file (dired-get-filename nil t)))
8579 (setq file (if file
8580 (abbreviate-file-name
8581 (expand-file-name (dired-get-filename nil t)))
8582 ;; otherwise, no file so use current directory.
8583 default-directory))
8584 (setq cpltxt (concat "file:" file)
8585 link (org-make-link cpltxt))))
8587 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8588 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8589 (cond
8591 (setq cpltxt
8592 (concat "file:"
8593 (abbreviate-file-name
8594 (buffer-file-name (buffer-base-buffer)))
8595 "::" (match-string 1))
8596 link (org-make-link cpltxt)))
8597 ((and (featurep 'org-id)
8598 (or (eq org-link-to-org-use-id t)
8599 (and (eq org-link-to-org-use-id 'create-if-interactive)
8600 (org-called-interactively-p 'any))
8601 (and (eq org-link-to-org-use-id
8602 'create-if-interactive-and-no-custom-id)
8603 (org-called-interactively-p 'any)
8604 (not custom-id))
8605 (and org-link-to-org-use-id
8606 (org-entry-get nil "ID"))))
8607 ;; We can make a link using the ID.
8608 (setq link (condition-case nil
8609 (prog1 (org-id-store-link)
8610 (setq desc (plist-get org-store-link-plist
8611 :description)))
8612 (error
8613 ;; probably before first headline, link to file only
8614 (concat "file:"
8615 (abbreviate-file-name
8616 (buffer-file-name (buffer-base-buffer))))))))
8617 (t
8618 ;; Just link to current headline
8619 (setq cpltxt (concat "file:"
8620 (abbreviate-file-name
8621 (buffer-file-name (buffer-base-buffer)))))
8622 ;; Add a context search string
8623 (when (org-xor org-context-in-file-links arg)
8624 (setq txt (cond
8625 ((org-on-heading-p) nil)
8626 ((org-region-active-p)
8627 (buffer-substring (region-beginning) (region-end)))
8628 (t nil)))
8630 (setq cpltxt
8631 (concat cpltxt "::"
8632 (condition-case nil
8633 (org-make-org-heading-search-string txt)
8634 (error "")))
8635 desc (or (nth 4 (ignore-errors
8636 (org-heading-components))) "NONE"))))
8638 (setq cpltxt (substring cpltxt 0 -2)))
8639 (setq link (org-make-link cpltxt)))))
8641 ((buffer-file-name (buffer-base-buffer))
8642 ;; Just link to this file here.
8643 (setq cpltxt (concat "file:"
8644 (abbreviate-file-name
8645 (buffer-file-name (buffer-base-buffer)))))
8646 ;; Add a context string
8647 (when (org-xor org-context-in-file-links arg)
8648 (setq txt (if (org-region-active-p)
8649 (buffer-substring (region-beginning) (region-end))
8650 (buffer-substring (point-at-bol) (point-at-eol))))
8651 ;; Only use search option if there is some text.
8653 (setq cpltxt
8654 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8655 desc "NONE")))
8656 (setq link (org-make-link cpltxt)))
8658 ((org-called-interactively-p 'interactive)
8659 (error "Cannot link to a buffer which is not visiting a file"))
8661 (t (setq link nil)))
8663 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8664 (setq link (or link cpltxt)
8665 desc (or desc cpltxt))
8666 (if (equal desc "NONE") (setq desc nil))
8668 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8669 (progn
8670 (setq org-stored-links
8671 (cons (list link desc) org-stored-links))
8672 (message "Stored: %s" (or desc link))
8673 (when custom-id
8674 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8675 "::#" custom-id))
8676 (setq org-stored-links
8677 (cons (list link desc) org-stored-links))))
8678 (or agenda-link (and link (org-make-link-string link desc)))))))
8680 (defun org-store-link-props (&rest plist)
8681 "Store link properties, extract names and addresses."
8682 (let (x adr)
8683 (when (setq x (plist-get plist :from))
8684 (setq adr (mail-extract-address-components x))
8685 (setq plist (plist-put plist :fromname (car adr)))
8686 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8687 (when (setq x (plist-get plist :to))
8688 (setq adr (mail-extract-address-components x))
8689 (setq plist (plist-put plist :toname (car adr)))
8690 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8691 (let ((from (plist-get plist :from))
8692 (to (plist-get plist :to)))
8693 (when (and from to org-from-is-user-regexp)
8694 (setq plist
8695 (plist-put plist :fromto
8696 (if (string-match org-from-is-user-regexp from)
8697 (concat "to %t")
8698 (concat "from %f"))))))
8699 (setq org-store-link-plist plist))
8701 (defun org-add-link-props (&rest plist)
8702 "Add these properties to the link property list."
8703 (let (key value)
8704 (while plist
8705 (setq key (pop plist) value (pop plist))
8706 (setq org-store-link-plist
8707 (plist-put org-store-link-plist key value)))))
8709 (defun org-email-link-description (&optional fmt)
8710 "Return the description part of an email link.
8711 This takes information from `org-store-link-plist' and formats it
8712 according to FMT (default from `org-email-link-description-format')."
8713 (setq fmt (or fmt org-email-link-description-format))
8714 (let* ((p org-store-link-plist)
8715 (to (plist-get p :toaddress))
8716 (from (plist-get p :fromaddress))
8717 (table
8718 (list
8719 (cons "%c" (plist-get p :fromto))
8720 (cons "%F" (plist-get p :from))
8721 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8722 (cons "%T" (plist-get p :to))
8723 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8724 (cons "%s" (plist-get p :subject))
8725 (cons "%d" (plist-get p :date))
8726 (cons "%m" (plist-get p :message-id)))))
8727 (when (string-match "%c" fmt)
8728 ;; Check if the user wrote this message
8729 (if (and org-from-is-user-regexp from to
8730 (save-match-data (string-match org-from-is-user-regexp from)))
8731 (setq fmt (replace-match "to %t" t t fmt))
8732 (setq fmt (replace-match "from %f" t t fmt))))
8733 (org-replace-escapes fmt table)))
8735 (defun org-make-org-heading-search-string (&optional string heading)
8736 "Make search string for STRING or current headline."
8737 (interactive)
8738 (let ((s (or string (org-get-heading)))
8739 (lines org-context-in-file-links))
8740 (unless (and string (not heading))
8741 ;; We are using a headline, clean up garbage in there.
8742 (if (string-match org-todo-regexp s)
8743 (setq s (replace-match "" t t s)))
8745 (setq s (replace-match "" t t s)))
8746 (setq s (org-trim s))
8749 (setq s (replace-match "" t t s)))
8750 (while (string-match org-ts-regexp s)
8751 (setq s (replace-match "" t t s))))
8752 (or string (setq s (concat "*" s))) ; Add * for headlines
8753 (when (and string (integerp lines) (> lines 0))
8755 (when (< lines (length slines))
8756 (setq s (mapconcat
8757 'identity
8758 (reverse (nthcdr (- (length slines) lines)
8762 (defun org-make-link (&rest strings)
8763 "Concatenate STRINGS."
8764 (apply 'concat strings))
8766 (defun org-make-link-string (link &optional description)
8767 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8769 (error "Empty link"))
8770 (when (and description
8771 (stringp description)
8773 (setq description nil))
8774 (when (stringp description)
8775 ;; Remove brackets from the description, they are fatal.
8777 (setq description (replace-match "{" t t description)))
8779 (setq description (replace-match "}" t t description))))
8780 (when (equal link description)
8781 ;; No description needed, it is identical
8782 (setq description nil))
8783 (when (and (not description)
8784 (not (string-match (org-image-file-name-regexp) link))
8785 (not (equal link (org-link-escape link))))
8786 (setq description (org-extract-attributes link)))
8787 (setq link
8788 (cond ((string-match (org-image-file-name-regexp) link) link)
8789 ((string-match org-link-types-re link)
8790 (concat (match-string 1 link)
8791 (org-link-escape (substring link (match-end 1)))))
8792 (t (org-link-escape link))))
8793 (concat "[[" link "]"
8794 (if description (concat "[" description "]") "")
8795 "]"))
8797 (defconst org-link-escape-chars
8798 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8799 "List of characters that should be escaped in link.
8800 This is the list that is used for internal purposes.")
8802 (defvar org-url-encoding-use-url-hexify nil)
8804 (defconst org-link-escape-chars-browser
8805 '(?\ )
8806 "List of escapes for characters that are problematic in links.
8807 This is the list that is used before handing over to the browser.")
8809 (defun org-link-escape (text &optional table merge)
8810 "Return percent escaped representation of TEXT.
8811 TEXT is a string with the text to escape.
8812 Optional argument TABLE is a list with characters that should be
8813 escaped. When nil, `org-link-escape-chars' is used.
8814 If optional argument MERGE is set, merge TABLE into
8815 `org-link-escape-chars'."
8816 (if (and org-url-encoding-use-url-hexify (not table))
8817 (url-hexify-string text)
8818 (cond
8819 ((and table merge)
8820 (mapc (lambda (defchr)
8821 (unless (member defchr table)
8822 (setq table (cons defchr table)))) org-link-escape-chars))
8823 ((null table)
8824 (setq table org-link-escape-chars)))
8825 (mapconcat
8826 (lambda (char)
8827 (if (or (member char table)
8828 (< char 32) (= char 37) (> char 126))
8829 (mapconcat (lambda (sequence-element)
8830 (format "%%%.2X" sequence-element))
8831 (or (encode-coding-char char 'utf-8)
8832 (error "Unable to percent escape character: %s"
8833 (char-to-string char))) "")
8834 (char-to-string char))) text "")))
8836 (defun org-link-unescape (str)
8837 "Unhex hexified unicode strings as returned from the JavaScript function
8838 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8839 (unless (and (null str) (string= "" str))
8840 (let ((pos 0) (case-fold-search t) unhexed)
8842 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8843 (setq str (replace-match unhexed t t str))
8844 (setq pos (+ pos (length unhexed))))))
8845 str)
8847 (defun org-link-unescape-compound (hex)
8848 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8849 Note: this function also decodes single byte encodings like
8851 (save-match-data
8852 (let* ((bytes (cdr (split-string hex "%")))
8853 (ret "")
8854 (eat 0)
8855 (sum 0))
8856 (while bytes
8857 (let* ((val (string-to-number (pop bytes) 16))
8858 (shift-xor
8859 (if (= 0 eat)
8860 (cond
8861 ((>= val 252) (cons 6 252))
8862 ((>= val 248) (cons 5 248))
8863 ((>= val 240) (cons 4 240))
8864 ((>= val 224) (cons 3 224))
8865 ((>= val 192) (cons 2 192))
8866 (t (cons 0 0)))
8867 (cons 6 128))))
8868 (if (>= val 192) (setq eat (car shift-xor)))
8869 (setq val (logxor val (cdr shift-xor)))
8870 (setq sum (+ (lsh sum (car shift-xor)) val))
8871 (if (> eat 0) (setq eat (- eat 1)))
8872 (cond
8873 ((= 0 eat) ;multi byte
8874 (setq ret (concat ret (org-char-to-string sum)))
8875 (setq sum 0))
8876 ((not bytes) ; single byte(s)
8877 (setq ret (org-link-unescape-single-byte-sequence hex))))
8878 )) ;; end (while bytes
8879 ret )))
8881 (defun org-link-unescape-single-byte-sequence (hex)
8882 "Unhexify hex-encoded single byte character sequences."
8883 (mapconcat (lambda (byte)
8884 (char-to-string (string-to-number byte 16)))
8885 (cdr (split-string hex "%")) ""))
8887 (defun org-xor (a b)
8888 "Exclusive or."
8889 (if a (not b) b))
8891 (defun org-fixup-message-id-for-http (s)
8892 "Replace special characters in a message id, so it can be used in an http query."
8893 (when (string-match "%" s)
8894 (setq s (mapconcat (lambda (c)
8895 (if (eq c ?%)
8896 "%25"
8897 (char-to-string c)))
8898 s "")))
8899 (while (string-match "<" s)
8900 (setq s (replace-match "%3C" t t s)))
8901 (while (string-match ">" s)
8902 (setq s (replace-match "%3E" t t s)))
8903 (while (string-match "@" s)
8904 (setq s (replace-match "%40" t t s)))
8905 s)
8907 ;;;###autoload
8908 (defun org-insert-link-global ()
8909 "Insert a link like Org-mode does.
8910 This command can be called in any mode to insert a link in Org-mode syntax."
8911 (interactive)
8912 (org-load-modules-maybe)
8913 (org-run-like-in-org-mode 'org-insert-link))
8915 (defun org-insert-link (&optional complete-file link-location)
8916 "Insert a link. At the prompt, enter the link.
8918 Completion can be used to insert any of the link protocol prefixes like
8919 http or ftp in use.
8921 The history can be used to select a link previously stored with
8922 `org-store-link'. When the empty string is entered (i.e. if you just
8923 press RET at the prompt), the link defaults to the most recently
8924 stored link. As SPC triggers completion in the minibuffer, you need to
8925 use M-SPC or C-q SPC to force the insertion of a space character.
8927 You will also be prompted for a description, and if one is given, it will
8928 be displayed in the buffer instead of the link.
8930 If there is already a link at point, this command will allow you to edit link
8931 and description parts.
8934 be selected using completion. The path to the file will be relative to the
8935 current directory if the file is in the current directory or a subdirectory.
8936 Otherwise, the link will be the absolute path as completed in the minibuffer
8937 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8938 option `org-link-file-path-type'.
8941 the current directory or below.
8944 `org-keep-stored-link-after-insertion'.
8946 If `org-make-link-description-function' is non-nil, this function will be
8947 called with the link target, and the result will be the default
8948 link description.
8950 If the LINK-LOCATION parameter is non-nil, this value will be
8951 used as the link location instead of reading one interactively."
8952 (interactive "P")
8953 (let* ((wcf (current-window-configuration))
8954 (region (if (org-region-active-p)
8955 (buffer-substring (region-beginning) (region-end))))
8956 (remove (and region (list (region-beginning) (region-end))))
8957 (desc region)
8958 tmphist ; byte-compile incorrectly complains about this
8959 (link link-location)
8960 entry file all-prefixes)
8961 (cond
8962 (link-location) ; specified by arg, just use it.
8963 ((org-in-regexp org-bracket-link-regexp 1)
8964 ;; We do have a link at point, and we are going to edit it.
8965 (setq remove (list (match-beginning 0) (match-end 0)))
8966 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8967 (setq link (read-string "Link: "
8968 (org-link-unescape
8969 (org-match-string-no-properties 1)))))
8970 ((or (org-in-regexp org-angle-link-re)
8971 (org-in-regexp org-plain-link-re))
8972 ;; Convert to bracket link
8973 (setq remove (list (match-beginning 0) (match-end 0))
8974 link (read-string "Link: "
8975 (org-remove-angle-brackets (match-string 0)))))
8976 ((member complete-file '((4) (16)))
8977 ;; Completing read for file names.
8978 (setq link (org-file-complete-link complete-file)))
8979 (t
8980 ;; Read link, with completion for stored links.
8981 (with-output-to-temp-buffer "*Org Links*"
8982 (princ "Insert a link.
8984 (when org-stored-links
8986 (princ (mapconcat
8987 (lambda (x)
8988 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8990 (let ((cw (selected-window)))
8991 (select-window (get-buffer-window "*Org Links*" 'visible))
8992 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8993 (unless (pos-visible-in-window-p (point-max))
8994 (org-fit-window-to-buffer))
8995 (and (window-live-p cw) (select-window cw)))
8996 ;; Fake a link history, containing the stored links.
8997 (setq tmphist (append (mapcar 'car org-stored-links)
8998 org-insert-link-history))
8999 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9000 (mapcar 'car org-link-abbrev-alist)
9001 org-link-types))
9002 (unwind-protect
9003 (progn
9004 (setq link
9005 (let ((org-completion-use-ido nil)
9006 (org-completion-use-iswitchb nil))
9007 (org-completing-read
9008 "Link: "
9009 (append
9010 (mapcar (lambda (x) (list (concat x ":")))
9011 all-prefixes)
9012 (mapcar 'car org-stored-links))
9013 nil nil nil
9014 'tmphist
9015 (car (car org-stored-links)))))
9017 (error "No link selected"))
9018 (if (or (member link all-prefixes)
9019 (and (equal ":" (substring link -1))
9020 (member (substring link 0 -1) all-prefixes)
9021 (setq link (substring link 0 -1))))
9022 (setq link (org-link-try-special-completion link))))
9023 (set-window-configuration wcf)
9024 (kill-buffer "*Org Links*"))
9025 (setq entry (assoc link org-stored-links))
9026 (or entry (push link org-insert-link-history))
9027 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9028 (not org-keep-stored-link-after-insertion))
9029 (setq org-stored-links (delq (assoc link org-stored-links)
9030 org-stored-links)))
9031 (setq desc (or desc (nth 1 entry)))))
9033 (if (string-match org-plain-link-re link)
9034 ;; URL-like link, normalize the use of angular brackets.
9035 (setq link (org-make-link (org-remove-angle-brackets link))))
9037 ;; Check if we are linking to the current file with a search option
9038 ;; If yes, simplify the link by using only the search option.
9039 (when (and buffer-file-name
9041 (let* ((path (match-string 1 link))
9042 (case-fold-search nil)
9043 (search (match-string 2 link)))
9044 (save-match-data
9045 (if (equal (file-truename buffer-file-name) (file-truename path))
9046 ;; We are linking to this same file, with a search option
9047 (setq link search)))))
9049 ;; Check if we can/should use a relative path. If yes, simplify the link
9051 (let* ((type (match-string 1 link))
9052 (path (match-string 2 link))
9053 (origpath path)
9054 (case-fold-search nil))
9055 (cond
9056 ((or (eq org-link-file-path-type 'absolute)
9057 (equal complete-file '(16)))
9058 (setq path (abbreviate-file-name (expand-file-name path))))
9059 ((eq org-link-file-path-type 'noabbrev)
9060 (setq path (expand-file-name path)))
9061 ((eq org-link-file-path-type 'relative)
9062 (setq path (file-relative-name path)))
9063 (t
9064 (save-match-data
9065 (if (string-match (concat "^" (regexp-quote
9066 (expand-file-name
9067 (file-name-as-directory
9068 default-directory))))
9069 (expand-file-name path))
9070 ;; We are linking a file with relative path name.
9071 (setq path (substring (expand-file-name path)
9072 (match-end 0)))
9073 (setq path (abbreviate-file-name (expand-file-name path)))))))
9074 (setq link (concat type path))
9075 (if (equal desc origpath)
9076 (setq desc path))))
9078 (if org-make-link-description-function
9079 (setq desc (funcall org-make-link-description-function link desc)))
9081 (setq desc (read-string "Description: " desc))
9083 (if remove (apply 'delete-region remove))
9084 (insert (org-make-link-string link desc))))
9086 (defun org-link-try-special-completion (type)
9087 "If there is completion support for link type TYPE, offer it."
9088 (let ((fun (intern (concat "org-" type "-complete-link"))))
9089 (if (functionp fun)
9090 (funcall fun)
9091 (read-string "Link (no completion support): " (concat type ":")))))
9093 (defun org-file-complete-link (&optional arg)
9094 "Create a file link using completion."
9095 (let (file link)
9096 (setq file (read-file-name "File: "))
9097 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9098 (pwd1 (file-name-as-directory (abbreviate-file-name
9099 (expand-file-name ".")))))
9100 (cond
9101 ((equal arg '(16))
9102 (setq link (org-make-link
9103 "file:"
9104 (abbreviate-file-name (expand-file-name file)))))
9106 (setq link (org-make-link "file:" (match-string 1 file))))
9108 (expand-file-name file))
9109 (setq link (org-make-link
9110 "file:" (match-string 1 (expand-file-name file)))))
9111 (t (setq link (org-make-link "file:" file)))))
9112 link))
9114 (defun org-completing-read (&rest args)
9115 "Completing-read with SPACE being a normal character."
9116 (let ((minibuffer-local-completion-map
9117 (copy-keymap minibuffer-local-completion-map)))
9118 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9119 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9120 (apply 'org-icompleting-read args)))
9122 (defun org-completing-read-no-i (&rest args)
9123 (let (org-completion-use-ido org-completion-use-iswitchb)
9124 (apply 'org-completing-read args)))
9126 (defun org-iswitchb-completing-read (prompt choices &rest args)
9127 "Use iswitch as a completing-read replacement to choose from choices.
9128 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9129 from."
9130 (let* ((iswitchb-use-virtual-buffers nil)
9131 (iswitchb-make-buflist-hook
9132 (lambda ()
9133 (setq iswitchb-temp-buflist choices))))
9134 (iswitchb-read-buffer prompt)))
9136 (defun org-icompleting-read (&rest args)
9137 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9138 (org-without-partial-completion
9139 (if (and org-completion-use-ido
9140 (fboundp 'ido-completing-read)
9141 (boundp 'ido-mode) ido-mode
9142 (listp (second args)))
9143 (let ((ido-enter-matching-directory nil))
9144 (apply 'ido-completing-read (concat (car args))
9145 (if (consp (car (nth 1 args)))
9146 (mapcar 'car (nth 1 args))
9147 (nth 1 args))
9148 (cddr args)))
9149 (if (and org-completion-use-iswitchb
9150 (boundp 'iswitchb-mode) iswitchb-mode
9151 (listp (second args)))
9152 (apply 'org-iswitchb-completing-read (concat (car args))
9153 (if (consp (car (nth 1 args)))
9154 (mapcar 'car (nth 1 args))
9155 (nth 1 args))
9156 (cddr args))
9157 (apply 'completing-read args)))))
9159 (defun org-extract-attributes (s)
9160 "Extract the attributes cookie from a string and set as text property."
9161 (let (a attr (start 0) key value)
9162 (save-match-data
9164 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9166 (setq key (match-string 1 a) value (match-string 2 a)
9167 start (match-end 0)
9168 attr (plist-put attr (intern key) value))))
9169 (org-add-props s nil 'org-attr attr))
9170 s))
9172 (defun org-extract-attributes-from-string (tag)
9173 (let (key value attr)
9175 (setq key (match-string 1 tag) value (match-string 2 tag)
9176 tag (replace-match "" t t tag)
9177 attr (plist-put attr (intern key) value)))
9178 (cons tag attr)))
9180 (defun org-attributes-to-string (plist)
9181 "Format a property list into an HTML attribute list."
9182 (let ((s "") key value)
9183 (while plist
9184 (setq key (pop plist) value (pop plist))
9185 (and value
9187 s))
9189 ;;; Opening/following a link
9191 (defvar org-link-search-failed nil)
9193 (defvar org-open-link-functions nil
9194 "Hook for functions finding a plain text link.
9195 These functions must take a single argument, the link content.
9196 They will be called for links that look like [[link text][description]]
9200 These functions will be called *before* Org attempts to resolve the
9201 link by doing text searches in the current buffer - so if you want a
9203 handle this as a special case.
9205 When the function does handle the link, it must return a non-nil value.
9206 If it decides that it is not responsible for this link, it must return
9207 nil to indicate that that Org-mode can continue with other options
9208 like exact and fuzzy text search.")
9210 (defun org-next-link ()
9211 "Move forward to the next link.
9212 If the link is in hidden text, expose it."
9213 (interactive)
9214 (when (and org-link-search-failed (eq this-command last-command))
9215 (goto-char (point-min))
9216 (message "Link search wrapped back to beginning of buffer"))
9217 (setq org-link-search-failed nil)
9218 (let* ((pos (point))
9219 (ct (org-context))
9220 (a (assoc :link ct)))
9221 (if a (goto-char (nth 2 a)))
9222 (if (re-search-forward org-any-link-re nil t)
9223 (progn
9224 (goto-char (match-beginning 0))
9225 (if (outline-invisible-p) (org-show-context)))
9226 (goto-char pos)
9227 (setq org-link-search-failed t)
9228 (error "No further link found"))))
9230 (defun org-previous-link ()
9231 "Move backward to the previous link.
9232 If the link is in hidden text, expose it."
9233 (interactive)
9234 (when (and org-link-search-failed (eq this-command last-command))
9235 (goto-char (point-max))
9236 (message "Link search wrapped back to end of buffer"))
9237 (setq org-link-search-failed nil)
9238 (let* ((pos (point))
9239 (ct (org-context))
9240 (a (assoc :link ct)))
9241 (if a (goto-char (nth 1 a)))
9242 (if (re-search-backward org-any-link-re nil t)
9243 (progn
9244 (goto-char (match-beginning 0))
9245 (if (outline-invisible-p) (org-show-context)))
9246 (goto-char pos)
9247 (setq org-link-search-failed t)
9248 (error "No further link found"))))
9250 (defun org-translate-link (s)
9251 "Translate a link string if a translation function has been defined."
9252 (if (and org-link-translation-function
9253 (fboundp org-link-translation-function)
9255 (progn
9256 (setq s (funcall org-link-translation-function
9257 (match-string 1) (match-string 2)))
9258 (concat (car s) ":" (cdr s)))
9259 s))
9261 (defun org-translate-link-from-planner (type path)
9262 "Translate a link from Emacs Planner syntax so that Org can follow it.
9263 This is still an experimental function, your mileage may vary."
9264 (cond
9265 ((member type '("http" "https" "news" "ftp"))
9266 ;; standard Internet links are the same.
9267 nil)
9268 ((and (equal type "irc") (string-match "^//" path))
9269 ;; Planner has two / at the beginning of an irc link, we have 1.
9270 ;; We should have zero, actually....
9271 (setq path (substring path 1)))
9272 ((and (equal type "lisp") (string-match "^/" path))
9273 ;; Planner has a slash, we do not.
9274 (setq type "elisp" path (substring path 1)))
9276 ;; A typical message link. Planner has the id after the final slash,
9277 ;; we separate it with a hash mark
9278 (setq path (concat (match-string 1 path) "#"
9279 (org-remove-angle-brackets (match-string 2 path)))))
9280 )
9281 (cons type path))
9283 (defun org-find-file-at-mouse (ev)
9284 "Open file link or URL at mouse."
9285 (interactive "e")
9286 (mouse-set-point ev)
9287 (org-open-at-point 'in-emacs))
9289 (defun org-open-at-mouse (ev)
9290 "Open file link or URL at mouse.
9291 See the docstring of `org-open-file' for details."
9292 (interactive "e")
9293 (mouse-set-point ev)
9294 (if (eq major-mode 'org-agenda-mode)
9295 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9296 (org-open-at-point))
9298 (defvar org-window-config-before-follow-link nil
9299 "The window configuration before following a link.
9300 This is saved in case the need arises to restore it.")
9302 (defvar org-open-link-marker (make-marker)
9303 "Marker pointing to the location where `org-open-at-point; was called.")
9305 ;;;###autoload
9306 (defun org-open-at-point-global ()
9307 "Follow a link like Org-mode does.
9308 This command can be called in any mode to follow a link that has
9309 Org-mode syntax."
9310 (interactive)
9311 (org-run-like-in-org-mode 'org-open-at-point))
9313 ;;;###autoload
9314 (defun org-open-link-from-string (s &optional arg reference-buffer)
9315 "Open a link in the string S, as if it was in Org-mode."
9317 (let ((reference-buffer (or reference-buffer (current-buffer))))
9318 (with-temp-buffer
9319 (let ((org-inhibit-startup t))
9320 (org-mode)
9321 (insert s)
9322 (goto-char (point-min))
9323 (when reference-buffer
9324 (setq org-link-abbrev-alist-local
9325 (with-current-buffer reference-buffer
9326 org-link-abbrev-alist-local)))
9327 (org-open-at-point arg reference-buffer)))))
9329 (defvar org-open-at-point-functions nil
9330 "Hook that is run when following a link at point.
9332 Functions in this hook must return t if they identify and follow
9333 a link at point. If they don't find anything interesting at point,
9334 they must return nil.")
9336 (defun org-open-at-point (&optional arg reference-buffer)
9337 "Open link at or after point.
9338 If there is no link at point, this function will search forward up to
9339 the end of the current line.
9340 Normally, files will be opened by an appropriate application. If the
9341 optional prefix argument ARG is non-nil, Emacs will visit the file.
9342 With a double prefix argument, try to open outside of Emacs, in the
9343 application the system uses for this file type."
9344 (interactive "P")
9345 ;; if in a code block, then open the block's results
9346 (unless (call-interactively #'org-babel-open-src-block-result)
9347 (org-load-modules-maybe)
9348 (move-marker org-open-link-marker (point))
9349 (setq org-window-config-before-follow-link (current-window-configuration))
9350 (org-remove-occur-highlights nil nil t)
9351 (cond
9352 ((and (org-on-heading-p)
9353 (not (org-in-regexp
9358 (not (get-text-property (point) 'org-linked-text)))
9359 (or (org-offer-links-in-entry arg)
9360 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9361 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9362 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9363 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9364 (not (org-in-regexp org-bracket-link-regexp)))
9365 (org-footnote-action))
9366 (t
9367 (let (type path link line search (pos (point)))
9368 (catch 'match
9369 (save-excursion
9371 (when (org-in-regexp org-bracket-link-regexp 1)
9372 (setq link (org-extract-attributes
9373 (org-link-unescape (org-match-string-no-properties 1))))
9375 (setq link (replace-match " " t t link)))
9376 (setq link (org-link-expand-abbrev link))
9377 (cond
9378 ((or (file-name-absolute-p link)
9380 (setq type "file" path link))
9381 ((string-match org-link-re-with-space3 link)
9382 (setq type (match-string 1 link) path (match-string 2 link)))
9383 (t (setq type "thisfile" path link)))
9384 (throw 'match t)))
9386 (when (get-text-property (point) 'org-linked-text)
9387 (setq type "thisfile"
9388 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9389 (1+ (point)) (point))
9390 path (buffer-substring
9391 (or (previous-single-property-change pos 'org-linked-text)
9392 (point-min))
9393 (or (next-single-property-change pos 'org-linked-text)
9394 (point-max))))
9395 (throw 'match t))
9397 (save-excursion
9398 (when (or (org-in-regexp org-angle-link-re)
9399 (org-in-regexp org-plain-link-re))
9400 (setq type (match-string 1) path (match-string 2))
9401 (throw 'match t)))
9402 (save-excursion
9404 (setq type "tags"
9405 path (match-string 1))
9406 (while (string-match ":" path)
9407 (setq path (replace-match "+" t t path)))
9408 (throw 'match t)))
9410 (setq type "tree-match"
9411 path (match-string 1))
9412 (throw 'match t)))
9413 (unless path
9414 (error "No link found"))
9416 ;; switch back to reference buffer
9417 ;; needed when if called in a temporary buffer through
9418 ;; org-open-link-from-string
9419 (with-current-buffer (or reference-buffer (current-buffer))
9421 ;; Remove any trailing spaces in path
9423 (setq path (replace-match "" t t path)))
9424 (if (and org-link-translation-function
9425 (fboundp org-link-translation-function))
9426 ;; Check if we need to translate the link
9427 (let ((tmp (funcall org-link-translation-function type path)))
9428 (setq type (car tmp) path (cdr tmp))))
9430 (cond
9432 ((assoc type org-link-protocols)
9433 (funcall (nth 1 (assoc type org-link-protocols)) path))
9435 ((equal type "mailto")
9436 (let ((cmd (car org-link-mailto-program))
9437 (args (cdr org-link-mailto-program)) args1
9438 (address path) (subject "") a)
9440 (setq address (match-string 1 path)
9441 subject (org-link-escape (match-string 2 path))))
9442 (while args
9443 (cond
9444 ((not (stringp (car args))) (push (pop args) args1))
9445 (t (setq a (pop args))
9446 (if (string-match "%a" a)
9447 (setq a (replace-match address t t a)))
9448 (if (string-match "%s" a)
9449 (setq a (replace-match subject t t a)))
9450 (push a args1))))
9451 (apply cmd (nreverse args1))))
9453 ((member type '("http" "https" "ftp" "news"))
9454 (browse-url (concat type ":" (org-link-escape
9455 path org-link-escape-chars-browser))))
9457 ((string= type "doi")
9458 (browse-url (concat "http://dx.doi.org/"
9459 (org-link-escape
9460 path org-link-escape-chars-browser))))
9462 ((member type '("message"))
9463 (browse-url (concat type ":" path)))
9465 ((string= type "tags")
9466 (org-tags-view arg path))
9468 ((string= type "tree-match")
9471 ((string= type "file")
9473 (setq line (string-to-number (match-string 1 path))
9474 path (substring path 0 (match-beginning 0)))
9476 (setq search (match-string 1 path)
9477 path (substring path 0 (match-beginning 0)))))
9478 (if (string-match "[*?{]" (file-name-nondirectory path))
9479 (dired path)
9480 (org-open-file path arg line search)))
9482 ((string= type "shell")
9483 (let ((cmd path))
9484 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9485 (string-match org-confirm-shell-link-not-regexp cmd))
9486 (not org-confirm-shell-link-function)
9487 (funcall org-confirm-shell-link-function
9489 (org-add-props cmd nil
9490 'face 'org-warning))))
9491 (progn
9492 (message "Executing %s" cmd)
9493 (shell-command cmd))
9494 (error "Abort"))))
9496 ((string= type "elisp")
9497 (let ((cmd path))
9498 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9499 (string-match org-confirm-elisp-link-not-regexp cmd))
9500 (not org-confirm-elisp-link-function)
9501 (funcall org-confirm-elisp-link-function
9503 (org-add-props cmd nil
9504 'face 'org-warning))))
9505 (message "%s => %s" cmd
9506 (if (equal (string-to-char cmd) ?\()
9507 (eval (read cmd))
9508 (call-interactively (read cmd))))
9509 (error "Abort"))))
9511 ((and (string= type "thisfile")
9512 (run-hook-with-args-until-success
9513 'org-open-link-functions path)))
9515 ((string= type "thisfile")
9516 (if arg
9517 (switch-to-buffer-other-window
9518 (org-get-buffer-for-internal-link (current-buffer)))
9519 (org-mark-ring-push))
9520 (let ((cmd `(org-link-search
9521 ,path
9522 ,(cond ((equal arg '(4)) ''occur)
9523 ((equal arg '(16)) ''org-occur)
9524 (t nil))
9525 ,pos)))
9526 (condition-case nil (eval cmd)
9527 (error (progn (widen) (eval cmd))))))
9529 (t
9530 (browse-url-at-point)))))))
9531 (move-marker org-open-link-marker nil)
9532 (run-hook-with-args 'org-follow-link-hook)))
9534 (defun org-offer-links-in-entry (&optional nth zero)
9535 "Offer links in the current entry and follow the selected link.
9536 If there is only one link, follow it immediately as well.
9537 If NTH is an integer, immediately pick the NTH link found.
9538 If ZERO is a string, check also this string for a link, and if
9539 there is one, offer it as link number zero."
9543 (cnt ?0)
9544 (in-emacs (if (integerp nth) nil nth))
9545 have-zero end links link c)
9546 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9547 (push (match-string 0 zero) links)
9548 (setq cnt (1- cnt) have-zero t))
9549 (save-excursion
9550 (org-back-to-heading t)
9551 (setq end (save-excursion (outline-next-heading) (point)))
9552 (while (re-search-forward re end t)
9553 (push (match-string 0) links))
9554 (setq links (org-uniquify (reverse links))))
9556 (cond
9557 ((null links)
9558 (message "No links"))
9559 ((equal (length links) 1)
9560 (setq link (list (car links))))
9561 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9562 (setq link (nth (if have-zero nth (1- nth)) links)))
9563 (t ; we have to select a link
9564 (save-excursion
9565 (save-window-excursion
9566 (delete-other-windows)
9567 (with-output-to-temp-buffer "*Select Link*"
9568 (mapc (lambda (l)
9569 (if (not (string-match org-bracket-link-regexp l))
9571 (org-remove-angle-brackets l)))
9572 (if (match-end 3)
9574 (match-string 3 l) (match-string 1 l)))
9576 (match-string 1 l))))))
9577 links))
9578 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9579 (message "Select link to open, RET to open all:")
9580 (setq c (read-char-exclusive))
9581 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9582 (when (equal c ?q) (error "Abort"))
9583 (if (equal c ?\C-m)
9584 (setq link links)
9585 (setq nth (- c ?0))
9586 (if have-zero (setq nth (1+ nth)))
9587 (unless (and (integerp nth) (>= (length links) nth))
9588 (error "Invalid link selection"))
9589 (setq link (list (nth (1- nth) links))))))
9590 (if link
9591 (let ((buf (current-buffer)))
9592 (dolist (l link)
9593 (org-open-link-from-string l in-emacs buf))
9594 t)
9595 nil)))
9597 ;; Add special file links that specify the way of opening
9599 (org-add-link-type "file+sys" 'org-open-file-with-system)
9600 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9601 (defun org-open-file-with-system (path)
9602 "Open file at PATH using the system way of opening it."
9603 (org-open-file path 'system))
9604 (defun org-open-file-with-emacs (path)
9605 "Open file at PATH in Emacs."
9606 (org-open-file path 'emacs))
9607 (defun org-remove-file-link-modifiers ()
9608 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9609 (goto-char (point-min))
9611 (org-if-unprotected
9612 (replace-match "file:" t t))))
9613 (eval-after-load "org-exp"
9614 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9615 'org-remove-file-link-modifiers))
9617 ;;;; Time estimates
9619 (defun org-get-effort (&optional pom)
9620 "Get the effort estimate for the current entry."
9621 (org-entry-get pom org-effort-property))
9623 ;;; File search
9625 (defvar org-create-file-search-functions nil
9626 "List of functions to construct the right search string for a file link.
9627 These functions are called in turn with point at the location to
9628 which the link should point.
9630 A function in the hook should first test if it would like to
9631 handle this file type, for example by checking the `major-mode'
9632 or the file extension. If it decides not to handle this file, it
9633 should just return nil to give other functions a chance. If it
9634 does handle the file, it must return the search string to be used
9635 when following the link. The search string will be part of the
9636 file link, given after a double colon, and `org-open-at-point'
9637 will automatically search for it. If special measures must be
9638 taken to make the search successful, another function should be
9639 added to the companion hook `org-execute-file-search-functions',
9640 which see.
9642 A function in this hook may also use `setq' to set the variable
9643 `description' to provide a suggestion for the descriptive text to
9644 be used for this link when it gets inserted into an Org-mode
9647 (defvar org-execute-file-search-functions nil
9648 "List of functions to execute a file search triggered by a link.
9650 Functions added to this hook must accept a single argument, the
9651 search string that was part of the file link, the part after the
9652 double colon. The function must first check if it would like to
9653 handle this search, for example by checking the `major-mode' or
9654 the file extension. If it decides not to handle this search, it
9655 should just return nil to give other functions a chance. If it
9656 does handle the search, it must return a non-nil value to keep
9657 other functions from trying.
9659 Each function can access the current prefix argument through the
9660 variable `current-prefix-argument'. Note that a single prefix is
9661 used to force opening a link in Emacs, so it may be good to only
9662 use a numeric or double prefix to guide the search function.
9664 In case this is needed, a function in this hook can also restore
9665 the window configuration before `org-open-at-point' was called using:
9667 (set-window-configuration org-window-config-before-follow-link)")
9669 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9670 (defun org-link-search (s &optional type avoid-pos)
9671 "Search for a link search option.
9672 If S is surrounded by forward slashes, it is interpreted as a
9673 regular expression. In org-mode files, this will create an `org-occur'
9674 sparse tree. In ordinary files, `occur' will be used to list matches.
9675 If the current buffer is in `dired-mode', grep will be used to search
9676 in all files. If AVOID-POS is given, ignore matches near that position."
9677 (let ((case-fold-search t)
9681 org-emphasis-alist)
9683 (pos (point))
9684 (pre nil) (post nil)
9685 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9686 (cond
9687 ;; First check if there are any special search functions
9688 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9689 ;; Now try the builtin stuff
9690 ((and (equal (string-to-char s0) ?#)
9691 (> (length s0) 1)
9692 (save-excursion
9693 (goto-char (point-min))
9694 (and
9695 (re-search-forward
9697 (setq type 'dedicated
9698 pos (match-beginning 0))))
9699 ;; There is an exact target for this
9700 (goto-char pos)
9701 (org-back-to-heading t)))
9702 ((save-excursion
9703 (goto-char (point-min))
9704 (and
9705 (re-search-forward
9706 (concat "<<" (regexp-quote s0) ">>") nil t)
9707 (setq type 'dedicated
9708 pos (match-beginning 0))))
9709 ;; There is an exact target for this
9710 (goto-char pos))
9712 (save-excursion
9713 (goto-char (point-min))
9714 (and
9715 (re-search-forward
9716 (concat "[^[]" (regexp-quote
9717 (format org-coderef-label-format
9718 (match-string 1 s0))))
9719 nil t)
9720 (setq type 'dedicated
9721 pos (1+ (match-beginning 0))))))
9722 ;; There is a coderef target for this
9723 (goto-char pos))
9725 ;; A regular expression
9726 (cond
9727 ((org-mode-p)
9728 (org-occur (match-string 1 s)))
9729 ;;((eq major-mode 'dired-mode)
9730 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9731 (t (org-do-occur (match-string 1 s)))))
9732 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9733 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9734 (goto-char (point-min))
9735 (cond
9736 ((let (case-fold-search)
9737 (re-search-forward (format org-complex-heading-regexp-format
9738 (regexp-quote s))
9739 nil t))
9740 ;; OK, found a match
9741 (setq type 'dedicated)
9742 (goto-char (match-beginning 0)))
9743 ((and (not org-link-search-inhibit-query)
9744 (eq org-link-search-must-match-exact-headline 'query-to-create)
9745 (y-or-n-p "No match - create this as a new heading? "))
9746 (goto-char (point-max))
9747 (or (bolp) (newline))
9749 (beginning-of-line 0))
9750 (t
9751 (goto-char pos)
9752 (error "No match"))))
9753 (t
9754 ;; A normal search string
9755 (when (equal (string-to-char s) ?*)
9756 ;; Anchor on headlines, post may include tags.
9759 s (substring s 1)))
9760 (remove-text-properties
9761 0 (length s)
9762 '(face nil mouse-face nil keymap nil fontified nil) s)
9763 ;; Make a series of regular expressions to find a match
9772 re4 (concat "[^a-zA-Z_]" re4_)
9774 re1 (concat pre re2 post)
9775 re3 (concat pre (if pre re4_ re4) post)
9776 re5 (concat pre ".*" re4)
9777 re2 (concat pre re2)
9778 re2a (concat pre (if pre re2a_ re2a))
9779 re4 (concat pre (if pre re4_ re4))
9783 ))
9784 (cond
9785 ((eq type 'org-occur) (org-occur reall))
9786 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9787 (t (goto-char (point-min))
9788 (setq type 'fuzzy)
9789 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9790 (org-search-not-self 1 re1 nil t)
9791 (org-search-not-self 1 re2 nil t)
9792 (org-search-not-self 1 re2a nil t)
9793 (org-search-not-self 1 re3 nil t)
9794 (org-search-not-self 1 re4 nil t)
9795 (org-search-not-self 1 re5 nil t)
9796 )
9797 (goto-char (match-beginning 1))
9798 (goto-char pos)
9799 (error "No match"))))))
9800 (and (org-mode-p) (org-show-context 'link-search))
9801 type))
9803 (defun org-search-not-self (group &rest args)
9804 "Execute `re-search-forward', but only accept matches that do not
9805 enclose the position of `org-open-link-marker'."
9806 (let ((m org-open-link-marker))
9807 (catch 'exit
9808 (while (apply 're-search-forward args)
9809 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9810 (goto-char (match-end group))
9811 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9812 (> (match-beginning 0) (marker-position m))
9813 (< (match-end 0) (marker-position m)))
9814 (save-match-data
9815 (or (not (org-in-regexp
9816 org-bracket-link-analytic-regexp 1))
9817 (not (match-end 4)) ; no description
9818 (and (<= (match-beginning 4) (point))
9819 (>= (match-end 4) (point))))))
9820 (throw 'exit (point))))))))
9822 (defun org-get-buffer-for-internal-link (buffer)
9823 "Return a buffer to be used for displaying the link target of internal links."
9824 (cond
9825 ((not org-display-internal-link-with-indirect-buffer)
9826 buffer)
9827 ((string-match "(Clone)$" (buffer-name buffer))
9828 (message "Buffer is already a clone, not making another one")
9829 ;; we also do not modify visibility in this case
9830 buffer)
9831 (t ; make a new indirect buffer for displaying the link
9832 (let* ((bn (buffer-name buffer))
9833 (ibn (concat bn "(Clone)"))
9834 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9835 (with-current-buffer ib (org-overview))
9836 ib))))
9838 (defun org-do-occur (regexp &optional cleanup)
9839 "Call the Emacs command `occur'.
9840 If CLEANUP is non-nil, remove the printout of the regular expression
9841 in the *Occur* buffer. This is useful if the regex is long and not useful
9842 to read."
9843 (occur regexp)
9844 (when cleanup
9845 (let ((cwin (selected-window)) win beg end)
9846 (when (setq win (get-buffer-window "*Occur*"))
9847 (select-window win))
9848 (goto-char (point-min))
9849 (when (re-search-forward "match[a-z]+" nil t)
9850 (setq beg (match-end 0))
9852 (setq end (1- (match-beginning 0)))))
9853 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9854 (goto-char (point-min))
9855 (select-window cwin))))
9857 ;;; The mark ring for links jumps
9859 (defvar org-mark-ring nil
9860 "Mark ring for positions before jumps in Org-mode.")
9861 (defvar org-mark-ring-last-goto nil
9862 "Last position in the mark ring used to go back.")
9863 ;; Fill and close the ring
9864 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9865 (loop for i from 1 to org-mark-ring-length do
9866 (push (make-marker) org-mark-ring))
9867 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9868 org-mark-ring)
9870 (defun org-mark-ring-push (&optional pos buffer)
9871 "Put the current position or POS into the mark ring and rotate it."
9872 (interactive)
9873 (setq pos (or pos (point)))
9874 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9875 (move-marker (car org-mark-ring)
9876 (or pos (point))
9877 (or buffer (current-buffer)))
9878 (message "%s"
9879 (substitute-command-keys
9882 (defun org-mark-ring-goto (&optional n)
9883 "Jump to the previous position in the mark ring.
9884 With prefix arg N, jump back that many stored positions. When
9885 called several times in succession, walk through the entire ring.
9886 Org-mode commands jumping to a different position in the current file,
9887 or to another Org-mode file, automatically push the old position
9888 onto the ring."
9889 (interactive "p")
9890 (let (p m)
9891 (if (eq last-command this-command)
9892 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9893 (setq p org-mark-ring))
9894 (setq org-mark-ring-last-goto p)
9895 (setq m (car p))
9896 (org-pop-to-buffer-same-window (marker-buffer m))
9897 (goto-char m)
9898 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9900 (defun org-remove-angle-brackets (s)
9901 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9902 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9903 s)
9904 (defun org-add-angle-brackets (s)
9905 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9906 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9907 s)
9908 (defun org-remove-double-quotes (s)
9911 s)
9913 ;;; Following specific links
9915 (defun org-follow-timestamp-link ()
9916 (cond
9917 ((org-at-date-range-p t)
9918 (let ((org-agenda-start-on-weekday)
9919 (t1 (match-string 1))
9920 (t2 (match-string 2)))
9921 (setq t1 (time-to-days (org-time-string-to-time t1))
9922 t2 (time-to-days (org-time-string-to-time t2)))
9923 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9924 ((org-at-timestamp-p t)
9925 (org-agenda-list nil (time-to-days (org-time-string-to-time
9926 (substring (match-string 1) 0 10)))
9927 1))
9928 (t (error "This should not happen"))))
9931 ;;; Following file links
9932 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9933 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9934 (declare-function mailcap-mime-info
9935 "mailcap" (string &optional request no-decode))
9936 (defvar org-wait nil)
9937 (defun org-open-file (path &optional in-emacs line search)
9938 "Open the file at PATH.
9939 First, this expands any special file name abbreviations. Then the
9940 configuration variable `org-file-apps' is checked if it contains an
9941 entry for this file type, and if yes, the corresponding command is launched.
9943 If no application is found, Emacs simply visits the file.
9945 With optional prefix argument IN-EMACS, Emacs will visit the file.
9947 prefix arg, Org tries to avoid opening in Emacs
9948 and to use an external application to visit the file.
9950 Optional LINE specifies a line to go to, optional SEARCH a string
9951 to search for. If LINE or SEARCH is given, the file will be
9952 opened in Emacs, unless an entry from org-file-apps that makes
9953 use of groups in a regexp matches.
9955 If you want to change the way frames are used when following a
9956 link, please customize `org-link-frame-setup'.
9958 If the file does not exist, an error is thrown."
9959 (let* ((file (if (equal path "")
9960 buffer-file-name
9961 (substitute-in-file-name (expand-file-name path))))
9962 (file-apps (append org-file-apps (org-default-apps)))
9963 (apps (org-remove-if
9964 'org-file-apps-entry-match-against-dlink-p file-apps))
9965 (apps-dlink (org-remove-if-not
9966 'org-file-apps-entry-match-against-dlink-p file-apps))
9967 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9968 (dirp (if remp nil (file-directory-p file)))
9969 (file (if (and dirp org-open-directory-means-index-dot-org)
9970 (concat (file-name-as-directory file) "index.org")
9971 file))
9972 (a-m-a-p (assq 'auto-mode apps))
9973 (dfile (downcase file))
9974 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9975 (link (cond ((and (eq line nil)
9976 (eq search nil))
9977 file)
9978 (line
9979 (concat file "::" (number-to-string line)))
9980 (search
9981 (concat file "::" search))))
9982 (dlink (downcase link))
9983 (old-buffer (current-buffer))
9984 (old-pos (point))
9985 (old-mode major-mode)
9986 ext cmd link-match-data)
9988 (setq ext (match-string 1 dfile))
9990 (setq ext (match-string 1 dfile))))
9991 (cond
9992 ((member in-emacs '((16) system))
9993 (setq cmd (cdr (assoc 'system apps))))
9994 (in-emacs (setq cmd 'emacs))
9995 (t
9996 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9997 (and dirp (cdr (assoc 'directory apps)))
9998 ; first, try matching against apps-dlink
9999 ; if we get a match here, store the match data for later
10000 (let ((match (assoc-default dlink apps-dlink
10001 'string-match)))
10002 (if match
10003 (progn (setq link-match-data (match-data))
10004 match)
10005 (progn (setq in-emacs (or in-emacs line search))
10006 nil))) ; if we have no match in apps-dlink,
10007 ; always open the file in emacs if line or search
10008 ; is given (for backwards compatibility)
10009 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10010 'string-match)
10011 (cdr (assoc ext apps))
10012 (cdr (assoc t apps))))))
10013 (when (eq cmd 'system)
10014 (setq cmd (cdr (assoc 'system apps))))
10015 (when (eq cmd 'default)
10016 (setq cmd (cdr (assoc t apps))))
10017 (when (eq cmd 'mailcap)
10018 (require 'mailcap)
10019 (mailcap-parse-mailcaps)
10020 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10021 (command (mailcap-mime-info mime-type)))
10022 (if (stringp command)
10023 (setq cmd command)
10024 (setq cmd 'emacs))))
10025 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10026 (not (file-exists-p file))
10027 (not org-open-non-existing-files))
10028 (error "No such file: %s" file))
10029 (cond
10031 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10033 (setq cmd (replace-match "%s" t t cmd)))
10034 (while (string-match "%s" cmd)
10035 (setq cmd (replace-match
10036 (save-match-data
10037 (shell-quote-argument
10038 (convert-standard-filename file)))
10039 t t cmd)))
10041 ;; Replace "%1", "%2" etc. in command with group matches from regex
10042 (save-match-data
10043 (let ((match-index 1)
10044 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10045 (set-match-data link-match-data)
10046 (while (<= match-index number-of-groups)
10047 (let ((regex (concat "%" (number-to-string match-index)))
10048 (replace-with (match-string match-index dlink)))
10049 (while (string-match regex cmd)
10050 (setq cmd (replace-match replace-with t t cmd))))
10051 (setq match-index (+ match-index 1)))))
10053 (save-window-excursion
10054 (start-process-shell-command cmd nil cmd)
10055 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10056 ))
10057 ((or (stringp cmd)
10058 (eq cmd 'emacs))
10059 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10060 (widen)
10061 (if line (org-goto-line line)
10062 (if search (org-link-search search))))
10063 ((consp cmd)
10064 (let ((file (convert-standard-filename file)))
10065 (save-match-data
10066 (set-match-data link-match-data)
10067 (eval cmd))))
10068 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10069 (and (org-mode-p) (eq old-mode 'org-mode)
10070 (or (not (equal old-buffer (current-buffer)))
10071 (not (equal old-pos (point))))
10072 (org-mark-ring-push old-pos old-buffer))))
10074 (defun org-file-apps-entry-match-against-dlink-p (entry)
10075 "This function returns non-nil if `entry' uses a regular
10076 expression which should be matched against the whole link by
10077 org-open-file.
10079 It assumes that is the case when the entry uses a regular
10080 expression which has at least one grouping construct and the
10081 action is either a lisp form or a command string containing
10082 '%1', i.e. using at least one subexpression match as a
10083 parameter."
10084 (let ((selector (car entry))
10085 (action (cdr entry)))
10086 (if (stringp selector)
10087 (and (> (regexp-opt-depth selector) 0)
10088 (or (and (stringp action)
10089 (string-match "%[0-9]" action))
10090 (consp action)))
10091 nil)))
10093 (defun org-default-apps ()
10094 "Return the default applications for this operating system."
10095 (cond
10096 ((eq system-type 'darwin)
10097 org-file-apps-defaults-macosx)
10098 ((eq system-type 'windows-nt)
10099 org-file-apps-defaults-windowsnt)
10100 (t org-file-apps-defaults-gnu)))
10102 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10103 "Convert extensions to regular expressions in the cars of LIST.
10104 Also, weed out any non-string entries, because the return value is used
10105 only for regexp matching.
10106 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10107 point to the symbol `emacs', indicating that the file should
10108 be opened in Emacs."
10109 (append
10110 (delq nil
10111 (mapcar (lambda (x)
10112 (if (not (stringp (car x)))
10113 nil
10115 x
10117 list))
10118 (if add-auto-mode
10119 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10121 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10122 (defun org-file-remote-p (file)
10123 "Test whether FILE specifies a location on a remote system.
10124 Return non-nil if the location is indeed remote.
10128 (cond ((fboundp 'file-remote-p)
10129 (file-remote-p file))
10130 ((fboundp 'tramp-handle-file-remote-p)
10131 (tramp-handle-file-remote-p file))
10132 ((and (boundp 'ange-ftp-name-format)
10133 (string-match (car ange-ftp-name-format) file))
10134 t)
10135 (t nil)))
10138 ;;;; Refiling
10140 (defun org-get-org-file ()
10141 "Read a filename, with default directory `org-directory'."
10142 (let ((default (or org-default-notes-file remember-data-file)))
10143 (read-file-name (format "File name [%s]: " default)
10144 (file-name-as-directory org-directory)
10145 default)))
10147 (defun org-notes-order-reversed-p ()
10148 "Check if the current file should receive notes in reversed order."
10149 (cond
10150 ((not org-reverse-note-order) nil)
10151 ((eq t org-reverse-note-order) t)
10152 ((not (listp org-reverse-note-order)) nil)
10153 (t (catch 'exit
10154 (let ((all org-reverse-note-order)
10155 entry)
10156 (while (setq entry (pop all))
10157 (if (string-match (car entry) buffer-file-name)
10158 (throw 'exit (cdr entry))))
10159 nil)))))
10161 (defvar org-refile-target-table nil
10162 "The list of refile targets, created by `org-refile'.")
10164 (defvar org-agenda-new-buffers nil
10165 "Buffers created to visit agenda files.")
10167 (defvar org-refile-cache nil
10168 "Cache for refile targets.")
10170 (defvar org-refile-markers nil
10171 "All the markers used for caching refile locations.")
10173 (defun org-refile-marker (pos)
10174 "Get a new refile marker, but only if caching is in use."
10175 (if (not org-refile-use-cache)
10176 pos
10177 (let ((m (make-marker)))
10178 (move-marker m pos)
10179 (push m org-refile-markers)
10180 m)))
10182 (defun org-refile-cache-clear ()
10183 "Clear the refile cache and disable all the markers."
10184 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10185 (setq org-refile-markers nil)
10186 (setq org-refile-cache nil)
10187 (message "Refile cache has been cleared"))
10189 (defun org-refile-cache-check-set (set)
10190 "Check if all the markers in the cache still have live buffers."
10191 (let (marker)
10192 (catch 'exit
10193 (while (and set (setq marker (nth 3 (pop set))))
10194 ;; if org-refile-use-outline-path is 'file, marker may be nil
10195 (when (and marker (null (marker-buffer marker)))
10196 (message "not found") (sit-for 3)
10197 (throw 'exit nil)))
10198 t)))
10200 (defun org-refile-cache-put (set &rest identifiers)
10201 "Push the refile targets SET into the cache, under IDENTIFIERS."
10202 (let* ((key (sha1 (prin1-to-string identifiers)))
10203 (entry (assoc key org-refile-cache)))
10204 (if entry
10205 (setcdr entry set)
10206 (push (cons key set) org-refile-cache))))
10208 (defun org-refile-cache-get (&rest identifiers)
10209 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10210 (cond
10211 ((not org-refile-cache) nil)
10212 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10213 (t
10214 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10215 org-refile-cache))))
10216 (and set (org-refile-cache-check-set set) set)))))
10218 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10219 "Produce a table with refile targets."
10220 (let ((case-fold-search nil)
10221 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10222 (entries (or org-refile-targets '((nil . (:level . 1)))))
10223 targets tgs txt re files f desc descre fast-path-p level pos0)
10224 (message "Getting targets...")
10225 (with-current-buffer (or default-buffer (current-buffer))
10226 (while (setq entry (pop entries))
10227 (setq files (car entry) desc (cdr entry))
10228 (setq fast-path-p nil)
10229 (cond
10230 ((null files) (setq files (list (current-buffer))))
10231 ((eq files 'org-agenda-files)
10232 (setq files (org-agenda-files 'unrestricted)))
10233 ((and (symbolp files) (fboundp files))
10234 (setq files (funcall files)))
10235 ((and (symbolp files) (boundp files))
10236 (setq files (symbol-value files))))
10237 (if (stringp files) (setq files (list files)))
10238 (cond
10239 ((eq (car desc) :tag)
10241 ((eq (car desc) :todo)
10243 ((eq (car desc) :regexp)
10244 (setq descre (cdr desc)))
10245 ((eq (car desc) :level)
10247 (if org-odd-levels-only
10248 (1- (* 2 (cdr desc)))
10249 (cdr desc)))
10251 ((eq (car desc) :maxlevel)
10252 (setq fast-path-p t)
10254 (if org-odd-levels-only
10255 (1- (* 2 (cdr desc)))
10256 (cdr desc)))
10258 (t (error "Bad refiling target description %s" desc)))
10259 (while (setq f (pop files))
10260 (with-current-buffer
10261 (if (bufferp f) f (org-get-agenda-file-buffer f))
10262 (or
10263 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10264 (progn
10265 (if (bufferp f) (setq f (buffer-file-name
10266 (buffer-base-buffer f))))
10267 (setq f (and f (expand-file-name f)))
10268 (if (eq org-refile-use-outline-path 'file)
10269 (push (list (file-name-nondirectory f) f nil nil) tgs))
10270 (save-excursion
10271 (save-restriction
10272 (widen)
10273 (goto-char (point-min))
10274 (while (re-search-forward descre nil t)
10275 (goto-char (setq pos0 (point-at-bol)))
10276 (catch 'next
10277 (when org-refile-target-verify-function
10278 (save-match-data
10279 (or (funcall org-refile-target-verify-function)
10280 (throw 'next t))))
10281 (when (and (looking-at org-complex-heading-regexp)
10282 (not (member (match-string 4) excluded-entries)))
10283 (setq level (org-reduced-level
10284 (- (match-end 1) (match-beginning 1)))
10285 txt (org-link-display-format (match-string 4))
10287 re (format org-complex-heading-regexp-format
10288 (regexp-quote (match-string 4))))
10289 (when org-refile-use-outline-path
10290 (setq txt (mapconcat
10291 'org-protect-slash
10292 (append
10293 (if (eq org-refile-use-outline-path
10294 'file)
10295 (list (file-name-nondirectory
10296 (buffer-file-name
10297 (buffer-base-buffer))))
10298 (if (eq org-refile-use-outline-path
10299 'full-file-path)
10300 (list (buffer-file-name
10301 (buffer-base-buffer)))))
10302 (org-get-outline-path fast-path-p
10303 level txt)
10304 (list txt))
10305 "/")))
10306 (push (list txt f re (org-refile-marker (point)))
10307 tgs)))
10308 (when (= (point) pos0)
10309 ;; verification function has not moved point
10310 (goto-char (point-at-eol))))))))
10311 (when org-refile-use-cache
10312 (org-refile-cache-put tgs (buffer-file-name) descre))
10313 (setq targets (append tgs targets))
10314 ))))
10315 (message "Getting targets...done")
10316 (nreverse targets)))
10318 (defun org-protect-slash (s)
10319 (while (string-match "/" s)
10321 s)
10323 (defvar org-olpa (make-vector 20 nil))
10325 (defun org-get-outline-path (&optional fastp level heading)
10326 "Return the outline path to the current entry, as a list.
10328 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10329 routine which makes outline path derivations for an entire file,
10330 avoiding backtracing. Refile target collection makes use of that."
10331 (if fastp
10332 (progn
10333 (if (> level 19)
10334 (error "Outline path failure, more than 19 levels"))
10335 (loop for i from level upto 19 do
10336 (aset org-olpa i nil))
10337 (prog1
10338 (delq nil (append org-olpa nil))
10339 (aset org-olpa level heading)))
10340 (let (rtn case-fold-search)
10341 (save-excursion
10342 (save-restriction
10343 (widen)
10344 (while (org-up-heading-safe)
10345 (when (looking-at org-complex-heading-regexp)
10346 (push (org-match-string-no-properties 4) rtn)))
10347 rtn)))))
10349 (defun org-format-outline-path (path &optional width prefix)
10350 "Format the outline path PATH for display.
10351 Width is the maximum number of characters that is available.
10352 Prefix is a prefix to be included in the returned string,
10353 such as the file name."
10354 (setq width (or width 79))
10355 (if prefix (setq width (- width (length prefix))))
10356 (if (not path)
10357 (or prefix "")
10358 (let* ((nsteps (length path))
10359 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10360 (maxwidth (if (<= total-width width)
10361 10000 ;; everything fits
10362 ;; we need to shorten the level headings
10363 (/ (- width nsteps) nsteps)))
10364 (org-odd-levels-only nil)
10365 (n 0)
10366 (total (1+ (length prefix))))
10367 (setq maxwidth (max maxwidth 10))
10368 (concat prefix
10369 (mapconcat
10370 (lambda (h)
10371 (setq n (1+ n))
10372 (if (and (= n nsteps) (< maxwidth 10000))
10373 (setq maxwidth (- total-width total)))
10374 (if (< (length h) maxwidth)
10375 (progn (setq total (+ total (length h) 1)) h)
10376 (setq h (substring h 0 (- maxwidth 2))
10377 total (+ total maxwidth 1))
10379 (setq h (substring h 0 (match-beginning 0))))
10380 (setq h (concat h "..")))
10381 (org-add-props h nil 'face
10382 (nth (% (1- n) org-n-level-faces)
10383 org-level-faces))
10384 h)
10385 path "/")))))
10387 (defun org-display-outline-path (&optional file current)
10388 "Display the current outline path in the echo area."
10389 (interactive "P")
10390 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10391 (case-fold-search nil)
10392 (path (and (org-mode-p) (org-get-outline-path))))
10393 (if current (setq path (append path
10394 (save-excursion
10395 (org-back-to-heading t)
10396 (if (looking-at org-complex-heading-regexp)
10397 (list (match-string 4)))))))
10398 (message "%s"
10399 (org-format-outline-path
10400 path
10401 (1- (frame-width))
10402 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10404 (defvar org-refile-history nil
10405 "History for refiling operations.")
10407 (defvar org-after-refile-insert-hook nil
10408 "Hook run after `org-refile' has inserted its stuff at the new location.
10409 Note that this is still *before* the stuff will be removed from
10410 the *old* location.")
10412 (defvar org-capture-last-stored-marker)
10413 (defun org-refile (&optional goto default-buffer rfloc)
10414 "Move the entry or entries at point to another heading.
10415 The list of target headings is compiled using the information in
10416 `org-refile-targets', which see.
10418 At the target location, the entry is filed as a subitem of the target
10419 heading. Depending on `org-reverse-note-order', the new subitem will
10420 either be the first or the last subitem.
10422 If there is an active region, all entries in that region will be moved.
10423 However, the region must fulfill the requirement that the first heading
10424 is the first one sets the top-level of the moved text - at most siblings
10425 below it are allowed.
10427 With prefix arg GOTO, the command will only visit the target location
10428 and not actually move anything.
10431 go to the location where the last refiling operation has put the subtree.
10432 With a prefix argument of `2', refile to the running clock.
10434 RFLOC can be a refile location obtained in a different way.
10436 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10438 If you are using target caching (see `org-refile-use-cache'),
10439 You have to clear the target cache in order to find new targets.
10440 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10441 prefix argument (`C-u C-u C-u C-c C-w')."
10443 (interactive "P")
10444 (if (member goto '(0 (64)))
10445 (org-refile-cache-clear)
10446 (let* ((cbuf (current-buffer))
10447 (regionp (org-region-active-p))
10448 (region-start (and regionp (region-beginning)))
10449 (region-end (and regionp (region-end)))
10450 (region-length (and regionp (- region-end region-start)))
10451 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10452 pos it nbuf file re level reversed)
10453 (setq last-command nil)
10454 (when regionp
10455 (goto-char region-start)
10456 (or (bolp) (goto-char (point-at-bol)))
10457 (setq region-start (point))
10458 (unless (or (org-kill-is-subtree-p
10459 (buffer-substring region-start region-end))
10460 (prog1 org-refile-active-region-within-subtree
10461 (org-toggle-heading)))
10462 (error "The region is not a (sequence of) subtree(s)")))
10463 (if (equal goto '(16))
10464 (org-refile-goto-last-stored)
10465 (when (or
10466 (and (equal goto 2)
10467 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10468 (prog1
10469 (setq it (list (or org-clock-heading "running clock")
10470 (buffer-file-name
10471 (marker-buffer org-clock-hd-marker))
10472 ""
10473 (marker-position org-clock-hd-marker)))
10474 (setq goto nil)))
10475 (setq it (or rfloc
10476 (save-excursion
10477 (org-back-to-heading t)
10478 (org-refile-get-location
10479 (cond (goto "Goto")
10480 (regionp "Refile region to")
10481 (t "Refile subtree to")) default-buffer
10482 org-refile-allow-creating-parent-nodes)))))
10483 (setq file (nth 1 it)
10484 re (nth 2 it)
10485 pos (nth 3 it))
10486 (if (and (not goto)
10487 pos
10488 (equal (buffer-file-name) file)
10489 (if regionp
10490 (and (>= pos region-start)
10491 (<= pos region-end))
10492 (and (>= pos (point))
10493 (< pos (save-excursion
10494 (org-end-of-subtree t t))))))
10495 (error "Cannot refile to position inside the tree or region"))
10497 (setq nbuf (or (find-buffer-visiting file)
10498 (find-file-noselect file)))
10499 (if goto
10500 (progn
10501 (org-pop-to-buffer-same-window nbuf)
10502 (goto-char pos)
10503 (org-show-context 'org-goto))
10504 (if regionp
10505 (progn
10506 (org-kill-new (buffer-substring region-start region-end))
10507 (org-save-markers-in-region region-start region-end))
10508 (org-copy-subtree 1 nil t))
10509 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10510 (find-file-noselect file)))
10511 (setq reversed (org-notes-order-reversed-p))
10512 (save-excursion
10513 (save-restriction
10514 (widen)
10515 (if pos
10516 (progn
10517 (goto-char pos)
10518 (looking-at org-outline-regexp)
10519 (setq level (org-get-valid-level (funcall outline-level) 1))
10520 (goto-char
10521 (if reversed
10522 (or (outline-next-heading) (point-max))
10523 (or (save-excursion (org-get-next-sibling))
10524 (org-end-of-subtree t t)
10525 (point-max)))))
10526 (setq level 1)
10527 (if (not reversed)
10528 (goto-char (point-max))
10529 (goto-char (point-min))
10530 (or (outline-next-heading) (goto-char (point-max)))))
10531 (if (not (bolp)) (newline))
10532 (org-paste-subtree level)
10533 (when org-log-refile
10534 (org-add-log-setup 'refile nil nil 'findpos
10535 org-log-refile)
10536 (unless (eq org-log-refile 'note)
10537 (save-excursion (org-add-log-note))))
10538 (and org-auto-align-tags (org-set-tags nil t))
10539 (bookmark-set "org-refile-last-stored")
10540 ;; If we are refiling for capture, make sure that the
10541 ;; last-capture pointers point here
10542 (when (org-bound-and-true-p org-refile-for-capture)
10543 (bookmark-set "org-capture-last-stored-marker")
10544 (move-marker org-capture-last-stored-marker (point)))
10545 (if (fboundp 'deactivate-mark) (deactivate-mark))
10546 (run-hooks 'org-after-refile-insert-hook))))
10547 (if regionp
10548 (delete-region (point) (+ (point) region-length))
10549 (org-cut-subtree))
10550 (when (featurep 'org-inlinetask)
10551 (org-inlinetask-remove-END-maybe))
10552 (setq org-markers-to-move nil)
10555 (defun org-refile-goto-last-stored ()
10556 "Go to the location where the last refile was stored."
10557 (interactive)
10558 (bookmark-jump "org-refile-last-stored")
10559 (message "This is the location of the last refile"))
10561 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10562 "Prompt the user for a refile location, using PROMPT.
10563 PROMPT should not be suffixed with a colon and a space, because
10564 this function appends the default value from
10565 `org-refile-history' automatically, if that is not empty."
10566 (let ((org-refile-targets org-refile-targets)
10567 (org-refile-use-outline-path org-refile-use-outline-path)
10568 excluded-entries)
10569 (when (and (eq major-mode 'org-mode)
10570 (not org-refile-use-cache))
10571 (org-map-tree
10572 (lambda()
10573 (setq excluded-entries
10574 (append excluded-entries (list (org-get-heading t t)))))))
10575 (setq org-refile-target-table
10576 (org-refile-get-targets default-buffer excluded-entries)))
10577 (unless org-refile-target-table
10578 (error "No refile targets"))
10579 (let* ((prompt (concat prompt
10580 (and (car org-refile-history)
10581 (concat " (default " (car org-refile-history) ")"))
10582 ": "))
10583 (cbuf (current-buffer))
10584 (partial-completion-mode nil)
10585 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10586 (cfunc (if (and org-refile-use-outline-path
10587 org-outline-path-complete-in-steps)
10588 'org-olpath-completing-read
10589 'org-icompleting-read))
10590 (extra (if org-refile-use-outline-path "/" ""))
10591 (filename (and cfn (expand-file-name cfn)))
10592 (tbl (mapcar
10593 (lambda (x)
10594 (if (and (not (member org-refile-use-outline-path
10595 '(file full-file-path)))
10596 (not (equal filename (nth 1 x))))
10597 (cons (concat (car x) extra " ("
10598 (file-name-nondirectory (nth 1 x)) ")")
10599 (cdr x))
10600 (cons (concat (car x) extra) (cdr x))))
10601 org-refile-target-table))
10602 (completion-ignore-case t)
10603 pa answ parent-target child parent old-hist)
10604 (setq old-hist org-refile-history)
10605 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10606 nil 'org-refile-history (car org-refile-history)))
10607 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10608 (org-refile-check-position pa)
10609 (if pa
10610 (progn
10611 (when (or (not org-refile-history)
10612 (not (eq old-hist org-refile-history))
10613 (not (equal (car pa) (car org-refile-history))))
10614 (setq org-refile-history
10615 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10616 org-refile-history
10617 (cdr org-refile-history))))
10618 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10619 (pop org-refile-history)))
10620 pa)
10622 (progn
10623 (setq parent (match-string 1 answ)
10624 child (match-string 2 answ))
10625 (setq parent-target (or (assoc parent tbl)
10626 (assoc (concat parent "/") tbl)))
10627 (when (and parent-target
10628 (or (eq new-nodes t)
10629 (and (eq new-nodes 'confirm)
10631 child)))))
10632 (org-refile-new-child parent-target child)))
10633 (error "Invalid target location")))))
10635 (defun org-refile-check-position (refile-pointer)
10636 "Check if the refile pointer matches the readline to which it points."
10637 (let* ((file (nth 1 refile-pointer))
10638 (re (nth 2 refile-pointer))
10639 (pos (nth 3 refile-pointer))
10640 buffer)
10641 (when (org-string-nw-p re)
10642 (setq buffer (if (markerp pos)
10643 (marker-buffer pos)
10644 (or (find-buffer-visiting file)
10645 (find-file-noselect file))))
10646 (with-current-buffer buffer
10647 (save-excursion
10648 (save-restriction
10649 (widen)
10650 (goto-char pos)
10651 (beginning-of-line 1)
10652 (unless (org-looking-at-p re)
10653 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10655 (defun org-refile-new-child (parent-target child)
10656 "Use refile target PARENT-TARGET to add new CHILD below it."
10657 (unless parent-target
10658 (error "Cannot find parent for new node"))
10659 (let ((file (nth 1 parent-target))
10660 (pos (nth 3 parent-target))
10661 level)
10662 (with-current-buffer (or (find-buffer-visiting file)
10663 (find-file-noselect file))
10664 (save-excursion
10665 (save-restriction
10666 (widen)
10667 (if pos
10668 (goto-char pos)
10669 (goto-char (point-max))
10670 (if (not (bolp)) (newline)))
10671 (when (looking-at org-outline-regexp)
10672 (setq level (funcall outline-level))
10673 (org-end-of-subtree t t))
10674 (org-back-over-empty-lines)
10676 (if pos (org-get-valid-level level 1) 1) ?*)
10678 (beginning-of-line 0)
10679 (list (concat (car parent-target) "/" child) file "" (point)))))))
10681 (defun org-olpath-completing-read (prompt collection &rest args)
10682 "Read an outline path like a file name."
10683 (let ((thetable collection)
10684 (org-completion-use-ido nil) ; does not work with ido.
10685 (org-completion-use-iswitchb nil)) ; or iswitchb
10686 (apply
10687 'org-icompleting-read prompt
10688 (lambda (string predicate &optional flag)
10689 (let (rtn r f (l (length string)))
10690 (cond
10691 ((eq flag nil)
10692 ;; try completion
10693 (try-completion string thetable))
10694 ((eq flag t)
10695 ;; all-completions
10696 (setq rtn (all-completions string thetable predicate))
10697 (mapcar
10698 (lambda (x)
10699 (setq r (substring x l))
10700 (if (string-match " ([^)]*)$" x)
10701 (setq f (match-string 0 x))
10702 (setq f ""))
10703 (if (string-match "/" r)
10704 (concat string (substring r 0 (match-end 0)) f)
10705 x))
10706 rtn))
10707 ((eq flag 'lambda)
10708 ;; exact match?
10709 (assoc string thetable)))
10710 ))
10711 args)))
10713 ;;;; Dynamic blocks
10715 (defun org-find-dblock (name)
10716 "Find the first dynamic block with name NAME in the buffer.
10717 If not found, stay at current position and return nil."
10718 (let (pos)
10719 (save-excursion
10720 (goto-char (point-min))
10722 nil t)
10723 (match-beginning 0))))
10724 (if pos (goto-char pos))
10725 pos))
10727 (defconst org-dblock-start-re
10729 "Matches the start line of a dynamic block, with parameters.")
10732 "Matches the end of a dynamic block.")
10734 (defun org-create-dblock (plist)
10735 "Create a dynamic block section, with parameters taken from PLIST.
10736 PLIST must contain a :name entry which is used as name of the block."
10738 (end-of-line 1)
10739 (newline))
10740 (let ((col (current-column))
10741 (name (plist-get plist :name)))
10742 (insert "#+BEGIN: " name)
10743 (while plist
10744 (if (eq (car plist) :name)
10745 (setq plist (cddr plist))
10746 (insert " " (prin1-to-string (pop plist)))))
10748 (beginning-of-line -2)))
10750 (defun org-prepare-dblock ()
10751 "Prepare dynamic block for refresh.
10752 This empties the block, puts the cursor at the insert position and returns
10753 the property list including an extra property :name with the block name."
10754 (unless (looking-at org-dblock-start-re)
10755 (error "Not at a dynamic block"))
10756 (let* ((begdel (1+ (match-end 0)))
10757 (name (org-no-properties (match-string 1)))
10758 (params (append (list :name name)
10759 (read (concat "(" (match-string 3) ")")))))
10760 (save-excursion
10761 (beginning-of-line 1)
10763 (setq params (plist-put params :indentation-column (current-column))))
10764 (unless (re-search-forward org-dblock-end-re nil t)
10765 (error "Dynamic block not terminated"))
10766 (setq params
10767 (append params
10768 (list :content (buffer-substring
10769 begdel (match-beginning 0)))))
10770 (delete-region begdel (match-beginning 0))
10771 (goto-char begdel)
10772 (open-line 1)
10773 params))
10775 (defun org-map-dblocks (&optional command)
10776 "Apply COMMAND to all dynamic blocks in the current buffer.
10777 If COMMAND is not given, use `org-update-dblock'."
10778 (let ((cmd (or command 'org-update-dblock)))
10779 (save-excursion
10780 (goto-char (point-min))
10781 (while (re-search-forward org-dblock-start-re nil t)
10782 (goto-char (match-beginning 0))
10783 (save-excursion
10784 (condition-case nil
10785 (funcall cmd)
10786 (error (message "Error during update of dynamic block"))))
10787 (unless (re-search-forward org-dblock-end-re nil t)
10788 (error "Dynamic block not terminated"))))))
10790 (defun org-dblock-update (&optional arg)
10791 "User command for updating dynamic blocks.
10792 Update the dynamic block at point. With prefix ARG, update all dynamic
10793 blocks in the buffer."
10794 (interactive "P")
10795 (if arg
10796 (org-update-all-dblocks)
10797 (or (looking-at org-dblock-start-re)
10798 (org-beginning-of-dblock))
10799 (org-update-dblock)))
10801 (defun org-update-dblock ()
10802 "Update the dynamic block at point.
10803 This means to empty the block, parse for parameters and then call
10804 the correct writing function."
10805 (interactive)
10806 (save-window-excursion
10807 (let* ((pos (point))
10808 (line (org-current-line))
10809 (params (org-prepare-dblock))
10810 (name (plist-get params :name))
10811 (indent (plist-get params :indentation-column))
10812 (cmd (intern (concat "org-dblock-write:" name))))
10813 (message "Updating dynamic block `%s' at line %d..." name line)
10814 (funcall cmd params)
10815 (message "Updating dynamic block `%s' at line %d...done" name line)
10816 (goto-char pos)
10817 (when (and indent (> indent 0))
10818 (setq indent (make-string indent ?\ ))
10819 (save-excursion
10820 (org-beginning-of-dblock)
10821 (forward-line 1)
10822 (while (not (looking-at org-dblock-end-re))
10823 (insert indent)
10824 (beginning-of-line 2))
10825 (when (looking-at org-dblock-end-re)
10827 (replace-match ""))
10828 (insert indent)))))))
10830 (defun org-beginning-of-dblock ()
10831 "Find the beginning of the dynamic block at point.
10832 Error if there is no such block at point."
10833 (let ((pos (point))
10834 beg)
10835 (end-of-line 1)
10836 (if (and (re-search-backward org-dblock-start-re nil t)
10837 (setq beg (match-beginning 0))
10838 (re-search-forward org-dblock-end-re nil t)
10839 (> (match-end 0) pos))
10840 (goto-char beg)
10841 (goto-char pos)
10842 (error "Not in a dynamic block"))))
10844 (defun org-update-all-dblocks ()
10845 "Update all dynamic blocks in the buffer.
10846 This function can be used in a hook."
10847 (interactive)
10848 (when (org-mode-p)
10849 (org-map-dblocks 'org-update-dblock)))
10852 ;;;; Completion
10854 (defconst org-additional-option-like-keywords
10855 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10856 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10857 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10858 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10859 "BEGIN:" "END:"
10860 "ORGTBL" "TBLFM:" "TBLNAME:"
10861 "BEGIN_EXAMPLE" "END_EXAMPLE"
10862 "BEGIN_QUOTE" "END_QUOTE"
10863 "BEGIN_VERSE" "END_VERSE"
10864 "BEGIN_CENTER" "END_CENTER"
10865 "BEGIN_SRC" "END_SRC"
10866 "BEGIN_RESULT" "END_RESULT"
10867 "SOURCE:" "SRCNAME:" "FUNCTION:"
10868 "RESULTS:" "DATA:"
10869 "HEADER:" "HEADERS:"
10870 "BABEL:"
10871 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10872 "CAPTION:" "LABEL:"
10873 "SETUPFILE:"
10874 "INCLUDE:"
10875 "BIND:"
10876 "MACRO:"))
10878 (defcustom org-structure-template-alist
10879 '(
10892 ("L" "#+latex: "
10896 ("H" "#+html: "
10899 ("A" "#+ascii: ")
10900 ("i" "#+index: ?"
10901 "#+index: ?")
10902 ("I" "#+include %file ?"
10904 )
10905 "Structure completion elements.
10906 This is a list of abbreviation keys and values. The value gets inserted
10907 if you type `<' followed by the key and then press the completion key,
10908 usually `M-TAB'. %file will be replaced by a file name after prompting
10909 for the file using completion. The cursor will be placed at the position
10910 of the `?` in the template.
10911 There are two templates for each key, the first uses the original Org syntax,
10912 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10913 the default when the /org-mtags.el/ module has been loaded. See also the
10914 variable `org-mtags-prefer-muse-templates'.
10915 This is an experimental feature, it is undecided if it is going to stay in."
10916 :group 'org-completion
10917 :type '(repeat
10918 (string :tag "Key")
10919 (string :tag "Template")
10920 (string :tag "Muse Template")))
10922 (defun org-try-structure-completion ()
10923 "Try to complete a structure template before point.
10925 expands them."
10926 (let ((l (buffer-substring (point-at-bol) (point)))
10927 a)
10930 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10931 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10932 (match-beginning 1)) a)
10933 t)))
10935 (defun org-complete-expand-structure-template (start cell)
10936 "Expand a structure template."
10937 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10938 (rpl (nth (if musep 2 1) cell))
10939 (ind ""))
10940 (delete-region start (point))
10942 (cond
10943 ((bolp))
10945 (setq ind (buffer-substring (point-at-bol) (point))))
10946 (t (newline))))
10947 (setq start (point))
10948 (if (string-match "%file" rpl)
10949 (setq rpl (replace-match
10950 (concat
10952 (save-match-data
10953 (abbreviate-file-name (read-file-name "Include file: ")))
10955 t t rpl)))
10958 (insert rpl)
10961 ;;;; TODO, DEADLINE, Comments
10963 (defun org-toggle-comment ()
10964 "Change the COMMENT state of an entry."
10965 (interactive)
10966 (save-excursion
10967 (org-back-to-heading)
10968 (let (case-fold-search)
10969 (if (looking-at (concat org-outline-regexp
10971 (replace-match "" t t nil 1)
10972 (if (looking-at org-outline-regexp)
10973 (progn
10974 (goto-char (match-end 0))
10975 (insert org-comment-string " ")))))))
10977 (defvar org-last-todo-state-is-todo nil
10978 "This is non-nil when the last TODO state change led to a TODO state.
10979 If the last change removed the TODO tag or switched to DONE, then
10980 this is nil.")
10982 (defvar org-setting-tags nil) ; dynamically skipped
10984 (defvar org-todo-setup-filter-hook nil
10985 "Hook for functions that pre-filter todo specs.
10986 Each function takes a todo spec and returns either nil or the spec
10987 transformed into canonical form." )
10989 (defvar org-todo-get-default-hook nil
10990 "Hook for functions that get a default item for todo.
10991 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10992 nil or a string to be used for the todo mark." )
10994 (defvar org-agenda-headline-snapshot-before-repeat)
10996 (defun org-current-effective-time ()
10997 "Return current time adjusted for `org-extend-today-until' variable"
10998 (let* ((ct (org-current-time))
10999 (dct (decode-time ct))
11000 (ct1
11001 (if (and org-use-effective-time
11002 (< (nth 2 dct) org-extend-today-until))
11003 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11004 ct)))
11005 ct1))
11007 (defun org-todo-yesterday (&optional arg)
11008 "Like `org-todo' but the time of change will be 23:59 of yesterday"
11009 (interactive "P")
11010 (let* ((hour (third (decode-time
11011 (org-current-time))))
11012 (org-extend-today-until (1+ hour)))
11013 (org-todo arg)))
11015 (defun org-todo (&optional arg)
11016 "Change the TODO state of an item.
11017 The state of an item is given by a keyword at the start of the heading,
11018 like
11019 *** TODO Write paper
11020 *** DONE Call mom
11022 The different keywords are specified in the variable `org-todo-keywords'.
11024 So for this example: when the item starts with TODO, it is changed to DONE.
11025 When it starts with DONE, the DONE is removed. And when neither TODO nor
11026 DONE are present, add TODO at the beginning of the heading.
11029 state.
11030 With numeric prefix arg, switch to that state.
11032 keywords (nextset).
11035 For calling through lisp, arg is also interpreted in the following way:
11036 'none -> empty state
11038 'done -> switch to DONE
11039 'nextset -> switch to the next set of keywords
11040 'previousset -> switch to the previous set of keywords
11042 really is a member of `org-todo-keywords'."
11043 (interactive "P")
11044 (if (equal arg '(16)) (setq arg 'nextset))
11045 (let ((org-blocker-hook org-blocker-hook)
11046 (case-fold-search nil))
11047 (when (equal arg '(64))
11048 (setq arg nil org-blocker-hook nil))
11049 (when (and org-blocker-hook
11050 (or org-inhibit-blocking
11051 (org-entry-get nil "NOBLOCKING")))
11052 (setq org-blocker-hook nil))
11053 (save-excursion
11054 (catch 'exit
11055 (org-back-to-heading t)
11056 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11058 (looking-at " *"))
11059 (let* ((match-data (match-data))
11060 (startpos (point-at-bol))
11061 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11062 (org-log-done org-log-done)
11063 (org-log-repeat org-log-repeat)
11064 (org-todo-log-states org-todo-log-states)
11065 (this (match-string 1))
11066 (hl-pos (match-beginning 0))
11067 (head (org-get-todo-sequence-head this))
11068 (ass (assoc head org-todo-kwd-alist))
11069 (interpret (nth 1 ass))
11070 (done-word (nth 3 ass))
11071 (final-done-word (nth 4 ass))
11072 (last-state (or this ""))
11073 (completion-ignore-case t)
11074 (member (member this org-todo-keywords-1))
11075 (tail (cdr member))
11076 (state (cond
11077 ((and org-todo-key-trigger
11078 (or (and (equal arg '(4))
11079 (eq org-use-fast-todo-selection 'prefix))
11080 (and (not arg) org-use-fast-todo-selection
11081 (not (eq org-use-fast-todo-selection
11082 'prefix)))))
11083 ;; Use fast selection
11084 (org-fast-todo-selection))
11085 ((and (equal arg '(4))
11086 (or (not org-use-fast-todo-selection)
11087 (not org-todo-key-trigger)))
11088 ;; Read a state with completion
11089 (org-icompleting-read
11090 "State: " (mapcar (lambda(x) (list x))
11091 org-todo-keywords-1)
11092 nil t))
11093 ((eq arg 'right)
11094 (if this
11095 (if tail (car tail) nil)
11096 (car org-todo-keywords-1)))
11097 ((eq arg 'left)
11098 (if (equal member org-todo-keywords-1)
11099 nil
11100 (if this
11101 (nth (- (length org-todo-keywords-1)
11102 (length tail) 2)
11103 org-todo-keywords-1)
11104 (org-last org-todo-keywords-1))))
11105 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11106 (setq arg nil))) ; hack to fall back to cycling
11107 (arg
11108 ;; user or caller requests a specific state
11109 (cond
11110 ((equal arg "") nil)
11111 ((eq arg 'none) nil)
11112 ((eq arg 'done) (or done-word (car org-done-keywords)))
11113 ((eq arg 'nextset)
11114 (or (car (cdr (member head org-todo-heads)))
11115 (car org-todo-heads)))
11116 ((eq arg 'previousset)
11117 (let ((org-todo-heads (reverse org-todo-heads)))
11118 (or (car (cdr (member head org-todo-heads)))
11119 (car org-todo-heads))))
11120 ((car (member arg org-todo-keywords-1)))
11121 ((stringp arg)
11122 (error "State `%s' not valid in this file" arg))
11123 ((nth (1- (prefix-numeric-value arg))
11124 org-todo-keywords-1))))
11125 ((null member) (or head (car org-todo-keywords-1)))
11126 ((equal this final-done-word) nil) ;; -> make empty
11127 ((null tail) nil) ;; -> first entry
11128 ((memq interpret '(type priority))
11129 (if (eq this-command last-command)
11130 (car tail)
11131 (if (> (length tail) 0)
11132 (or done-word (car org-done-keywords))
11133 nil)))
11134 (t
11135 (car tail))))
11136 (state (or
11137 (run-hook-with-args-until-success
11138 'org-todo-get-default-hook state last-state)
11139 state))
11140 (next (if state (concat " " state " ") " "))
11141 (change-plist (list :type 'todo-state-change :from this :to state
11142 :position startpos))
11143 dolog now-done-p)
11144 (when org-blocker-hook
11145 (setq org-last-todo-state-is-todo
11146 (not (member this org-done-keywords)))
11147 (unless (save-excursion
11148 (save-match-data
11149 (org-with-wide-buffer
11150 (run-hook-with-args-until-failure
11151 'org-blocker-hook change-plist))))
11152 (if (org-called-interactively-p 'interactive)
11153 (error "TODO state change from %s to %s blocked" this state)
11154 ;; fail silently
11155 (message "TODO state change from %s to %s blocked" this state)
11156 (throw 'exit nil))))
11157 (store-match-data match-data)
11158 (replace-match next t t)
11159 (unless (pos-visible-in-window-p hl-pos)
11160 (message "TODO state changed to %s" (org-trim next)))
11161 (unless head
11162 (setq head (org-get-todo-sequence-head state)
11163 ass (assoc head org-todo-kwd-alist)
11164 interpret (nth 1 ass)
11165 done-word (nth 3 ass)
11166 final-done-word (nth 4 ass)))
11167 (when (memq arg '(nextset previousset))
11168 (message "Keyword-Set %d/%d: %s"
11169 (- (length org-todo-sets) -1
11170 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11171 (length org-todo-sets)
11172 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11173 (setq org-last-todo-state-is-todo
11174 (not (member state org-done-keywords)))
11175 (setq now-done-p (and (member state org-done-keywords)
11176 (not (member this org-done-keywords))))
11177 (and logging (org-local-logging logging))
11178 (when (and (or org-todo-log-states org-log-done)
11179 (not (eq org-inhibit-logging t))
11180 (not (memq arg '(nextset previousset))))
11181 ;; we need to look at recording a time and note
11182 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11183 (nth 2 (assoc this org-todo-log-states))))
11184 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11185 (setq dolog 'time))
11186 (when (and state
11187 (member state org-not-done-keywords)
11188 (not (member this org-not-done-keywords)))
11189 ;; This is now a todo state and was not one before
11190 ;; If there was a CLOSED time stamp, get rid of it.
11191 (org-add-planning-info nil nil 'closed))
11192 (when (and now-done-p org-log-done)
11193 ;; It is now done, and it was not done before
11194 (org-add-planning-info 'closed (org-current-effective-time))
11195 (if (and (not dolog) (eq 'note org-log-done))
11196 (org-add-log-setup 'done state this 'findpos 'note)))
11197 (when (and state dolog)
11198 ;; This is a non-nil state, and we need to log it
11199 (org-add-log-setup 'state state this 'findpos dolog)))
11200 ;; Fixup tag positioning
11201 (org-todo-trigger-tag-changes state)
11202 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11203 (when org-provide-todo-statistics
11204 (org-update-parent-todo-statistics))
11205 (run-hooks 'org-after-todo-state-change-hook)
11206 (if (and arg (not (member state org-done-keywords)))
11207 (setq head (org-get-todo-sequence-head state)))
11208 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11209 ;; Do we need to trigger a repeat?
11210 (when now-done-p
11211 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11212 ;; This is for the agenda, take a snapshot of the headline.
11213 (save-match-data
11214 (setq org-agenda-headline-snapshot-before-repeat
11215 (org-get-heading))))
11216 (org-auto-repeat-maybe state))
11217 ;; Fixup cursor location if close to the keyword
11218 (if (and (outline-on-heading-p)
11219 (not (bolp))
11220 (save-excursion (beginning-of-line 1)
11221 (looking-at org-todo-line-regexp))
11222 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11223 (progn
11224 (goto-char (or (match-end 2) (match-end 1)))
11225 (and (looking-at " ") (just-one-space))))
11226 (when org-trigger-hook
11227 (save-excursion
11228 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11230 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11231 "Block turning an entry into a TODO, using the hierarchy.
11232 This checks whether the current task should be blocked from state
11233 changes. Such blocking occurs when:
11235 1. The task has children which are not all in a completed state.
11237 2. A task has a parent with the property :ORDERED:, and there
11238 are siblings prior to the current task with incomplete
11239 status.
11241 3. The parent of the task is blocked because it has siblings that should
11242 be done first, or is child of a block grandparent TODO entry."
11244 (if (not org-enforce-todo-dependencies)
11245 t ; if locally turned off don't block
11246 (catch 'dont-block
11247 ;; If this is not a todo state change, or if this entry is already DONE,
11248 ;; do not block
11249 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11250 (member (plist-get change-plist :from)
11251 (cons 'done org-done-keywords))
11252 (member (plist-get change-plist :to)
11253 (cons 'todo org-not-done-keywords))
11254 (not (plist-get change-plist :to)))
11255 (throw 'dont-block t))
11256 ;; If this task has children, and any are undone, it's blocked
11257 (save-excursion
11258 (org-back-to-heading t)
11259 (let ((this-level (funcall outline-level)))
11260 (outline-next-heading)
11261 (let ((child-level (funcall outline-level)))
11262 (while (and (not (eobp))
11263 (> child-level this-level))
11264 ;; this todo has children, check whether they are all
11265 ;; completed
11266 (if (and (not (org-entry-is-done-p))
11267 (org-entry-is-todo-p))
11268 (throw 'dont-block nil))
11269 (outline-next-heading)
11270 (setq child-level (funcall outline-level))))))
11271 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11272 ;; any previous siblings are undone, it's blocked
11273 (save-excursion
11274 (org-back-to-heading t)
11275 (let* ((pos (point))
11276 (parent-pos (and (org-up-heading-safe) (point))))
11277 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11278 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11279 (forward-line 1)
11280 (re-search-forward org-not-done-heading-regexp pos t))
11281 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11282 ;; Search further up the hierarchy, to see if an anchestor is blocked
11283 (while t
11284 (goto-char parent-pos)
11285 (if (not (looking-at org-not-done-heading-regexp))
11286 (throw 'dont-block t)) ; do not block, parent is not a TODO
11287 (setq pos (point))
11288 (setq parent-pos (and (org-up-heading-safe) (point)))
11289 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11290 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11291 (forward-line 1)
11292 (re-search-forward org-not-done-heading-regexp pos t))
11293 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11295 (defcustom org-track-ordered-property-with-tag nil
11296 "Should the ORDERED property also be shown as a tag?
11297 The ORDERED property decides if an entry should require subtasks to be
11298 completed in sequence. Since a property is not very visible, setting
11299 this option means that toggling the ORDERED property with the command
11300 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11301 not relevant for the behavior, but it makes things more visible.
11303 Note that toggling the tag with tags commands will not change the property
11304 and therefore not influence behavior!
11306 This can be t, meaning the tag ORDERED should be used, It can also be a
11307 string to select a different tag for this task."
11308 :group 'org-todo
11309 :type '(choice
11310 (const :tag "No tracking" nil)
11311 (const :tag "Track with ORDERED tag" t)
11312 (string :tag "Use other tag")))
11314 (defun org-toggle-ordered-property ()
11315 "Toggle the ORDERED property of the current entry.
11316 For better visibility, you can track the value of this property with a tag.
11317 See variable `org-track-ordered-property-with-tag'."
11318 (interactive)
11319 (let* ((t1 org-track-ordered-property-with-tag)
11320 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11321 (save-excursion
11322 (org-back-to-heading)
11323 (if (org-entry-get nil "ORDERED")
11324 (progn
11325 (org-delete-property "ORDERED")
11326 (and tag (org-toggle-tag tag 'off))
11327 (message "Subtasks can be completed in arbitrary order"))
11328 (org-entry-put nil "ORDERED" "t")
11329 (and tag (org-toggle-tag tag 'on))
11330 (message "Subtasks must be completed in sequence")))))
11332 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11333 (defun org-block-todo-from-checkboxes (change-plist)
11334 "Block turning an entry into a TODO, using checkboxes.
11335 This checks whether the current task should be blocked from state
11336 changes because there are unchecked boxes in this entry."
11337 (if (not org-enforce-todo-checkbox-dependencies)
11338 t ; if locally turned off don't block
11339 (catch 'dont-block
11340 ;; If this is not a todo state change, or if this entry is already DONE,
11341 ;; do not block
11342 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11343 (member (plist-get change-plist :from)
11344 (cons 'done org-done-keywords))
11345 (member (plist-get change-plist :to)
11346 (cons 'todo org-not-done-keywords))
11347 (not (plist-get change-plist :to)))
11348 (throw 'dont-block t))
11349 ;; If this task has checkboxes that are not checked, it's blocked
11350 (save-excursion
11351 (org-back-to-heading t)
11352 (let ((beg (point)) end)
11353 (outline-next-heading)
11354 (setq end (point))
11355 (goto-char beg)
11357 end t)
11358 (progn
11359 (if (boundp 'org-blocked-by-checkboxes)
11360 (setq org-blocked-by-checkboxes t))
11361 (throw 'dont-block nil)))))
11362 t))) ; do not block
11364 (defun org-entry-blocked-p ()
11365 "Is the current entry blocked?"
11366 (if (org-entry-get nil "NOBLOCKING")
11367 nil ;; Never block this entry
11368 (not
11369 (run-hook-with-args-until-failure
11370 'org-blocker-hook
11371 (list :type 'todo-state-change
11372 :position (point)
11373 :from 'todo
11374 :to 'done)))))
11376 (defun org-update-statistics-cookies (all)
11377 "Update the statistics cookie, either from TODO or from checkboxes.
11378 This should be called with the cursor in a line with a statistics cookie."
11379 (interactive "P")
11380 (if all
11381 (progn
11382 (org-update-checkbox-count 'all)
11383 (org-map-entries 'org-update-parent-todo-statistics))
11384 (if (not (org-on-heading-p))
11385 (org-update-checkbox-count)
11386 (let ((pos (move-marker (make-marker) (point)))
11387 end l1 l2)
11388 (ignore-errors (org-back-to-heading t))
11389 (if (not (org-on-heading-p))
11390 (org-update-checkbox-count)
11391 (setq l1 (org-outline-level))
11392 (setq end (save-excursion
11393 (outline-next-heading)
11394 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11395 (point)))
11396 (if (and (save-excursion
11397 (re-search-forward
11399 (not (save-excursion (re-search-forward
11401 (org-update-checkbox-count)
11402 (if (and l2 (> l2 l1))
11403 (progn
11404 (goto-char end)
11405 (org-update-parent-todo-statistics))
11406 (goto-char pos)
11407 (beginning-of-line 1)
11408 (while (re-search-forward
11410 (point-at-eol) t)
11411 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11412 (goto-char pos)
11413 (move-marker pos nil)))))
11415 (defvar org-entry-property-inherited-from) ;; defined below
11416 (defun org-update-parent-todo-statistics ()
11417 "Update any statistics cookie in the parent of the current headline.
11418 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11419 the entire subtree and this will travel up the hierarchy and update
11420 statistics everywhere."
11421 (let* ((prop (save-excursion (org-up-heading-safe)
11422 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11423 (recursive (or (not org-hierarchical-todo-statistics)
11425 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11426 0))
11427 (first t)
11429 level ltoggle l1 new ndel
11430 (cnt-all 0) (cnt-done 0) is-percent kwd
11431 checkbox-beg ov ovs ove cookie-present)
11432 (catch 'exit
11433 (save-excursion
11434 (beginning-of-line 1)
11435 (setq ltoggle (funcall outline-level))
11436 ;; Three situations are to consider:
11438 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11439 ;; to the top-level ancestor on the headline;
11441 ;; 2. If parent has "recursive" property, repeat up to the
11442 ;; headline setting that property, taking inheritance into
11443 ;; account;
11445 ;; 3. Else, move up to direct parent and proceed only once.
11446 (while (and (setq level (org-up-heading-safe))
11447 (or recursive first)
11448 (>= (point) lim))
11449 (setq first nil cookie-present nil)
11450 (unless (and level
11451 (not (string-match
11453 (downcase (or (org-entry-get nil "COOKIE_DATA")
11454 "")))))
11455 (throw 'exit nil))
11456 (while (re-search-forward box-re (point-at-eol) t)
11457 (setq cnt-all 0 cnt-done 0 cookie-present t)
11458 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11459 (save-match-data
11460 (unless (outline-next-heading) (throw 'exit nil))
11461 (while (and (looking-at org-complex-heading-regexp)
11462 (> (setq l1 (length (match-string 1))) level))
11463 (setq kwd (and (or recursive (= l1 ltoggle))
11464 (match-string 2)))
11465 (if (or (eq org-provide-todo-statistics 'all-headlines)
11466 (and (listp org-provide-todo-statistics)
11467 (or (member kwd org-provide-todo-statistics)
11468 (member kwd org-done-keywords))))
11469 (setq cnt-all (1+ cnt-all))
11470 (if (eq org-provide-todo-statistics t)
11471 (and kwd (setq cnt-all (1+ cnt-all)))))
11472 (and (member kwd org-done-keywords)
11473 (setq cnt-done (1+ cnt-done)))
11474 (outline-next-heading)))
11475 (setq new
11476 (if is-percent
11477 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11478 (format "[%d/%d]" cnt-done cnt-all))
11479 ndel (- (match-end 0) checkbox-beg))
11480 ;; handle overlays when updating cookie from column view
11481 (when (setq ov (car (overlays-at checkbox-beg)))
11482 (setq ovs (overlay-start ov) ove (overlay-end ov))
11483 (delete-overlay ov))
11484 (goto-char checkbox-beg)
11485 (insert new)
11486 (delete-region (point) (+ (point) ndel))
11487 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11488 (when ov (move-overlay ov ovs ove)))
11489 (when cookie-present
11490 (run-hook-with-args 'org-after-todo-statistics-hook
11491 cnt-done (- cnt-all cnt-done))))))
11492 (run-hooks 'org-todo-statistics-hook)))
11494 (defvar org-after-todo-statistics-hook nil
11495 "Hook that is called after a TODO statistics cookie has been updated.
11496 Each function is called with two arguments: the number of not-done entries
11497 and the number of done entries.
11499 For example, the following function, when added to this hook, will switch
11500 an entry to DONE when all children are done, and back to TODO when new
11501 entries are set to a TODO status. Note that this hook is only called
11502 when there is a statistics cookie in the headline!
11504 (defun org-summary-todo (n-done n-not-done)
11506 (let (org-log-done org-log-states) ; turn off logging
11508 ")
11510 (defvar org-todo-statistics-hook nil
11511 "Hook that is run whenever Org thinks TODO statistics should be updated.
11512 This hook runs even if there is no statistics cookie present, in which case
11513 `org-after-todo-statistics-hook' would not run.")
11515 (defun org-todo-trigger-tag-changes (state)
11516 "Apply the changes defined in `org-todo-state-tags-triggers'."
11517 (let ((l org-todo-state-tags-triggers)
11518 changes)
11519 (when (or (not state) (equal state ""))
11520 (setq changes (append changes (cdr (assoc "" l)))))
11521 (when (and (stringp state) (> (length state) 0))
11522 (setq changes (append changes (cdr (assoc state l)))))
11523 (when (member state org-not-done-keywords)
11524 (setq changes (append changes (cdr (assoc 'todo l)))))
11525 (when (member state org-done-keywords)
11526 (setq changes (append changes (cdr (assoc 'done l)))))
11527 (dolist (c changes)
11528 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11530 (defun org-local-logging (value)
11531 "Get logging settings from a property VALUE."
11532 (let* (words w a)
11533 ;; directly set the variables, they are already local.
11534 (setq org-log-done nil
11535 org-log-repeat nil
11536 org-todo-log-states nil)
11537 (setq words (org-split-string value))
11538 (while (setq w (pop words))
11539 (cond
11540 ((setq a (assoc w org-startup-options))
11541 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11542 (set (nth 1 a) (nth 2 a))))
11543 ((setq a (org-extract-log-state-settings w))
11544 (and (member (car a) org-todo-keywords-1)
11545 (push a org-todo-log-states)))))))
11547 (defun org-get-todo-sequence-head (kwd)
11548 "Return the head of the TODO sequence to which KWD belongs.
11549 If KWD is not set, check if there is a text property remembering the
11550 right sequence."
11551 (let (p)
11552 (cond
11553 ((not kwd)
11554 (or (get-text-property (point-at-bol) 'org-todo-head)
11555 (progn
11556 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11557 nil (point-at-eol)))
11558 (get-text-property p 'org-todo-head))))
11559 ((not (member kwd org-todo-keywords-1))
11560 (car org-todo-keywords-1))
11561 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11563 (defun org-fast-todo-selection ()
11564 "Fast TODO keyword selection with single keys.
11565 Returns the new TODO keyword, or nil if no state change should occur."
11566 (let* ((fulltable org-todo-key-alist)
11567 (done-keywords org-done-keywords) ;; needed for the faces.
11568 (maxlen (apply 'max (mapcar
11569 (lambda (x)
11570 (if (stringp (car x)) (string-width (car x)) 0))
11571 fulltable)))
11572 (expert nil)
11573 (fwidth (+ maxlen 3 1 3))
11574 (ncol (/ (- (window-width) 4) fwidth))
11575 tg cnt e c tbl
11576 groups ingroup)
11577 (save-excursion
11578 (save-window-excursion
11579 (if expert
11580 (set-buffer (get-buffer-create " *Org todo*"))
11581 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11582 (erase-buffer)
11583 (org-set-local 'org-done-keywords done-keywords)
11584 (setq tbl fulltable cnt 0)
11585 (while (setq e (pop tbl))
11586 (cond
11587 ((equal e '(:startgroup))
11588 (push '() groups) (setq ingroup t)
11589 (when (not (= cnt 0))
11590 (setq cnt 0)
11592 (insert "{ "))
11593 ((equal e '(:endgroup))
11594 (setq ingroup nil cnt 0)
11596 ((equal e '(:newline))
11597 (when (not (= cnt 0))
11598 (setq cnt 0)
11600 (setq e (car tbl))
11601 (while (equal (car tbl) '(:newline))
11603 (setq tbl (cdr tbl)))))
11604 (t
11605 (setq tg (car e) c (cdr e))
11606 (if ingroup (push tg (car groups)))
11607 (setq tg (org-add-props tg nil 'face
11608 (org-get-todo-face tg)))
11609 (if (and (= cnt 0) (not ingroup)) (insert " "))
11610 (insert "[" c "] " tg (make-string
11611 (- fwidth 4 (length tg)) ?\ ))
11612 (when (= (setq cnt (1+ cnt)) ncol)
11614 (if ingroup (insert " "))
11615 (setq cnt 0)))))
11617 (goto-char (point-min))
11618 (if (not expert) (org-fit-window-to-buffer))
11619 (message "[a-z..]:Set [SPC]:clear")
11620 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11621 (cond
11622 ((or (= c ?\C-g)
11623 (and (= c ?q) (not (rassoc c fulltable))))
11624 (setq quit-flag t))
11625 ((= c ?\ ) nil)
11626 ((setq e (rassoc c fulltable) tg (car e))
11627 tg)
11628 (t (setq quit-flag t)))))))
11630 (defun org-entry-is-todo-p ()
11631 (member (org-get-todo-state) org-not-done-keywords))
11633 (defun org-entry-is-done-p ()
11634 (member (org-get-todo-state) org-done-keywords))
11636 (defun org-get-todo-state ()
11637 (save-excursion
11638 (org-back-to-heading t)
11639 (and (looking-at org-todo-line-regexp)
11640 (match-end 2)
11641 (match-string 2))))
11643 (defun org-at-date-range-p (&optional inactive-ok)
11644 "Is the cursor inside a date range?"
11645 (interactive)
11646 (save-excursion
11647 (catch 'exit
11648 (let ((pos (point)))
11650 (skip-chars-backward "<[")
11651 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11652 (>= (match-end 0) pos)
11653 (throw 'exit t))
11655 (skip-chars-backward "<[")
11656 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11657 (>= (match-end 0) pos)
11658 (throw 'exit t)))
11659 nil)))
11661 (defun org-get-repeat (&optional tagline)
11662 "Check if there is a deadline/schedule with repeater in this entry."
11663 (save-match-data
11664 (save-excursion
11665 (org-back-to-heading t)
11666 (and (re-search-forward (if tagline
11668 org-repeat-re)
11669 (org-entry-end-position) t)
11670 (match-string-no-properties 1)))))
11672 (defvar org-last-changed-timestamp)
11673 (defvar org-last-inserted-timestamp)
11674 (defvar org-log-post-message)
11675 (defvar org-log-note-purpose)
11676 (defvar org-log-note-how)
11677 (defvar org-log-note-extra)
11678 (defun org-auto-repeat-maybe (done-word)
11679 "Check if the current headline contains a repeated deadline/schedule.
11680 If yes, set TODO state back to what it was and change the base date
11681 of repeating deadline/scheduled time stamps to new date.
11682 This function is run automatically after each state change to a DONE state."
11683 ;; last-state is dynamically scoped into this function
11684 (let* ((repeat (org-get-repeat))
11685 (aa (assoc last-state org-todo-kwd-alist))
11686 (interpret (nth 1 aa))
11687 (head (nth 2 aa))
11688 (whata '(("d" . day) ("m" . month) ("y" . year)))
11689 (msg "Entry repeats: ")
11690 (org-log-done nil)
11691 (org-todo-log-states nil)
11692 re type n what ts time to-state)
11693 (when repeat
11694 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11695 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11696 org-todo-repeat-to-state))
11697 (unless (and to-state (member to-state org-todo-keywords-1))
11698 (setq to-state (if (eq interpret 'type) last-state head)))
11699 (org-todo to-state)
11700 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11701 (org-entry-put nil "LAST_REPEAT" (format-time-string
11702 (org-time-stamp-format t t))))
11703 (when org-log-repeat
11704 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11705 (memq 'org-add-log-note post-command-hook))
11706 ;; OK, we are already setup for some record
11707 (if (eq org-log-repeat 'note)
11708 ;; make sure we take a note, not only a time stamp
11709 (setq org-log-note-how 'note))
11710 ;; Set up for taking a record
11711 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11712 last-state
11713 'findpos org-log-repeat)))
11714 (org-back-to-heading t)
11715 (org-add-planning-info nil nil 'closed)
11719 (while (re-search-forward
11720 re (save-excursion (outline-next-heading) (point)) t)
11721 (setq type (if (match-end 1) org-scheduled-string
11722 (if (match-end 3) org-deadline-string "Plain:"))
11723 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11725 (setq n (string-to-number (match-string 2 ts))
11726 what (match-string 3 ts))
11727 (if (equal what "w") (setq n (* n 7) what "d"))
11728 ;; Preparation, see if we need to modify the start date for the change
11729 (when (match-end 1)
11730 (setq time (save-match-data (org-time-string-to-time ts)))
11731 (cond
11732 ((equal (match-string 1 ts) ".")
11733 ;; Shift starting date to today
11734 (org-timestamp-change
11735 (- (org-today) (time-to-days time))
11736 'day))
11737 ((equal (match-string 1 ts) "+")
11738 (let ((nshiftmax 10) (nshift 0))
11739 (while (or (= nshift 0)
11740 (<= (time-to-days time)
11741 (time-to-days (current-time))))
11742 (when (= (incf nshift) nshiftmax)
11743 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11744 (error "Abort")))
11745 (org-timestamp-change n (cdr (assoc what whata)))
11746 (org-at-timestamp-p t)
11747 (setq ts (match-string 1))
11748 (setq time (save-match-data (org-time-string-to-time ts)))))
11749 (org-timestamp-change (- n) (cdr (assoc what whata)))
11750 ;; rematch, so that we have everything in place for the real shift
11751 (org-at-timestamp-p t)
11752 (setq ts (match-string 1))
11754 (org-timestamp-change n (cdr (assoc what whata)))
11755 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11756 (setq org-log-post-message msg)
11757 (message "%s" msg))))
11759 (defun org-show-todo-tree (arg)
11760 "Make a compact tree which shows all headlines marked with TODO.
11761 The tree will show the lines where the regexp matches, and all higher
11762 headlines above the match.
11764 With a numeric prefix N, construct a sparse tree for the Nth element
11765 of `org-todo-keywords-1'."
11766 (interactive "P")
11767 (let ((case-fold-search nil)
11768 (kwd-re
11769 (cond ((null arg) org-not-done-regexp)
11770 ((equal arg '(4))
11771 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11772 (mapcar 'list org-todo-keywords-1))))
11776 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11777 (regexp-quote (nth (1- (prefix-numeric-value arg))
11778 org-todo-keywords-1)))
11779 (t (error "Invalid prefix argument: %s" arg)))))
11780 (message "%d TODO entries found"
11781 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11783 (defun org-deadline (&optional remove time)
11785 With argument REMOVE, remove any deadline from the item.
11786 With argument TIME, set the deadline at the corresponding date. TIME
11788 (interactive "P")
11789 (let* ((old-date (org-entry-get nil "DEADLINE"))
11790 (repeater (and old-date
11791 (string-match
11793 old-date)
11794 (match-string 1 old-date))))
11795 (if remove
11796 (progn
11797 (when (and old-date org-log-redeadline)
11798 (org-add-log-setup 'deldeadline nil old-date 'findpos
11799 org-log-redeadline))
11800 (org-remove-timestamp-with-keyword org-deadline-string)
11801 (message "Item no longer has a deadline."))
11802 (org-add-planning-info 'deadline time 'closed)
11803 (when (and old-date org-log-redeadline
11804 (not (equal old-date
11805 (substring org-last-inserted-timestamp 1 -1))))
11806 (org-add-log-setup 'redeadline nil old-date 'findpos
11807 org-log-redeadline))
11808 (when repeater
11809 (save-excursion
11810 (org-back-to-heading t)
11811 (when (re-search-forward (concat org-deadline-string " "
11812 org-last-inserted-timestamp)
11813 (save-excursion
11814 (outline-next-heading) (point)) t)
11815 (goto-char (1- (match-end 0)))
11816 (insert " " repeater)
11817 (setq org-last-inserted-timestamp
11818 (concat (substring org-last-inserted-timestamp 0 -1)
11819 " " repeater
11820 (substring org-last-inserted-timestamp -1))))))
11821 (message "Deadline on %s" org-last-inserted-timestamp))))
11823 (defun org-schedule (&optional remove time)
11824 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11825 With argument REMOVE, remove any scheduling date from the item.
11826 With argument TIME, scheduled at the corresponding date. TIME can
11828 (interactive "P")
11829 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11830 (repeater (and old-date
11831 (string-match
11833 old-date)
11834 (match-string 1 old-date))))
11835 (if remove
11836 (progn
11837 (when (and old-date org-log-reschedule)
11838 (org-add-log-setup 'delschedule nil old-date 'findpos
11839 org-log-reschedule))
11840 (org-remove-timestamp-with-keyword org-scheduled-string)
11841 (message "Item is no longer scheduled."))
11842 (org-add-planning-info 'scheduled time 'closed)
11843 (when (and old-date org-log-reschedule
11844 (not (equal old-date
11845 (substring org-last-inserted-timestamp 1 -1))))
11846 (org-add-log-setup 'reschedule nil old-date 'findpos
11847 org-log-reschedule))
11848 (when repeater
11849 (save-excursion
11850 (org-back-to-heading t)
11851 (when (re-search-forward (concat org-scheduled-string " "
11852 org-last-inserted-timestamp)
11853 (save-excursion
11854 (outline-next-heading) (point)) t)
11855 (goto-char (1- (match-end 0)))
11856 (insert " " repeater)
11857 (setq org-last-inserted-timestamp
11858 (concat (substring org-last-inserted-timestamp 0 -1)
11859 " " repeater
11860 (substring org-last-inserted-timestamp -1))))))
11861 (message "Scheduled to %s" org-last-inserted-timestamp))))
11863 (defun org-get-scheduled-time (pom &optional inherit)
11864 "Get the scheduled time as a time tuple, of a format suitable
11865 for calling org-schedule with, or if there is no scheduling,
11866 returns nil."
11867 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11868 (when time
11869 (apply 'encode-time (org-parse-time-string time)))))
11871 (defun org-get-deadline-time (pom &optional inherit)
11872 "Get the deadline as a time tuple, of a format suitable for
11873 calling org-deadline with, or if there is no scheduling, returns
11874 nil."
11875 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11876 (when time
11877 (apply 'encode-time (org-parse-time-string time)))))
11879 (defun org-remove-timestamp-with-keyword (keyword)
11880 "Remove all time stamps with KEYWORD in the current entry."
11882 beg)
11883 (save-excursion
11884 (org-back-to-heading t)
11885 (setq beg (point))
11886 (outline-next-heading)
11887 (while (re-search-backward re beg t)
11888 (replace-match "")
11890 (equal (char-before) ?\ ))
11891 (backward-delete-char 1)
11893 (point-at-bol) (point-at-eol)))
11894 (delete-region (point-at-bol)
11895 (min (point-max) (1+ (point-at-eol))))))))))
11897 (defun org-add-planning-info (what &optional time &rest remove)
11898 "Insert new timestamp with keyword in the line directly after the headline.
11899 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11900 If non is given, the user is prompted for a date.
11901 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11902 be removed."
11903 (interactive)
11904 (let (org-time-was-given org-end-time-was-given ts
11905 end default-time default-input)
11907 (catch 'exit
11908 (when (and (memq what '(scheduled deadline))
11909 (or (not time)
11910 (and (stringp time)
11911 (string-match "^[-+]+[0-9]" time))))
11912 ;; Try to get a default date/time from existing timestamp
11913 (save-excursion
11914 (org-back-to-heading t)
11915 (setq end (save-excursion (outline-next-heading) (point)))
11916 (when (re-search-forward (if (eq what 'scheduled)
11917 org-scheduled-time-regexp
11918 org-deadline-time-regexp)
11919 end t)
11920 (setq ts (match-string 1)
11921 default-time
11922 (apply 'encode-time (org-parse-time-string ts))
11923 default-input (and ts (org-get-compact-tod ts))))))
11924 (when what
11925 (setq time
11926 (if (and (stringp time)
11927 (string-match "^[-+]+[0-9]" time))
11928 ;; This is a relative time, set the proper date
11929 (apply 'encode-time
11930 (org-read-date-analyze
11931 time default-time (decode-time default-time)))
11932 ;; If necessary, get the time from the user
11933 (or time (org-read-date nil 'to-time nil nil
11934 default-time default-input)))))
11936 (when (and org-insert-labeled-timestamps-at-point
11937 (member what '(scheduled deadline)))
11938 (insert
11939 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11940 (org-insert-time-stamp time org-time-was-given
11941 nil nil nil (list org-end-time-was-given))
11942 (setq what nil))
11943 (save-excursion
11944 (save-restriction
11945 (let (col list elt ts buffer-invisibility-spec)
11946 (org-back-to-heading t)
11948 (goto-char (match-end 1))
11949 (setq col (current-column))
11950 (goto-char (match-end 0))
11952 (when (and (not what)
11953 (not (looking-at
11955 org-keyword-time-not-clock-regexp))))
11956 ;; Nothing to add, nothing to remove...... :-)
11957 (throw 'exit nil))
11958 (if (and (not (looking-at org-outline-regexp))
11961 (not (equal (match-string 1) org-clock-string)))
11962 (narrow-to-region (match-beginning 0) (match-end 0))
11964 (backward-char 1)
11965 (narrow-to-region (point) (point))
11966 (and org-adapt-indentation (org-indent-to-column col)))
11967 ;; Check if we have to remove something.
11968 (setq list (cons what remove))
11969 (while list
11970 (setq elt (pop list))
11971 (when (or (and (eq elt 'scheduled)
11972 (re-search-forward org-scheduled-time-regexp nil t))
11973 (and (eq elt 'deadline)
11974 (re-search-forward org-deadline-time-regexp nil t))
11975 (and (eq elt 'closed)
11976 (re-search-forward org-closed-time-regexp nil t)))
11977 (replace-match "")
11978 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11980 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11981 (when what
11982 (insert
11983 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11984 (cond ((eq what 'scheduled) org-scheduled-string)
11985 ((eq what 'deadline) org-deadline-string)
11986 ((eq what 'closed) org-closed-string))
11987 " ")
11988 (setq ts (org-insert-time-stamp
11989 time
11990 (or org-time-was-given
11991 (and (eq what 'closed) org-log-done-with-time))
11992 (eq what 'closed)
11993 nil nil (list org-end-time-was-given)))
11994 (insert
11995 (if (not (or (bolp) (eq (char-before) ?\ )
11996 (memq (char-after) '(32 10))
11997 (eobp))) " " ""))
11998 (end-of-line 1))
11999 (goto-char (point-min))
12000 (widen)
12003 (delete-region (1- (point)) (point-at-eol)))
12004 ts))))))
12006 (defvar org-log-note-marker (make-marker))
12007 (defvar org-log-note-purpose nil)
12008 (defvar org-log-note-state nil)
12009 (defvar org-log-note-previous-state nil)
12010 (defvar org-log-note-how nil)
12011 (defvar org-log-note-extra nil)
12012 (defvar org-log-note-window-configuration nil)
12013 (defvar org-log-note-return-to (make-marker))
12014 (defvar org-log-note-effective-time nil
12015 "Remembered current time so that dynamically scoped
12016 `org-extend-today-until' affects tha timestamps in state change
12017 log")
12019 (defvar org-log-post-message nil
12020 "Message to be displayed after a log note has been stored.
12021 The auto-repeater uses this.")
12023 (defun org-add-note ()
12024 "Add a note to the current entry.
12025 This is done in the same way as adding a state change note."
12026 (interactive)
12027 (org-add-log-setup 'note nil nil 'findpos nil))
12029 (defvar org-property-end-re)
12030 (defun org-add-log-setup (&optional purpose state prev-state
12031 findpos how extra)
12032 "Set up the post command hook to take a note.
12033 If this is about to TODO state change, the new state is expected in STATE.
12034 When FINDPOS is non-nil, find the correct position for the note in
12035 the current entry. If not, assume that it can be inserted at point.
12036 HOW is an indicator what kind of note should be created.
12037 EXTRA is additional text that will be inserted into the notes buffer."
12038 (let* ((org-log-into-drawer (org-log-into-drawer))
12039 (drawer (cond ((stringp org-log-into-drawer)
12040 org-log-into-drawer)
12041 (org-log-into-drawer "LOGBOOK")
12042 (t nil))))
12043 (save-restriction
12044 (save-excursion
12045 (when findpos
12046 (org-back-to-heading t)
12047 (narrow-to-region (point) (save-excursion
12048 (outline-next-heading) (point)))
12052 (goto-char (match-end 0))
12053 (cond
12054 (drawer
12056 nil t)
12057 (progn
12058 (goto-char (match-end 0))
12059 (or org-log-states-order-reversed
12060 (and (re-search-forward org-property-end-re nil t)
12061 (goto-char (1- (match-beginning 0))))))
12063 (beginning-of-line 0)
12064 (org-indent-line-function)
12065 (beginning-of-line 2)
12066 (org-indent-line-function)
12067 (end-of-line 0)))
12068 ((and org-log-state-notes-insert-after-drawers
12069 (save-excursion
12070 (forward-line) (looking-at org-drawer-regexp)))
12071 (forward-line)
12072 (while (looking-at org-drawer-regexp)
12073 (goto-char (match-end 0))
12074 (re-search-forward org-property-end-re (point-max) t)
12075 (forward-line))
12076 (forward-line -1)))
12077 (unless org-log-states-order-reversed
12079 (org-skip-over-state-notes)
12081 (move-marker org-log-note-marker (point))
12082 (setq org-log-note-purpose purpose
12083 org-log-note-state state
12084 org-log-note-previous-state prev-state
12085 org-log-note-how how
12086 org-log-note-extra extra
12087 org-log-note-effective-time (org-current-effective-time))
12088 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12090 (defun org-skip-over-state-notes ()
12091 "Skip past the list of State notes in an entry."
12093 (when (ignore-errors (goto-char (org-in-item-p)))
12094 (let* ((struct (org-list-struct))
12095 (prevs (org-list-prevs-alist struct)))
12097 (goto-char (or (org-list-get-next-item (point) struct prevs)
12098 (org-list-get-item-end (point) struct)))))))
12100 (defun org-add-log-note (&optional purpose)
12101 "Pop up a window for taking a note, and add this note later at point."
12102 (remove-hook 'post-command-hook 'org-add-log-note)
12103 (setq org-log-note-window-configuration (current-window-configuration))
12104 (delete-other-windows)
12105 (move-marker org-log-note-return-to (point))
12106 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12107 (goto-char org-log-note-marker)
12108 (org-switch-to-buffer-other-window "*Org Note*")
12109 (erase-buffer)
12110 (if (memq org-log-note-how '(time state))
12111 (let (current-prefix-arg) (org-store-log-note))
12112 (let ((org-inhibit-startup t)) (org-mode))
12113 (insert (format "# Insert note for %s.
12115 (cond
12116 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12117 ((eq org-log-note-purpose 'done) "closed todo item")
12118 ((eq org-log-note-purpose 'state)
12120 (or org-log-note-previous-state "")
12121 (or org-log-note-state "")))
12122 ((eq org-log-note-purpose 'reschedule)
12123 "rescheduling")
12124 ((eq org-log-note-purpose 'delschedule)
12125 "no longer scheduled")
12126 ((eq org-log-note-purpose 'redeadline)
12127 "changing deadline")
12128 ((eq org-log-note-purpose 'deldeadline)
12129 "removing deadline")
12130 ((eq org-log-note-purpose 'refile)
12131 "refiling")
12132 ((eq org-log-note-purpose 'note)
12133 "this entry")
12134 (t (error "This should not happen")))))
12135 (if org-log-note-extra (insert org-log-note-extra))
12136 (org-set-local 'org-finish-function 'org-store-log-note)
12137 (run-hooks 'org-log-buffer-setup-hook)))
12139 (defvar org-note-abort nil) ; dynamically scoped
12140 (defun org-store-log-note ()
12141 "Finish taking a log note, and insert it to where it belongs."
12142 (let ((txt (buffer-string))
12143 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12144 lines ind bul)
12145 (kill-buffer (current-buffer))
12147 (setq txt (replace-match "" t t txt)))
12149 (setq txt (replace-match "" t t txt)))
12152 (setq note
12153 (org-replace-escapes
12154 note
12155 (list (cons "%u" (user-login-name))
12156 (cons "%U" user-full-name)
12157 (cons "%t" (format-time-string
12158 (org-time-stamp-format 'long 'inactive)
12159 org-log-note-effective-time))
12160 (cons "%T" (format-time-string
12161 (org-time-stamp-format 'long nil)
12162 org-log-note-effective-time))
12163 (cons "%s" (if org-log-note-state
12165 ""))
12166 (cons "%S" (if org-log-note-previous-state
12170 (push note lines))
12171 (when (or current-prefix-arg org-note-abort)
12172 (when org-log-into-drawer
12173 (org-remove-empty-drawer-at
12174 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12175 org-log-note-marker))
12176 (setq lines nil))
12177 (when lines
12178 (with-current-buffer (marker-buffer org-log-note-marker)
12179 (save-excursion
12180 (goto-char org-log-note-marker)
12181 (move-marker org-log-note-marker nil)
12182 (end-of-line 1)
12184 (setq ind (save-excursion
12185 (if (ignore-errors (goto-char (org-in-item-p)))
12186 (let ((struct (org-list-struct)))
12187 (org-list-get-ind
12188 (org-list-get-top-point struct) struct))
12190 (cond
12191 ((and (org-at-heading-p)
12192 org-adapt-indentation)
12193 (1+ (org-current-level)))
12194 ((org-at-heading-p) 0)
12195 (t (org-get-indentation))))))
12196 (setq bul (org-list-bullet-string "-"))
12197 (org-indent-line-to ind)
12198 (insert bul (pop lines))
12199 (let ((ind-body (+ (length bul) ind)))
12200 (while lines
12202 (org-indent-line-to ind-body)
12203 (insert (pop lines))))
12204 (message "Note stored")
12205 (org-back-to-heading t)
12206 (org-cycle-hide-drawers 'children)))))
12207 (set-window-configuration org-log-note-window-configuration)
12208 (with-current-buffer (marker-buffer org-log-note-return-to)
12209 (goto-char org-log-note-return-to))
12210 (move-marker org-log-note-return-to nil)
12211 (and org-log-post-message (message "%s" org-log-post-message)))
12213 (defun org-remove-empty-drawer-at (drawer pos)
12214 "Remove an empty drawer DRAWER at position POS.
12215 POS may also be a marker."
12216 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12217 (save-excursion
12218 (save-restriction
12219 (widen)
12220 (goto-char pos)
12221 (if (org-in-regexp
12223 (replace-match ""))))))
12225 (defun org-sparse-tree (&optional arg)
12226 "Create a sparse tree, prompt for the details.
12227 This command can create sparse trees. You first need to select the type
12228 of match used to create the tree:
12230 t Show all TODO entries.
12231 T Show entries with a specific TODO keyword.
12232 m Show entries selected by a tags/property match.
12233 p Enter a property name and its value (both with completion on existing
12234 names/values) and show entries with that property.
12235 r Show entries matching a regular expression (`/' can be used as well)
12236 d Show deadlines due within `org-deadline-warning-days'.
12237 b Show deadlines and scheduled items before a date.
12238 a Show deadlines and scheduled items after a date."
12239 (interactive "P")
12240 (let (ans kwd value)
12241 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12242 (setq ans (read-char-exclusive))
12243 (cond
12244 ((equal ans ?d)
12245 (call-interactively 'org-check-deadlines))
12246 ((equal ans ?b)
12247 (call-interactively 'org-check-before-date))
12248 ((equal ans ?a)
12249 (call-interactively 'org-check-after-date))
12250 ((equal ans ?t)
12251 (org-show-todo-tree nil))
12252 ((equal ans ?T)
12253 (org-show-todo-tree '(4)))
12254 ((member ans '(?T ?m))
12255 (call-interactively 'org-match-sparse-tree))
12256 ((member ans '(?p ?P))
12257 (setq kwd (org-icompleting-read "Property: "
12258 (mapcar 'list (org-buffer-property-keys))))
12259 (setq value (org-icompleting-read "Value: "
12260 (mapcar 'list (org-property-values kwd))))
12263 (org-match-sparse-tree arg (concat kwd "=" value)))
12264 ((member ans '(?r ?R ?/))
12265 (call-interactively 'org-occur))
12268 (defvar org-occur-highlights nil
12269 "List of overlays used for occur matches.")
12270 (make-variable-buffer-local 'org-occur-highlights)
12271 (defvar org-occur-parameters nil
12272 "Parameters of the active org-occur calls.
12273 This is a list, each call to org-occur pushes as cons cell,
12274 containing the regular expression and the callback, onto the list.
12275 The list can contain several entries if `org-occur' has been called
12276 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12277 will only contain one set of parameters. When the highlights are
12278 removed (for example with `C-c C-c', or with the next edit (depending
12279 on `org-remove-highlights-with-change'), this variable is emptied
12280 as well.")
12281 (make-variable-buffer-local 'org-occur-parameters)
12283 (defun org-occur (regexp &optional keep-previous callback)
12284 "Make a compact tree which shows all matches of REGEXP.
12285 The tree will show the lines where the regexp matches, and all higher
12286 headlines above the match. It will also show the heading after the match,
12287 to make sure editing the matching entry is easy.
12288 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12289 call to `org-occur' will be kept, to allow stacking of calls to this
12290 command.
12291 If CALLBACK is non-nil, it is a function which is called to confirm
12292 that the match should indeed be shown."
12294 (when (equal regexp "")
12295 (error "Regexp cannot be empty"))
12296 (unless keep-previous
12297 (org-remove-occur-highlights nil nil t))
12298 (push (cons regexp callback) org-occur-parameters)
12299 (let ((cnt 0))
12300 (save-excursion
12301 (goto-char (point-min))
12302 (if (or (not keep-previous) ; do not want to keep
12303 (not org-occur-highlights)) ; no previous matches
12304 ;; hide everything
12305 (org-overview))
12306 (while (re-search-forward regexp nil t)
12307 (when (or (not callback)
12308 (save-match-data (funcall callback)))
12309 (setq cnt (1+ cnt))
12310 (when org-highlight-sparse-tree-matches
12311 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12312 (org-show-context 'occur-tree))))
12313 (when org-remove-highlights-with-change
12314 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12315 nil 'local))
12316 (unless org-sparse-tree-open-archived-trees
12317 (org-hide-archived-subtrees (point-min) (point-max)))
12318 (run-hooks 'org-occur-hook)
12319 (if (org-called-interactively-p 'interactive)
12320 (message "%d match(es) for regexp %s" cnt regexp))
12321 cnt))
12323 (defun org-occur-next-match (&optional n reset)
12324 "Function for `next-error-function' to find sparse tree matches.
12325 N is the number of matches to move, when negative move backwards.
12326 RESET is entirely ignored - this function always goes back to the
12327 starting point when no match is found."
12328 (let* ((limit (if (< n 0) (point-min) (point-max)))
12329 (search-func (if (< n 0)
12330 'previous-single-char-property-change
12331 'next-single-char-property-change))
12332 (n (abs n))
12333 (pos (point))
12334 p1)
12335 (catch 'exit
12336 (while (setq p1 (funcall search-func (point) 'org-type))
12337 (when (equal p1 limit)
12338 (goto-char pos)
12339 (error "No more matches"))
12340 (when (equal (get-char-property p1 'org-type) 'org-occur)
12341 (setq n (1- n))
12342 (when (= n 0)
12343 (goto-char p1)
12344 (throw 'exit (point))))
12345 (goto-char p1))
12346 (goto-char p1)
12347 (error "No more matches"))))
12349 (defun org-show-context (&optional key)
12350 "Make sure point and context are visible.
12351 How much context is shown depends upon the variables
12352 `org-show-hierarchy-above', `org-show-following-heading'. and
12353 `org-show-siblings'."
12354 (let ((heading-p (org-on-heading-p t))
12355 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12356 (following-p (org-get-alist-option org-show-following-heading key))
12357 (entry-p (org-get-alist-option org-show-entry-below key))
12358 (siblings-p (org-get-alist-option org-show-siblings key)))
12359 (catch 'exit
12360 ;; Show heading or entry text
12361 (if (and heading-p (not entry-p))
12362 (org-flag-heading nil) ; only show the heading
12363 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12364 (org-show-hidden-entry))) ; show entire entry
12365 (when following-p
12366 ;; Show next sibling, or heading below text
12367 (save-excursion
12368 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12369 (org-flag-heading nil))))
12370 (when siblings-p (org-show-siblings))
12371 (when hierarchy-p
12372 ;; show all higher headings, possibly with siblings
12373 (save-excursion
12374 (while (and (condition-case nil
12375 (progn (org-up-heading-all 1) t)
12376 (error nil))
12377 (not (bobp)))
12378 (org-flag-heading nil)
12379 (when siblings-p (org-show-siblings))))))))
12381 (defvar org-reveal-start-hook nil
12382 "Hook run before revealing a location.")
12384 (defun org-reveal (&optional siblings)
12385 "Show current entry, hierarchy above it, and the following headline.
12386 This can be used to show a consistent set of context around locations
12387 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12388 not t for the search context.
12390 With optional argument SIBLINGS, on each level of the hierarchy all
12391 siblings are shown. This repairs the tree structure to what it would
12392 look like when opened with hierarchical calls to `org-cycle'.
12394 go to the parent and show the
12395 entire tree."
12396 (interactive "P")
12397 (run-hooks 'org-reveal-start-hook)
12398 (let ((org-show-hierarchy-above t)
12399 (org-show-following-heading t)
12400 (org-show-siblings (if siblings t org-show-siblings)))
12401 (org-show-context nil))
12402 (when (equal siblings '(16))
12403 (save-excursion
12404 (when (org-up-heading-safe)
12405 (org-show-subtree)
12406 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12408 (defun org-highlight-new-match (beg end)
12409 "Highlight from BEG to END and mark the highlight is an occur headline."
12410 (let ((ov (make-overlay beg end)))
12411 (overlay-put ov 'face 'secondary-selection)
12412 (overlay-put ov 'org-type 'org-occur)
12413 (push ov org-occur-highlights)))
12415 (defun org-remove-occur-highlights (&optional beg end noremove)
12416 "Remove the occur highlights from the buffer.
12417 BEG and END are ignored. If NOREMOVE is nil, remove this function
12418 from the `before-change-functions' in the current buffer."
12419 (interactive)
12420 (unless org-inhibit-highlight-removal
12421 (mapc 'delete-overlay org-occur-highlights)
12422 (setq org-occur-highlights nil)
12423 (setq org-occur-parameters nil)
12424 (unless noremove
12425 (remove-hook 'before-change-functions
12426 'org-remove-occur-highlights 'local))))
12428 ;;;; Priorities
12431 "Regular expression matching the priority indicator.")
12433 (defvar org-remove-priority-next-time nil)
12435 (defun org-priority-up ()
12436 "Increase the priority of the current item."
12437 (interactive)
12438 (org-priority 'up))
12440 (defun org-priority-down ()
12441 "Decrease the priority of the current item."
12442 (interactive)
12443 (org-priority 'down))
12445 (defun org-priority (&optional action)
12446 "Change the priority of an item by ARG.
12447 ACTION can be `set', `up', `down', or a character."
12448 (interactive)
12449 (unless org-enable-priority-commands
12450 (error "Priority commands are disabled"))
12451 (setq action (or action 'set))
12452 (let (current new news have remove)
12453 (save-excursion
12454 (org-back-to-heading t)
12455 (if (looking-at org-priority-regexp)
12456 (setq current (string-to-char (match-string 2))
12457 have t))
12458 (cond
12459 ((eq action 'remove)
12460 (setq remove t new ?\ ))
12461 ((or (eq action 'set)
12462 (if (featurep 'xemacs) (characterp action) (integerp action)))
12463 (if (not (eq action 'set))
12464 (setq new action)
12465 (message "Priority %c-%c, SPC to remove: "
12466 org-highest-priority org-lowest-priority)
12467 (save-match-data
12468 (setq new (read-char-exclusive))))
12469 (if (and (= (upcase org-highest-priority) org-highest-priority)
12470 (= (upcase org-lowest-priority) org-lowest-priority))
12471 (setq new (upcase new)))
12472 (cond ((equal new ?\ ) (setq remove t))
12473 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12474 (error "Priority must be between `%c' and `%c'"
12475 org-highest-priority org-lowest-priority))))
12476 ((eq action 'up)
12477 (setq new (if have
12478 (1- current) ; normal cycling
12479 ;; last priority was empty
12480 (if (eq last-command this-command)
12481 org-lowest-priority ; wrap around empty to lowest
12482 ;; default
12483 (if org-priority-start-cycle-with-default
12484 org-default-priority
12485 (1- org-default-priority))))))
12486 ((eq action 'down)
12487 (setq new (if have
12488 (1+ current) ; normal cycling
12489 ;; last priority was empty
12490 (if (eq last-command this-command)
12491 org-highest-priority ; wrap around empty to highest
12492 ;; default
12493 (if org-priority-start-cycle-with-default
12494 org-default-priority
12495 (1+ org-default-priority))))))
12496 (t (error "Invalid action")))
12497 (if (or (< (upcase new) org-highest-priority)
12498 (> (upcase new) org-lowest-priority))
12499 (if (and (memq action '(up down))
12500 (not have) (not (eq last-command this-command)))
12501 ;; `new' is from default priority
12502 (error
12503 "The default can not be set, see `org-default-priority' why")
12504 ;; normal cycling: `new' is beyond highest/lowest priority
12505 ;; and is wrapped around to the empty priority
12506 (setq remove t)))
12507 (setq news (format "%c" new))
12508 (if have
12509 (if remove
12510 (replace-match "" t t nil 1)
12511 (replace-match news t t nil 2))
12512 (if remove
12513 (error "No priority cookie found in line")
12514 (let ((case-fold-search nil))
12515 (looking-at org-todo-line-regexp))
12516 (if (match-end 2)
12517 (progn
12518 (goto-char (match-end 2))
12519 (insert " [#" news "]"))
12520 (goto-char (match-beginning 3))
12521 (insert "[#" news "] "))))
12522 (org-preserve-lc (org-set-tags nil 'align)))
12523 (if remove
12524 (message "Priority removed")
12525 (message "Priority of current item set to %s" news))))
12527 (defun org-get-priority (s)
12528 "Find priority cookie and return priority."
12529 (if (functionp org-get-priority-function)
12530 (funcall org-get-priority-function)
12531 (save-match-data
12532 (if (not (string-match org-priority-regexp s))
12533 (* 1000 (- org-lowest-priority org-default-priority))
12534 (* 1000 (- org-lowest-priority
12535 (string-to-char (match-string 2 s))))))))
12537 ;;;; Tags
12539 (defvar org-agenda-archives-mode)
12540 (defvar org-map-continue-from nil
12541 "Position from where mapping should continue.
12542 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12544 (defvar org-scanner-tags nil
12545 "The current tag list while the tags scanner is running.")
12546 (defvar org-trust-scanner-tags nil
12547 "Should `org-get-tags-at' use the tags for the scanner.
12548 This is for internal dynamical scoping only.
12549 When this is non-nil, the function `org-get-tags-at' will return the value
12550 of `org-scanner-tags' instead of building the list by itself. This
12551 can lead to large speed-ups when the tags scanner is used in a file with
12552 many entries, and when the list of tags is retrieved, for example to
12553 obtain a list of properties. Building the tags list for each entry in such
12554 a file becomes an N^2 operation - but with this variable set, it scales
12555 as N.")
12557 (defun org-scan-tags (action matcher &optional todo-only)
12558 "Scan headline tags with inheritance and produce output ACTION.
12560 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12561 or `agenda' to produce an entry list for an agenda view. It can also be
12562 a Lisp form or a function that should be called at each matched headline, in
12563 this case the return value is a list of all return values from these calls.
12565 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12566 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12567 only lines with a TODO keyword are included in the output."
12568 (require 'org-agenda)
12571 (org-re
12573 (props (list 'face 'default
12574 'done-face 'org-agenda-done
12575 'undone-face 'default
12576 'mouse-face 'highlight
12577 'org-not-done-regexp org-not-done-regexp
12578 'org-todo-regexp org-todo-regexp
12579 'help-echo
12580 (format "mouse-2 or RET jump to org file %s"
12581 (abbreviate-file-name
12582 (or (buffer-file-name (buffer-base-buffer))
12583 (buffer-name (buffer-base-buffer)))))))
12584 (case-fold-search nil)
12585 (org-map-continue-from nil)
12586 lspos tags tags-list
12587 (tags-alist (list (cons 0 org-file-tags)))
12588 (llast 0) rtn rtn1 level category i txt
12589 todo marker entry priority)
12590 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12591 (setq action (list 'lambda nil action)))
12592 (save-excursion
12593 (goto-char (point-min))
12594 (when (eq action 'sparse-tree)
12595 (org-overview)
12596 (org-remove-occur-highlights))
12597 (while (re-search-forward re nil t)
12598 (catch :skip
12599 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12600 tags (if (match-end 4) (org-match-string-no-properties 4)))
12601 (goto-char (setq lspos (match-beginning 0)))
12602 (setq level (org-reduced-level (funcall outline-level))
12603 category (org-get-category))
12604 (setq i llast llast level)
12605 ;; remove tag lists from same and sublevels
12606 (while (>= i level)
12607 (when (setq entry (assoc i tags-alist))
12608 (setq tags-alist (delete entry tags-alist)))
12609 (setq i (1- i)))
12610 ;; add the next tags
12611 (when tags
12612 (setq tags (org-split-string tags ":")
12613 tags-alist
12614 (cons (cons level tags) tags-alist)))
12615 ;; compile tags for current headline
12616 (setq tags-list
12617 (if org-use-tag-inheritance
12618 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12619 tags)
12620 org-scanner-tags tags-list)
12621 (when org-use-tag-inheritance
12622 (setcdr (car tags-alist)
12623 (mapcar (lambda (x)
12624 (setq x (copy-sequence x))
12625 (org-add-prop-inherited x))
12626 (cdar tags-alist))))
12627 (when (and tags org-use-tag-inheritance
12628 (or (not (eq t org-use-tag-inheritance))
12629 org-tags-exclude-from-inheritance))
12630 ;; selective inheritance, remove uninherited ones
12631 (setcdr (car tags-alist)
12632 (org-remove-uninherited-tags (cdar tags-alist))))
12633 (when (and
12635 ;; eval matcher only when the todo condition is OK
12636 (and (or (not todo-only) (member todo org-not-done-keywords))
12637 (let ((case-fold-search t)) (eval matcher)))
12639 ;; Call the skipper, but return t if it does not skip,
12640 ;; so that the `and' form continues evaluating
12641 (progn
12642 (unless (eq action 'sparse-tree) (org-agenda-skip))
12643 t)
12645 ;; Check if timestamps are deselecting this entry
12646 (or (not todo-only)
12647 (and (member todo org-not-done-keywords)
12648 (or (not org-agenda-tags-todo-honor-ignore-options)
12649 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12651 ;; Extra check for the archive tag
12652 ;; FIXME: Does the skipper already do this????
12653 (or
12654 (not (member org-archive-tag tags-list))
12655 ;; we have an archive tag, should we use this anyway?
12656 (or (not org-agenda-skip-archived-trees)
12657 (and (eq action 'agenda) org-agenda-archives-mode))))
12659 ;; select this headline
12661 (cond
12662 ((eq action 'sparse-tree)
12663 (and org-highlight-sparse-tree-matches
12664 (org-get-heading) (match-end 0)
12665 (org-highlight-new-match
12666 (match-beginning 0) (match-beginning 1)))
12667 (org-show-context 'tags-tree))
12668 ((eq action 'agenda)
12669 (setq txt (org-format-agenda-item
12670 ""
12671 (concat
12672 (if (eq org-tags-match-list-sublevels 'indented)
12673 (make-string (1- level) ?.) "")
12674 (org-get-heading))
12675 category
12676 tags-list
12677 )
12678 priority (org-get-priority txt))
12679 (goto-char lspos)
12680 (setq marker (org-agenda-new-marker))
12681 (org-add-props txt props
12682 'org-marker marker 'org-hd-marker marker 'org-category category
12683 'todo-state todo
12684 'priority priority 'type "tagsmatch")
12685 (push txt rtn))
12686 ((functionp action)
12687 (setq org-map-continue-from nil)
12688 (save-excursion
12689 (setq rtn1 (funcall action))
12690 (push rtn1 rtn)))
12691 (t (error "Invalid action")))
12693 ;; if we are to skip sublevels, jump to end of subtree
12694 (unless org-tags-match-list-sublevels
12695 (org-end-of-subtree t)
12696 (backward-char 1))))
12697 ;; Get the correct position from where to continue
12698 (if org-map-continue-from
12699 (goto-char org-map-continue-from)
12700 (and (= (point) lspos) (end-of-line 1)))))
12701 (when (and (eq action 'sparse-tree)
12702 (not org-sparse-tree-open-archived-trees))
12703 (org-hide-archived-subtrees (point-min) (point-max)))
12704 (nreverse rtn)))
12706 (defun org-remove-uninherited-tags (tags)
12707 "Remove all tags that are not inherited from the list TAGS."
12708 (cond
12709 ((eq org-use-tag-inheritance t)
12710 (if org-tags-exclude-from-inheritance
12711 (org-delete-all org-tags-exclude-from-inheritance tags)
12712 tags))
12713 ((not org-use-tag-inheritance) nil)
12714 ((stringp org-use-tag-inheritance)
12715 (delq nil (mapcar
12716 (lambda (x)
12717 (if (and (string-match org-use-tag-inheritance x)
12718 (not (member x org-tags-exclude-from-inheritance)))
12719 x nil))
12720 tags)))
12721 ((listp org-use-tag-inheritance)
12722 (delq nil (mapcar
12723 (lambda (x)
12724 (if (member x org-use-tag-inheritance) x nil))
12725 tags)))))
12727 (defvar todo-only) ;; dynamically scoped
12729 (defun org-match-sparse-tree (&optional todo-only match)
12730 "Create a sparse tree according to tags string MATCH.
12731 MATCH can contain positive and negative selection of tags, like
12733 If optional argument TODO-ONLY is non-nil, only select lines that are
12734 also TODO lines."
12735 (interactive "P")
12736 (org-prepare-agenda-buffers (list (current-buffer)))
12737 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12739 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12741 (defvar org-cached-props nil)
12742 (defun org-cached-entry-get (pom property)
12743 (if (or (eq t org-use-property-inheritance)
12744 (and (stringp org-use-property-inheritance)
12745 (string-match org-use-property-inheritance property))
12746 (and (listp org-use-property-inheritance)
12747 (member property org-use-property-inheritance)))
12748 ;; Caching is not possible, check it directly
12749 (org-entry-get pom property 'inherit)
12750 ;; Get all properties, so that we can do complicated checks easily
12751 (cdr (assoc property (or org-cached-props
12752 (setq org-cached-props
12753 (org-entry-properties pom)))))))
12755 (defun org-global-tags-completion-table (&optional files)
12756 "Return the list of all tags in all agenda buffer/files.
12757 Optional FILES argument is a list of files to which can be used
12758 instead of the agenda files."
12759 (save-excursion
12760 (org-uniquify
12761 (delq nil
12762 (apply 'append
12763 (mapcar
12764 (lambda (file)
12765 (set-buffer (find-file-noselect file))
12766 (append (org-get-buffer-tags)
12767 (mapcar (lambda (x) (if (stringp (car-safe x))
12768 (list (car-safe x)) nil))
12769 org-tag-alist)))
12770 (if (and files (car files))
12771 files
12772 (org-agenda-files))))))))
12774 (defun org-make-tags-matcher (match)
12775 "Create the TAGS/TODO matcher form for the selection string MATCH."
12776 ;; todo-only is scoped dynamically into this function, and the function
12777 ;; may change it if the matcher asks for it.
12778 (unless match
12779 ;; Get a new match request, with completion
12780 (let ((org-last-tags-completion-table
12781 (org-global-tags-completion-table)))
12782 (setq match (org-completing-read-no-i
12783 "Match: " 'org-tags-completion-function nil nil nil
12784 'org-tags-history))))
12786 ;; Parse the string and create a lisp form
12787 (let ((match0 match)
12788 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12789 minus tag mm
12790 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12791 orterms term orlist re-p str-p level-p level-op time-p
12792 prop-p pn pv po gv rest)
12793 (if (string-match "/+" match)
12794 ;; match contains also a todo-matching request
12795 (progn
12796 (setq tagsmatch (substring match 0 (match-beginning 0))
12797 todomatch (substring match (match-end 0)))
12798 (if (string-match "^!" todomatch)
12799 (setq todo-only t todomatch (substring todomatch 1)))
12801 (setq todomatch nil)))
12802 ;; only matching tags
12803 (setq tagsmatch match todomatch nil))
12805 ;; Make the tags matcher
12807 (setq tagsmatcher t)
12808 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12809 (while (setq term (pop orterms))
12811 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12812 (while (string-match re term)
12813 (setq rest (substring term (match-end 0))
12814 minus (and (match-end 1)
12815 (equal (match-string 1 term) "-"))
12816 tag (save-match-data (replace-regexp-in-string
12818 (match-string 2 term)))
12819 re-p (equal (string-to-char tag) ?{)
12820 level-p (match-end 4)
12821 prop-p (match-end 5)
12822 mm (cond
12823 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12824 (level-p
12825 (setq level-op (org-op-to-function (match-string 3 term)))
12826 `(,level-op level ,(string-to-number
12827 (match-string 4 term))))
12828 (prop-p
12829 (setq pn (match-string 5 term)
12830 po (match-string 6 term)
12831 pv (match-string 7 term)
12832 re-p (equal (string-to-char pv) ?{)
12834 time-p (save-match-data
12836 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12837 (if time-p (setq pv (org-matcher-time pv)))
12838 (setq po (org-op-to-function po (if time-p 'time str-p)))
12839 (cond
12840 ((equal pn "CATEGORY")
12841 (setq gv '(get-text-property (point) 'org-category)))
12842 ((equal pn "TODO")
12843 (setq gv 'todo))
12844 (t
12845 (setq gv `(org-cached-entry-get nil ,pn))))
12846 (if re-p
12847 (if (eq po 'org<>)
12848 `(not (string-match ,pv (or ,gv "")))
12849 `(string-match ,pv (or ,gv "")))
12850 (if str-p
12851 `(,po (or ,gv "") ,pv)
12852 `(,po (string-to-number (or ,gv ""))
12853 ,(string-to-number pv) ))))
12854 (t `(member ,tag tags-list)))
12855 mm (if minus (list 'not mm) mm)
12856 term rest)
12857 (push mm tagsmatcher))
12858 (push (if (> (length tagsmatcher) 1)
12859 (cons 'and tagsmatcher)
12860 (car tagsmatcher))
12861 orlist)
12862 (setq tagsmatcher nil))
12863 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12864 (setq tagsmatcher
12865 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12866 ;; Make the todo matcher
12868 (setq todomatcher t)
12869 (setq orterms (org-split-string todomatch "|") orlist nil)
12870 (while (setq term (pop orterms))
12871 (while (string-match re term)
12872 (setq minus (and (match-end 1)
12873 (equal (match-string 1 term) "-"))
12874 kwd (match-string 2 term)
12875 re-p (equal (string-to-char kwd) ?{)
12876 term (substring term (match-end 0))
12877 mm (if re-p
12878 `(string-match ,(substring kwd 1 -1) todo)
12879 (list 'equal 'todo kwd))
12880 mm (if minus (list 'not mm) mm))
12881 (push mm todomatcher))
12882 (push (if (> (length todomatcher) 1)
12883 (cons 'and todomatcher)
12884 (car todomatcher))
12885 orlist)
12886 (setq todomatcher nil))
12887 (setq todomatcher (if (> (length orlist) 1)
12888 (cons 'or orlist) (car orlist))))
12890 ;; Return the string and lisp forms of the matcher
12891 (setq matcher (if todomatcher
12892 (list 'and tagsmatcher todomatcher)
12893 tagsmatcher))
12894 (cons match0 matcher)))
12896 (defun org-op-to-function (op &optional stringp)
12897 "Turn an operator into the appropriate function."
12898 (setq op
12899 (cond
12900 ((equal op "<" ) '(< string< org-time<))
12901 ((equal op ">" ) '(> org-string> org-time>))
12902 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12903 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12904 ((member op '("=" "==")) '(= string= org-time=))
12905 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12906 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12908 (defun org<> (a b) (not (= a b)))
12909 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12910 (defun org-string>= (a b) (not (string< a b)))
12911 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12912 (defun org-string<> (a b) (not (string= a b)))
12913 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12914 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12915 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12916 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12917 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12918 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12919 (defun org-2ft (s)
12920 "Convert S to a floating point time.
12921 If S is already a number, just return it. If it is a string, parse
12922 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12923 (cond
12924 ((numberp s) s)
12925 ((stringp s)
12926 (condition-case nil
12927 (float-time (apply 'encode-time (org-parse-time-string s)))
12928 (error 0.)))
12929 (t 0.)))
12931 (defun org-time-today ()
12932 "Time in seconds today at 0:00.
12933 Returns the float number of seconds since the beginning of the
12934 epoch to the beginning of today (00:00)."
12935 (float-time (apply 'encode-time
12936 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12938 (defun org-matcher-time (s)
12939 "Interpret a time comparison value."
12940 (save-match-data
12941 (cond
12942 ((string= s "<now>") (float-time))
12943 ((string= s "<today>") (org-time-today))
12944 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12945 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12947 (+ (org-time-today)
12948 (* (string-to-number (match-string 1 s))
12949 (cdr (assoc (match-string 2 s)
12950 '(("d" . 86400.0) ("w" . 604800.0)
12951 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12952 (t (org-2ft s)))))
12954 (defun org-match-any-p (re list)
12955 "Does re match any element of list?"
12956 (setq list (mapcar (lambda (x) (string-match re x)) list))
12957 (delq nil list))
12959 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12960 (defvar org-tags-overlay (make-overlay 1 1))
12961 (org-detach-overlay org-tags-overlay)
12963 (defun org-get-local-tags-at (&optional pos)
12964 "Get a list of tags defined in the current headline."
12965 (org-get-tags-at pos 'local))
12967 (defun org-get-local-tags ()
12968 "Get a list of tags defined in the current headline."
12969 (org-get-tags-at nil 'local))
12971 (defun org-get-tags-at (&optional pos local)
12972 "Get a list of all headline tags applicable at POS.
12973 POS defaults to point. If tags are inherited, the list contains
12974 the targets in the same sequence as the headlines appear, i.e.
12975 the tags of the current headline come last.
12976 When LOCAL is non-nil, only return tags from the current headline,
12977 ignore inherited ones."
12978 (interactive)
12979 (if (and org-trust-scanner-tags
12980 (or (not pos) (equal pos (point)))
12981 (not local))
12982 org-scanner-tags
12983 (let (tags ltags lastpos parent)
12984 (save-excursion
12985 (save-restriction
12986 (widen)
12987 (goto-char (or pos (point)))
12988 (save-match-data
12989 (catch 'done
12990 (condition-case nil
12991 (progn
12992 (org-back-to-heading t)
12993 (while (not (equal lastpos (point)))
12994 (setq lastpos (point))
12995 (when (looking-at
12997 (setq ltags (org-split-string
12998 (org-match-string-no-properties 1) ":"))
12999 (when parent
13000 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13001 (setq tags (append
13002 (if parent
13003 (org-remove-uninherited-tags ltags)
13004 ltags)
13005 tags)))
13006 (or org-use-tag-inheritance (throw 'done t))
13007 (if local (throw 'done t))
13008 (or (org-up-heading-safe) (error nil))
13009 (setq parent t)))
13010 (error nil)))))
13011 (if local
13012 tags
13013 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13015 (defun org-add-prop-inherited (s)
13016 (add-text-properties 0 (length s) '(inherited t) s)
13017 s)
13019 (defun org-toggle-tag (tag &optional onoff)
13020 "Toggle the tag TAG for the current line.
13021 If ONOFF is `on' or `off', don't toggle but set to this state."
13022 (let (res current)
13023 (save-excursion
13024 (org-back-to-heading t)
13026 (point-at-eol) t)
13027 (progn
13028 (setq current (match-string 1))
13029 (replace-match ""))
13030 (setq current ""))
13031 (setq current (nreverse (org-split-string current ":")))
13032 (cond
13033 ((eq onoff 'on)
13034 (setq res t)
13035 (or (member tag current) (push tag current)))
13036 ((eq onoff 'off)
13037 (or (not (member tag current)) (setq current (delete tag current))))
13038 (t (if (member tag current)
13039 (setq current (delete tag current))
13040 (setq res t)
13041 (push tag current))))
13042 (end-of-line 1)
13043 (if current
13044 (progn
13045 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13046 (org-set-tags nil t))
13047 (delete-horizontal-space))
13048 (run-hooks 'org-after-tags-change-hook))
13049 res))
13051 (defun org-align-tags-here (to-col)
13052 ;; Assumes that this is a headline
13053 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13054 (beginning-of-line 1)
13056 (< pos (match-beginning 2)))
13057 (progn
13058 (setq tags-l (- (match-end 2) (match-beginning 2)))
13059 (goto-char (match-beginning 1))
13060 (insert " ")
13061 (delete-region (point) (1+ (match-beginning 2)))
13062 (setq ncol (max (1+ (current-column))
13063 (1+ col)
13064 (if (> to-col 0)
13065 to-col
13066 (- (abs to-col) tags-l))))
13067 (setq p (point))
13068 (insert (make-string (- ncol (current-column)) ?\ ))
13069 (setq ncol (current-column))
13070 (when indent-tabs-mode (tabify p (point-at-eol)))
13071 (org-move-to-column (min ncol col) t))
13072 (goto-char pos))))
13074 (defun org-set-tags-command (&optional arg just-align)
13075 "Call the set-tags command for the current entry."
13076 (interactive "P")
13077 (if (org-on-heading-p)
13078 (org-set-tags arg just-align)
13079 (save-excursion
13080 (org-back-to-heading t)
13081 (org-set-tags arg just-align))))
13083 (defun org-set-tags-to (data)
13084 "Set the tags of the current entry to DATA, replacing the current tags.
13085 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13086 If DATA is nil or the empty string, any tags will be removed."
13087 (interactive "sTags: ")
13088 (setq data
13089 (cond
13090 ((eq data nil) "")
13091 ((equal data "") "")
13092 ((stringp data)
13093 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13094 ":"))
13095 ((listp data)
13096 (concat ":" (mapconcat 'identity data ":") ":"))
13097 (t nil)))
13098 (when data
13099 (save-excursion
13100 (org-back-to-heading t)
13101 (when (looking-at org-complex-heading-regexp)
13102 (if (match-end 5)
13103 (progn
13104 (goto-char (match-beginning 5))
13105 (insert data)
13106 (delete-region (point) (point-at-eol))
13107 (org-set-tags nil 'align))
13108 (goto-char (point-at-eol))
13109 (insert " " data)
13110 (org-set-tags nil 'align)))
13111 (beginning-of-line 1)
13113 (delete-region (match-beginning 1) (match-end 1))))))
13115 (defun org-align-all-tags ()
13116 "Align the tags i all headings."
13117 (interactive)
13118 (save-excursion
13119 (or (ignore-errors (org-back-to-heading t))
13120 (outline-next-heading))
13121 (if (org-on-heading-p)
13122 (org-set-tags t)
13123 (message "No headings"))))
13125 (defvar org-indent-indentation-per-level)
13126 (defun org-set-tags (&optional arg just-align)
13127 "Set the tags for the current headline.
13128 With prefix ARG, realign all tags in headings in the current buffer."
13129 (interactive "P")
13130 (let* ((re org-outline-regexp-bol)
13131 (current (org-get-tags-string))
13132 (col (current-column))
13133 (org-setting-tags t)
13134 table current-tags inherited-tags ; computed below when needed
13135 tags p0 c0 c1 rpl di tc level)
13136 (if arg
13137 (save-excursion
13138 (goto-char (point-min))
13139 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13140 (while (re-search-forward re nil t)
13141 (org-set-tags nil t)
13142 (end-of-line 1)))
13143 (message "All tags realigned to column %d" org-tags-column))
13144 (if just-align
13145 (setq tags current)
13146 ;; Get a new set of tags from the user
13147 (save-excursion
13148 (setq table (append org-tag-persistent-alist
13149 (or org-tag-alist (org-get-buffer-tags))
13150 (and
13151 org-complete-tags-always-offer-all-agenda-tags
13152 (org-global-tags-completion-table
13153 (org-agenda-files))))
13154 org-last-tags-completion-table table
13155 current-tags (org-split-string current ":")
13156 inherited-tags (nreverse
13157 (nthcdr (length current-tags)
13158 (nreverse (org-get-tags-at))))
13159 tags
13160 (if (or (eq t org-use-fast-tag-selection)
13161 (and org-use-fast-tag-selection
13162 (delq nil (mapcar 'cdr table))))
13163 (org-fast-tag-selection
13164 current-tags inherited-tags table
13165 (if org-fast-tag-selection-include-todo
13166 org-todo-key-alist))
13167 (let ((org-add-colon-after-tag-completion t))
13168 (org-trim
13169 (org-icompleting-read "Tags: "
13170 'org-tags-completion-function
13171 nil nil current 'org-tags-history))))))
13172 (while (string-match "[-+&]+" tags)
13173 ;; No boolean logic, just a list
13174 (setq tags (replace-match ":" t t tags))))
13176 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13178 (if org-tags-sort-function
13179 (setq tags (mapconcat 'identity
13180 (sort (org-split-string
13181 tags (org-re "[^[:alnum:]_@#%]+"))
13182 org-tags-sort-function) ":")))
13185 (setq tags "")
13186 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13187 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13189 ;; Insert new tags at the correct column
13190 (beginning-of-line 1)
13191 (setq level (or (and (looking-at org-outline-regexp)
13192 (- (match-end 0) (point) 1))
13193 1))
13194 (cond
13195 ((and (equal current "") (equal tags "")))
13196 ((re-search-forward
13198 (point-at-eol) t)
13199 (if (equal tags "")
13200 (setq rpl "")
13201 (goto-char (match-beginning 0))
13202 (setq c0 (current-column)
13203 ;; compute offset for the case of org-indent-mode active
13204 di (if org-indent-mode
13205 (* (1- org-indent-indentation-per-level) (1- level))
13206 0)
13207 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13208 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13209 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13210 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13211 (replace-match rpl t t)
13212 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13213 tags)
13214 (t (error "Tags alignment failed")))
13215 (org-move-to-column col)
13216 (unless just-align
13217 (run-hooks 'org-after-tags-change-hook)))))
13219 (defun org-change-tag-in-region (beg end tag off)
13220 "Add or remove TAG for each entry in the region.
13221 This works in the agenda, and also in an org-mode buffer."
13222 (interactive
13223 (list (region-beginning) (region-end)
13224 (let ((org-last-tags-completion-table
13225 (if (org-mode-p)
13226 (org-get-buffer-tags)
13227 (org-global-tags-completion-table))))
13228 (org-icompleting-read
13229 "Tag: " 'org-tags-completion-function nil nil nil
13230 'org-tags-history))
13231 (progn
13233 (equal (read-char-exclusive) ?r))))
13234 (if (fboundp 'deactivate-mark) (deactivate-mark))
13235 (let ((agendap (equal major-mode 'org-agenda-mode))
13236 l1 l2 m buf pos newhead (cnt 0))
13237 (goto-char end)
13238 (setq l2 (1- (org-current-line)))
13239 (goto-char beg)
13240 (setq l1 (org-current-line))
13241 (loop for l from l1 to l2 do
13242 (org-goto-line l)
13243 (setq m (get-text-property (point) 'org-hd-marker))
13244 (when (or (and (org-mode-p) (org-on-heading-p))
13245 (and agendap m))
13246 (setq buf (if agendap (marker-buffer m) (current-buffer))
13247 pos (if agendap m (point)))
13248 (with-current-buffer buf
13249 (save-excursion
13250 (save-restriction
13251 (goto-char pos)
13252 (setq cnt (1+ cnt))
13253 (org-toggle-tag tag (if off 'off 'on))
13254 (setq newhead (org-get-heading)))))
13255 (and agendap (org-agenda-change-all-lines newhead m))))
13256 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13258 (defun org-tags-completion-function (string predicate &optional flag)
13259 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13260 (confirm (lambda (x) (stringp (car x)))))
13262 (setq s1 (match-string 1 string)
13263 s2 (match-string 2 string))
13264 (setq s1 "" s2 string))
13265 (cond
13266 ((eq flag nil)
13267 ;; try completion
13268 (setq rtn (try-completion s2 ctable confirm))
13269 (if (stringp rtn)
13270 (setq rtn
13271 (concat s1 s2 (substring rtn (length s2))
13272 (if (and org-add-colon-after-tag-completion
13273 (assoc rtn ctable))
13274 ":" ""))))
13275 rtn)
13276 ((eq flag t)
13277 ;; all-completions
13278 (all-completions s2 ctable confirm)
13279 )
13280 ((eq flag 'lambda)
13281 ;; exact match?
13282 (assoc s2 ctable)))
13283 ))
13285 (defun org-fast-tag-insert (kwd tags face &optional end)
13286 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13287 (insert (format "%-12s" (concat kwd ":"))
13288 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13289 (or end "")))
13291 (defun org-fast-tag-show-exit (flag)
13292 (save-excursion
13293 (org-goto-line 3)
13295 (replace-match ""))
13296 (when flag
13297 (end-of-line 1)
13298 (org-move-to-column (- (window-width) 19) t)
13299 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13301 (defun org-set-current-tags-overlay (current prefix)
13302 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13303 (if (featurep 'xemacs)
13304 (org-overlay-display org-tags-overlay (concat prefix s)
13305 'secondary-selection)
13306 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13307 (org-overlay-display org-tags-overlay (concat prefix s)))))
13309 (defvar org-last-tag-selection-key nil)
13310 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13311 "Fast tag selection with single keys.
13312 CURRENT is the current list of tags in the headline, INHERITED is the
13313 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13314 possibly with grouping information. TODO-TABLE is a similar table with
13315 TODO keywords, should these have keys assigned to them.
13316 If the keys are nil, a-z are automatically assigned.
13317 Returns the new tags string, or nil to not change the current settings."
13318 (let* ((fulltable (append table todo-table))
13319 (maxlen (apply 'max (mapcar
13320 (lambda (x)
13321 (if (stringp (car x)) (string-width (car x)) 0))
13322 fulltable)))
13323 (buf (current-buffer))
13324 (expert (eq org-fast-tag-selection-single-key 'expert))
13325 (buffer-tags nil)
13326 (fwidth (+ maxlen 3 1 3))
13327 (ncol (/ (- (window-width) 4) fwidth))
13328 (i-face 'org-done)
13329 (c-face 'org-todo)
13330 tg cnt e c char c1 c2 ntable tbl rtn
13331 ov-start ov-end ov-prefix
13332 (exit-after-next org-fast-tag-selection-single-key)
13333 (done-keywords org-done-keywords)
13334 groups ingroup)
13335 (save-excursion
13336 (beginning-of-line 1)
13337 (if (looking-at
13339 (setq ov-start (match-beginning 1)
13340 ov-end (match-end 1)
13341 ov-prefix "")
13342 (setq ov-start (1- (point-at-eol))
13343 ov-end (1+ ov-start))
13345 (setq ov-prefix
13346 (concat
13347 (buffer-substring (1- (point)) (point))
13348 (if (> (current-column) org-tags-column)
13349 " "
13350 (make-string (- org-tags-column (current-column)) ?\ ))))))
13351 (move-overlay org-tags-overlay ov-start ov-end)
13352 (save-window-excursion
13353 (if expert
13354 (set-buffer (get-buffer-create " *Org tags*"))
13355 (delete-other-windows)
13356 (split-window-vertically)
13357 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13358 (erase-buffer)
13359 (org-set-local 'org-done-keywords done-keywords)
13362 (org-fast-tag-show-exit exit-after-next)
13363 (org-set-current-tags-overlay current ov-prefix)
13364 (setq tbl fulltable char ?a cnt 0)
13365 (while (setq e (pop tbl))
13366 (cond
13367 ((equal (car e) :startgroup)
13368 (push '() groups) (setq ingroup t)
13369 (when (not (= cnt 0))
13370 (setq cnt 0)
13372 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13373 ((equal (car e) :endgroup)
13374 (setq ingroup nil cnt 0)
13376 ((equal e '(:newline))
13377 (when (not (= cnt 0))
13378 (setq cnt 0)
13380 (setq e (car tbl))
13381 (while (equal (car tbl) '(:newline))
13383 (setq tbl (cdr tbl)))))
13384 (t
13385 (setq tg (copy-sequence (car e)) c2 nil)
13386 (if (cdr e)
13387 (setq c (cdr e))
13388 ;; automatically assign a character.
13389 (setq c1 (string-to-char
13390 (downcase (substring
13391 tg (if (= (string-to-char tg) ?@) 1 0)))))
13392 (if (or (rassoc c1 ntable) (rassoc c1 table))
13393 (while (or (rassoc char ntable) (rassoc char table))
13394 (setq char (1+ char)))
13395 (setq c2 c1))
13396 (setq c (or c2 char)))
13397 (if ingroup (push tg (car groups)))
13398 (setq tg (org-add-props tg nil 'face
13399 (cond
13400 ((not (assoc tg table))
13401 (org-get-todo-face tg))
13402 ((member tg current) c-face)
13403 ((member tg inherited) i-face)
13404 (t nil))))
13405 (if (and (= cnt 0) (not ingroup)) (insert " "))
13406 (insert "[" c "] " tg (make-string
13407 (- fwidth 4 (length tg)) ?\ ))
13408 (push (cons tg c) ntable)
13409 (when (= (setq cnt (1+ cnt)) ncol)
13411 (if ingroup (insert " "))
13412 (setq cnt 0)))))
13413 (setq ntable (nreverse ntable))
13415 (goto-char (point-min))
13416 (if (not expert) (org-fit-window-to-buffer))
13417 (setq rtn
13418 (catch 'exit
13419 (while t
13420 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13421 (if (not groups) "no " "")
13422 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13423 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13424 (setq org-last-tag-selection-key c)
13425 (cond
13427 ((= c ?!)
13428 (setq groups (not groups))
13429 (goto-char (point-min))
13430 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13431 ((= c ?\C-c)
13432 (if (not expert)
13433 (org-fast-tag-show-exit
13434 (setq exit-after-next (not exit-after-next)))
13435 (setq expert nil)
13436 (delete-other-windows)
13437 (set-window-buffer (split-window-vertically) " *Org tags*")
13438 (org-switch-to-buffer-other-window " *Org tags*")
13439 (org-fit-window-to-buffer)))
13440 ((or (= c ?\C-g)
13441 (and (= c ?q) (not (rassoc c ntable))))
13442 (org-detach-overlay org-tags-overlay)
13443 (setq quit-flag t))
13444 ((= c ?\ )
13445 (setq current nil)
13446 (if exit-after-next (setq exit-after-next 'now)))
13448 (condition-case nil
13449 (setq tg (org-icompleting-read
13450 "Tag: "
13451 (or buffer-tags
13452 (with-current-buffer buf
13453 (org-get-buffer-tags)))))
13454 (quit (setq tg "")))
13456 (add-to-list 'buffer-tags (list tg))
13457 (if (member tg current)
13458 (setq current (delete tg current))
13459 (push tg current)))
13460 (if exit-after-next (setq exit-after-next 'now)))
13461 ((setq e (rassoc c todo-table) tg (car e))
13462 (with-current-buffer buf
13463 (save-excursion (org-todo tg)))
13464 (if exit-after-next (setq exit-after-next 'now)))
13465 ((setq e (rassoc c ntable) tg (car e))
13466 (if (member tg current)
13467 (setq current (delete tg current))
13468 (loop for g in groups do
13469 (if (member tg g)
13470 (mapc (lambda (x)
13471 (setq current (delete x current)))
13472 g)))
13473 (push tg current))
13474 (if exit-after-next (setq exit-after-next 'now))))
13476 ;; Create a sorted list
13477 (setq current
13478 (sort current
13479 (lambda (a b)
13480 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13481 (if (eq exit-after-next 'now) (throw 'exit t))
13482 (goto-char (point-min))
13483 (beginning-of-line 2)
13484 (delete-region (point) (point-at-eol))
13485 (org-fast-tag-insert "Current" current c-face)
13486 (org-set-current-tags-overlay current ov-prefix)
13487 (while (re-search-forward
13489 (setq tg (match-string 1))
13490 (add-text-properties
13491 (match-beginning 1) (match-end 1)
13492 (list 'face
13493 (cond
13494 ((member tg current) c-face)
13495 ((member tg inherited) i-face)
13496 (t (get-text-property (match-beginning 1) 'face))))))
13497 (goto-char (point-min)))))
13498 (org-detach-overlay org-tags-overlay)
13499 (if rtn
13500 (mapconcat 'identity current ":")
13501 nil))))
13503 (defun org-get-tags-string ()
13504 "Get the TAGS string in the current headline."
13505 (unless (org-on-heading-p t)
13506 (error "Not on a heading"))
13507 (save-excursion
13508 (beginning-of-line 1)
13510 (org-match-string-no-properties 1)
13511 "")))
13513 (defun org-get-tags ()
13514 "Get the list of tags specified in the current headline."
13515 (org-split-string (org-get-tags-string) ":"))
13517 (defun org-get-buffer-tags ()
13518 "Get a table of all tags used in the buffer, for completion."
13519 (let (tags)
13520 (save-excursion
13521 (goto-char (point-min))
13522 (while (re-search-forward
13524 (when (equal (char-after (point-at-bol 0)) ?*)
13525 (mapc (lambda (x) (add-to-list 'tags x))
13526 (org-split-string (org-match-string-no-properties 1) ":")))))
13527 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13528 (mapcar 'list tags)))
13530 ;;;; The mapping API
13532 ;;;###autoload
13533 (defun org-map-entries (func &optional match scope &rest skip)
13534 "Call FUNC at each headline selected by MATCH in SCOPE.
13536 FUNC is a function or a lisp form. The function will be called without
13537 arguments, with the cursor positioned at the beginning of the headline.
13538 The return values of all calls to the function will be collected and
13539 returned as a list.
13541 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13542 does not need to preserve point. After evaluation, the cursor will be
13543 moved to the end of the line (presumably of the headline of the
13544 processed entry) and search continues from there. Under some
13545 circumstances, this may not produce the wanted results. For example,
13546 if you have removed (e.g. archived) the current (sub)tree it could
13547 mean that the next entry will be skipped entirely. In such cases, you
13548 can specify the position from where search should continue by making
13549 FUNC set the variable `org-map-continue-from' to the desired buffer
13550 position.
13552 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13553 Only headlines that are matched by this query will be considered during
13554 the iteration. When MATCH is nil or t, all headlines will be
13555 visited by the iteration.
13557 SCOPE determines the scope of this command. It can be any of:
13559 nil The current buffer, respecting the restriction if any
13560 tree The subtree started with the entry at point
13561 region The entries within the active region, if any
13562 file The current buffer, without restriction
13563 file-with-archives
13564 The current buffer, and any archives associated with it
13565 agenda All agenda files
13566 agenda-with-archives
13567 All agenda files with any archive files associated with them
13568 \(file1 file2 ...)
13569 If this is a list, all files in the list will be scanned
13571 The remaining args are treated as settings for the skipping facilities of
13572 the scanner. The following items can be given here:
13574 archive skip trees with the archive tag.
13575 comment skip trees with the COMMENT keyword
13576 function or Emacs Lisp form:
13577 will be used as value for `org-agenda-skip-function', so whenever
13578 the function returns t, FUNC will not be called for that
13579 entry and search will continue from the point where the
13580 function leaves it.
13582 If your function needs to retrieve the tags including inherited tags
13583 at the *current* entry, you can use the value of the variable
13584 `org-scanner-tags' which will be much faster than getting the value
13585 with `org-get-tags-at'. If your function gets properties with
13586 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13587 to t around the call to `org-entry-properties' to get the same speedup.
13588 Note that if your function moves around to retrieve tags and properties at
13589 a *different* entry, you cannot use these techniques."
13590 (let* ((org-agenda-archives-mode nil) ; just to make sure
13591 (org-agenda-skip-archived-trees (memq 'archive skip))
13592 (org-agenda-skip-comment-trees (memq 'comment skip))
13593 (org-agenda-skip-function
13594 (car (org-delete-all '(comment archive) skip)))
13595 (org-tags-match-list-sublevels t)
13596 matcher file res
13597 org-todo-keywords-for-agenda
13598 org-done-keywords-for-agenda
13599 org-todo-keyword-alist-for-agenda
13600 org-drawers-for-agenda
13601 org-tag-alist-for-agenda)
13603 (cond
13604 ((eq match t) (setq matcher t))
13605 ((eq match nil) (setq matcher t))
13606 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13608 (save-excursion
13609 (save-restriction
13610 (cond ((eq scope 'tree)
13611 (org-back-to-heading t)
13612 (org-narrow-to-subtree)
13613 (setq scope nil))
13614 ((and (eq scope 'region) (org-region-active-p))
13615 (narrow-to-region (region-beginning) (region-end))
13616 (setq scope nil)))
13618 (if (not scope)
13619 (progn
13620 (org-prepare-agenda-buffers
13621 (list (buffer-file-name (current-buffer))))
13622 (setq res (org-scan-tags func matcher)))
13623 ;; Get the right scope
13624 (cond
13625 ((and scope (listp scope) (symbolp (car scope)))
13626 (setq scope (eval scope)))
13627 ((eq scope 'agenda)
13628 (setq scope (org-agenda-files t)))
13629 ((eq scope 'agenda-with-archives)
13630 (setq scope (org-agenda-files t))
13631 (setq scope (org-add-archive-files scope)))
13632 ((eq scope 'file)
13633 (setq scope (list (buffer-file-name))))
13634 ((eq scope 'file-with-archives)
13635 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13636 (org-prepare-agenda-buffers scope)
13637 (while (setq file (pop scope))
13638 (with-current-buffer (org-find-base-buffer-visiting file)
13639 (save-excursion
13640 (save-restriction
13641 (widen)
13642 (goto-char (point-min))
13643 (setq res (append res (org-scan-tags func matcher))))))))))
13644 res))
13646 ;;;; Properties
13648 ;;; Setting and retrieving properties
13650 (defconst org-special-properties
13651 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13652 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13653 "The special properties valid in Org-mode.
13655 These are properties that are not defined in the property drawer,
13656 but in some other way.")
13658 (defconst org-default-properties
13659 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13660 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13661 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13662 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13663 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13664 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13665 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13666 "Some properties that are used by Org-mode for various purposes.
13667 Being in this list makes sure that they are offered for completion.")
13670 "Regular expression matching the first line of a property drawer.")
13673 "Regular expression matching the last line of a property drawer.")
13676 "Regular expression matching the first line of a property drawer.")
13679 "Regular expression matching the first line of a property drawer.")
13681 (defconst org-property-drawer-re
13684 "Matches an entire property drawer.")
13686 (defconst org-clock-drawer-re
13689 "Matches an entire clock drawer.")
13691 (defsubst org-re-property (property)
13692 "Return a regexp matching PROPERTY.
13693 Match group 1 will be set to the value "
13696 (defun org-property-action ()
13697 "Do an action on properties."
13698 (interactive)
13699 (let (c)
13700 (org-at-property-p)
13701 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13702 (setq c (read-char-exclusive))
13703 (cond
13704 ((equal c ?s)
13705 (call-interactively 'org-set-property))
13706 ((equal c ?d)
13707 (call-interactively 'org-delete-property))
13708 ((equal c ?D)
13709 (call-interactively 'org-delete-property-globally))
13710 ((equal c ?c)
13711 (call-interactively 'org-compute-property-at-point))
13712 (t (error "No such property action %c" c)))))
13714 (defun org-set-effort (&optional value)
13715 "Set the effort property of the current entry.
13716 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13717 allowed value."
13718 (interactive "P")
13719 (if (equal value 0) (setq value 10))
13720 (let* ((completion-ignore-case t)
13721 (prop org-effort-property)
13722 (cur (org-entry-get nil prop))
13723 (allowed (org-property-get-allowed-values nil prop 'table))
13724 (existing (mapcar 'list (org-property-values prop)))
13725 rpl
13726 (val (cond
13727 ((stringp value) value)
13728 ((and allowed (integerp value))
13729 (or (car (nth (1- value) allowed))
13730 (car (org-last allowed))))
13731 (allowed
13732 (message "Select 1-9,0, [RET%s]: %s"
13733 (if cur (concat "=" cur) "")
13734 (mapconcat 'car allowed " "))
13735 (setq rpl (read-char-exclusive))
13737 cur
13738 (setq rpl (- rpl ?0))
13739 (if (equal rpl 0) (setq rpl 10))
13740 (if (and (> rpl 0) (<= rpl (length allowed)))
13741 (car (nth (1- rpl) allowed))
13742 (org-completing-read "Effort: " allowed nil))))
13743 (t
13744 (let (org-completion-use-ido org-completion-use-iswitchb)
13745 (org-completing-read
13747 (concat "[" cur "]") "")
13748 ": ")
13749 existing nil nil "" nil cur))))))
13750 (unless (equal (org-entry-get nil prop) val)
13751 (org-entry-put nil prop val))
13752 (message "%s is now %s" prop val)))
13754 (defun org-at-property-p ()
13755 "Is cursor inside a property drawer?"
13756 (save-excursion
13757 (beginning-of-line 1)
13759 (save-match-data ;; Used by calling procedures
13760 (let ((p (point))
13761 (range (unless (org-before-first-heading-p)
13762 (org-get-property-block))))
13763 (and range (<= (car range) p) (< p (cdr range))))))))
13765 (defun org-get-property-block (&optional beg end force)
13766 "Return the (beg . end) range of the body of the property drawer.
13767 BEG and END can be beginning and end of subtree, if not given
13768 they will be found.
13769 If the drawer does not exist and FORCE is non-nil, create the drawer."
13770 (catch 'exit
13771 (save-excursion
13772 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13773 (end (or end (progn (outline-next-heading) (point)))))
13774 (goto-char beg)
13775 (if (re-search-forward org-property-start-re end t)
13776 (setq beg (1+ (match-end 0)))
13777 (if force
13778 (save-excursion
13779 (org-insert-property-drawer)
13780 (setq end (progn (outline-next-heading) (point))))
13781 (throw 'exit nil))
13782 (goto-char beg)
13783 (if (re-search-forward org-property-start-re end t)
13784 (setq beg (1+ (match-end 0)))))
13785 (if (re-search-forward org-property-end-re end t)
13786 (setq end (match-beginning 0))
13787 (or force (throw 'exit nil))
13788 (goto-char beg)
13789 (setq end beg)
13790 (org-indent-line-function)
13792 (cons beg end)))))
13794 (defun org-entry-properties (&optional pom which specific)
13795 "Get all properties of the entry at point-or-marker POM.
13796 This includes the TODO keyword, the tags, time strings for deadline,
13797 scheduled, and clocking, and any additional properties defined in the
13798 entry. The return value is an alist, keys may occur multiple times
13799 if the property key was used several times.
13800 POM may also be nil, in which case the current entry is used.
13801 If WHICH is nil or `all', get all properties. If WHICH is
13802 `special' or `standard', only get that subclass. If WHICH
13803 is a string only get exactly this property. SPECIFIC can be a string, the
13804 specific property we are interested in. Specifying it can speed
13805 things up because then unnecessary parsing is avoided."
13806 (setq which (or which 'all))
13807 (org-with-point-at pom
13808 (let ((clockstr (substring org-clock-string 0 -1))
13809 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13810 (case-fold-search nil)
13811 beg end range props sum-props key key1 value string clocksum)
13812 (save-excursion
13813 (when (condition-case nil
13814 (and (org-mode-p) (org-back-to-heading t))
13815 (error nil))
13816 (setq beg (point))
13817 (setq sum-props (get-text-property (point) 'org-summaries))
13818 (setq clocksum (get-text-property (point) :org-clock-minutes))
13819 (outline-next-heading)
13820 (setq end (point))
13821 (when (memq which '(all special))
13822 ;; Get the special properties, like TODO and tags
13823 (goto-char beg)
13824 (when (and (or (not specific) (string= specific "TODO"))
13825 (looking-at org-todo-line-regexp) (match-end 2))
13826 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13827 (when (and (or (not specific) (string= specific "PRIORITY"))
13828 (looking-at org-priority-regexp))
13829 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13830 (when (or (not specific) (string= specific "FILE"))
13831 (push (cons "FILE" buffer-file-name) props))
13832 (when (and (or (not specific) (string= specific "TAGS"))
13833 (setq value (org-get-tags-string))
13835 (push (cons "TAGS" value) props))
13836 (when (and (or (not specific) (string= specific "ALLTAGS"))
13837 (setq value (org-get-tags-at)))
13838 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13839 ":"))
13840 props))
13841 (when (or (not specific) (string= specific "BLOCKED"))
13842 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13843 (when (or (not specific)
13844 (member specific
13845 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13846 "TIMESTAMP" "TIMESTAMP_IA")))
13847 (catch 'match
13848 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13849 (setq key (if (match-end 1)
13850 (substring (org-match-string-no-properties 1)
13851 0 -1))
13852 string (if (equal key clockstr)
13853 (org-no-properties
13854 (org-trim
13855 (buffer-substring
13856 (match-beginning 3) (goto-char
13857 (point-at-eol)))))
13858 (substring (org-match-string-no-properties 3)
13859 1 -1)))
13860 ;; Get the correct property name from the key. This is
13861 ;; necessary if the user has configured time keywords.
13862 (setq key1 (concat key ":"))
13863 (cond
13864 ((not key)
13865 (setq key
13866 (if (= (char-after (match-beginning 3)) ?\[)
13867 "TIMESTAMP_IA" "TIMESTAMP")))
13868 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13869 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13870 ((equal key1 org-closed-string) (setq key "CLOSED"))
13871 ((equal key1 org-clock-string) (setq key "CLOCK")))
13872 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13873 (progn
13874 (push (cons key string) props)
13875 ;; no need to search further if match is found
13876 (throw 'match t))
13877 (when (or (equal key "CLOCK") (not (assoc key props)))
13878 (push (cons key string) props))))))
13879 )
13881 (when (memq which '(all standard))
13882 ;; Get the standard properties, like :PROP: ...
13883 (setq range (org-get-property-block beg end))
13884 (when range
13885 (goto-char (car range))
13886 (while (re-search-forward
13888 (cdr range) t)
13889 (setq key (org-match-string-no-properties 1)
13890 value (org-trim (or (org-match-string-no-properties 2) "")))
13891 (unless (member key excluded)
13892 (push (cons key (or value "")) props)))))
13893 (if clocksum
13894 (push (cons "CLOCKSUM"
13895 (org-columns-number-to-string (/ (float clocksum) 60.)
13896 'add_times))
13897 props))
13898 (unless (assoc "CATEGORY" props)
13899 (push (cons "CATEGORY" (org-get-category)) props))
13900 (append sum-props (nreverse props)))))))
13902 (defun org-entry-get (pom property &optional inherit literal-nil)
13903 "Get value of PROPERTY for entry at point-or-marker POM.
13904 If INHERIT is non-nil and the entry does not have the property,
13905 then also check higher levels of the hierarchy.
13906 If INHERIT is the symbol `selective', use inheritance only if the setting
13907 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13908 If the property is present but empty, the return value is the empty string.
13909 If the property is not present at all, nil is returned.
13912 do not interpret it as the list atom nil. This is used for inheritance
13914 (org-with-point-at pom
13915 (if (and inherit (if (eq inherit 'selective)
13916 (org-property-inherit-p property)
13917 t))
13918 (org-entry-get-with-inheritance property literal-nil)
13919 (if (member property org-special-properties)
13920 ;; We need a special property. Use `org-entry-properties' to
13921 ;; retrieve it, but specify the wanted property
13922 (cdr (assoc property (org-entry-properties nil 'special property)))
13923 (let ((range (unless (org-before-first-heading-p)
13924 (org-get-property-block))))
13925 (if (and range
13926 (goto-char (car range))
13927 (re-search-forward
13928 (org-re-property property)
13929 (cdr range) t))
13930 ;; Found the property, return it.
13931 (if (match-end 1)
13932 (if literal-nil
13933 (org-match-string-no-properties 1)
13934 (org-not-nil (org-match-string-no-properties 1)))
13935 "")))))))
13937 (defun org-property-or-variable-value (var &optional inherit)
13938 "Check if there is a property fixing the value of VAR.
13939 If yes, return this value. If not, return the current value of the variable."
13940 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13942 (read prop)
13943 (symbol-value var))))
13945 (defun org-entry-delete (pom property)
13946 "Delete the property PROPERTY from entry at point-or-marker POM."
13947 (org-with-point-at pom
13948 (if (member property org-special-properties)
13949 nil ; cannot delete these properties.
13950 (let ((range (org-get-property-block)))
13951 (if (and range
13952 (goto-char (car range))
13953 (re-search-forward
13954 (org-re-property property)
13955 (cdr range) t))
13956 (progn
13957 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13958 t)
13959 nil)))))
13961 ;; Multi-values properties are properties that contain multiple values
13962 ;; These values are assumed to be single words, separated by whitespace.
13963 (defun org-entry-add-to-multivalued-property (pom property value)
13964 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13965 (let* ((old (org-entry-get pom property))
13967 (setq value (org-entry-protect-space value))
13968 (unless (member value values)
13969 (setq values (cons value values))
13970 (org-entry-put pom property
13971 (mapconcat 'identity values " ")))))
13973 (defun org-entry-remove-from-multivalued-property (pom property value)
13974 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13975 (let* ((old (org-entry-get pom property))
13977 (setq value (org-entry-protect-space value))
13978 (when (member value values)
13979 (setq values (delete value values))
13980 (org-entry-put pom property
13981 (mapconcat 'identity values " ")))))
13983 (defun org-entry-member-in-multivalued-property (pom property value)
13984 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13985 (let* ((old (org-entry-get pom property))
13987 (setq value (org-entry-protect-space value))
13988 (member value values)))
13990 (defun org-entry-get-multivalued-property (pom property)
13991 "Return a list of values in a multivalued property."
13992 (let* ((value (org-entry-get pom property))
13994 (mapcar 'org-entry-restore-space values)))
13996 (defun org-entry-put-multivalued-property (pom property &rest values)
13997 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13998 VALUES should be a list of strings. Spaces will be protected."
13999 (org-entry-put pom property
14000 (mapconcat 'org-entry-protect-space values " "))
14001 (let* ((value (org-entry-get pom property))
14003 (mapcar 'org-entry-restore-space values)))
14005 (defun org-entry-protect-space (s)
14006 "Protect spaces and newline in string S."
14007 (while (string-match " " s)
14008 (setq s (replace-match "%20" t t s)))
14010 (setq s (replace-match "%0A" t t s)))
14011 s)
14013 (defun org-entry-restore-space (s)
14014 "Restore spaces and newline in string S."
14015 (while (string-match "%20" s)
14016 (setq s (replace-match " " t t s)))
14017 (while (string-match "%0A" s)
14019 s)
14021 (defvar org-entry-property-inherited-from (make-marker)
14022 "Marker pointing to the entry from where a property was inherited.
14023 Each call to `org-entry-get-with-inheritance' will set this marker to the
14024 location of the entry where the inheritance search matched. If there was
14025 no match, the marker will point nowhere.
14026 Note that also `org-entry-get' calls this function, if the INHERIT flag
14027 is set.")
14029 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14030 "Get entry property, and search higher levels if not present.
14031 The search will stop at the first ancestor which has the property defined.
14033 should be considered as undefined (this is the meaning of nil here).
14035 (move-marker org-entry-property-inherited-from nil)
14036 (let (tmp)
14037 (unless (org-before-first-heading-p)
14038 (save-excursion
14039 (save-restriction
14040 (widen)
14041 (catch 'ex
14042 (while t
14043 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14044 (org-back-to-heading t)
14045 (move-marker org-entry-property-inherited-from (point))
14046 (throw 'ex tmp))
14047 (or (org-up-heading-safe) (throw 'ex nil)))))))
14048 (setq tmp (or tmp
14049 (cdr (assoc property org-file-properties))
14050 (cdr (assoc property org-global-properties))
14051 (cdr (assoc property org-global-properties-fixed))))
14052 (if literal-nil tmp (org-not-nil tmp))))
14054 (defvar org-property-changed-functions nil
14055 "Hook called when the value of a property has changed.
14056 Each hook function should accept two arguments, the name of the property
14057 and the new value.")
14059 (defun org-entry-put (pom property value)
14060 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14061 (org-with-point-at pom
14062 (org-back-to-heading t)
14063 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14064 range)
14065 (cond
14066 ((equal property "TODO")
14068 (not (member value org-todo-keywords-1)))
14070 (if (or (not value)
14072 (setq value 'none))
14073 (org-todo value)
14074 (org-set-tags nil 'align))
14075 ((equal property "PRIORITY")
14077 (string-to-char value) ?\ ))
14078 (org-set-tags nil 'align))
14079 ((equal property "SCHEDULED")
14080 (if (re-search-forward org-scheduled-time-regexp end t)
14081 (cond
14082 ((eq value 'earlier) (org-timestamp-change -1 'day))
14083 ((eq value 'later) (org-timestamp-change 1 'day))
14084 (t (call-interactively 'org-schedule)))
14085 (call-interactively 'org-schedule)))
14086 ((equal property "DEADLINE")
14087 (if (re-search-forward org-deadline-time-regexp end t)
14088 (cond
14089 ((eq value 'earlier) (org-timestamp-change -1 'day))
14090 ((eq value 'later) (org-timestamp-change 1 'day))
14091 (t (call-interactively 'org-deadline)))
14092 (call-interactively 'org-deadline)))
14093 ((member property org-special-properties)
14094 (error "The %s property can not yet be set with `org-entry-put'"
14095 property))
14096 (t ; a non-special property
14097 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14098 (setq range (org-get-property-block beg end 'force))
14099 (goto-char (car range))
14100 (if (re-search-forward
14101 (org-re-property property) (cdr range) t)
14102 (progn
14103 (delete-region (match-beginning 0) (match-end 0))
14104 (goto-char (match-beginning 0)))
14105 (goto-char (cdr range))
14107 (backward-char 1)
14108 (org-indent-line-function))
14109 (insert ":" property ":")
14110 (and value (insert " " value))
14111 (org-indent-line-function)))))
14112 (run-hook-with-args 'org-property-changed-functions property value)))
14114 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14115 "Get all property keys in the current buffer.
14116 With INCLUDE-SPECIALS, also list the special properties that reflect things
14117 like tags and TODO state.
14118 With INCLUDE-DEFAULTS, also include properties that has special meaning
14119 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14120 and others.
14121 With INCLUDE-COLUMNS, also include property names given in COLUMN
14122 formats in the current buffer."
14123 (let (rtn range cfmt s p)
14124 (save-excursion
14125 (save-restriction
14126 (widen)
14127 (goto-char (point-min))
14128 (while (re-search-forward org-property-start-re nil t)
14129 (setq range (org-get-property-block))
14130 (goto-char (car range))
14131 (while (re-search-forward
14133 (cdr range) t)
14134 (add-to-list 'rtn (org-match-string-no-properties 1)))
14135 (outline-next-heading))))
14137 (when include-specials
14138 (setq rtn (append org-special-properties rtn)))
14140 (when include-defaults
14141 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14142 (add-to-list 'rtn org-effort-property))
14144 (when include-columns
14145 (save-excursion
14146 (save-restriction
14147 (widen)
14148 (goto-char (point-min))
14149 (while (re-search-forward
14151 nil t)
14152 (setq cfmt (match-string 2) s 0)
14154 cfmt s)
14155 (setq s (match-end 0)
14156 p (match-string 1 cfmt))
14157 (unless (or (equal p "ITEM")
14158 (member p org-special-properties))
14159 (add-to-list 'rtn (match-string 1 cfmt))))))))
14161 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14163 (defun org-property-values (key)
14164 "Return a list of all values of property KEY in the current buffer."
14165 (save-excursion
14166 (save-restriction
14167 (widen)
14168 (goto-char (point-min))
14169 (let ((re (org-re-property key))
14170 values)
14171 (while (re-search-forward re nil t)
14172 (add-to-list 'values (org-trim (match-string 1))))
14173 (delete "" values)))))
14175 (defun org-insert-property-drawer ()
14176 "Insert a property drawer into the current entry."
14177 (interactive)
14178 (org-back-to-heading t)
14179 (looking-at org-outline-regexp)
14180 (let ((indent (if org-adapt-indentation
14181 (- (match-end 0)(match-beginning 0))
14182 0))
14183 (beg (point))
14185 end hiddenp)
14186 (outline-next-heading)
14187 (setq end (point))
14188 (goto-char beg)
14189 (while (re-search-forward re end t))
14190 (setq hiddenp (outline-invisible-p))
14191 (end-of-line 1)
14194 (if (member (match-string 1) '("CLOCK:" ":END:"))
14195 ;; just skip this line
14196 (beginning-of-line 2)
14197 ;; Drawer start, find the end
14199 (beginning-of-line 1)))
14200 (org-skip-over-state-notes)
14202 (if (eq (char-before) ?*) (forward-char 1))
14204 (beginning-of-line 0)
14205 (org-indent-to-column indent)
14206 (beginning-of-line 2)
14207 (org-indent-to-column indent)
14208 (beginning-of-line 0)
14209 (if hiddenp
14210 (save-excursion
14211 (org-back-to-heading t)
14212 (hide-entry))
14213 (org-flag-drawer t))))
14215 (defvar org-property-set-functions-alist nil
14216 "Property set function alist.
14217 Each entry should have the following format:
14219 (PROPERTY . READ-FUNCTION)
14221 The read function will be called with the same argument as
14222 `org-completing-read'.")
14224 (defun org-set-property-function (property)
14225 "Get the function that should be used to set PROPERTY.
14226 This is computed according to `org-property-set-functions-alist'."
14227 (or (cdr (assoc property org-property-set-functions-alist))
14228 'org-completing-read))
14230 (defun org-read-property-value (property)
14231 "Read PROPERTY value from user."
14232 (let* ((completion-ignore-case t)
14233 (allowed (org-property-get-allowed-values nil property 'table))
14234 (cur (org-entry-get nil property))
14235 (prompt (concat property " value"
14237 (concat " [" cur "]") "") ": "))
14238 (set-function (org-set-property-function property))
14239 (val (if allowed
14240 (funcall set-function prompt allowed nil
14241 (not (get-text-property 0 'org-unrestricted
14242 (caar allowed))))
14243 (let (org-completion-use-ido org-completion-use-iswitchb)
14244 (funcall set-function prompt
14245 (mapcar 'list (org-property-values property))
14246 nil nil "" nil cur)))))
14247 (if (equal val "")
14248 cur
14249 val)))
14251 (defvar org-last-set-property nil)
14252 (defun org-read-property-name ()
14253 "Read a property name."
14254 (let* ((completion-ignore-case t)
14255 (keys (org-buffer-property-keys nil t t))
14256 (default-prop (or (save-excursion
14257 (save-match-data
14258 (beginning-of-line)
14260 (null (string= (match-string 1) "END"))
14261 (match-string 1))))
14262 org-last-set-property))
14263 (property (org-icompleting-read
14264 (concat "Property"
14265 (if default-prop (concat " [" default-prop "]") "")
14266 ": ")
14267 (mapcar 'list keys)
14268 nil nil nil nil
14269 default-prop
14270 )))
14271 (if (member property keys)
14272 property
14273 (or (cdr (assoc (downcase property)
14274 (mapcar (lambda (x) (cons (downcase x) x))
14275 keys)))
14276 property))))
14278 (defun org-set-property (property value)
14279 "In the current entry, set PROPERTY to VALUE.
14280 When called interactively, this will prompt for a property name, offering
14281 completion on existing and default properties. And then it will prompt
14282 for a value, offering completion either on allowed values (via an inherited
14283 xxx_ALL property) or on existing values in other instances of this property
14284 in the current file."
14285 (interactive (list nil nil))
14286 (let* ((property (or property (org-read-property-name)))
14287 (value (or value (org-read-property-value property))))
14288 (setq org-last-set-property property)
14289 ;; Possibly postprocess the inserted value:
14290 (when (assoc property org-properties-postprocess-alist)
14291 (setq value (funcall (cadr fn) value)))
14292 (unless (equal (org-entry-get nil property) value)
14293 (org-entry-put nil property value))))
14295 (defun org-delete-property (property)
14296 "In the current entry, delete PROPERTY."
14297 (interactive
14298 (let* ((completion-ignore-case t)
14299 (prop (org-icompleting-read "Property: "
14300 (org-entry-properties nil 'standard))))
14301 (list prop)))
14302 (message "Property %s %s" property
14303 (if (org-entry-delete nil property)
14304 "deleted"
14305 "was not present in the entry")))
14307 (defun org-delete-property-globally (property)
14308 "Remove PROPERTY globally, from all entries."
14309 (interactive
14310 (let* ((completion-ignore-case t)
14311 (prop (org-icompleting-read
14312 "Globally remove property: "
14313 (mapcar 'list (org-buffer-property-keys)))))
14314 (list prop)))
14315 (save-excursion
14316 (save-restriction
14317 (widen)
14318 (goto-char (point-min))
14319 (let ((cnt 0))
14320 (while (re-search-forward
14321 (org-re-property property)
14322 nil t)
14323 (setq cnt (1+ cnt))
14324 (replace-match ""))
14327 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14329 (defun org-compute-property-at-point ()
14330 "Compute the property at point.
14331 This looks for an enclosing column format, extracts the operator and
14332 then applies it to the property in the column format's scope."
14333 (interactive)
14334 (unless (org-at-property-p)
14335 (error "Not at a property"))
14336 (let ((prop (org-match-string-no-properties 2)))
14337 (org-columns-get-format-and-top-level)
14338 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14339 (error "No operator defined for property %s" prop))
14340 (org-columns-compute prop)))
14342 (defvar org-property-allowed-value-functions nil
14343 "Hook for functions supplying allowed values for a specific property.
14344 The functions must take a single argument, the name of the property, and
14346 the values, this means that these values are intended as defaults for
14347 completion, but that other values should be allowed too.
14348 The functions must return nil if they are not responsible for this
14349 property.")
14351 (defun org-property-get-allowed-values (pom property &optional table)
14352 "Get allowed values for the property PROPERTY.
14353 When TABLE is non-nil, return an alist that can directly be used for
14354 completion."
14355 (let (vals)
14356 (cond
14357 ((equal property "TODO")
14358 (setq vals (org-with-point-at pom
14359 (append org-todo-keywords-1 '("")))))
14360 ((equal property "PRIORITY")
14361 (let ((n org-lowest-priority))
14362 (while (>= n org-highest-priority)
14363 (push (char-to-string n) vals)
14364 (setq n (1- n)))))
14365 ((member property org-special-properties))
14366 ((setq vals (run-hook-with-args-until-success
14367 'org-property-allowed-value-functions property)))
14368 (t
14369 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14371 (setq vals (car (read-from-string (concat "(" vals ")"))))
14372 (setq vals (mapcar (lambda (x)
14373 (cond ((stringp x) x)
14374 ((numberp x) (number-to-string x))
14375 ((symbolp x) (symbol-name x))
14376 (t "???")))
14377 vals)))))
14378 (when (member ":ETC" vals)
14379 (setq vals (remove ":ETC" vals))
14380 (org-add-props (car vals) '(org-unrestricted t)))
14381 (if table (mapcar 'list vals) vals)))
14383 (defun org-property-previous-allowed-value (&optional previous)
14384 "Switch to the next allowed value for this property."
14385 (interactive)
14386 (org-property-next-allowed-value t))
14388 (defun org-property-next-allowed-value (&optional previous)
14389 "Switch to the next allowed value for this property."
14390 (interactive)
14391 (unless (org-at-property-p)
14392 (error "Not at a property"))
14393 (let* ((key (match-string 2))
14394 (value (match-string 3))
14395 (allowed (or (org-property-get-allowed-values (point) key)
14396 (and (member value '("[ ]" "[-]" "[X]"))
14397 '("[ ]" "[X]"))))
14398 nval)
14399 (unless allowed
14400 (error "Allowed values for this property have not been defined"))
14401 (if previous (setq allowed (reverse allowed)))
14402 (if (member value allowed)
14403 (setq nval (car (cdr (member value allowed)))))
14404 (setq nval (or nval (car allowed)))
14405 (if (equal nval value)
14406 (error "Only one allowed value for this property"))
14407 (org-at-property-p)
14408 (replace-match (concat " :" key ": " nval) t t)
14409 (org-indent-line-function)
14410 (beginning-of-line 1)
14412 (run-hook-with-args 'org-property-changed-functions key nval)))
14414 (defun org-find-olp (path &optional this-buffer)
14415 "Return a marker pointing to the entry at outline path OLP.
14416 If anything goes wrong, throw an error.
14417 You can wrap this call to catch the error like this:
14419 (condition-case msg
14420 (org-mobile-locate-entry (match-string 4))
14421 (error (nth 1 msg)))
14423 The return value will then be either a string with the error message,
14424 or a marker if everything is OK.
14426 If THIS-BUFFER is set, the outline path does not contain a file,
14427 only headings."
14428 (let* ((file (if this-buffer buffer-file-name (pop path)))
14429 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14430 (level 1)
14431 (lmin 1)
14432 (lmax 1)
14433 limit re end found pos heading cnt flevel)
14434 (unless buffer (error "File not found :%s" file))
14435 (with-current-buffer buffer
14436 (save-excursion
14437 (save-restriction
14438 (widen)
14439 (setq limit (point-max))
14440 (goto-char (point-min))
14441 (while (setq heading (pop path))
14442 (setq re (format org-complex-heading-regexp-format
14443 (regexp-quote heading)))
14444 (setq cnt 0 pos (point))
14445 (while (re-search-forward re end t)
14446 (setq level (- (match-end 1) (match-beginning 1)))
14447 (if (and (>= level lmin) (<= level lmax))
14448 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14449 (when (= cnt 0) (error "Heading not found on level %d: %s"
14450 lmax heading))
14451 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14452 lmax heading))
14453 (goto-char found)
14454 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14455 (setq end (save-excursion (org-end-of-subtree t t))))
14456 (when (org-on-heading-p)
14457 (move-marker (make-marker) (point))))))))
14459 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14460 "Find node HEADING in BUFFER.
14461 Return a marker to the heading if it was found, or nil if not.
14462 If POS-ONLY is set, return just the position instead of a marker.
14464 The heading text must match exact, but it may have a TODO keyword,
14465 a priority cookie and tags in the standard locations."
14466 (with-current-buffer (or buffer (current-buffer))
14467 (save-excursion
14468 (save-restriction
14469 (widen)
14470 (goto-char (point-min))
14471 (let (case-fold-search)
14472 (if (re-search-forward
14473 (format org-complex-heading-regexp-format
14474 (regexp-quote heading)) nil t)
14475 (if pos-only
14476 (match-beginning 0)
14477 (move-marker (make-marker) (match-beginning 0)))))))))
14479 (defun org-find-exact-heading-in-directory (heading &optional dir)
14480 "Find Org node headline HEADING in all .org files in directory DIR.
14481 When the target headline is found, return a marker to this location."
14482 (let ((files (directory-files (or dir default-directory)
14484 file visiting m buffer)
14485 (catch 'found
14486 (while (setq file (pop files))
14487 (message "trying %s" file)
14488 (setq visiting (org-find-base-buffer-visiting file))
14489 (setq buffer (or visiting (find-file-noselect file)))
14490 (setq m (org-find-exact-headline-in-buffer
14491 heading buffer))
14492 (when (and (not m) (not visiting)) (kill-buffer buffer))
14493 (and m (throw 'found m))))))
14495 (defun org-find-entry-with-id (ident)
14496 "Locate the entry that contains the ID property with exact value IDENT.
14497 IDENT can be a string, a symbol or a number, this function will search for
14498 the string representation of it.
14499 Return the position where this entry starts, or nil if there is no such entry."
14500 (interactive "sID: ")
14501 (let ((id (cond
14502 ((stringp ident) ident)
14503 ((symbol-name ident) (symbol-name ident))
14504 ((numberp ident) (number-to-string ident))
14505 (t (error "IDENT %s must be a string, symbol or number" ident))))
14506 (case-fold-search nil))
14507 (save-excursion
14508 (save-restriction
14509 (widen)
14510 (goto-char (point-min))
14511 (when (re-search-forward
14513 nil t)
14514 (org-back-to-heading t)
14515 (point))))))
14517 ;;;; Timestamps
14519 (defvar org-last-changed-timestamp nil)
14520 (defvar org-last-inserted-timestamp nil
14521 "The last time stamp inserted with `org-insert-time-stamp'.")
14522 (defvar org-time-was-given) ; dynamically scoped parameter
14523 (defvar org-end-time-was-given) ; dynamically scoped parameter
14524 (defvar org-ts-what) ; dynamically scoped parameter
14526 (defun org-time-stamp (arg &optional inactive)
14527 "Prompt for a date/time and insert a time stamp.
14528 If the user specifies a time like HH:MM, or if this command is called
14529 with a prefix argument, the time stamp will contain date and time.
14530 Otherwise, only the date will be included. All parts of a date not
14531 specified by the user will be filled in from the current date/time.
14532 So if you press just return without typing anything, the time stamp
14533 will represent the current date/time. If there is already a timestamp
14534 at the cursor, it will be modified."
14535 (interactive "P")
14536 (let* ((ts nil)
14537 (default-time
14538 ;; Default time is either today, or, when entering a range,
14539 ;; the range start.
14540 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14541 (save-excursion
14542 (re-search-backward
14544 (- (point) 20) t)))
14545 (apply 'encode-time (org-parse-time-string (match-string 1)))
14546 (current-time)))
14547 (default-input (and ts (org-get-compact-tod ts)))
14548 (repeater (save-excursion
14549 (save-match-data
14550 (beginning-of-line)
14551 (when (re-search-forward
14553 (save-excursion (progn (end-of-line) (point))) t)
14554 (match-string 0)))))
14555 org-time-was-given org-end-time-was-given time)
14556 (cond
14557 ((and (org-at-timestamp-p t)
14558 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14559 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14560 (insert "--")
14561 (setq time (let ((this-command this-command))
14562 (org-read-date arg 'totime nil nil
14563 default-time default-input)))
14564 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14565 ((org-at-timestamp-p t)
14566 (setq time (let ((this-command this-command))
14567 (org-read-date arg 'totime nil nil default-time default-input)))
14568 (when (org-at-timestamp-p t) ; just to get the match data
14569 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14570 (replace-match "")
14571 (setq org-last-changed-timestamp
14572 (org-insert-time-stamp
14573 time (or org-time-was-given arg)
14574 inactive nil nil (list org-end-time-was-given)))
14575 (when repeater (goto-char (1- (point))) (insert " " repeater)
14576 (setq org-last-changed-timestamp
14577 (concat (substring org-last-inserted-timestamp 0 -1)
14578 " " repeater ">"))))
14579 (message "Timestamp updated"))
14580 (t
14581 (setq time (let ((this-command this-command))
14582 (org-read-date arg 'totime nil nil default-time default-input)))
14583 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14584 nil nil (list org-end-time-was-given))))))
14586 ;; FIXME: can we use this for something else, like computing time differences?
14587 (defun org-get-compact-tod (s)
14588 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14589 (let* ((t1 (match-string 1 s))
14590 (h1 (string-to-number (match-string 2 s)))
14591 (m1 (string-to-number (match-string 3 s)))
14592 (t2 (and (match-end 4) (match-string 5 s)))
14593 (h2 (and t2 (string-to-number (match-string 6 s))))
14594 (m2 (and t2 (string-to-number (match-string 7 s))))
14595 dh dm)
14596 (if (not t2)
14597 t1
14598 (setq dh (- h2 h1) dm (- m2 m1))
14599 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14600 (concat t1 "+" (number-to-string dh)
14601 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14603 (defun org-time-stamp-inactive (&optional arg)
14604 "Insert an inactive time stamp.
14605 An inactive time stamp is enclosed in square brackets instead of angle
14606 brackets. It is inactive in the sense that it does not trigger agenda entries,
14607 does not link to the calendar and cannot be changed with the S-cursor keys.
14608 So these are more for recording a certain time/date."
14609 (interactive "P")
14610 (org-time-stamp arg 'inactive))
14612 (defvar org-date-ovl (make-overlay 1 1))
14613 (overlay-put org-date-ovl 'face 'org-warning)
14614 (org-detach-overlay org-date-ovl)
14616 (defvar org-ans1) ; dynamically scoped parameter
14617 (defvar org-ans2) ; dynamically scoped parameter
14619 (defvar org-plain-time-of-day-regexp) ; defined below
14621 (defvar org-overriding-default-time nil) ; dynamically scoped
14622 (defvar org-read-date-overlay nil)
14623 (defvar org-dcst nil) ; dynamically scoped
14624 (defvar org-read-date-history nil)
14625 (defvar org-read-date-final-answer nil)
14626 (defvar org-read-date-analyze-futurep nil)
14627 (defvar org-read-date-analyze-forced-year nil)
14629 (defun org-read-date (&optional with-time to-time from-string prompt
14630 default-time default-input)
14631 "Read a date, possibly a time, and make things smooth for the user.
14632 The prompt will suggest to enter an ISO date, but you can also enter anything
14633 which will at least partially be understood by `parse-time-string'.
14634 Unrecognized parts of the date will default to the current day, month, year,
14635 hour and minute. If this command is called to replace a timestamp at point,
14636 of to enter the second timestamp of a range, the default time is taken
14637 from the existing stamp. Furthermore, the command prefers the future,
14638 so if you are giving a date where the year is not given, and the day-month
14639 combination is already past in the current year, it will assume you
14640 mean next year. For details, see the manual. A few examples:
14642 3-2-5 --> 2003-02-05
14643 feb 15 --> currentyear-02-15
14644 2/15 --> currentyear-02-15
14645 sep 12 9 --> 2009-09-12
14646 12:45 --> today 12:45
14647 22 sept 0:34 --> currentyear-09-22 0:34
14648 12 --> currentyear-currentmonth-12
14649 Fri --> nearest Friday (today or later)
14650 etc.
14652 Furthermore you can specify a relative date by giving, as the *first* thing
14653 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14654 change in days weeks, months, years.
14655 With a single plus or minus, the date is relative to today. With a double
14656 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14657 +4d --> four days from today
14658 +4 --> same as above
14659 +2w --> two weeks from today
14660 ++5 --> five days from default date
14662 The function understands only English month and weekday abbreviations,
14663 but this can be configured with the variables `parse-time-months' and
14664 `parse-time-weekdays'.
14666 While prompting, a calendar is popped up - you can also select the
14667 date with the mouse (button 1). The calendar shows a period of three
14668 months. To scroll it to other months, use the keys `>' and `<'.
14669 If you don't like the calendar, turn it off with
14670 \(setq org-read-date-popup-calendar nil)
14672 With optional argument TO-TIME, the date will immediately be converted
14673 to an internal time.
14674 With an optional argument WITH-TIME, the prompt will suggest to also
14675 insert a time. Note that when WITH-TIME is not set, you can still
14676 enter a time, and this function will inform the calling routine about
14677 this change. The calling routine may then choose to change the format
14678 used to insert the time stamp into the buffer to include the time.
14679 With optional argument FROM-STRING, read from this string instead from
14680 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14681 the time/date that is used for everything that is not specified by the
14682 user."
14683 (require 'parse-time)
14684 (let* ((org-time-stamp-rounding-minutes
14685 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14686 (org-dcst org-display-custom-times)
14687 (ct (org-current-time))
14688 (def (or org-overriding-default-time default-time ct))
14689 (defdecode (decode-time def))
14690 (dummy (progn
14691 (when (< (nth 2 defdecode) org-extend-today-until)
14692 (setcar (nthcdr 2 defdecode) -1)
14693 (setcar (nthcdr 1 defdecode) 59)
14694 (setq def (apply 'encode-time defdecode)
14695 defdecode (decode-time def)))))
14696 (calendar-frame-setup nil)
14697 (calendar-setup nil)
14698 (calendar-move-hook nil)
14699 (calendar-view-diary-initially-flag nil)
14700 (calendar-view-holidays-initially-flag nil)
14701 (timestr (format-time-string
14702 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14703 (prompt (concat (if prompt (concat prompt " ") "")
14704 (format "Date+time [%s]: " timestr)))
14705 ans (org-ans0 "") org-ans1 org-ans2 final)
14707 (cond
14708 (from-string (setq ans from-string))
14709 (org-read-date-popup-calendar
14710 (save-excursion
14711 (save-window-excursion
14712 (calendar)
14713 (unwind-protect
14714 (progn
14715 (calendar-forward-day (- (time-to-days def)
14716 (calendar-absolute-from-gregorian
14717 (calendar-current-date))))
14718 (org-eval-in-calendar nil t)
14719 (let* ((old-map (current-local-map))
14720 (map (copy-keymap calendar-mode-map))
14721 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14722 (org-defkey map (kbd "RET") 'org-calendar-select)
14723 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14724 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14725 (org-defkey minibuffer-local-map [(meta shift left)]
14726 (lambda () (interactive)
14727 (org-eval-in-calendar '(calendar-backward-month 1))))
14728 (org-defkey minibuffer-local-map [(meta shift right)]
14729 (lambda () (interactive)
14730 (org-eval-in-calendar '(calendar-forward-month 1))))
14731 (org-defkey minibuffer-local-map [(meta shift up)]
14732 (lambda () (interactive)
14733 (org-eval-in-calendar '(calendar-backward-year 1))))
14734 (org-defkey minibuffer-local-map [(meta shift down)]
14735 (lambda () (interactive)
14736 (org-eval-in-calendar '(calendar-forward-year 1))))
14737 (org-defkey minibuffer-local-map [?\e (shift left)]
14738 (lambda () (interactive)
14739 (org-eval-in-calendar '(calendar-backward-month 1))))
14740 (org-defkey minibuffer-local-map [?\e (shift right)]
14741 (lambda () (interactive)
14742 (org-eval-in-calendar '(calendar-forward-month 1))))
14743 (org-defkey minibuffer-local-map [?\e (shift up)]
14744 (lambda () (interactive)
14745 (org-eval-in-calendar '(calendar-backward-year 1))))
14746 (org-defkey minibuffer-local-map [?\e (shift down)]
14747 (lambda () (interactive)
14748 (org-eval-in-calendar '(calendar-forward-year 1))))
14749 (org-defkey minibuffer-local-map [(shift up)]
14750 (lambda () (interactive)
14751 (org-eval-in-calendar '(calendar-backward-week 1))))
14752 (org-defkey minibuffer-local-map [(shift down)]
14753 (lambda () (interactive)
14754 (org-eval-in-calendar '(calendar-forward-week 1))))
14755 (org-defkey minibuffer-local-map [(shift left)]
14756 (lambda () (interactive)
14757 (org-eval-in-calendar '(calendar-backward-day 1))))
14758 (org-defkey minibuffer-local-map [(shift right)]
14759 (lambda () (interactive)
14760 (org-eval-in-calendar '(calendar-forward-day 1))))
14761 (org-defkey minibuffer-local-map ">"
14762 (lambda () (interactive)
14763 (org-eval-in-calendar '(scroll-calendar-left 1))))
14764 (org-defkey minibuffer-local-map "<"
14765 (lambda () (interactive)
14766 (org-eval-in-calendar '(scroll-calendar-right 1))))
14767 (org-defkey minibuffer-local-map "\C-v"
14768 (lambda () (interactive)
14769 (org-eval-in-calendar
14770 '(calendar-scroll-left-three-months 1))))
14771 (org-defkey minibuffer-local-map "\M-v"
14772 (lambda () (interactive)
14773 (org-eval-in-calendar
14774 '(calendar-scroll-right-three-months 1))))
14775 (run-hooks 'org-read-date-minibuffer-setup-hook)
14776 (unwind-protect
14777 (progn
14778 (use-local-map map)
14779 (add-hook 'post-command-hook 'org-read-date-display)
14780 (setq org-ans0 (read-string prompt default-input
14781 'org-read-date-history nil))
14782 ;; org-ans0: from prompt
14783 ;; org-ans1: from mouse click
14784 ;; org-ans2: from calendar motion
14785 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14786 (remove-hook 'post-command-hook 'org-read-date-display)
14787 (use-local-map old-map)
14788 (when org-read-date-overlay
14789 (delete-overlay org-read-date-overlay)
14790 (setq org-read-date-overlay nil)))))
14791 (bury-buffer "*Calendar*")))))
14793 (t ; Naked prompt only
14794 (unwind-protect
14795 (setq ans (read-string prompt default-input
14796 'org-read-date-history timestr))
14797 (when org-read-date-overlay
14798 (delete-overlay org-read-date-overlay)
14799 (setq org-read-date-overlay nil)))))
14801 (setq final (org-read-date-analyze ans def defdecode))
14803 (when org-read-date-analyze-forced-year
14804 (message "Year was forced into %s"
14805 (if org-read-date-force-compatible-dates
14806 "compatible range (1970-2037)"
14807 "range representable on this machine"))
14808 (ding))
14810 ;; One round trip to get rid of 34th of August and stuff like that....
14811 (setq final (decode-time (apply 'encode-time final)))
14813 (setq org-read-date-final-answer ans)
14815 (if to-time
14816 (apply 'encode-time final)
14817 (if (and (boundp 'org-time-was-given) org-time-was-given)
14818 (format "%04d-%02d-%02d %02d:%02d"
14819 (nth 5 final) (nth 4 final) (nth 3 final)
14820 (nth 2 final) (nth 1 final))
14821 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14823 (defvar def)
14824 (defvar defdecode)
14825 (defvar with-time)
14826 (defun org-read-date-display ()
14827 "Display the current date prompt interpretation in the minibuffer."
14828 (when org-read-date-display-live
14829 (when org-read-date-overlay
14830 (delete-overlay org-read-date-overlay))
14831 (let ((p (point)))
14832 (end-of-line 1)
14833 (while (not (equal (buffer-substring
14834 (max (point-min) (- (point) 4)) (point))
14835 " "))
14836 (insert " "))
14837 (goto-char p))
14838 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14839 " " (or org-ans1 org-ans2)))
14840 (org-end-time-was-given nil)
14841 (f (org-read-date-analyze ans def defdecode))
14842 (fmts (if org-dcst
14843 org-time-stamp-custom-formats
14844 org-time-stamp-formats))
14845 (fmt (if (or with-time
14846 (and (boundp 'org-time-was-given) org-time-was-given))
14847 (cdr fmts)
14848 (car fmts)))
14849 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14850 (when (and org-end-time-was-given
14851 (string-match org-plain-time-of-day-regexp txt))
14852 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14853 org-end-time-was-given
14854 (substring txt (match-end 0)))))
14855 (when org-read-date-analyze-futurep
14856 (setq txt (concat txt " (=>F)")))
14857 (setq org-read-date-overlay
14858 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14859 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14861 (defun org-read-date-analyze (ans def defdecode)
14862 "Analyze the combined answer of the date prompt."
14863 ;; FIXME: cleanup and comment
14864 (let ((nowdecode (decode-time (current-time)))
14865 delta deltan deltaw deltadef year month day
14866 hour minute second wday pm h2 m2 tl wday1
14867 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14868 (setq org-read-date-analyze-futurep nil
14869 org-read-date-analyze-forced-year nil)
14871 (setq ans "+0"))
14873 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14874 (setq ans (replace-match "" t t ans)
14875 deltan (car delta)
14876 deltaw (nth 1 delta)
14877 deltadef (nth 2 delta)))
14879 ;; Check if there is an iso week date in there
14880 ;; If yes, store the info and postpone interpreting it until the rest
14881 ;; of the parsing is done
14882 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14883 (setq iso-year (if (match-end 1)
14884 (org-small-year-to-year
14885 (string-to-number (match-string 1 ans))))
14886 iso-weekday (if (match-end 3)
14887 (string-to-number (match-string 3 ans)))
14888 iso-week (string-to-number (match-string 2 ans)))
14889 (setq ans (replace-match "" t t ans)))
14891 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14892 (when (string-match
14894 (setq year (if (match-end 2)
14895 (string-to-number (match-string 2 ans))
14896 (progn (setq kill-year t)
14897 (string-to-number (format-time-string "%Y"))))
14898 month (string-to-number (match-string 3 ans))
14899 day (string-to-number (match-string 4 ans)))
14900 (if (< year 100) (setq year (+ 2000 year)))
14902 t nil ans)))
14904 ;; Help matching dottet european dates
14905 (when (string-match
14906 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14907 (setq year (if (match-end 3)
14908 (string-to-number (match-string 3 ans))
14909 (progn (setq kill-year t)
14910 (string-to-number (format-time-string "%Y"))))
14911 day (string-to-number (match-string 1 ans))
14912 month (string-to-number (match-string 2 ans))
14914 t nil ans)))
14916 ;; Help matching american dates, like 5/30 or 5/30/7
14917 (when (string-match
14918 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14919 (setq year (if (match-end 4)
14920 (string-to-number (match-string 4 ans))
14921 (progn (setq kill-year t)
14922 (string-to-number (format-time-string "%Y"))))
14923 month (string-to-number (match-string 1 ans))
14924 day (string-to-number (match-string 2 ans)))
14925 (if (< year 100) (setq year (+ 2000 year)))
14927 t nil ans)))
14928 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14929 ;; If there is a time with am/pm, and *no* time without it, we convert
14930 ;; so that matching will be successful.
14931 (loop for i from 1 to 2 do ; twice, for end time as well
14934 (setq hour (string-to-number (match-string 1 ans))
14935 minute (if (match-end 3)
14936 (string-to-number (match-string 3 ans))
14937 0)
14938 pm (equal ?p
14939 (string-to-char (downcase (match-string 4 ans)))))
14940 (if (and (= hour 12) (not pm))
14941 (setq hour 0)
14942 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14943 (setq ans (replace-match (format "%02d:%02d" hour minute)
14944 t t ans))))
14946 ;; Check if a time range is given as a duration
14947 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14948 (setq hour (string-to-number (match-string 1 ans))
14949 h2 (+ hour (string-to-number (match-string 3 ans)))
14950 minute (string-to-number (match-string 2 ans))
14951 m2 (+ minute (if (match-end 5) (string-to-number
14952 (match-string 5 ans))0)))
14953 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14954 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14955 t t ans)))
14957 ;; Check if there is a time range
14958 (when (boundp 'org-end-time-was-given)
14959 (setq org-time-was-given nil)
14960 (when (and (string-match org-plain-time-of-day-regexp ans)
14961 (match-end 8))
14962 (setq org-end-time-was-given (match-string 8 ans))
14963 (setq ans (concat (substring ans 0 (match-beginning 7))
14964 (substring ans (match-end 7))))))
14966 (setq tl (parse-time-string ans)
14967 day (or (nth 3 tl) (nth 3 defdecode))
14968 month (or (nth 4 tl)
14969 (if (and org-read-date-prefer-future
14970 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14971 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14972 (nth 4 defdecode)))
14973 year (or (and (not kill-year) (nth 5 tl))
14974 (if (and org-read-date-prefer-future
14975 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14976 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14977 (nth 5 defdecode)))
14978 hour (or (nth 2 tl) (nth 2 defdecode))
14979 minute (or (nth 1 tl) (nth 1 defdecode))
14980 second (or (nth 0 tl) 0)
14981 wday (nth 6 tl))
14983 (when (and (eq org-read-date-prefer-future 'time)
14984 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14985 (equal day (nth 3 nowdecode))
14986 (equal month (nth 4 nowdecode))
14987 (equal year (nth 5 nowdecode))
14988 (nth 2 tl)
14989 (or (< (nth 2 tl) (nth 2 nowdecode))
14990 (and (= (nth 2 tl) (nth 2 nowdecode))
14991 (nth 1 tl)
14992 (< (nth 1 tl) (nth 1 nowdecode)))))
14993 (setq day (1+ day)
14994 futurep t))
14996 ;; Special date definitions below
14997 (cond
14998 (iso-week
14999 ;; There was an iso week
15000 (require 'cal-iso)
15001 (setq futurep nil)
15002 (setq year (or iso-year year)
15003 day (or iso-weekday wday 1)
15004 wday nil ; to make sure that the trigger below does not match
15005 iso-date (calendar-gregorian-from-absolute
15006 (calendar-absolute-from-iso
15007 (list iso-week day year))))
15008 ; FIXME: Should we also push ISO weeks into the future?
15009 ; (when (and org-read-date-prefer-future
15010 ; (not iso-year)
15011 ; (< (calendar-absolute-from-gregorian iso-date)
15012 ; (time-to-days (current-time))))
15013 ; (setq year (1+ year)
15014 ; iso-date (calendar-gregorian-from-absolute
15015 ; (calendar-absolute-from-iso
15016 ; (list iso-week day year)))))
15017 (setq month (car iso-date)
15018 year (nth 2 iso-date)
15019 day (nth 1 iso-date)))
15020 (deltan
15021 (setq futurep nil)
15022 (unless deltadef
15023 (let ((now (decode-time (current-time))))
15024 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15025 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15026 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15027 ((equal deltaw "m") (setq month (+ month deltan)))
15028 ((equal deltaw "y") (setq year (+ year deltan)))))
15029 ((and wday (not (nth 3 tl)))
15030 (setq futurep nil)
15031 ;; Weekday was given, but no day, so pick that day in the week
15032 ;; on or after the derived date.
15033 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15034 (unless (equal wday wday1)
15035 (setq day (+ day (% (- wday wday1 -7) 7))))))
15036 (if (and (boundp 'org-time-was-given)
15037 (nth 2 tl))
15038 (setq org-time-was-given t))
15039 (if (< year 100) (setq year (+ 2000 year)))
15040 ;; Check of the date is representable
15041 (if org-read-date-force-compatible-dates
15042 (progn
15043 (if (< year 1970)
15044 (setq year 1970 org-read-date-analyze-forced-year t))
15045 (if (> year 2037)
15046 (setq year 2037 org-read-date-analyze-forced-year t)))
15047 (condition-case nil
15048 (ignore (encode-time second minute hour day month year))
15049 (error
15050 (setq year (nth 5 defdecode))
15051 (setq org-read-date-analyze-forced-year t))))
15052 (setq org-read-date-analyze-futurep futurep)
15053 (list second minute hour day month year)))
15055 (defvar parse-time-weekdays)
15057 (defun org-read-date-get-relative (s today default)
15058 "Check string S for special relative date string.
15059 TODAY and DEFAULT are internal times, for today and for a default.
15060 Return shift list (N what def-flag)
15062 N is the number of WHATs to shift.
15063 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15064 the DEFAULT date rather than TODAY."
15065 (when (and
15066 (string-match
15067 (concat
15072 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15073 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15074 (string-to-char (substring (match-string 1 s) -1))
15075 ?+))
15076 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15077 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15078 (what (if (match-end 3) (match-string 3 s) "d"))
15079 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15080 (date (if rel default today))
15081 (wday (nth 6 (decode-time date)))
15082 delta)
15083 (if wday1
15084 (progn
15085 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15086 (if (= dir ?-) (setq delta (- delta 7)))
15087 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15088 (list delta "d" rel))
15089 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15091 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15092 "Turn a user-specified date into the internal representation.
15093 The internal representation needed by the calendar is (month day year).
15094 This is a wrapper to handle the brain-dead convention in calendar that
15095 user function argument order change dependent on argument order."
15096 (if (boundp 'calendar-date-style)
15097 (cond
15098 ((eq calendar-date-style 'american)
15099 (list arg1 arg2 arg3))
15100 ((eq calendar-date-style 'european)
15101 (list arg2 arg1 arg3))
15102 ((eq calendar-date-style 'iso)
15103 (list arg2 arg3 arg1)))
15104 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15105 (if (org-bound-and-true-p european-calendar-style)
15106 (list arg2 arg1 arg3)
15107 (list arg1 arg2 arg3)))))
15109 (defun org-eval-in-calendar (form &optional keepdate)
15110 "Eval FORM in the calendar window and return to current window.
15111 Also, store the cursor date in variable org-ans2."
15112 (let ((sf (selected-frame))
15113 (sw (selected-window)))
15114 (select-window (get-buffer-window "*Calendar*" t))
15115 (eval form)
15116 (when (and (not keepdate) (calendar-cursor-to-date))
15117 (let* ((date (calendar-cursor-to-date))
15118 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15119 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15120 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15121 (select-window sw)
15122 (org-select-frame-set-input-focus sf)))
15124 (defun org-calendar-select ()
15125 "Return to `org-read-date' with the date currently selected.
15126 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15127 (interactive)
15128 (when (calendar-cursor-to-date)
15129 (let* ((date (calendar-cursor-to-date))
15130 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15131 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15132 (if (active-minibuffer-window) (exit-minibuffer))))
15134 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15135 "Insert a date stamp for the date given by the internal TIME.
15136 WITH-HM means use the stamp format that includes the time of the day.
15137 INACTIVE means use square brackets instead of angular ones, so that the
15138 stamp will not contribute to the agenda.
15139 PRE and POST are optional strings to be inserted before and after the
15140 stamp.
15141 The command returns the inserted time stamp."
15142 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15143 stamp)
15144 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15145 (insert-before-markers (or pre ""))
15146 (when (listp extra)
15147 (setq extra (car extra))
15148 (if (and (stringp extra)
15150 (setq extra (format "-%02d:%02d"
15151 (string-to-number (match-string 1 extra))
15152 (string-to-number (match-string 2 extra))))
15153 (setq extra nil)))
15154 (when extra
15155 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15156 (insert-before-markers (setq stamp (format-time-string fmt time)))
15157 (insert-before-markers (or post ""))
15158 (setq org-last-inserted-timestamp stamp)))
15160 (defun org-toggle-time-stamp-overlays ()
15161 "Toggle the use of custom time stamp formats."
15162 (interactive)
15163 (setq org-display-custom-times (not org-display-custom-times))
15164 (unless org-display-custom-times
15165 (let ((p (point-min)) (bmp (buffer-modified-p)))
15166 (while (setq p (next-single-property-change p 'display))
15167 (if (and (get-text-property p 'display)
15168 (eq (get-text-property p 'face) 'org-date))
15169 (remove-text-properties
15170 p (setq p (next-single-property-change p 'display))
15171 '(display t))))
15172 (set-buffer-modified-p bmp)))
15173 (if (featurep 'xemacs)
15174 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15175 (org-restart-font-lock)
15176 (setq org-table-may-need-update t)
15177 (if org-display-custom-times
15178 (message "Time stamps are overlayed with custom format")
15179 (message "Time stamp overlays removed")))
15181 (defun org-display-custom-time (beg end)
15182 "Overlay modified time stamp format over timestamp between BEG and END."
15183 (let* ((ts (buffer-substring beg end))
15184 t1 w1 with-hm tf time str w2 (off 0))
15185 (save-match-data
15186 (setq t1 (org-parse-time-string ts t))
15187 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15188 (setq off (- (match-end 0) (match-beginning 0)))))
15189 (setq end (- end off))
15190 (setq w1 (- end beg)
15191 with-hm (and (nth 1 t1) (nth 2 t1))
15192 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15193 time (org-fix-decoded-time t1)
15194 str (org-add-props
15195 (format-time-string
15196 (substring tf 1 -1) (apply 'encode-time time))
15197 nil 'mouse-face 'highlight)
15198 w2 (length str))
15199 (if (not (= w2 w1))
15200 (add-text-properties (1+ beg) (+ 2 beg)
15201 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15202 (if (featurep 'xemacs)
15203 (progn
15204 (put-text-property beg end 'invisible t)
15205 (put-text-property beg end 'end-glyph (make-glyph str)))
15206 (put-text-property beg end 'display str))))
15208 (defun org-translate-time (string)
15209 "Translate all timestamps in STRING to custom format.
15210 But do this only if the variable `org-display-custom-times' is set."
15211 (when org-display-custom-times
15212 (save-match-data
15213 (let* ((start 0)
15214 (re org-ts-regexp-both)
15215 t1 with-hm inactive tf time str beg end)
15216 (while (setq start (string-match re string start))
15217 (setq beg (match-beginning 0)
15218 end (match-end 0)
15219 t1 (save-match-data
15220 (org-parse-time-string (substring string beg end) t))
15221 with-hm (and (nth 1 t1) (nth 2 t1))
15222 inactive (equal (substring string beg (1+ beg)) "[")
15223 tf (funcall (if with-hm 'cdr 'car)
15224 org-time-stamp-custom-formats)
15225 time (org-fix-decoded-time t1)
15226 str (format-time-string
15227 (concat
15228 (if inactive "[" "<") (substring tf 1 -1)
15229 (if inactive "]" ">"))
15230 (apply 'encode-time time))
15231 string (replace-match str t t string)
15232 start (+ start (length str)))))))
15233 string)
15235 (defun org-fix-decoded-time (time)
15236 "Set 0 instead of nil for the first 6 elements of time.
15237 Don't touch the rest."
15238 (let ((n 0))
15239 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15241 (defun org-days-to-time (timestamp-string)
15242 "Difference between TIMESTAMP-STRING and now in days."
15243 (- (time-to-days (org-time-string-to-time timestamp-string))
15244 (time-to-days (current-time))))
15246 (defun org-deadline-close (timestamp-string &optional ndays)
15247 "Is the time in TIMESTAMP-STRING close to the current date?"
15248 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15249 (and (< (org-days-to-time timestamp-string) ndays)
15250 (not (org-entry-is-done-p))))
15252 (defun org-get-wdays (ts)
15253 "Get the deadline lead time appropriate for timestring TS."
15254 (cond
15255 ((<= org-deadline-warning-days 0)
15256 ;; 0 or negative, enforce this value no matter what
15257 (- org-deadline-warning-days))
15259 ;; lead time is specified.
15260 (floor (* (string-to-number (match-string 1 ts))
15261 (cdr (assoc (match-string 2 ts)
15262 '(("d" . 1) ("w" . 7)
15263 ("m" . 30.4) ("y" . 365.25)))))))
15264 ;; go for the default.
15265 (t org-deadline-warning-days)))
15267 (defun org-calendar-select-mouse (ev)
15268 "Return to `org-read-date' with the date currently selected.
15269 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15270 (interactive "e")
15271 (mouse-set-point ev)
15272 (when (calendar-cursor-to-date)
15273 (let* ((date (calendar-cursor-to-date))
15274 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15275 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15276 (if (active-minibuffer-window) (exit-minibuffer))))
15278 (defun org-check-deadlines (ndays)
15279 "Check if there are any deadlines due or past due.
15280 A deadline is considered due if it happens within `org-deadline-warning-days'
15281 days from today's date. If the deadline appears in an entry marked DONE,
15282 it is not shown. The prefix arg NDAYS can be used to test that many
15284 (interactive "P")
15285 (let* ((org-warn-days
15286 (cond
15287 ((equal ndays '(4)) 100000)
15288 (ndays (prefix-numeric-value ndays))
15289 (t (abs org-deadline-warning-days))))
15290 (case-fold-search nil)
15292 (callback
15293 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15295 (message "%d deadlines past-due or due within %d days"
15296 (org-occur regexp nil callback)
15297 org-warn-days)))
15299 (defun org-check-before-date (date)
15300 "Check if there are deadlines or scheduled entries before DATE."
15301 (interactive (list (org-read-date)))
15302 (let ((case-fold-search nil)
15306 (callback
15307 (lambda () (time-less-p
15308 (org-time-string-to-time (match-string 2))
15309 (org-time-string-to-time date)))))
15310 (message "%d entries before %s"
15311 (org-occur regexp nil callback) date)))
15313 (defun org-check-after-date (date)
15314 "Check if there are deadlines or scheduled entries after DATE."
15315 (interactive (list (org-read-date)))
15316 (let ((case-fold-search nil)
15320 (callback
15321 (lambda () (not
15322 (time-less-p
15323 (org-time-string-to-time (match-string 2))
15324 (org-time-string-to-time date))))))
15325 (message "%d entries after %s"
15326 (org-occur regexp nil callback) date)))
15328 (defun org-evaluate-time-range (&optional to-buffer)
15329 "Evaluate a time range by computing the difference between start and end.
15330 Normally the result is just printed in the echo area, but with prefix arg
15331 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15332 If the time range is actually in a table, the result is inserted into the
15333 next column.
15334 For time difference computation, a year is assumed to be exactly 365
15335 days in order to avoid rounding problems."
15336 (interactive "P")
15337 (or
15338 (org-clock-update-time-maybe)
15339 (save-excursion
15340 (unless (org-at-date-range-p t)
15341 (goto-char (point-at-bol))
15342 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15343 (if (not (org-at-date-range-p t))
15344 (error "Not at a time-stamp range, and none found in current line")))
15345 (let* ((ts1 (match-string 1))
15346 (ts2 (match-string 2))
15347 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15348 (match-end (match-end 0))
15349 (time1 (org-time-string-to-time ts1))
15350 (time2 (org-time-string-to-time ts2))
15351 (t1 (org-float-time time1))
15352 (t2 (org-float-time time2))
15353 (diff (abs (- t2 t1)))
15354 (negative (< (- t2 t1) 0))
15355 ;; (ys (floor (* 365 24 60 60)))
15356 (ds (* 24 60 60))
15357 (hs (* 60 60))
15358 (fy "%dy %dd %02d:%02d")
15359 (fy1 "%dy %dd")
15360 (fd "%dd %02d:%02d")
15361 (fd1 "%dd")
15362 (fh "%02d:%02d")
15363 y d h m align)
15364 (if havetime
15365 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15366 y 0
15367 d (floor (/ diff ds)) diff (mod diff ds)
15368 h (floor (/ diff hs)) diff (mod diff hs)
15369 m (floor (/ diff 60)))
15370 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15371 y 0
15372 d (floor (+ (/ diff ds) 0.5))
15373 h 0 m 0))
15374 (if (not to-buffer)
15375 (message "%s" (org-make-tdiff-string y d h m))
15376 (if (org-at-table-p)
15377 (progn
15378 (goto-char match-end)
15379 (setq align t)
15380 (and (looking-at " *|") (goto-char (match-end 0))))
15381 (goto-char match-end))
15382 (if (looking-at
15384 (replace-match ""))
15385 (if negative (insert " -"))
15386 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15387 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15388 (insert " " (format fh h m))))
15389 (if align (org-table-align))
15390 (message "Time difference inserted")))))
15392 (defun org-make-tdiff-string (y d h m)
15393 (let ((fmt "")
15394 (l nil))
15395 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15396 l (push y l)))
15397 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15398 l (push d l)))
15399 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15400 l (push h l)))
15401 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15402 l (push m l)))
15403 (apply 'format fmt (nreverse l))))
15405 (defun org-time-string-to-time (s)
15406 (apply 'encode-time (org-parse-time-string s)))
15407 (defun org-time-string-to-seconds (s)
15408 (org-float-time (org-time-string-to-time s)))
15410 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15411 "Convert a time stamp to an absolute day number.
15412 If there is a specifier for a cyclic time stamp, get the closest date to
15413 DAYNR.
15414 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15415 The variable date is bound by the calendar when this is called."
15416 (cond
15418 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15419 daynr
15420 (+ daynr 1000)))
15422 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15423 (time-to-days (current-time))) (match-string 0 s)
15424 prefer show-all))
15425 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15427 (defun org-days-to-iso-week (days)
15428 "Return the iso week number."
15429 (require 'cal-iso)
15430 (car (calendar-iso-from-absolute days)))
15432 (defun org-small-year-to-year (year)
15433 "Convert 2-digit years into 4-digit years.
15434 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15435 The year 2000 cannot be abbreviated. Any year larger than 99
15436 is returned unchanged."
15437 (if (< year 38)
15438 (setq year (+ 2000 year))
15439 (if (< year 100)
15440 (setq year (+ 1900 year))))
15441 year)
15443 (defun org-time-from-absolute (d)
15444 "Return the time corresponding to date D.
15445 D may be an absolute day number, or a calendar-type list (month day year)."
15446 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15447 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15449 (defun org-calendar-holiday ()
15450 "List of holidays, for Diary display in Org-mode."
15451 (require 'holidays)
15452 (let ((hl (funcall
15453 (if (fboundp 'calendar-check-holidays)
15454 'calendar-check-holidays 'check-calendar-holidays) date)))
15455 (if hl (mapconcat 'identity hl "; "))))
15457 (defun org-diary-sexp-entry (sexp entry date)
15458 "Process a SEXP diary ENTRY for DATE."
15459 (require 'diary-lib)
15460 (let ((result (if calendar-debug-sexp
15461 (let ((stack-trace-on-error t))
15462 (eval (car (read-from-string sexp))))
15463 (condition-case nil
15464 (eval (car (read-from-string sexp)))
15465 (error
15466 (beep)
15467 (message "Bad sexp at line %d in %s: %s"
15468 (org-current-line)
15469 (buffer-file-name) sexp)
15470 (sleep-for 2))))))
15471 (cond ((stringp result) (split-string result "; "))
15472 ((and (consp result)
15473 (not (consp (cdr result)))
15474 (stringp (cdr result))) (cdr result))
15475 ((and (consp result)
15476 (stringp (car result))) result)
15477 (result entry)
15478 (t nil))))
15480 (defun org-diary-to-ical-string (frombuf)
15481 "Get iCalendar entries from diary entries in buffer FROMBUF.
15482 This uses the icalendar.el library."
15483 (let* ((tmpdir (if (featurep 'xemacs)
15484 (temp-directory)
15485 temporary-file-directory))
15486 (tmpfile (make-temp-name
15487 (expand-file-name "orgics" tmpdir)))
15488 buf rtn b e)
15489 (with-current-buffer frombuf
15490 (icalendar-export-region (point-min) (point-max) tmpfile)
15491 (setq buf (find-buffer-visiting tmpfile))
15492 (set-buffer buf)
15493 (goto-char (point-min))
15494 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15495 (setq b (match-beginning 0)))
15496 (goto-char (point-max))
15497 (if (re-search-backward "^END:VEVENT" nil t)
15498 (setq e (match-end 0)))
15500 (kill-buffer buf)
15501 (delete-file tmpfile)
15502 rtn))
15504 (defun org-closest-date (start current change prefer show-all)
15505 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15506 When PREFER is `past', return a date that is either CURRENT or past.
15507 When PREFER is `future', return a date that is either CURRENT or future.
15508 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15509 ;; Make the proper lists from the dates
15510 (catch 'exit
15511 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15512 dn dw sday cday n1 n2 n0
15513 d m y y1 y2 date1 date2 nmonths nm ny m2)
15515 (setq start (org-date-to-gregorian start)
15516 current (org-date-to-gregorian
15517 (if show-all
15518 current
15519 (time-to-days (current-time))))
15520 sday (calendar-absolute-from-gregorian start)
15521 cday (calendar-absolute-from-gregorian current))
15523 (if (<= cday sday) (throw 'exit sday))
15526 (setq dn (string-to-number (match-string 1 change))
15527 dw (cdr (assoc (match-string 2 change) a1)))
15528 (error "Invalid change specifier: %s" change))
15529 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15530 (cond
15531 ((eq dw 'day)
15532 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15533 n2 (+ n1 dn)))
15534 ((eq dw 'year)
15535 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15536 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15537 (setq date1 (list m d y1)
15538 n1 (calendar-absolute-from-gregorian date1)
15539 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15540 n2 (calendar-absolute-from-gregorian date2)))
15541 ((eq dw 'month)
15542 ;; approx number of month between the two dates
15543 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15544 ;; How often does dn fit in there?
15545 (setq d (nth 1 start) m (car start) y (nth 2 start)
15546 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15547 m (+ m nm)
15548 ny (floor (/ m 12))
15549 y (+ y ny)
15550 m (- m (* ny 12)))
15551 (while (> m 12) (setq m (- m 12) y (1+ y)))
15552 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15553 (setq m2 (+ m dn) y2 y)
15554 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15555 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15556 (while (<= n2 cday)
15557 (setq n1 n2 m m2 y y2)
15558 (setq m2 (+ m dn) y2 y)
15559 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15560 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15561 ;; Make sure n1 is the earlier date
15562 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15563 (if show-all
15564 (cond
15565 ((eq prefer 'past) (if (= cday n2) n2 n1))
15566 ((eq prefer 'future) (if (= cday n1) n1 n2))
15567 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15568 (cond
15569 ((eq prefer 'past) (if (= cday n2) n2 n1))
15570 ((eq prefer 'future) (if (= cday n1) n1 n2))
15571 (t (if (= cday n1) n1 n2)))))))
15573 (defun org-date-to-gregorian (date)
15574 "Turn any specification of DATE into a Gregorian date for the calendar."
15575 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15576 ((and (listp date) (= (length date) 3)) date)
15577 ((stringp date)
15578 (setq date (org-parse-time-string date))
15579 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15580 ((listp date)
15581 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15583 (defun org-parse-time-string (s &optional nodefault)
15584 "Parse the standard Org-mode time string.
15585 This should be a lot faster than the normal `parse-time-string'.
15586 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15587 hour and minute fields will be nil if not given."
15588 (if (string-match org-ts-regexp0 s)
15589 (list 0
15590 (if (or (match-beginning 8) (not nodefault))
15591 (string-to-number (or (match-string 8 s) "0")))
15592 (if (or (match-beginning 7) (not nodefault))
15593 (string-to-number (or (match-string 7 s) "0")))
15594 (string-to-number (match-string 4 s))
15595 (string-to-number (match-string 3 s))
15596 (string-to-number (match-string 2 s))
15597 nil nil nil)
15598 (error "Not a standard Org-mode time string: %s" s)))
15600 (defun org-timestamp-up (&optional arg)
15601 "Increase the date item at the cursor by one.
15602 If the cursor is on the year, change the year. If it is on the month,
15603 the day or the time, change that.
15604 With prefix ARG, change by that many units."
15605 (interactive "p")
15606 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15608 (defun org-timestamp-down (&optional arg)
15609 "Decrease the date item at the cursor by one.
15610 If the cursor is on the year, change the year. If it is on the month,
15611 the day or the time, change that.
15612 With prefix ARG, change by that many units."
15613 (interactive "p")
15614 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15616 (defun org-timestamp-up-day (&optional arg)
15617 "Increase the date in the time stamp by one day.
15618 With prefix ARG, change that many days."
15619 (interactive "p")
15620 (if (and (not (org-at-timestamp-p t))
15621 (org-on-heading-p))
15622 (org-todo 'up)
15623 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15625 (defun org-timestamp-down-day (&optional arg)
15626 "Decrease the date in the time stamp by one day.
15627 With prefix ARG, change that many days."
15628 (interactive "p")
15629 (if (and (not (org-at-timestamp-p t))
15630 (org-on-heading-p))
15631 (org-todo 'down)
15632 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15634 (defun org-at-timestamp-p (&optional inactive-ok)
15635 "Determine if the cursor is in or at a timestamp."
15636 (interactive)
15637 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15638 (pos (point))
15639 (ans (or (looking-at tsr)
15640 (save-excursion
15642 (if (> (point) (point-min)) (backward-char 1))
15643 (and (looking-at tsr)
15644 (> (- (match-end 0) pos) -1))))))
15645 (and ans
15646 (boundp 'org-ts-what)
15647 (setq org-ts-what
15648 (cond
15649 ((= pos (match-beginning 0)) 'bracket)
15650 ;; Point is considered to be "on the bracket" whether
15651 ;; it's really on it or right after it.
15652 ((or (= pos (1- (match-end 0)))
15653 (= pos (match-end 0))) 'bracket)
15654 ((org-pos-in-match-range pos 2) 'year)
15655 ((org-pos-in-match-range pos 3) 'month)
15656 ((org-pos-in-match-range pos 7) 'hour)
15657 ((org-pos-in-match-range pos 8) 'minute)
15658 ((or (org-pos-in-match-range pos 4)
15659 (org-pos-in-match-range pos 5)) 'day)
15660 ((and (> pos (or (match-end 8) (match-end 5)))
15661 (< pos (match-end 0)))
15662 (- pos (or (match-end 8) (match-end 5))))
15663 (t 'day))))
15664 ans))
15666 (defun org-toggle-timestamp-type ()
15667 "Toggle the type (<active> or [inactive]) of a time stamp."
15668 (interactive)
15669 (when (org-at-timestamp-p t)
15670 (let ((beg (match-beginning 0)) (end (match-end 0))
15671 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15672 (save-excursion
15673 (goto-char beg)
15674 (while (re-search-forward "[][<>]" end t)
15675 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15676 t t)))
15677 (message "Timestamp is now %sactive"
15678 (if (equal (char-after beg) ?<) "" "in")))))
15680 (defun org-timestamp-change (n &optional what updown)
15681 "Change the date in the time stamp at point.
15682 The date will be changed by N times WHAT. WHAT can be `day', `month',
15683 `year', `minute', `second'. If WHAT is not given, the cursor position
15684 in the timestamp determines what will be changed."
15685 (let ((origin (point)) origin-cat
15686 with-hm inactive
15687 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15688 org-ts-what
15689 extra rem
15690 ts time time0)
15691 (if (not (org-at-timestamp-p t))
15692 (error "Not at a timestamp"))
15693 (if (and (not what) (eq org-ts-what 'bracket))
15694 (org-toggle-timestamp-type)
15695 ;; Point isn't on brackets. Remember the part of the time-stamp
15696 ;; the point was in. Indeed, size of time-stamps may change,
15697 ;; but point must be kept in the same category nonetheless.
15698 (setq origin-cat org-ts-what)
15699 (if (and (not what) (not (eq org-ts-what 'day))
15700 org-display-custom-times
15701 (get-text-property (point) 'display)
15702 (not (get-text-property (1- (point)) 'display)))
15703 (setq org-ts-what 'day))
15704 (setq org-ts-what (or what org-ts-what)
15705 inactive (= (char-after (match-beginning 0)) ?\[)
15706 ts (match-string 0))
15707 (replace-match "")
15708 (if (string-match
15710 ts)
15711 (setq extra (match-string 1 ts)))
15713 (setq with-hm t))
15714 (setq time0 (org-parse-time-string ts))
15715 (when (and updown
15716 (eq org-ts-what 'minute)
15717 (not current-prefix-arg))
15718 ;; This looks like s-up and s-down. Change by one rounding step.
15719 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15720 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15721 (setcar (cdr time0) (+ (nth 1 time0)
15722 (if (> n 0) (- rem) (- dm rem))))))
15723 (setq time
15724 (encode-time (or (car time0) 0)
15725 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15726 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15727 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15728 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15729 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15730 (nthcdr 6 time0)))
15731 (when (and (member org-ts-what '(hour minute))
15732 extra
15734 (setq extra (org-modify-ts-extra
15735 extra
15736 (if (eq org-ts-what 'hour) 2 5)
15737 n dm)))
15738 (when (integerp org-ts-what)
15739 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15740 (if (eq what 'calendar)
15741 (let ((cal-date (org-get-date-from-calendar)))
15742 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15743 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15744 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15745 (setcar time0 (or (car time0) 0))
15746 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15747 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15748 (setq time (apply 'encode-time time0))))
15749 ;; Insert the new time-stamp, and ensure point stays in the same
15750 ;; category as before (i.e. not after the last position in that
15751 ;; category).
15752 (let ((pos (point)))
15753 ;; Stay before inserted string. `save-excursion' is of no use.
15754 (setq org-last-changed-timestamp
15755 (org-insert-time-stamp time with-hm inactive nil nil extra))
15756 (goto-char pos))
15757 (save-match-data
15758 (looking-at org-ts-regexp3)
15759 (goto-char (cond
15760 ;; `day' category ends before `hour' if any, or at
15761 ;; the end of the day name.
15762 ((eq origin-cat 'day)
15763 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15764 ((eq origin-cat 'hour) (min (match-end 7) origin))
15765 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15766 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15767 ;; `year' and `month' have both fixed size: point
15768 ;; couldn't have moved into another part.
15769 (t origin))))
15770 ;; Update clock if on a CLOCK line.
15771 (org-clock-update-time-maybe)
15772 ;; Try to recenter the calendar window, if any.
15773 (if (and org-calendar-follow-timestamp-change
15774 (get-buffer-window "*Calendar*" t)
15775 (memq org-ts-what '(day month year)))
15776 (org-recenter-calendar (time-to-days time))))))
15778 (defun org-modify-ts-extra (s pos n dm)
15779 "Change the different parts of the lead-time and repeat fields in timestamp."
15780 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15781 ng h m new rem)
15782 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15783 (cond
15784 ((or (org-pos-in-match-range pos 2)
15785 (org-pos-in-match-range pos 3))
15786 (setq m (string-to-number (match-string 3 s))
15787 h (string-to-number (match-string 2 s)))
15788 (if (org-pos-in-match-range pos 2)
15789 (setq h (+ h n))
15790 (setq n (* dm (org-no-warnings (signum n))))
15791 (when (not (= 0 (setq rem (% m dm))))
15792 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15793 (setq m (+ m n)))
15794 (if (< m 0) (setq m (+ m 60) h (1- h)))
15795 (if (> m 59) (setq m (- m 60) h (1+ h)))
15796 (setq h (min 24 (max 0 h)))
15797 (setq ng 1 new (format "-%02d:%02d" h m)))
15798 ((org-pos-in-match-range pos 6)
15799 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15800 ((org-pos-in-match-range pos 5)
15801 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15803 ((org-pos-in-match-range pos 9)
15804 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15805 ((org-pos-in-match-range pos 8)
15806 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15808 (when ng
15809 (setq s (concat
15810 (substring s 0 (match-beginning ng))
15811 new
15812 (substring s (match-end ng))))))
15813 s))
15815 (defun org-recenter-calendar (date)
15816 "If the calendar is visible, recenter it to DATE."
15817 (let* ((win (selected-window))
15818 (cwin (get-buffer-window "*Calendar*" t))
15819 (calendar-move-hook nil))
15820 (when cwin
15821 (select-window cwin)
15822 (calendar-goto-date (if (listp date) date
15823 (calendar-gregorian-from-absolute date)))
15824 (select-window win))))
15826 (defun org-goto-calendar (&optional arg)
15827 "Go to the Emacs calendar at the current date.
15828 If there is a time stamp in the current line, go to that date.
15829 A prefix ARG can be used to force the current date."
15830 (interactive "P")
15831 (let ((tsr org-ts-regexp) diff
15832 (calendar-move-hook nil)
15833 (calendar-view-holidays-initially-flag nil)
15834 (calendar-view-diary-initially-flag nil))
15835 (if (or (org-at-timestamp-p)
15836 (save-excursion
15837 (beginning-of-line 1)
15838 (looking-at (concat ".*" tsr))))
15839 (let ((d1 (time-to-days (current-time)))
15840 (d2 (time-to-days
15841 (org-time-string-to-time (match-string 1)))))
15842 (setq diff (- d2 d1))))
15843 (calendar)
15844 (calendar-goto-today)
15845 (if (and diff (not arg)) (calendar-forward-day diff))))
15847 (defun org-get-date-from-calendar ()
15848 "Return a list (month day year) of date at point in calendar."
15849 (with-current-buffer "*Calendar*"
15850 (save-match-data
15851 (calendar-cursor-to-date))))
15853 (defun org-date-from-calendar ()
15854 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15855 If there is already a time stamp at the cursor position, update it."
15856 (interactive)
15857 (if (org-at-timestamp-p t)
15858 (org-timestamp-change 0 'calendar)
15859 (let ((cal-date (org-get-date-from-calendar)))
15860 (org-insert-time-stamp
15861 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15863 (defcustom org-effort-durations
15864 `(("h" . 60)
15865 ("d" . ,(* 60 8))
15866 ("w" . ,(* 60 8 5))
15867 ("m" . ,(* 60 8 5 4))
15868 ("y" . ,(* 60 8 5 40)))
15869 "Conversion factor to minutes for an effort modifier.
15871 Each entry has the form (MODIFIER . MINUTES).
15873 In an effort string, a number followed by MODIFIER is multiplied
15874 by the specified number of MINUTES to obtain an effort in
15875 minutes.
15879 :group 'org-agenda
15880 :type '(alist :key-type (string :tag "Modifier")
15881 :value-type (number :tag "Minutes")))
15883 ;;;; Files
15885 (defun org-save-all-org-buffers ()
15886 "Save all Org-mode buffers without user confirmation."
15887 (interactive)
15888 (message "Saving all Org-mode buffers...")
15889 (save-some-buffers t 'org-mode-p)
15890 (when (featurep 'org-id) (org-id-locations-save))
15891 (message "Saving all Org-mode buffers... done"))
15893 (defun org-revert-all-org-buffers ()
15894 "Revert all Org-mode buffers.
15895 Prompt for confirmation when there are unsaved changes.
15896 Be sure you know what you are doing before letting this function
15897 overwrite your changes.
15899 This function is useful in a setup where one tracks org files
15900 with a version control system, to revert on one machine after pulling
15901 changes from another. I believe the procedure must be like this:
15903 1. M-x org-save-all-org-buffers
15904 2. Pull changes from the other machine, resolve conflicts
15905 3. M-x org-revert-all-org-buffers"
15906 (interactive)
15907 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15908 (error "Abort"))
15909 (save-excursion
15910 (save-window-excursion
15911 (mapc
15912 (lambda (b)
15913 (when (and (with-current-buffer b (org-mode-p))
15914 (with-current-buffer b buffer-file-name))
15915 (org-pop-to-buffer-same-window b)
15916 (revert-buffer t 'no-confirm)))
15917 (buffer-list))
15918 (when (and (featurep 'org-id) org-id-track-globally)
15919 (org-id-locations-load)))))
15921 ;;;; Agenda files
15923 ;;;###autoload
15924 (defun org-switchb (&optional arg)
15925 "Switch between Org buffers.
15926 With a prefix argument, restrict available to files.
15927 With two prefix arguments, restrict available buffers to agenda files.
15929 Defaults to `iswitchb' for buffer name completion.
15930 Set `org-completion-use-ido' to make it use ido instead."
15931 (interactive "P")
15932 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15933 ((equal arg '(16)) (org-buffer-list 'agenda))
15934 (t (org-buffer-list))))
15935 (org-completion-use-iswitchb org-completion-use-iswitchb)
15936 (org-completion-use-ido org-completion-use-ido))
15937 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15938 (setq org-completion-use-iswitchb t))
15939 (org-pop-to-buffer-same-window
15940 (org-icompleting-read "Org buffer: "
15941 (mapcar 'list (mapcar 'buffer-name blist))
15942 nil t))))
15944 ;;; Define some older names previously used for this functionality
15945 ;;;###autoload
15946 (defalias 'org-ido-switchb 'org-switchb)
15947 ;;;###autoload
15948 (defalias 'org-iswitchb 'org-switchb)
15950 (defun org-buffer-list (&optional predicate exclude-tmp)
15951 "Return a list of Org buffers.
15952 PREDICATE can be `export', `files' or `agenda'.
15954 export restrict the list to Export buffers.
15955 files restrict the list to buffers visiting Org files.
15956 agenda restrict the list to buffers visiting agenda files.
15958 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15959 (let* ((bfn nil)
15960 (agenda-files (and (eq predicate 'agenda)
15961 (mapcar 'file-truename (org-agenda-files t))))
15962 (filter
15963 (cond
15964 ((eq predicate 'files)
15965 (lambda (b) (with-current-buffer b (org-mode-p))))
15966 ((eq predicate 'export)
15967 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15968 ((eq predicate 'agenda)
15969 (lambda (b)
15970 (with-current-buffer b
15971 (and (org-mode-p)
15972 (setq bfn (buffer-file-name b))
15973 (member (file-truename bfn) agenda-files)))))
15974 (t (lambda (b) (with-current-buffer b
15975 (or (org-mode-p)
15976 (string-match "\*Org .*Export"
15977 (buffer-name b)))))))))
15978 (delq nil
15979 (mapcar
15980 (lambda(b)
15981 (if (and (funcall filter b)
15982 (or (not exclude-tmp)
15983 (not (string-match "tmp" (buffer-name b)))))
15984 b
15985 nil))
15986 (buffer-list)))))
15988 (defun org-agenda-files (&optional unrestricted archives)
15989 "Get the list of agenda files.
15990 Optional UNRESTRICTED means return the full list even if a restriction
15991 is currently in place.
15992 When ARCHIVES is t, include all archive files that are really being
15993 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15994 `org-agenda-archives-mode' is t."
15995 (let ((files
15996 (cond
15997 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15998 ((stringp org-agenda-files) (org-read-agenda-file-list))
15999 ((listp org-agenda-files) org-agenda-files)
16000 (t (error "Invalid value of `org-agenda-files'")))))
16001 (setq files (apply 'append
16002 (mapcar (lambda (f)
16003 (if (file-directory-p f)
16004 (directory-files
16005 f t org-agenda-file-regexp)
16006 (list f)))
16007 files)))
16008 (when org-agenda-skip-unavailable-files
16009 (setq files (delq nil
16010 (mapcar (function
16011 (lambda (file)
16012 (and (file-readable-p file) file)))
16013 files))))
16014 (when (or (eq archives t)
16015 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16016 (setq files (org-add-archive-files files)))
16017 files))
16019 (defun org-agenda-file-p (&optional file)
16020 "Return non-nil, if FILE is an agenda file.
16021 If FILE is omitted, use the file associated with the current
16022 buffer."
16023 (member (or file (buffer-file-name))
16024 (org-agenda-files t)))
16026 (defun org-edit-agenda-file-list ()
16027 "Edit the list of agenda files.
16028 Depending on setup, this either uses customize to edit the variable
16029 `org-agenda-files', or it visits the file that is holding the list. In the
16030 latter case, the buffer is set up in a way that saving it automatically kills
16031 the buffer and restores the previous window configuration."
16032 (interactive)
16033 (if (stringp org-agenda-files)
16034 (let ((cw (current-window-configuration)))
16035 (find-file org-agenda-files)
16036 (org-set-local 'org-window-configuration cw)
16037 (org-add-hook 'after-save-hook
16038 (lambda ()
16039 (set-window-configuration
16040 (prog1 org-window-configuration
16041 (kill-buffer (current-buffer))))
16042 (org-install-agenda-files-menu)
16043 (message "New agenda file list installed"))
16044 nil 'local)
16045 (message "%s" (substitute-command-keys
16047 (customize-variable 'org-agenda-files)))
16049 (defun org-store-new-agenda-file-list (list)
16050 "Set new value for the agenda file list and save it correctly."
16051 (if (stringp org-agenda-files)
16052 (let ((fe (org-read-agenda-file-list t)) b u)
16053 (while (setq b (find-buffer-visiting org-agenda-files))
16054 (kill-buffer b))
16055 (with-temp-file org-agenda-files
16056 (insert
16057 (mapconcat
16058 (lambda (f) ;; Keep un-expanded entries.
16059 (if (setq u (assoc f fe))
16060 (cdr u)
16061 f))
16064 (let ((org-mode-hook nil) (org-inhibit-startup t)
16065 (org-insert-mode-line-in-empty-file nil))
16066 (setq org-agenda-files list)
16067 (customize-save-variable 'org-agenda-files org-agenda-files))))
16069 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16070 "Read the list of agenda files from a file.
16071 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16072 filenames, used by `org-store-new-agenda-file-list' to write back
16073 un-expanded file names."
16074 (when (file-directory-p org-agenda-files)
16075 (error "`org-agenda-files' cannot be a single directory"))
16076 (when (stringp org-agenda-files)
16077 (with-temp-buffer
16078 (insert-file-contents org-agenda-files)
16079 (mapcar
16080 (lambda (f)
16081 (let ((e (expand-file-name (substitute-in-file-name f)
16082 org-directory)))
16083 (if pair-with-expansion
16084 (cons e f)
16085 e)))
16088 ;;;###autoload
16089 (defun org-cycle-agenda-files ()
16090 "Cycle through the files in `org-agenda-files'.
16091 If the current buffer visits an agenda file, find the next one in the list.
16092 If the current buffer does not, find the first agenda file."
16093 (interactive)
16094 (let* ((fs (org-agenda-files t))
16095 (files (append fs (list (car fs))))
16096 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16097 file)
16098 (unless files (error "No agenda files"))
16099 (catch 'exit
16100 (while (setq file (pop files))
16101 (if (equal (file-truename file) tcf)
16102 (when (car files)
16103 (find-file (car files))
16104 (throw 'exit t))))
16105 (find-file (car fs)))
16106 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16108 (defun org-agenda-file-to-front (&optional to-end)
16109 "Move/add the current file to the top of the agenda file list.
16110 If the file is not present in the list, it is added to the front. If it is
16111 present, it is moved there. With optional argument TO-END, add/move to the
16112 end of the list."
16113 (interactive "P")
16114 (let ((org-agenda-skip-unavailable-files nil)
16115 (file-alist (mapcar (lambda (x)
16116 (cons (file-truename x) x))
16117 (org-agenda-files t)))
16118 (ctf (file-truename buffer-file-name))
16119 x had)
16120 (setq x (assoc ctf file-alist) had x)
16122 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16123 (if to-end
16124 (setq file-alist (append (delq x file-alist) (list x)))
16125 (setq file-alist (cons x (delq x file-alist))))
16126 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16127 (org-install-agenda-files-menu)
16128 (message "File %s to %s of agenda file list"
16129 (if had "moved" "added") (if to-end "end" "front"))))
16131 (defun org-remove-file (&optional file)
16132 "Remove current file from the list of files in variable `org-agenda-files'.
16133 These are the files which are being checked for agenda entries.
16134 Optional argument FILE means use this file instead of the current."
16135 (interactive)
16136 (let* ((org-agenda-skip-unavailable-files nil)
16137 (file (or file buffer-file-name))
16138 (true-file (file-truename file))
16139 (afile (abbreviate-file-name file))
16140 (files (delq nil (mapcar
16141 (lambda (x)
16142 (if (equal true-file
16143 (file-truename x))
16144 nil x))
16145 (org-agenda-files t)))))
16146 (if (not (= (length files) (length (org-agenda-files t))))
16147 (progn
16148 (org-store-new-agenda-file-list files)
16149 (org-install-agenda-files-menu)
16150 (message "Removed file: %s" afile))
16151 (message "File was not in list: %s (not removed)" afile))))
16153 (defun org-file-menu-entry (file)
16154 (vector file (list 'find-file file) t))
16156 (defun org-check-agenda-file (file)
16157 "Make sure FILE exists. If not, ask user what to do."
16158 (when (not (file-exists-p file))
16159 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16160 (abbreviate-file-name file))
16161 (let ((r (downcase (read-char-exclusive))))
16162 (cond
16163 ((equal r ?r)
16164 (org-remove-file file)
16165 (throw 'nextfile t))
16166 (t (error "Abort"))))))
16168 (defun org-get-agenda-file-buffer (file)
16169 "Get a buffer visiting FILE. If the buffer needs to be created, add
16170 it to the list of buffers which might be released later."
16171 (let ((buf (org-find-base-buffer-visiting file)))
16172 (if buf
16173 buf ; just return it
16174 ;; Make a new buffer and remember it
16175 (setq buf (find-file-noselect file))
16176 (if buf (push buf org-agenda-new-buffers))
16177 buf)))
16179 (defun org-release-buffers (blist)
16180 "Release all buffers in list, asking the user for confirmation when needed.
16181 When a buffer is unmodified, it is just killed. When modified, it is saved
16182 \(if the user agrees) and then killed."
16183 (let (buf file)
16184 (while (setq buf (pop blist))
16185 (setq file (buffer-file-name buf))
16186 (when (and (buffer-modified-p buf)
16187 file
16188 (y-or-n-p (format "Save file %s? " file)))
16189 (with-current-buffer buf (save-buffer)))
16190 (kill-buffer buf))))
16192 (defun org-prepare-agenda-buffers (files)
16193 "Create buffers for all agenda files, protect archived trees and comments."
16194 (interactive)
16195 (let ((pa '(:org-archived t))
16196 (pc '(:org-comment t))
16197 (pall '(:org-archived t :org-comment t))
16198 (inhibit-read-only t)
16199 (rea (concat ":" org-archive-tag ":"))
16200 bmp file re)
16201 (save-excursion
16202 (save-restriction
16203 (while (setq file (pop files))
16204 (catch 'nextfile
16205 (if (bufferp file)
16206 (set-buffer file)
16207 (org-check-agenda-file file)
16208 (set-buffer (org-get-agenda-file-buffer file)))
16209 (widen)
16210 (setq bmp (buffer-modified-p))
16211 (org-refresh-category-properties)
16212 (setq org-todo-keywords-for-agenda
16213 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16214 (setq org-done-keywords-for-agenda
16215 (append org-done-keywords-for-agenda org-done-keywords))
16216 (setq org-todo-keyword-alist-for-agenda
16217 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16218 (setq org-drawers-for-agenda
16219 (append org-drawers-for-agenda org-drawers))
16220 (setq org-tag-alist-for-agenda
16221 (append org-tag-alist-for-agenda org-tag-alist))
16223 (save-excursion
16224 (remove-text-properties (point-min) (point-max) pall)
16225 (when org-agenda-skip-archived-trees
16226 (goto-char (point-min))
16227 (while (re-search-forward rea nil t)
16228 (if (org-on-heading-p t)
16229 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16230 (goto-char (point-min))
16232 (while (re-search-forward re nil t)
16233 (add-text-properties
16234 (match-beginning 0) (org-end-of-subtree t) pc)))
16235 (set-buffer-modified-p bmp)))))
16236 (setq org-todo-keywords-for-agenda
16237 (org-uniquify org-todo-keywords-for-agenda))
16238 (setq org-todo-keyword-alist-for-agenda
16239 (org-uniquify org-todo-keyword-alist-for-agenda)
16240 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16242 ;;;; Embedded LaTeX
16244 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16245 "Keymap for the minor `org-cdlatex-mode'.")
16247 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16248 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16249 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16250 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16251 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16253 (defvar org-cdlatex-texmathp-advice-is-done nil
16254 "Flag remembering if we have applied the advice to texmathp already.")
16256 (define-minor-mode org-cdlatex-mode
16257 "Toggle the minor `org-cdlatex-mode'.
16258 This mode supports entering LaTeX environment and math in LaTeX fragments
16259 in Org-mode.
16261 nil " OCDL" nil
16262 (when org-cdlatex-mode (require 'cdlatex))
16263 (unless org-cdlatex-texmathp-advice-is-done
16264 (setq org-cdlatex-texmathp-advice-is-done t)
16265 (defadvice texmathp (around org-math-always-on activate)
16266 "Always return t in org-mode buffers.
16267 This is because we want to insert math symbols without dollars even outside
16268 the LaTeX math segments. If Orgmode thinks that point is actually inside
16269 an embedded LaTeX fragment, let texmathp do its job.
16271 (interactive)
16272 (let (p)
16273 (cond
16274 ((not (org-mode-p)) ad-do-it)
16275 ((eq this-command 'cdlatex-math-symbol)
16276 (setq ad-return-value t
16277 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16278 (t
16279 (let ((p (org-inside-LaTeX-fragment-p)))
16280 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16281 (setq ad-return-value t
16282 texmathp-why '("Org-mode embedded math" . 0))
16283 (if p ad-do-it)))))))))
16285 (defun turn-on-org-cdlatex ()
16286 "Unconditionally turn on `org-cdlatex-mode'."
16287 (org-cdlatex-mode 1))
16289 (defun org-inside-LaTeX-fragment-p ()
16290 "Test if point is inside a LaTeX fragment.
16292 sequence appearing also before point.
16293 Even though the matchers for math are configurable, this function assumes
16295 delimiters are skipped when they have been removed by customization.
16296 The return value is nil, or a cons cell with the delimiter and the
16297 position of this delimiter.
16299 This function does a reasonably good job, but can locally be fooled by
16300 for example currency specifications. For example it will assume being in
16302 fragments that are properly closed, but during editing, we have to live
16303 with the uncertainty caused by missing closing delimiters. This function
16304 looks only before point, not after."
16305 (catch 'exit
16306 (let ((pos (point))
16307 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16308 (lim (progn
16310 (point)))
16311 dd-on str (start 0) m re)
16312 (goto-char pos)
16313 (when dodollar
16315 re (nth 1 (assoc "$" org-latex-regexps)))
16316 (while (string-match re str start)
16317 (cond
16318 ((= (match-end 0) (length str))
16319 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16320 ((= (match-end 0) (- (length str) 5))
16321 (throw 'exit nil))
16322 (t (setq start (match-end 0))))))
16323 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16324 (goto-char pos)
16325 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16326 (and (match-beginning 2) (throw 'exit nil))
16327 ;; count $$
16329 (setq dd-on (not dd-on)))
16330 (goto-char pos)
16331 (if dd-on (cons "$$" m))))))
16333 (defun org-inside-latex-macro-p ()
16334 "Is point inside a LaTeX macro or its arguments?"
16335 (save-match-data
16336 (org-in-regexp
16339 (defun org-try-cdlatex-tab ()
16340 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16341 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16342 - inside a LaTeX fragment, or
16343 - after the first word in a line, where an abbreviation expansion could
16344 insert a LaTeX environment."
16345 (when org-cdlatex-mode
16346 (cond
16347 ((save-excursion
16348 (skip-chars-backward "a-zA-Z0-9*")
16350 (bolp))
16351 (cdlatex-tab) t)
16352 ((org-inside-LaTeX-fragment-p)
16353 (cdlatex-tab) t)
16354 (t nil))))
16356 (defun org-cdlatex-underscore-caret (&optional arg)
16357 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16358 Revert to the normal definition outside of these fragments."
16359 (interactive "P")
16360 (if (org-inside-LaTeX-fragment-p)
16361 (call-interactively 'cdlatex-sub-superscript)
16362 (let (org-cdlatex-mode)
16363 (call-interactively (key-binding (vector last-input-event))))))
16365 (defun org-cdlatex-math-modify (&optional arg)
16366 "Execute `cdlatex-math-modify' in LaTeX fragments.
16367 Revert to the normal definition outside of these fragments."
16368 (interactive "P")
16369 (if (org-inside-LaTeX-fragment-p)
16370 (call-interactively 'cdlatex-math-modify)
16371 (let (org-cdlatex-mode)
16372 (call-interactively (key-binding (vector last-input-event))))))
16374 (defvar org-latex-fragment-image-overlays nil
16375 "List of overlays carrying the images of latex fragments.")
16376 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16378 (defun org-remove-latex-fragment-image-overlays ()
16379 "Remove all overlays with LaTeX fragment images in current buffer."
16380 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16381 (setq org-latex-fragment-image-overlays nil))
16383 (defun org-preview-latex-fragment (&optional subtree)
16384 "Preview the LaTeX fragment at point, or all locally or globally.
16385 If the cursor is in a LaTeX fragment, create the image and overlay
16386 it over the source code. If there is no fragment at point, display
16387 all fragments in the current text, from one headline to the next. With
16388 prefix SUBTREE, display all fragments in the current subtree. With a
16390 the cursor is before the first headline,
16391 display all fragments in the buffer.
16393 (interactive "P")
16394 (org-remove-latex-fragment-image-overlays)
16395 (save-excursion
16396 (save-restriction
16397 (let (beg end at msg)
16398 (cond
16399 ((or (equal subtree '(16))
16400 (not (save-excursion
16401 (re-search-backward org-outline-regexp-bol nil t))))
16402 (setq beg (point-min) end (point-max)
16403 msg "Creating images for buffer...%s"))
16404 ((equal subtree '(4))
16405 (org-back-to-heading)
16406 (setq beg (point) end (org-end-of-subtree t)
16407 msg "Creating images for subtree...%s"))
16408 (t
16409 (if (setq at (org-inside-LaTeX-fragment-p))
16410 (goto-char (max (point-min) (- (cdr at) 2)))
16411 (org-back-to-heading))
16412 (setq beg (point) end (progn (outline-next-heading) (point))
16413 msg (if at "Creating image...%s"
16414 "Creating images for entry...%s"))))
16415 (message msg "")
16416 (narrow-to-region beg end)
16417 (goto-char beg)
16418 (org-format-latex
16419 (concat "ltxpng/" (file-name-sans-extension
16420 (file-name-nondirectory
16421 buffer-file-name)))
16422 default-directory 'overlays msg at 'forbuffer 'dvipng)
16423 (message msg "done. Use `C-c C-c' to remove images.")))))
16425 (defvar org-latex-regexps
16427 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16430 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16434 "Regular expressions for matching embedded LaTeX.")
16436 (defvar org-export-have-math nil) ;; dynamic scoping
16437 (defun org-format-latex (prefix &optional dir overlays msg at
16438 forbuffer processing-type)
16439 "Replace LaTeX fragments with links to an image, and produce images.
16440 Some of the options can be changed using the variable
16441 `org-format-latex-options'."
16442 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16443 (let* ((prefixnodir (file-name-nondirectory prefix))
16444 (absprefix (expand-file-name prefix dir))
16445 (todir (file-name-directory absprefix))
16446 (opt org-format-latex-options)
16447 (matchers (plist-get opt :matchers))
16448 (re-list org-latex-regexps)
16449 (org-format-latex-header-extra
16450 (plist-get (org-infile-export-plist) :latex-header-extra))
16451 (cnt 0) txt hash link beg end re e checkdir
16452 executables-checked string
16453 m n block linkfile movefile ov)
16454 ;; Check the different regular expressions
16455 (while (setq e (pop re-list))
16456 (setq m (car e) re (nth 1 e) n (nth 2 e)
16458 (when (member m matchers)
16459 (goto-char (point-min))
16460 (while (re-search-forward re nil t)
16461 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16462 (not (get-text-property (match-beginning n)
16463 'org-protected))
16464 (or (not overlays)
16465 (not (eq (get-char-property (match-beginning n)
16466 'org-overlay-type)
16467 'org-latex-overlay))))
16468 (setq org-export-have-math t)
16469 (cond
16470 ((eq processing-type 'verbatim)
16471 ;; Leave the text verbatim, just protect it
16472 (add-text-properties (match-beginning n) (match-end n)
16473 '(org-protected t)))
16474 ((eq processing-type 'mathjax)
16475 ;; Prepare for MathJax processing
16476 (setq string (match-string n))
16477 (if (member m '("$" "$1"))
16478 (save-excursion
16479 (delete-region (match-beginning n) (match-end n))
16480 (goto-char (match-beginning n))
16483 '(org-protected t))))
16484 (add-text-properties (match-beginning n) (match-end n)
16485 '(org-protected t))))
16486 ((or (eq processing-type 'dvipng) t)
16487 ;; Process to an image
16488 (setq txt (match-string n)
16489 beg (match-beginning n) end (match-end n)
16490 cnt (1+ cnt))
16491 (let (print-length print-level) ; make sure full list is printed
16492 (setq hash (sha1 (prin1-to-string
16493 (list org-format-latex-header
16494 org-format-latex-header-extra
16495 org-export-latex-default-packages-alist
16496 org-export-latex-packages-alist
16497 org-format-latex-options
16498 forbuffer txt)))
16499 linkfile (format "%s_%s.png" prefix hash)
16500 movefile (format "%s_%s.png" absprefix hash)))
16501 (setq link (concat block "[[file:" linkfile "]]" block))
16502 (if msg (message msg cnt))
16503 (goto-char beg)
16504 (unless checkdir ; make sure the directory exists
16505 (setq checkdir t)
16506 (or (file-directory-p todir) (make-directory todir t)))
16508 (unless executables-checked
16509 (org-check-external-command
16510 "latex" "needed to convert LaTeX fragments to images")
16511 (org-check-external-command
16512 "dvipng" "needed to convert LaTeX fragments to images")
16513 (setq executables-checked t))
16515 (unless (file-exists-p movefile)
16516 (org-create-formula-image
16517 txt movefile opt forbuffer))
16518 (if overlays
16519 (progn
16520 (mapc (lambda (o)
16521 (if (eq (overlay-get o 'org-overlay-type)
16522 'org-latex-overlay)
16523 (delete-overlay o)))
16524 (overlays-in beg end))
16525 (setq ov (make-overlay beg end))
16526 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16527 (if (featurep 'xemacs)
16528 (progn
16529 (overlay-put ov 'invisible t)
16530 (overlay-put
16531 ov 'end-glyph
16532 (make-glyph (vector 'png :file movefile))))
16533 (overlay-put
16534 ov 'display
16535 (list 'image :type 'png :file movefile :ascent 'center)))
16536 (push ov org-latex-fragment-image-overlays)
16537 (goto-char end))
16538 (delete-region beg end)
16539 (insert (org-add-props link
16540 (list 'org-latex-src
16541 (replace-regexp-in-string
16544 ;; This function borrows from Ganesh Swami's latex2png.el
16545 (defun org-create-formula-image (string tofile options buffer)
16546 "This calls dvipng."
16547 (require 'org-latex)
16548 (let* ((tmpdir (if (featurep 'xemacs)
16549 (temp-directory)
16550 temporary-file-directory))
16551 (texfilebase (make-temp-name
16552 (expand-file-name "orgtex" tmpdir)))
16553 (texfile (concat texfilebase ".tex"))
16554 (dvifile (concat texfilebase ".dvi"))
16555 (pngfile (concat texfilebase ".png"))
16556 (fnh (if (featurep 'xemacs)
16557 (font-height (get-face-font 'default))
16558 (face-attribute 'default :height nil)))
16559 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16560 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16561 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16562 "Black"))
16563 (bg (or (plist-get options (if buffer :background :html-background))
16564 "Transparent")))
16565 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16566 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16567 (with-temp-file texfile
16568 (insert (org-splice-latex-header
16569 org-format-latex-header
16570 org-export-latex-default-packages-alist
16571 org-export-latex-packages-alist t
16572 org-format-latex-header-extra))
16574 (require 'org-latex)
16575 (org-export-latex-fix-inputenc))
16576 (let ((dir default-directory))
16577 (condition-case nil
16578 (progn
16579 (cd tmpdir)
16580 (call-process "latex" nil nil nil texfile))
16581 (error nil))
16582 (cd dir))
16583 (if (not (file-exists-p dvifile))
16584 (progn (message "Failed to create dvi file from %s" texfile) nil)
16585 (condition-case nil
16586 (call-process "dvipng" nil nil nil
16587 "-fg" fg "-bg" bg
16588 "-D" dpi
16589 ;;"-x" scale "-y" scale
16590 "-T" "tight"
16591 "-o" pngfile
16592 dvifile)
16593 (error nil))
16594 (if (not (file-exists-p pngfile))
16595 (if org-format-latex-signal-error
16596 (error "Failed to create png file from %s" texfile)
16597 (message "Failed to create png file from %s" texfile)
16598 nil)
16599 ;; Use the requested file name and clean up
16600 (copy-file pngfile tofile 'replace)
16601 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16602 (delete-file (concat texfilebase e)))
16603 pngfile))))
16605 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16606 "Fill a LaTeX header template TPL.
16607 In the template, the following place holders will be recognized:
16610 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16612 [NO-PACKAGES] do not include PKG
16613 [EXTRA] the string EXTRA
16614 [NO-EXTRA] do not include EXTRA
16616 For backward compatibility, if both the positive and the negative place
16618 assumed to be present at the end of the template.
16619 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16620 EXTRA is a string.
16621 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16622 (let (rpl (end ""))
16624 (setq rpl (if (or (match-end 1) (not def-pkg))
16625 "" (org-latex-packages-to-string def-pkg snippets-p t))
16626 tpl (replace-match rpl t t tpl))
16627 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16630 (setq rpl (if (or (match-end 1) (not pkg))
16631 "" (org-latex-packages-to-string pkg snippets-p t))
16632 tpl (replace-match rpl t t tpl))
16633 (if pkg (setq end
16635 (org-latex-packages-to-string pkg snippets-p)))))
16638 (setq rpl (if (or (match-end 1) (not extra))
16640 tpl (replace-match rpl t t tpl))
16646 tpl)))
16648 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16650 (setq pkg (mapconcat (lambda(p)
16651 (cond
16652 ((stringp p) p)
16653 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16654 (format "%% Package %s omitted" (cadr p)))
16655 ((equal "" (car p))
16657 (t
16659 (car p) (cadr p)))))
16660 pkg
16664 (defun org-dvipng-color (attr)
16665 "Return an rgb color specification for dvipng."
16666 (apply 'format "rgb %s %s %s"
16667 (mapcar 'org-normalize-color
16668 (color-values (face-attribute 'default attr nil)))))
16670 (defun org-normalize-color (value)
16671 "Return string to be used as color value for an RGB component."
16672 (format "%g" (/ value 65535.0)))
16674 ;; Image display
16677 (defvar org-inline-image-overlays nil)
16678 (make-variable-buffer-local 'org-inline-image-overlays)
16680 (defun org-toggle-inline-images (&optional include-linked)
16681 "Toggle the display of inline images.
16682 INCLUDE-LINKED is passed to `org-display-inline-images'."
16683 (interactive "P")
16684 (if org-inline-image-overlays
16685 (progn
16686 (org-remove-inline-images)
16687 (message "Inline image display turned off"))
16688 (org-display-inline-images include-linked)
16689 (if org-inline-image-overlays
16690 (message "%d images displayed inline"
16691 (length org-inline-image-overlays))
16692 (message "No images to display inline"))))
16694 (defun org-display-inline-images (&optional include-linked refresh beg end)
16695 "Display inline images.
16696 Normally only links without a description part are inlined, because this
16697 is how it will work for export. When INCLUDE-LINKED is set, also links
16698 with a description part will be inlined. This can be nice for a quick
16699 look at those images, but it does not reflect what exported files will look
16700 like.
16701 When REFRESH is set, refresh existing images between BEG and END.
16702 This will create new image displays only if necessary.
16703 BEG and END default to the buffer boundaries."
16704 (interactive "P")
16705 (unless refresh
16706 (org-remove-inline-images)
16707 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16708 (save-excursion
16709 (save-restriction
16710 (widen)
16711 (setq beg (or beg (point-min)) end (or end (point-max)))
16712 (goto-char (point-min))
16714 (substring (org-image-file-name-regexp) 0 -2)
16716 old file ov img)
16717 (while (re-search-forward re end t)
16718 (setq old (get-char-property-and-overlay (match-beginning 1)
16719 'org-image-overlay))
16720 (setq file (expand-file-name
16721 (concat (or (match-string 3) "") (match-string 4))))
16722 (when (file-exists-p file)
16723 (if (and (car-safe old) refresh)
16724 (image-refresh (overlay-get (cdr old) 'display))
16725 (setq img (save-match-data (create-image file)))
16726 (when img
16727 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16728 (overlay-put ov 'display img)
16729 (overlay-put ov 'face 'default)
16730 (overlay-put ov 'org-image-overlay t)
16731 (overlay-put ov 'modification-hooks
16732 (list 'org-display-inline-modification-hook))
16733 (push ov org-inline-image-overlays)))))))))
16735 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16736 "Remove inline-display overlay if a corresponding region is modified."
16737 (let ((inhibit-modification-hooks t))
16738 (when (and ov after)
16739 (delete ov org-inline-image-overlays)
16740 (delete-overlay ov))))
16742 (defun org-remove-inline-images ()
16743 "Remove inline display of images."
16744 (interactive)
16745 (mapc 'delete-overlay org-inline-image-overlays)
16746 (setq org-inline-image-overlays nil))
16748 ;;;; Key bindings
16750 ;; Make `C-c C-x' a prefix key
16751 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16753 ;; TAB key with modifiers
16754 (org-defkey org-mode-map "\C-i" 'org-cycle)
16755 (org-defkey org-mode-map [(tab)] 'org-cycle)
16756 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16757 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16759 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16760 ;; The following line is necessary under Suse GNU/Linux
16761 (unless (featurep 'xemacs)
16762 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16763 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16764 (define-key org-mode-map [backtab] 'org-shifttab)
16766 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16767 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16768 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16770 ;; Cursor keys with modifiers
16771 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16772 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16773 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16774 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16776 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16777 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16778 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16779 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16781 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16782 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16783 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16784 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16786 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16787 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16788 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16789 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16791 ;; Babel keys
16792 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16793 (mapc (lambda (pair)
16794 (define-key org-babel-map (car pair) (cdr pair)))
16795 org-babel-key-bindings)
16797 ;;; Extra keys for tty access.
16798 ;; We only set them when really needed because otherwise the
16799 ;; menus don't show the simple keys
16801 (when (or org-use-extra-keys
16802 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16803 (not window-system))
16804 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16805 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16806 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16807 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16808 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16809 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16810 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16811 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16812 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16813 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16814 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16815 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16816 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16817 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16818 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16819 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16820 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16821 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16822 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16823 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16824 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16825 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16826 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16827 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16828 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16829 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16830 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16831 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16833 ;; All the other keys
16835 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16836 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16837 (if (boundp 'narrow-map)
16838 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16839 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16840 (if (boundp 'narrow-map)
16841 (org-defkey narrow-map "b" 'org-narrow-to-block)
16842 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16843 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16844 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16845 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16846 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16847 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16848 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16849 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16850 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16851 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16852 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16853 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16854 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16855 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16856 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16857 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16858 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16860 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16861 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16862 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16863 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16864 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16865 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16866 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16867 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16868 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16869 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16870 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16871 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16872 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16873 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16874 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16875 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16876 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16877 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16878 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16879 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16881 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16882 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16883 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16884 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16885 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16886 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16887 (org-defkey org-mode-map "\C-c^" 'org-sort)
16888 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16889 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16890 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16891 (org-defkey org-mode-map "\C-m" 'org-return)
16892 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16893 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16894 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16895 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16896 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16897 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16898 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16899 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16900 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16901 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16902 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16903 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16904 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16905 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16906 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16907 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16908 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16909 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16910 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16911 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16912 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16913 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16915 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16916 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16917 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16918 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16920 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16921 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16922 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16923 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16924 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16925 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16926 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16927 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16928 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16929 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16931 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16932 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16933 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16934 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16935 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16936 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16937 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16939 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16940 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16941 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16942 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16943 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16945 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16947 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16949 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16950 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16952 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16955 (when (featurep 'xemacs)
16956 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16959 (defconst org-speed-commands-default
16960 '(
16961 ("Outline Navigation")
16962 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16963 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16964 ("f" . (org-speed-move-safe 'org-forward-same-level))
16965 ("b" . (org-speed-move-safe 'org-backward-same-level))
16966 ("u" . (org-speed-move-safe 'outline-up-heading))
16967 ("j" . org-goto)
16968 ("g" . (org-refile t))
16969 ("Outline Visibility")
16970 ("c" . org-cycle)
16971 ("C" . org-shifttab)
16972 (" " . org-display-outline-path)
16973 ("Outline Structure Editing")
16974 ("U" . org-shiftmetaup)
16975 ("D" . org-shiftmetadown)
16976 ("r" . org-metaright)
16977 ("l" . org-metaleft)
16978 ("R" . org-shiftmetaright)
16979 ("L" . org-shiftmetaleft)
16980 ("i" . (progn (forward-char 1) (call-interactively
16981 'org-insert-heading-respect-content)))
16982 ("^" . org-sort)
16983 ("w" . org-refile)
16984 ("a" . org-archive-subtree-default-with-confirmation)
16985 ("." . org-mark-subtree)
16986 ("Clock Commands")
16987 ("I" . org-clock-in)
16988 ("O" . org-clock-out)
16989 ("Meta Data Editing")
16990 ("t" . org-todo)
16991 ("0" . (org-priority ?\ ))
16992 ("1" . (org-priority ?A))
16993 ("2" . (org-priority ?B))
16994 ("3" . (org-priority ?C))
16995 (";" . org-set-tags-command)
16996 ("e" . org-set-effort)
16997 ("Agenda Views etc")
16998 ("v" . org-agenda)
16999 ("/" . org-sparse-tree)
17000 ("Misc")
17001 ("o" . org-open-at-point)
17002 ("?" . org-speed-command-help)
17003 ("<" . (org-agenda-set-restriction-lock 'subtree))
17004 (">" . (org-agenda-remove-restriction-lock))
17005 )
17006 "The default speed commands.")
17008 (defun org-print-speed-command (e)
17009 (if (> (length (car e)) 1)
17010 (progn
17012 (princ (car e))
17014 (princ (make-string (length (car e)) ?-))
17016 (princ (car e))
17017 (princ " ")
17018 (if (symbolp (cdr e))
17019 (princ (symbol-name (cdr e)))
17020 (prin1 (cdr e)))
17023 (defun org-speed-command-help ()
17024 "Show the available speed commands."
17025 (interactive)
17026 (if (not org-use-speed-commands)
17027 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17028 (with-output-to-temp-buffer "*Help*"
17030 (mapc 'org-print-speed-command org-speed-commands-user)
17033 (mapc 'org-print-speed-command org-speed-commands-default))
17034 (with-current-buffer "*Help*"
17035 (setq truncate-lines t))))
17037 (defun org-speed-move-safe (cmd)
17038 "Execute CMD, but make sure that the cursor always ends up in a headline.
17039 If not, return to the original position and throw an error."
17040 (interactive)
17041 (let ((pos (point)))
17042 (call-interactively cmd)
17043 (unless (and (bolp) (org-on-heading-p))
17044 (goto-char pos)
17045 (error "Boundary reached while executing %s" cmd))))
17047 (defvar org-self-insert-command-undo-counter 0)
17049 (defvar org-table-auto-blank-field) ; defined in org-table.el
17050 (defvar org-speed-command nil)
17052 (defun org-speed-command-default-hook (keys)
17053 "Hook for activating single-letter speed commands.
17054 `org-speed-commands-default' specifies a minimal command set. Use
17055 `org-speed-commands-user' for further customization."
17056 (when (or (and (bolp) (looking-at org-outline-regexp))
17057 (and (functionp org-use-speed-commands)
17058 (funcall org-use-speed-commands)))
17059 (cdr (assoc keys (append org-speed-commands-user
17060 org-speed-commands-default)))))
17062 (defun org-babel-speed-command-hook (keys)
17063 "Hook for activating single-letter code block commands."
17064 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17065 (cdr (assoc keys org-babel-key-bindings))))
17067 (defcustom org-speed-command-hook
17068 '(org-speed-command-default-hook org-babel-speed-command-hook)
17069 "Hook for activating speed commands at strategic locations.
17070 Hook functions are called in sequence until a valid handler is
17071 found.
17073 Each hook takes a single argument, a user-pressed command key
17074 which is also a `self-insert-command' from the global map.
17076 Within the hook, examine the cursor position and the command key
17077 and return nil or a valid handler as appropriate. Handler could
17078 be one of an interactive command, a function, or a form.
17080 Set `org-use-speed-commands' to non-nil value to enable this
17081 hook. The default setting is `org-speed-command-default-hook'."
17082 :group 'org-structure
17083 :type 'hook)
17085 (defun org-self-insert-command (N)
17086 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17087 If the cursor is in a table looking at whitespace, the whitespace is
17088 overwritten, and the table is not marked as requiring realignment."
17089 (interactive "p")
17090 (cond
17091 ((and org-use-speed-commands
17092 (setq org-speed-command
17093 (run-hook-with-args-until-success
17094 'org-speed-command-hook (this-command-keys))))
17095 (cond
17096 ((commandp org-speed-command)
17097 (setq this-command org-speed-command)
17098 (call-interactively org-speed-command))
17099 ((functionp org-speed-command)
17100 (funcall org-speed-command))
17101 ((and org-speed-command (listp org-speed-command))
17102 (eval org-speed-command))
17103 (t (let (org-use-speed-commands)
17104 (call-interactively 'org-self-insert-command)))))
17105 ((and
17106 (org-table-p)
17107 (progn
17108 ;; check if we blank the field, and if that triggers align
17109 (and (featurep 'org-table) org-table-auto-blank-field
17110 (member last-command
17111 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17113 ;; got extra space, this field does not determine column width
17114 (let (org-table-may-need-update) (org-table-blank-field))
17115 ;; no extra space, this field may determine column width
17116 (org-table-blank-field)))
17117 t)
17118 (eq N 1)
17120 (let (org-table-may-need-update)
17121 (goto-char (1- (match-end 0)))
17122 (delete-char -1)
17123 (goto-char (match-beginning 0))
17124 (self-insert-command N)))
17125 (t
17126 (setq org-table-may-need-update t)
17127 (self-insert-command N)
17128 (org-fix-tags-on-the-fly)
17129 (if org-self-insert-cluster-for-undo
17130 (if (not (eq last-command 'org-self-insert-command))
17131 (setq org-self-insert-command-undo-counter 1)
17132 (if (>= org-self-insert-command-undo-counter 20)
17133 (setq org-self-insert-command-undo-counter 1)
17134 (and (> org-self-insert-command-undo-counter 0)
17135 buffer-undo-list (listp buffer-undo-list)
17136 (not (cadr buffer-undo-list)) ; remove nil entry
17137 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17138 (setq org-self-insert-command-undo-counter
17139 (1+ org-self-insert-command-undo-counter))))))))
17141 (defun org-fix-tags-on-the-fly ()
17142 (when (and (equal (char-after (point-at-bol)) ?*)
17143 (org-on-heading-p))
17144 (org-align-tags-here org-tags-column)))
17146 (defun org-delete-backward-char (N)
17147 "Like `delete-backward-char', insert whitespace at field end in tables.
17148 When deleting backwards, in tables this function will insert whitespace in
17150 still be marked for re-alignment if the field did fill the entire column,
17151 because, in this case the deletion might narrow the column."
17152 (interactive "p")
17153 (if (and (org-table-p)
17154 (eq N 1)
17155 (string-match "|" (buffer-substring (point-at-bol) (point)))
17156 (looking-at ".*?|"))
17157 (let ((pos (point))
17159 (c org-table-may-need-update))
17160 (backward-delete-char N)
17161 (if (not overwrite-mode)
17162 (progn
17163 (skip-chars-forward "^|")
17164 (insert " ")
17165 (goto-char (1- pos))))
17166 ;; noalign: if there were two spaces at the end, this field
17167 ;; does not determine the width of the column.
17168 (if noalign (setq org-table-may-need-update c)))
17169 (backward-delete-char N)
17170 (org-fix-tags-on-the-fly)))
17172 (defun org-delete-char (N)
17173 "Like `delete-char', but insert whitespace at field end in tables.
17174 When deleting characters, in tables this function will insert whitespace in
17176 still be marked for re-alignment if the field did fill the entire column,
17177 because, in this case the deletion might narrow the column."
17178 (interactive "p")
17179 (if (and (org-table-p)
17180 (not (bolp))
17181 (not (= (char-after) ?|))
17182 (eq N 1))
17183 (if (looking-at ".*?|")
17184 (let ((pos (point))
17186 (c org-table-may-need-update))
17187 (replace-match (concat
17188 (substring (match-string 0) 1 -1)
17189 " |"))
17190 (goto-char pos)
17191 ;; noalign: if there were two spaces at the end, this field
17192 ;; does not determine the width of the column.
17193 (if noalign (setq org-table-may-need-update c)))
17194 (delete-char N))
17195 (delete-char N)
17196 (org-fix-tags-on-the-fly)))
17198 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17199 (put 'org-self-insert-command 'delete-selection t)
17200 (put 'orgtbl-self-insert-command 'delete-selection t)
17201 (put 'org-delete-char 'delete-selection 'supersede)
17202 (put 'org-delete-backward-char 'delete-selection 'supersede)
17203 (put 'org-yank 'delete-selection 'yank)
17205 ;; Make `flyspell-mode' delay after some commands
17206 (put 'org-self-insert-command 'flyspell-delayed t)
17207 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17208 (put 'org-delete-char 'flyspell-delayed t)
17209 (put 'org-delete-backward-char 'flyspell-delayed t)
17211 ;; Make pabbrev-mode expand after org-mode commands
17212 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17213 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17215 ;; How to do this: Measure non-white length of current string
17216 ;; If equal to column width, we should realign.
17218 (defun org-remap (map &rest commands)
17219 "In MAP, remap the functions given in COMMANDS.
17220 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17221 (let (new old)
17222 (while commands
17223 (setq old (pop commands) new (pop commands))
17224 (if (fboundp 'command-remapping)
17225 (org-defkey map (vector 'remap old) new)
17226 (substitute-key-definition old new map global-map)))))
17228 (when (eq org-enable-table-editor 'optimized)
17229 ;; If the user wants maximum table support, we need to hijack
17230 ;; some standard editing functions
17231 (org-remap org-mode-map
17232 'self-insert-command 'org-self-insert-command
17233 'delete-char 'org-delete-char
17234 'delete-backward-char 'org-delete-backward-char)
17235 (org-defkey org-mode-map "|" 'org-force-self-insert))
17237 (defvar org-ctrl-c-ctrl-c-hook nil
17238 "Hook for functions attaching themselves to `C-c C-c'.
17240 This can be used to add additional functionality to the C-c C-c
17241 key which executes context-dependent commands. This hook is run
17242 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17243 run after the last test.
17245 Each function will be called with no arguments. The function
17246 must check if the context is appropriate for it to act. If yes,
17247 it should do its thing and then return a non-nil value. If the
17248 context is wrong, just do nothing and return nil.")
17250 (defvar org-ctrl-c-ctrl-c-final-hook nil
17251 "Hook for functions attaching themselves to `C-c C-c'.
17253 This can be used to add additional functionality to the C-c C-c
17254 key which executes context-dependent commands. This hook is run
17255 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17256 before the first test.
17258 Each function will be called with no arguments. The function
17259 must check if the context is appropriate for it to act. If yes,
17260 it should do its thing and then return a non-nil value. If the
17261 context is wrong, just do nothing and return nil.")
17263 (defvar org-tab-first-hook nil
17264 "Hook for functions to attach themselves to TAB.
17265 See `org-ctrl-c-ctrl-c-hook' for more information.
17266 This hook runs as the first action when TAB is pressed, even before
17267 `org-cycle' messes around with the `outline-regexp' to cater for
17268 inline tasks and plain list item folding.
17269 If any function in this hook returns t, any other actions that
17270 would have been caused by TAB (such as table field motion or visibility
17271 cycling) will not occur.")
17273 (defvar org-tab-after-check-for-table-hook nil
17274 "Hook for functions to attach themselves to TAB.
17275 See `org-ctrl-c-ctrl-c-hook' for more information.
17276 This hook runs after it has been established that the cursor is not in a
17277 table, but before checking if the cursor is in a headline or if global cycling
17278 should be done.
17279 If any function in this hook returns t, not other actions like visibility
17280 cycling will be done.")
17282 (defvar org-tab-after-check-for-cycling-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 after it has been established that not table field motion and
17286 not visibility should be done because of current context. This is probably
17287 the place where a package like yasnippets can hook in.")
17289 (defvar org-tab-before-tab-emulation-hook nil
17290 "Hook for functions to attach themselves to TAB.
17291 See `org-ctrl-c-ctrl-c-hook' for more information.
17292 This hook runs after every other options for TAB have been exhausted, but
17295 (defvar org-metaleft-hook nil
17296 "Hook for functions attaching themselves to `M-left'.
17297 See `org-ctrl-c-ctrl-c-hook' for more information.")
17298 (defvar org-metaright-hook nil
17299 "Hook for functions attaching themselves to `M-right'.
17300 See `org-ctrl-c-ctrl-c-hook' for more information.")
17301 (defvar org-metaup-hook nil
17302 "Hook for functions attaching themselves to `M-up'.
17303 See `org-ctrl-c-ctrl-c-hook' for more information.")
17304 (defvar org-metadown-hook nil
17305 "Hook for functions attaching themselves to `M-down'.
17306 See `org-ctrl-c-ctrl-c-hook' for more information.")
17307 (defvar org-shiftmetaleft-hook nil
17308 "Hook for functions attaching themselves to `M-S-left'.
17309 See `org-ctrl-c-ctrl-c-hook' for more information.")
17310 (defvar org-shiftmetaright-hook nil
17311 "Hook for functions attaching themselves to `M-S-right'.
17312 See `org-ctrl-c-ctrl-c-hook' for more information.")
17313 (defvar org-shiftmetaup-hook nil
17314 "Hook for functions attaching themselves to `M-S-up'.
17315 See `org-ctrl-c-ctrl-c-hook' for more information.")
17316 (defvar org-shiftmetadown-hook nil
17317 "Hook for functions attaching themselves to `M-S-down'.
17318 See `org-ctrl-c-ctrl-c-hook' for more information.")
17319 (defvar org-metareturn-hook nil
17320 "Hook for functions attaching themselves to `M-RET'.
17321 See `org-ctrl-c-ctrl-c-hook' for more information.")
17322 (defvar org-shiftup-hook nil
17323 "Hook for functions attaching themselves to `S-up'.
17324 See `org-ctrl-c-ctrl-c-hook' for more information.")
17325 (defvar org-shiftup-final-hook nil
17326 "Hook for functions attaching themselves to `S-up'.
17327 This one runs after all other options except shift-select have been excluded.
17328 See `org-ctrl-c-ctrl-c-hook' for more information.")
17329 (defvar org-shiftdown-hook nil
17330 "Hook for functions attaching themselves to `S-down'.
17331 See `org-ctrl-c-ctrl-c-hook' for more information.")
17332 (defvar org-shiftdown-final-hook nil
17333 "Hook for functions attaching themselves to `S-down'.
17334 This one runs after all other options except shift-select have been excluded.
17335 See `org-ctrl-c-ctrl-c-hook' for more information.")
17336 (defvar org-shiftleft-hook nil
17337 "Hook for functions attaching themselves to `S-left'.
17338 See `org-ctrl-c-ctrl-c-hook' for more information.")
17339 (defvar org-shiftleft-final-hook nil
17340 "Hook for functions attaching themselves to `S-left'.
17341 This one runs after all other options except shift-select have been excluded.
17342 See `org-ctrl-c-ctrl-c-hook' for more information.")
17343 (defvar org-shiftright-hook nil
17344 "Hook for functions attaching themselves to `S-right'.
17345 See `org-ctrl-c-ctrl-c-hook' for more information.")
17346 (defvar org-shiftright-final-hook nil
17347 "Hook for functions attaching themselves to `S-right'.
17348 This one runs after all other options except shift-select have been excluded.
17349 See `org-ctrl-c-ctrl-c-hook' for more information.")
17351 (defun org-modifier-cursor-error ()
17352 "Throw an error, a modified cursor command was applied in wrong context."
17353 (error "This command is active in special context like tables, headlines or items"))
17355 (defun org-shiftselect-error ()
17356 "Throw an error because Shift-Cursor command was applied in wrong context."
17357 (if (and (boundp 'shift-select-mode) shift-select-mode)
17358 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17359 (error "This command works only in special context like headlines or timestamps")))
17361 (defun org-call-for-shift-select (cmd)
17362 (let ((this-command-keys-shift-translated t))
17363 (call-interactively cmd)))
17365 (defun org-shifttab (&optional arg)
17366 "Global visibility cycling or move to previous table field.
17367 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17368 on context.
17369 See the individual commands for more information."
17370 (interactive "P")
17371 (cond
17372 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17373 ((integerp arg)
17374 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17375 (message "Content view to level: %d" arg)
17376 (org-content (prefix-numeric-value arg2))
17377 (setq org-cycle-global-status 'overview)))
17378 (t (call-interactively 'org-global-cycle))))
17380 (defun org-shiftmetaleft ()
17381 "Promote subtree or delete table column.
17382 Calls `org-promote-subtree', `org-outdent-item',
17383 or `org-table-delete-column', depending on context.
17384 See the individual commands for more information."
17385 (interactive)
17386 (cond
17387 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17388 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17389 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17390 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17391 (t (org-modifier-cursor-error))))
17393 (defun org-shiftmetaright ()
17394 "Demote subtree or insert table column.
17395 Calls `org-demote-subtree', `org-indent-item',
17396 or `org-table-insert-column', depending on context.
17397 See the individual commands for more information."
17398 (interactive)
17399 (cond
17400 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17401 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17402 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17403 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17404 (t (org-modifier-cursor-error))))
17406 (defun org-shiftmetaup (&optional arg)
17407 "Move subtree up or kill table row.
17408 Calls `org-move-subtree-up' or `org-table-kill-row' or
17409 `org-move-item-up' depending on context. See the individual commands
17410 for more information."
17411 (interactive "P")
17412 (cond
17413 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17414 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17415 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17416 ((org-at-item-p) (call-interactively 'org-move-item-up))
17417 (t (org-modifier-cursor-error))))
17419 (defun org-shiftmetadown (&optional arg)
17420 "Move subtree down or insert table row.
17421 Calls `org-move-subtree-down' or `org-table-insert-row' or
17422 `org-move-item-down', depending on context. See the individual
17423 commands for more information."
17424 (interactive "P")
17425 (cond
17426 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17427 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17428 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17429 ((org-at-item-p) (call-interactively 'org-move-item-down))
17430 (t (org-modifier-cursor-error))))
17432 (defsubst org-hidden-tree-error ()
17433 (error
17434 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17436 (defun org-metaleft (&optional arg)
17437 "Promote heading or move table column to left.
17438 Calls `org-do-promote' or `org-table-move-column', depending on context.
17439 With no specific context, calls the Emacs default `backward-word'.
17440 See the individual commands for more information."
17441 (interactive "P")
17442 (cond
17443 ((run-hook-with-args-until-success 'org-metaleft-hook))
17444 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17445 ((org-with-limited-levels
17446 (or (org-on-heading-p)
17447 (and (org-region-active-p)
17448 (save-excursion
17449 (goto-char (region-beginning))
17450 (org-on-heading-p)))))
17451 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17452 (call-interactively 'org-do-promote))
17453 ;; At an inline task.
17454 ((org-on-heading-p)
17455 (call-interactively 'org-inlinetask-promote))
17456 ((or (org-at-item-p)
17457 (and (org-region-active-p)
17458 (save-excursion
17459 (goto-char (region-beginning))
17460 (org-at-item-p))))
17461 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17462 (call-interactively 'org-outdent-item))
17463 (t (call-interactively 'backward-word))))
17465 (defun org-metaright (&optional arg)
17466 "Demote subtree or move table column to right.
17467 Calls `org-do-demote' or `org-table-move-column', depending on context.
17468 With no specific context, calls the Emacs default `forward-word'.
17469 See the individual commands for more information."
17470 (interactive "P")
17471 (cond
17472 ((run-hook-with-args-until-success 'org-metaright-hook))
17473 ((org-at-table-p) (call-interactively 'org-table-move-column))
17474 ((org-with-limited-levels
17475 (or (org-on-heading-p)
17476 (and (org-region-active-p)
17477 (save-excursion
17478 (goto-char (region-beginning))
17479 (org-on-heading-p)))))
17480 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17481 (call-interactively 'org-do-demote))
17482 ;; At an inline task.
17483 ((org-on-heading-p)
17484 (call-interactively 'org-inlinetask-demote))
17485 ((or (org-at-item-p)
17486 (and (org-region-active-p)
17487 (save-excursion
17488 (goto-char (region-beginning))
17489 (org-at-item-p))))
17490 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17491 (call-interactively 'org-indent-item))
17492 (t (call-interactively 'forward-word))))
17494 (defun org-check-for-hidden (what)
17495 "Check if there are hidden headlines/items in the current visual line.
17496 WHAT can be either `headlines' or `items'. If the current line is
17497 an outline or item heading and it has a folded subtree below it,
17498 this function returns t, nil otherwise."
17499 (let ((re (cond
17500 ((eq what 'headlines) org-outline-regexp-bol)
17501 ((eq what 'items) (org-item-beginning-re))
17502 (t (error "This should not happen"))))
17503 beg end)
17504 (save-excursion
17505 (catch 'exit
17506 (unless (org-region-active-p)
17507 (setq beg (point-at-bol))
17508 (beginning-of-line 2)
17509 (while (and (not (eobp)) ;; this is like `next-line'
17510 (get-char-property (1- (point)) 'invisible))
17511 (beginning-of-line 2))
17512 (setq end (point))
17513 (goto-char beg)
17514 (goto-char (point-at-eol))
17515 (setq end (max end (point)))
17516 (while (re-search-forward re end t)
17517 (if (get-char-property (match-beginning 0) 'invisible)
17518 (throw 'exit t))))
17519 nil))))
17521 (defun org-metaup (&optional arg)
17522 "Move subtree up or move table row up.
17523 Calls `org-move-subtree-up' or `org-table-move-row' or
17524 `org-move-item-up', depending on context. See the individual commands
17525 for more information."
17526 (interactive "P")
17527 (cond
17528 ((run-hook-with-args-until-success 'org-metaup-hook))
17529 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17530 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17531 ((org-at-item-p) (call-interactively 'org-move-item-up))
17532 (t (transpose-lines 1) (beginning-of-line -1))))
17534 (defun org-metadown (&optional arg)
17535 "Move subtree down or move table row down.
17536 Calls `org-move-subtree-down' or `org-table-move-row' or
17537 `org-move-item-down', depending on context. See the individual
17538 commands for more information."
17539 (interactive "P")
17540 (cond
17541 ((run-hook-with-args-until-success 'org-metadown-hook))
17542 ((org-at-table-p) (call-interactively 'org-table-move-row))
17543 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17544 ((org-at-item-p) (call-interactively 'org-move-item-down))
17545 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17547 (defun org-shiftup (&optional arg)
17548 "Increase item in timestamp or increase priority of current headline.
17549 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17550 depending on context. See the individual commands for more information."
17551 (interactive "P")
17552 (cond
17553 ((run-hook-with-args-until-success 'org-shiftup-hook))
17554 ((and org-support-shift-select (org-region-active-p))
17555 (org-call-for-shift-select 'previous-line))
17556 ((org-at-timestamp-p t)
17557 (call-interactively (if org-edit-timestamp-down-means-later
17558 'org-timestamp-down 'org-timestamp-up)))
17559 ((and (not (eq org-support-shift-select 'always))
17560 org-enable-priority-commands
17561 (org-on-heading-p))
17562 (call-interactively 'org-priority-up))
17563 ((and (not org-support-shift-select) (org-at-item-p))
17564 (call-interactively 'org-previous-item))
17565 ((org-clocktable-try-shift 'up arg))
17566 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17567 (org-support-shift-select
17568 (org-call-for-shift-select 'previous-line))
17569 (t (org-shiftselect-error))))
17571 (defun org-shiftdown (&optional arg)
17572 "Decrease item in timestamp or decrease priority of current headline.
17573 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17574 depending on context. See the individual commands for more information."
17575 (interactive "P")
17576 (cond
17577 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17578 ((and org-support-shift-select (org-region-active-p))
17579 (org-call-for-shift-select 'next-line))
17580 ((org-at-timestamp-p t)
17581 (call-interactively (if org-edit-timestamp-down-means-later
17582 'org-timestamp-up 'org-timestamp-down)))
17583 ((and (not (eq org-support-shift-select 'always))
17584 org-enable-priority-commands
17585 (org-on-heading-p))
17586 (call-interactively 'org-priority-down))
17587 ((and (not org-support-shift-select) (org-at-item-p))
17588 (call-interactively 'org-next-item))
17589 ((org-clocktable-try-shift 'down arg))
17590 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17591 (org-support-shift-select
17592 (org-call-for-shift-select 'next-line))
17593 (t (org-shiftselect-error))))
17595 (defun org-shiftright (&optional arg)
17596 "Cycle the thing at point or in the current line, depending on context.
17597 Depending on context, this does one of the following:
17599 - switch a timestamp at point one day into the future
17600 - on a headline, switch to the next TODO keyword.
17601 - on an item, switch entire list to the next bullet type
17602 - on a property line, switch to the next allowed value
17603 - on a clocktable definition line, move time block into the future"
17604 (interactive "P")
17605 (cond
17606 ((run-hook-with-args-until-success 'org-shiftright-hook))
17607 ((and org-support-shift-select (org-region-active-p))
17608 (org-call-for-shift-select 'forward-char))
17609 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17610 ((and (not (eq org-support-shift-select 'always))
17611 (org-on-heading-p))
17612 (let ((org-inhibit-logging
17613 (not org-treat-S-cursor-todo-selection-as-state-change))
17614 (org-inhibit-blocking
17615 (not org-treat-S-cursor-todo-selection-as-state-change)))
17616 (org-call-with-arg 'org-todo 'right)))
17617 ((or (and org-support-shift-select
17618 (not (eq org-support-shift-select 'always))
17619 (org-at-item-bullet-p))
17620 (and (not org-support-shift-select) (org-at-item-p)))
17621 (org-call-with-arg 'org-cycle-list-bullet nil))
17622 ((and (not (eq org-support-shift-select 'always))
17623 (org-at-property-p))
17624 (call-interactively 'org-property-next-allowed-value))
17625 ((org-clocktable-try-shift 'right arg))
17626 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17627 (org-support-shift-select
17628 (org-call-for-shift-select 'forward-char))
17629 (t (org-shiftselect-error))))
17631 (defun org-shiftleft (&optional arg)
17632 "Cycle the thing at point or in the current line, depending on context.
17633 Depending on context, this does one of the following:
17635 - switch a timestamp at point one day into the past
17636 - on a headline, switch to the previous TODO keyword.
17637 - on an item, switch entire list to the previous bullet type
17638 - on a property line, switch to the previous allowed value
17639 - on a clocktable definition line, move time block into the past"
17640 (interactive "P")
17641 (cond
17642 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17643 ((and org-support-shift-select (org-region-active-p))
17644 (org-call-for-shift-select 'backward-char))
17645 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17646 ((and (not (eq org-support-shift-select 'always))
17647 (org-on-heading-p))
17648 (let ((org-inhibit-logging
17649 (not org-treat-S-cursor-todo-selection-as-state-change))
17650 (org-inhibit-blocking
17651 (not org-treat-S-cursor-todo-selection-as-state-change)))
17652 (org-call-with-arg 'org-todo 'left)))
17653 ((or (and org-support-shift-select
17654 (not (eq org-support-shift-select 'always))
17655 (org-at-item-bullet-p))
17656 (and (not org-support-shift-select) (org-at-item-p)))
17657 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17658 ((and (not (eq org-support-shift-select 'always))
17659 (org-at-property-p))
17660 (call-interactively 'org-property-previous-allowed-value))
17661 ((org-clocktable-try-shift 'left arg))
17662 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17663 (org-support-shift-select
17664 (org-call-for-shift-select 'backward-char))
17665 (t (org-shiftselect-error))))
17667 (defun org-shiftcontrolright ()
17668 "Switch to next TODO set."
17669 (interactive)
17670 (cond
17671 ((and org-support-shift-select (org-region-active-p))
17672 (org-call-for-shift-select 'forward-word))
17673 ((and (not (eq org-support-shift-select 'always))
17674 (org-on-heading-p))
17675 (org-call-with-arg 'org-todo 'nextset))
17676 (org-support-shift-select
17677 (org-call-for-shift-select 'forward-word))
17678 (t (org-shiftselect-error))))
17680 (defun org-shiftcontrolleft ()
17681 "Switch to previous TODO set."
17682 (interactive)
17683 (cond
17684 ((and org-support-shift-select (org-region-active-p))
17685 (org-call-for-shift-select 'backward-word))
17686 ((and (not (eq org-support-shift-select 'always))
17687 (org-on-heading-p))
17688 (org-call-with-arg 'org-todo 'previousset))
17689 (org-support-shift-select
17690 (org-call-for-shift-select 'backward-word))
17691 (t (org-shiftselect-error))))
17693 (defun org-shiftcontrolup ()
17694 "Change timestamps synchronously up in CLOCK log lines."
17695 (interactive)
17696 (cond ((and (not org-support-shift-select)
17697 (org-at-clock-log-p)
17698 (org-at-timestamp-p t))
17699 (org-clock-timestamps-up))
17700 (t (org-shiftselect-error))))
17702 (defun org-shiftcontroldown ()
17703 "Change timestamps synchronously down in CLOCK log lines."
17704 (interactive)
17705 (cond ((and (not org-support-shift-select)
17706 (org-at-clock-log-p)
17707 (org-at-timestamp-p t))
17708 (org-clock-timestamps-down))
17709 (t (org-shiftselect-error))))
17711 (defun org-ctrl-c-ret ()
17712 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17713 (interactive)
17714 (cond
17715 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17716 (t (call-interactively 'org-insert-heading))))
17718 (defun org-find-visible ()
17719 (let ((s (point)))
17720 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17721 (get-char-property s 'invisible)))
17722 s))
17723 (defun org-find-invisible ()
17724 (let ((s (point)))
17725 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17726 (not (get-char-property s 'invisible))))
17727 s))
17729 (defun org-copy-visible (beg end)
17730 "Copy the visible parts of the region."
17731 (interactive "r")
17732 (let (snippets s)
17733 (save-excursion
17734 (save-restriction
17735 (narrow-to-region beg end)
17736 (setq s (goto-char (point-min)))
17737 (while (not (= (point) (point-max)))
17738 (goto-char (org-find-invisible))
17739 (push (buffer-substring s (point)) snippets)
17740 (setq s (goto-char (org-find-visible))))))
17741 (kill-new (apply 'concat (nreverse snippets)))))
17743 (defun org-copy-special ()
17744 "Copy region in table or copy current subtree.
17745 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17746 See the individual commands for more information."
17747 (interactive)
17748 (call-interactively
17749 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17751 (defun org-cut-special ()
17752 "Cut region in table or cut current subtree.
17753 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17754 See the individual commands for more information."
17755 (interactive)
17756 (call-interactively
17757 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17759 (defun org-paste-special (arg)
17760 "Paste rectangular region into table, or past subtree relative to level.
17761 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17762 See the individual commands for more information."
17763 (interactive "P")
17764 (if (org-at-table-p)
17765 (org-table-paste-rectangle)
17766 (org-paste-subtree arg)))
17768 (defun org-edit-special (&optional arg)
17769 "Call a special editor for the stuff at point.
17770 When at a table, call the formula editor with `org-table-edit-formulas'.
17771 When at the first line of an src example, call `org-edit-src-code'.
17772 When in an #+include line, visit the include file. Otherwise call
17773 `ffap' to visit the file at point."
17774 (interactive)
17775 ;; possibly prep session before editing source
17776 (when arg
17777 (let* ((info (org-babel-get-src-block-info))
17778 (lang (nth 0 info))
17779 (params (nth 2 info))
17780 (session (cdr (assoc :session params))))
17781 (when (and info session) ;; we are in a source-code block with a session
17782 (funcall
17783 (intern (concat "org-babel-prep-session:" lang)) session params))))
17784 (cond ;; proceed with `org-edit-special'
17785 ((save-excursion
17786 (beginning-of-line 1)
17787 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17788 (find-file (org-trim (match-string 1))))
17789 ((org-edit-src-code))
17790 ((org-edit-fixed-width-region))
17791 ((org-at-table.el-p)
17792 (org-edit-src-code))
17793 ((or (org-at-table-p)
17794 (save-excursion
17795 (beginning-of-line 1)
17797 (call-interactively 'org-table-edit-formulas))
17798 (t (call-interactively 'ffap))))
17800 (defun org-ctrl-c-ctrl-c (&optional arg)
17801 "Set tags in headline, or update according to changed information at point.
17803 This command does many different things, depending on context:
17805 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17806 this is what we do.
17808 - If the cursor is on a statistics cookie, update it.
17810 - If the cursor is in a headline, prompt for tags and insert them
17811 into the current line, aligned to `org-tags-column'. When called
17812 with prefix arg, realign all tags in the current buffer.
17814 - If the cursor is in one of the special #+KEYWORD lines, this
17815 triggers scanning the buffer for these lines and updating the
17816 information.
17818 - If the cursor is inside a table, realign the table. This command
17819 works even if the automatic table editor has been turned off.
17821 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17822 the entire table.
17824 - If the cursor is at a footnote reference or definition, jump to
17825 the corresponding definition or references, respectively.
17827 - If the cursor is a the beginning of a dynamic block, update it.
17829 - If the current buffer is a capture buffer, close note and file it.
17831 - If the cursor is on a <<<target>>>, update radio targets and
17832 corresponding links in this buffer.
17834 - If the cursor is on a numbered item in a plain list, renumber the
17835 ordered list.
17837 - If the cursor is on a checkbox, toggle it.
17839 - If the cursor is on a code block, evaluate it. The variable
17840 `org-confirm-babel-evaluate' can be used to control prompting
17841 before code block evaluation, by default every code block
17842 evaluation requires confirmation. Code block evaluation can be
17843 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17844 (interactive "P")
17845 (let ((org-enable-table-editor t))
17846 (cond
17847 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17848 org-occur-highlights
17849 org-latex-fragment-image-overlays)
17850 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17851 (org-remove-occur-highlights)
17852 (org-remove-latex-fragment-image-overlays)
17853 (message "Temporary highlights/overlays removed from current buffer"))
17854 ((and (local-variable-p 'org-finish-function (current-buffer))
17855 (fboundp org-finish-function))
17856 (funcall org-finish-function))
17857 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17858 ((or (looking-at org-property-start-re)
17859 (org-at-property-p))
17860 (call-interactively 'org-property-action))
17861 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17863 (or (org-on-heading-p) (org-at-item-p)))
17864 (call-interactively 'org-update-statistics-cookies))
17865 ((org-on-heading-p) (call-interactively 'org-set-tags))
17866 ((org-at-table.el-p)
17867 (message "Use C-c ' to edit table.el tables"))
17868 ((org-at-table-p)
17869 (org-table-maybe-eval-formula)
17870 (if arg
17871 (call-interactively 'org-table-recalculate)
17872 (org-table-maybe-recalculate-line))
17873 (call-interactively 'org-table-align)
17874 (orgtbl-send-table 'maybe))
17875 ((or (org-footnote-at-reference-p)
17876 (org-footnote-at-definition-p))
17877 (call-interactively 'org-footnote-action))
17878 ((org-at-item-checkbox-p)
17879 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17880 ;; list only if at top item.
17881 (let* ((cbox (match-string 1))
17882 (struct (org-list-struct))
17883 (old-struct (copy-tree struct))
17884 (parents (org-list-parents-alist struct))
17885 (prevs (org-list-prevs-alist struct))
17886 (orderedp (org-entry-get nil "ORDERED"))
17887 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17888 block-item)
17889 ;; Use a light version of `org-toggle-checkbox' to avoid
17890 ;; computing list structure twice.
17891 (org-list-set-checkbox (point-at-bol) struct
17892 (cond
17893 ((equal arg '(16)) "[-]")
17894 ((equal arg '(4)) nil)
17895 ((equal "[X]" cbox) "[ ]")
17896 (t "[X]")))
17897 (org-list-struct-fix-ind struct parents)
17898 (org-list-struct-fix-bul struct prevs)
17899 (setq block-item
17900 (org-list-struct-fix-box struct parents prevs orderedp))
17901 (when block-item
17902 (message
17903 "Checkboxes were removed due to unchecked box at line %d"
17904 (org-current-line block-item)))
17905 (org-list-struct-apply-struct struct old-struct)
17906 (org-update-checkbox-count-maybe)
17907 (when firstp (org-list-send-list 'maybe))))
17908 ((org-at-item-p)
17909 ;; Cursor at an item: repair list. Do checkbox related actions
17910 ;; only if function was called with an argument. Send list only
17911 ;; if at top item.
17912 (let* ((struct (org-list-struct))
17913 (old-struct (copy-tree struct))
17914 (parents (org-list-parents-alist struct))
17915 (prevs (org-list-prevs-alist struct))
17916 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17917 (org-list-struct-fix-ind struct parents)
17918 (org-list-struct-fix-bul struct prevs)
17919 (when arg
17920 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17921 (org-list-struct-fix-box struct parents prevs))
17922 (org-list-struct-apply-struct struct old-struct)
17923 (when arg (org-update-checkbox-count-maybe))
17924 (when firstp (org-list-send-list 'maybe))))
17925 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17926 ;; Dynamic block
17927 (beginning-of-line 1)
17928 (save-excursion (org-update-dblock)))
17929 ((save-excursion
17930 (beginning-of-line 1)
17932 (cond
17933 ((equal (match-string 1) "TBLFM")
17934 ;; Recalculate the table before this line
17935 (save-excursion
17936 (beginning-of-line 1)
17938 (if (org-at-table-p)
17939 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17940 (t
17941 (let ((org-inhibit-startup-visibility-stuff t)
17942 (org-startup-align-all-tables nil))
17943 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17944 (message "Local setup has been refreshed"))))
17945 ((org-clock-update-time-maybe))
17946 (t
17947 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17948 (error "C-c C-c can do nothing useful at this location"))))))
17950 (defun org-mode-restart ()
17951 "Restart Org-mode, to scan again for special lines.
17952 Also updates the keyword regular expressions."
17953 (interactive)
17954 (org-mode)
17955 (message "Org-mode restarted"))
17957 (defun org-kill-note-or-show-branches ()
17958 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17959 (interactive)
17960 (if (not org-finish-function)
17961 (progn
17962 (hide-subtree)
17963 (call-interactively 'show-branches))
17964 (let ((org-note-abort t))
17965 (funcall org-finish-function))))
17967 (defun org-return (&optional indent)
17968 "Goto next table row or insert a newline.
17969 Calls `org-table-next-row' or `newline', depending on context.
17970 See the individual commands for more information."
17971 (interactive)
17972 (cond
17973 ((bobp) (if indent (newline-and-indent) (newline)))
17974 ((org-at-table-p)
17975 (org-table-justify-field-maybe)
17976 (call-interactively 'org-table-next-row))
17977 ;; when `newline-and-indent' is called within a list, make sure
17978 ;; text moved stays inside the item.
17979 ((and (org-in-item-p) indent)
17980 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17981 (progn
17982 (save-match-data (newline))
17983 (org-indent-line-to (length (match-string 0))))
17984 (let ((ind (org-get-indentation)))
17985 (newline)
17986 (if (org-looking-back org-list-end-re)
17987 (org-indent-line-function)
17988 (org-indent-line-to ind)))))
17989 ((and org-return-follows-link
17990 (eq (get-text-property (point) 'face) 'org-link))
17991 (call-interactively 'org-open-at-point))
17992 ((and (org-at-heading-p)
17993 (looking-at
17995 (org-show-entry)
17996 (end-of-line 1)
17997 (newline))
17998 (t (if indent (newline-and-indent) (newline)))))
18000 (defun org-return-indent ()
18001 "Goto next table row or insert a newline and indent.
18002 Calls `org-table-next-row' or `newline-and-indent', depending on
18003 context. See the individual commands for more information."
18004 (interactive)
18005 (org-return t))
18007 (defun org-ctrl-c-star ()
18008 "Compute table, or change heading status of lines.
18009 Calls `org-table-recalculate' or `org-toggle-heading',
18010 depending on context."
18011 (interactive)
18012 (cond
18013 ((org-at-table-p)
18014 (call-interactively 'org-table-recalculate))
18015 (t
18016 ;; Convert all lines in region to list items
18017 (call-interactively 'org-toggle-heading))))
18019 (defun org-ctrl-c-minus ()
18020 "Insert separator line in table or modify bullet status of line.
18021 Also turns a plain line or a region of lines into list items.
18022 Calls `org-table-insert-hline', `org-toggle-item', or
18023 `org-cycle-list-bullet', depending on context."
18024 (interactive)
18025 (cond
18026 ((org-at-table-p)
18027 (call-interactively 'org-table-insert-hline))
18028 ((org-region-active-p)
18029 (call-interactively 'org-toggle-item))
18030 ((org-in-item-p)
18031 (call-interactively 'org-cycle-list-bullet))
18032 (t
18033 (call-interactively 'org-toggle-item))))
18035 (defun org-toggle-item (arg)
18036 "Convert headings or normal lines to items, items to normal lines.
18037 If there is no active region, only the current line is considered.
18039 If the first non blank line in the region is an headline, convert
18040 all headlines to items, shifting text accordingly.
18042 If it is an item, convert all items to normal lines.
18044 If it is normal text, change region into an item. With a prefix
18045 argument ARG, change each line in region into an item."
18046 (interactive "P")
18047 (let ((shift-text
18048 (function
18049 ;; Shift text in current section to IND, from point to END.
18050 ;; The function leaves point to END line.
18051 (lambda (ind end)
18052 (let ((min-i 1000) (end (copy-marker end)))
18053 ;; First determine the minimum indentation (MIN-I) of
18054 ;; the text.
18055 (save-excursion
18056 (catch 'exit
18057 (while (< (point) end)
18058 (let ((i (org-get-indentation)))
18059 (cond
18060 ;; Skip blank lines and inline tasks.
18062 ((looking-at org-outline-regexp-bol))
18063 ;; We can't find less than 0 indentation.
18064 ((zerop i) (throw 'exit (setq min-i 0)))
18065 ((< i min-i) (setq min-i i))))
18066 (forward-line))))
18067 ;; Then indent each line so that a line indented to
18068 ;; MIN-I becomes indented to IND. Ignore blank lines
18069 ;; and inline tasks in the process.
18070 (let ((delta (- ind min-i)))
18071 (while (< (point) end)
18073 (looking-at org-outline-regexp-bol))
18074 (org-indent-line-to (+ (org-get-indentation) delta)))
18075 (forward-line)))))))
18076 (skip-blanks
18077 (function
18078 ;; Return beginning of first non-blank line, starting from
18079 ;; line at POS.
18080 (lambda (pos)
18081 (save-excursion
18082 (goto-char pos)
18084 (point-at-bol)))))
18085 beg end)
18086 ;; Determine boundaries of changes.
18087 (if (org-region-active-p)
18088 (setq beg (funcall skip-blanks (region-beginning))
18089 end (copy-marker (region-end)))
18090 (setq beg (funcall skip-blanks (point-at-bol))
18091 end (copy-marker (point-at-eol))))
18092 ;; Depending on the starting line, choose an action on the text
18093 ;; between BEG and END.
18094 (org-with-limited-levels
18095 (save-excursion
18096 (goto-char beg)
18097 (cond
18098 ;; Case 1. Start at an item: de-itemize. Note that it only
18099 ;; happens when a region is active: `org-ctrl-c-minus'
18100 ;; would call `org-cycle-list-bullet' otherwise.
18101 ((org-at-item-p)
18102 (while (< (point) end)
18103 (when (org-at-item-p)
18105 (delete-region (point) (match-end 0)))
18106 (forward-line)))
18107 ;; Case 2. Start at an heading: convert to items.
18108 ((org-on-heading-p)
18109 (let* ((bul (org-list-bullet-string "-"))
18110 (bul-len (length bul))
18111 ;; Indentation of the first heading. It should be
18112 ;; relative to the indentation of its parent, if any.
18113 (start-ind (save-excursion
18114 (cond
18115 ((not org-adapt-indentation) 0)
18116 ((not (outline-previous-heading)) 0)
18117 (t (length (match-string 0))))))
18118 ;; Level of first heading. Further headings will be
18119 ;; compared to it to determine hierarchy in the list.
18120 (ref-level (org-reduced-level (org-outline-level))))
18121 (while (< (point) end)
18122 (let* ((level (org-reduced-level (org-outline-level)))
18123 (delta (max 0 (- level ref-level))))
18124 ;; If current headline is less indented than the first
18125 ;; one, set it as reference, in order to preserve
18126 ;; subtrees.
18127 (when (< level ref-level) (setq ref-level level))
18128 (replace-match bul t t)
18129 (org-indent-line-to (+ start-ind (* delta bul-len)))
18130 ;; Ensure all text down to END (or SECTION-END) belongs
18131 ;; to the newly created item.
18132 (let ((section-end (save-excursion
18133 (or (outline-next-heading) (point)))))
18134 (forward-line)
18135 (funcall shift-text
18136 (+ start-ind (* (1+ delta) bul-len))
18137 (min end section-end)))))))
18138 ;; Case 3. Normal line with ARG: turn each non-item line into
18139 ;; an item.
18140 (arg
18141 (while (< (point) end)
18142 (unless (or (org-on-heading-p) (org-at-item-p))
18144 (replace-match
18146 (forward-line)))
18147 ;; Case 4. Normal line without ARG: make the first line of
18148 ;; region an item, and shift indentation of others
18149 ;; lines to set them as item's body.
18150 (t (let* ((bul (org-list-bullet-string "-"))
18151 (bul-len (length bul))
18152 (ref-ind (org-get-indentation)))
18154 (insert bul)
18155 (forward-line)
18156 (while (< (point) end)
18157 ;; Ensure that lines less indented than first one
18158 ;; still get included in item body.
18159 (funcall shift-text
18160 (+ ref-ind bul-len)
18161 (min end (save-excursion (or (outline-next-heading)
18162 (point)))))
18163 (forward-line)))))))))
18165 (defun org-toggle-heading (&optional nstars)
18166 "Convert headings to normal text, or items or text to headings.
18167 If there is no active region, only the current line is considered.
18169 If the first non blank line is an headline, remove the stars from
18170 all headlines in the region.
18172 If it is a plain list item, turn all plain list items into headings.
18174 If it is a normal line, turn each and every normal line (i.e. not
18175 an heading or an item) in the region into a heading.
18177 When converting a line into a heading, the number of stars is chosen
18178 such that the lines become children of the current entry. However,
18179 when a prefix argument is given, its value determines the number of
18180 stars to add."
18181 (interactive "P")
18182 (let ((skip-blanks
18183 (function
18184 ;; Return beginning of first non-blank line, starting from
18185 ;; line at POS.
18186 (lambda (pos)
18187 (save-excursion
18188 (goto-char pos)
18190 (point-at-bol)))))
18191 beg end)
18192 ;; Determine boundaries of changes. If region ends at a bol, do
18193 ;; not consider the last line to be in the region.
18194 (if (org-region-active-p)
18195 (setq beg (funcall skip-blanks (region-beginning))
18196 end (copy-marker (save-excursion
18197 (goto-char (region-end))
18198 (if (bolp) (point) (point-at-eol)))))
18199 (setq beg (funcall skip-blanks (point-at-bol))
18200 end (copy-marker (point-at-eol))))
18201 ;; Ensure inline tasks don't count as headings.
18202 (org-with-limited-levels
18203 (save-excursion
18204 (goto-char beg)
18205 (cond
18206 ;; Case 1. Started at an heading: de-star headings.
18207 ((org-on-heading-p)
18208 (while (< (point) end)
18209 (when (org-on-heading-p t)
18210 (looking-at org-outline-regexp) (replace-match ""))
18211 (forward-line)))
18212 ;; Case 2. Started at an item: change items into headlines.
18213 ;; One star will be added by `org-list-to-subtree'.
18214 ((org-at-item-p)
18215 (let* ((stars (make-string
18216 (if nstars
18217 ;; subtract the star that will be added again by
18218 ;; `org-list-to-subtree'
18219 (1- (prefix-numeric-value current-prefix-arg))
18220 (or (org-current-level) 0))
18221 ?*))
18222 (add-stars
18223 (cond (nstars "") ; stars from prefix only
18224 ((equal stars "") "") ; before first heading
18225 (org-odd-levels-only "*") ; inside heading, odd
18226 (t "")))) ; inside heading, oddeven
18227 (while (< (point) end)
18228 (when (org-at-item-p)
18229 ;; Pay attention to cases when region ends before list.
18230 (let* ((struct (org-list-struct))
18231 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18232 (save-restriction
18233 (narrow-to-region (point) list-end)
18234 (insert
18235 (org-list-to-subtree
18236 (org-list-parse-list t)
18237 '(:istart (concat stars add-stars (funcall get-stars depth))
18238 :icount (concat stars add-stars (funcall get-stars depth))))))))
18239 (forward-line))))
18240 ;; Case 3. Started at normal text: make every line an heading,
18241 ;; skipping headlines and items.
18242 (t (let* ((stars (make-string
18243 (if nstars
18244 (prefix-numeric-value current-prefix-arg)
18245 (or (org-current-level) 0))
18246 ?*))
18247 (add-stars
18248 (cond (nstars "") ; stars from prefix only
18249 ((equal stars "") "*") ; before first heading
18250 (org-odd-levels-only "**") ; inside heading, odd
18251 (t "*"))) ; inside heading, oddeven
18252 (rpl (concat stars add-stars " ")))
18253 (while (< (point) end)
18254 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18256 (replace-match (concat rpl (match-string 2))))
18257 (forward-line)))))))))
18259 (defun org-meta-return (&optional arg)
18260 "Insert a new heading or wrap a region in a table.
18261 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18262 See the individual commands for more information."
18263 (interactive "P")
18264 (cond
18265 ((run-hook-with-args-until-success 'org-metareturn-hook))
18266 ((org-at-table-p)
18267 (call-interactively 'org-table-wrap-region))
18268 (t (call-interactively 'org-insert-heading))))
18270 ;;; Menu entries
18272 ;; Define the Org-mode menus
18273 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18274 '("Tbl"
18275 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18276 ["Next Field" org-cycle (org-at-table-p)]
18277 ["Previous Field" org-shifttab (org-at-table-p)]
18278 ["Next Row" org-return (org-at-table-p)]
18279 "--"
18280 ["Blank Field" org-table-blank-field (org-at-table-p)]
18281 ["Edit Field" org-table-edit-field (org-at-table-p)]
18282 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18283 "--"
18284 ("Column"
18285 ["Move Column Left" org-metaleft (org-at-table-p)]
18286 ["Move Column Right" org-metaright (org-at-table-p)]
18287 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18288 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18289 ("Row"
18290 ["Move Row Up" org-metaup (org-at-table-p)]
18291 ["Move Row Down" org-metadown (org-at-table-p)]
18292 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18293 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18294 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18295 "--"
18296 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18297 ("Rectangle"
18298 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18299 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18300 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18301 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18302 "--"
18303 ("Calculate"
18304 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18305 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18306 ["Edit Formulas" org-edit-special (org-at-table-p)]
18307 "--"
18308 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18309 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18310 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18311 "--"
18312 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18313 "--"
18314 ["Sum Column/Rectangle" org-table-sum
18315 (or (org-at-table-p) (org-region-active-p))]
18316 ["Which Column?" org-table-current-column (org-at-table-p)])
18317 ["Debug Formulas"
18318 org-table-toggle-formula-debugger
18319 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18320 ["Show Col/Row Numbers"
18321 org-table-toggle-coordinate-overlays
18322 :style toggle
18323 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18324 "--"
18325 ["Create" org-table-create (and (not (org-at-table-p))
18326 org-enable-table-editor)]
18327 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18328 ["Import from File" org-table-import (not (org-at-table-p))]
18329 ["Export to File" org-table-export (org-at-table-p)]
18330 "--"
18331 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18333 (easy-menu-define org-org-menu org-mode-map "Org menu"
18334 '("Org"
18335 ("Show/Hide"
18336 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18337 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18338 ["Sparse Tree..." org-sparse-tree t]
18339 ["Reveal Context" org-reveal t]
18340 ["Show All" show-all t]
18341 "--"
18342 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18343 "--"
18344 ["New Heading" org-insert-heading t]
18345 ("Navigate Headings"
18346 ["Up" outline-up-heading t]
18347 ["Next" outline-next-visible-heading t]
18348 ["Previous" outline-previous-visible-heading t]
18349 ["Next Same Level" outline-forward-same-level t]
18350 ["Previous Same Level" outline-backward-same-level t]
18351 "--"
18352 ["Jump" org-goto t])
18353 ("Edit Structure"
18354 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18355 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18356 "--"
18357 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18358 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18359 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18360 "--"
18361 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18362 "--"
18363 ["Copy visible text" org-copy-visible t]
18364 "--"
18365 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18366 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18367 ["Demote Heading" org-metaright (not (org-at-table-p))]
18368 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18369 "--"
18370 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18371 "--"
18372 ["Convert to odd levels" org-convert-to-odd-levels t]
18373 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18374 ("Editing"
18375 ["Emphasis..." org-emphasize t]
18376 ["Edit Source Example" org-edit-special t]
18377 "--"
18378 ["Footnote new/jump" org-footnote-action t]
18379 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18380 ("Archive"
18381 ["Archive (default method)" org-archive-subtree-default t]
18382 "--"
18383 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18384 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18385 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18386 )
18387 "--"
18388 ("Hyperlinks"
18389 ["Store Link (Global)" org-store-link t]
18390 ["Find existing link to here" org-occur-link-in-agenda-files t]
18391 ["Insert Link" org-insert-link t]
18392 ["Follow Link" org-open-at-point t]
18393 "--"
18394 ["Next link" org-next-link t]
18395 ["Previous link" org-previous-link t]
18396 "--"
18397 ["Descriptive Links"
18398 org-toggle-link-display
18399 :style radio
18400 :selected org-link-display-descriptive
18401 ]
18402 ["Literal Links"
18403 org-toggle-link-display
18404 :style radio
18405 :selected (not org-link-display-descriptive)])
18406 "--"
18407 ("TODO Lists"
18408 ["TODO/DONE/-" org-todo t]
18409 ("Select keyword"
18410 ["Next keyword" org-shiftright (org-on-heading-p)]
18411 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18412 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18413 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18414 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18415 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18416 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18417 "--"
18418 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18419 :selected org-enforce-todo-dependencies :style toggle :active t]
18420 "Settings for tree at point"
18421 ["Do Children sequentially" org-toggle-ordered-property :style radio
18422 :selected (org-entry-get nil "ORDERED")
18423 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18424 ["Do Children parallel" org-toggle-ordered-property :style radio
18425 :selected (not (org-entry-get nil "ORDERED"))
18426 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18427 "--"
18428 ["Set Priority" org-priority t]
18429 ["Priority Up" org-shiftup t]
18430 ["Priority Down" org-shiftdown t]
18431 "--"
18432 ["Get news from all feeds" org-feed-update-all t]
18433 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18434 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18435 ("TAGS and Properties"
18436 ["Set Tags" org-set-tags-command t]
18437 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18438 "--"
18439 ["Set property" org-set-property t]
18440 ["Column view of properties" org-columns t]
18441 ["Insert Column View DBlock" org-insert-columns-dblock t])
18442 ("Dates and Scheduling"
18443 ["Timestamp" org-time-stamp t]
18444 ["Timestamp (inactive)" org-time-stamp-inactive t]
18445 ("Change Date"
18446 ["1 Day Later" org-shiftright t]
18447 ["1 Day Earlier" org-shiftleft t]
18448 ["1 ... Later" org-shiftup t]
18449 ["1 ... Earlier" org-shiftdown t])
18450 ["Compute Time Range" org-evaluate-time-range t]
18451 ["Schedule Item" org-schedule t]
18452 ["Deadline" org-deadline t]
18453 "--"
18454 ["Custom time format" org-toggle-time-stamp-overlays
18455 :style radio :selected org-display-custom-times]
18456 "--"
18457 ["Goto Calendar" org-goto-calendar t]
18458 ["Date from Calendar" org-date-from-calendar t]
18459 "--"
18460 ["Start/Restart Timer" org-timer-start t]
18461 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18462 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18463 ["Insert Timer String" org-timer t]
18464 ["Insert Timer Item" org-timer-item t])
18465 ("Logging work"
18466 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18467 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18468 ["Clock out" org-clock-out t]
18469 ["Clock cancel" org-clock-cancel t]
18470 "--"
18471 ["Mark as default task" org-clock-mark-default-task t]
18472 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18473 ["Goto running clock" org-clock-goto t]
18474 "--"
18475 ["Display times" org-clock-display t]
18476 ["Create clock table" org-clock-report t]
18477 "--"
18478 ["Record DONE time"
18479 (progn (setq org-log-done (not org-log-done))
18480 (message "Switching to %s will %s record a timestamp"
18481 (car org-done-keywords)
18482 (if org-log-done "automatically" "not")))
18483 :style toggle :selected org-log-done])
18484 "--"
18485 ["Agenda Command..." org-agenda t]
18486 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18487 ("File List for Agenda")
18488 ("Special views current file"
18489 ["TODO Tree" org-show-todo-tree t]
18490 ["Check Deadlines" org-check-deadlines t]
18491 ["Timeline" org-timeline t]
18492 ["Tags/Property tree" org-match-sparse-tree t])
18493 "--"
18494 ["Export/Publish..." org-export t]
18495 ("LaTeX"
18496 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18497 :selected org-cdlatex-mode]
18498 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18499 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18500 ["Modify math symbol" org-cdlatex-math-modify
18501 (org-inside-LaTeX-fragment-p)]
18502 ["Insert citation" org-reftex-citation t]
18503 "--"
18504 ["Template for BEAMER" org-insert-beamer-options-template t])
18505 "--"
18506 ("MobileOrg"
18507 ["Push Files and Views" org-mobile-push t]
18508 ["Get Captured and Flagged" org-mobile-pull t]
18509 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18510 "--"
18511 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18512 "--"
18513 ("Documentation"
18514 ["Show Version" org-version t]
18515 ["Info Documentation" org-info t])
18516 ("Customize"
18517 ["Browse Org Group" org-customize t]
18518 "--"
18519 ["Expand This Menu" org-create-customize-menu
18520 (fboundp 'customize-menu-create)])
18521 ["Send bug report" org-submit-bug-report t]
18522 "--"
18523 ("Refresh/Reload"
18524 ["Refresh setup current buffer" org-mode-restart t]
18525 ["Reload Org (after update)" org-reload t]
18526 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18527 ))
18529 (defun org-info (&optional node)
18530 "Read documentation for Org-mode in the info system.
18531 With optional NODE, go directly to that node."
18532 (interactive)
18533 (info (format "(org)%s" (or node ""))))
18535 ;;;###autoload
18536 (defun org-submit-bug-report ()
18537 "Submit a bug report on Org-mode via mail.
18539 Don't hesitate to report any problems or inaccurate documentation.
18541 If you don't have setup sending mail from (X)Emacs, please copy the
18542 output buffer into your mail program, as it gives us important
18543 information about your Org-mode version and configuration."
18544 (interactive)
18545 (require 'reporter)
18546 (org-load-modules-maybe)
18547 (org-require-autoloaded-modules)
18548 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18549 (reporter-submit-bug-report
18550 "emacs-orgmode@gnu.org"
18551 (org-version)
18552 (let (list)
18553 (save-window-excursion
18554 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18555 (delete-other-windows)
18556 (erase-buffer)
18557 (insert "You are about to submit a bug report to the Org-mode mailing list.
18559 We would like to add your full Org-mode and Outline configuration to the
18560 bug report. This greatly simplifies the work of the maintainer and
18561 other experts on the mailing list.
18563 HOWEVER, some variables you have customized may contain private
18564 information. The names of customers, colleagues, or friends, might
18565 appear in the form of file names, tags, todo states, or search strings.
18566 If you answer yes to the prompt, you might want to check and remove
18567 such private information before sending the email.")
18568 (add-text-properties (point-min) (point-max) '(face org-warning))
18569 (when (yes-or-no-p "Include your Org-mode configuration ")
18570 (mapatoms
18571 (lambda (v)
18572 (and (boundp v)
18574 (or (and (symbol-value v)
18576 (and
18577 (get v 'custom-type) (get v 'standard-value)
18578 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18579 (push v list)))))
18580 (kill-buffer (get-buffer "*Warn about privacy*"))
18581 list))
18582 nil nil
18583 "Remember to cover the basics, that is, what you expected to happen and
18584 what in fact did happen. You don't know how to make a good report? See
18586 http://orgmode.org/manual/Feedback.html#Feedback
18588 Your bug report will be posted to the Org-mode mailing list.
18589 ------------------------------------------------------------------------")
18590 (save-excursion
18595 (defun org-install-agenda-files-menu ()
18596 (let ((bl (buffer-list)))
18597 (save-excursion
18598 (while bl
18599 (set-buffer (pop bl))
18600 (if (org-mode-p) (setq bl nil)))
18601 (when (org-mode-p)
18602 (easy-menu-change
18603 '("Org") "File List for Agenda"
18604 (append
18605 (list
18606 ["Edit File List" (org-edit-agenda-file-list) t]
18607 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18608 ["Remove Current File from List" org-remove-file t]
18609 ["Cycle through agenda files" org-cycle-agenda-files t]
18610 ["Occur in all agenda files" org-occur-in-agenda-files t]
18611 "--")
18612 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18614 ;;;; Documentation
18616 ;;;###autoload
18617 (defun org-require-autoloaded-modules ()
18618 (interactive)
18619 (mapc 'require
18620 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18621 org-docbook org-exp org-html org-icalendar
18622 org-id org-latex
18623 org-publish org-remember org-table
18624 org-timer org-xoxo)))
18626 ;;;###autoload
18627 (defun org-reload (&optional uncompiled)
18628 "Reload all org lisp files.
18629 With prefix arg UNCOMPILED, load the uncompiled versions."
18630 (interactive "P")
18631 (require 'find-func)
18633 (dir-org (file-name-directory (org-find-library-name "org")))
18634 (dir-org-contrib (ignore-errors
18635 (file-name-directory
18636 (org-find-library-name "org-contribdir"))))
18637 (babel-files
18638 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18639 (append (list nil "comint" "eval" "exp" "keys"
18640 "lob" "ref" "table" "tangle")
18641 (delq nil
18642 (mapcar
18643 (lambda (lang)
18644 (when (cdr lang) (symbol-name (car lang))))
18645 org-babel-load-languages)))))
18646 (files
18647 (append (directory-files dir-org t file-re)
18648 babel-files
18649 (and dir-org-contrib
18650 (directory-files dir-org-contrib t file-re))))
18651 (remove-re (concat (if (featurep 'xemacs)
18652 "org-colview" "org-colview-xemacs")
18654 (setq files (mapcar 'file-name-sans-extension files))
18655 (setq files (mapcar
18656 (lambda (x) (if (string-match remove-re x) nil x))
18657 files))
18658 (setq files (delq nil files))
18659 (mapc
18660 (lambda (f)
18661 (when (featurep (intern (file-name-nondirectory f)))
18662 (if (and (not uncompiled)
18663 (file-exists-p (concat f ".elc")))
18664 (load (concat f ".elc") nil nil t)
18665 (load (concat f ".el") nil nil t))))
18666 files))
18667 (org-version))
18669 ;;;###autoload
18670 (defun org-customize ()
18671 "Call the customize function with org as argument."
18672 (interactive)
18673 (org-load-modules-maybe)
18674 (org-require-autoloaded-modules)
18675 (customize-browse 'org))
18677 (defun org-create-customize-menu ()
18678 "Create a full customization menu for Org-mode, insert it into the menu."
18679 (interactive)
18680 (org-load-modules-maybe)
18681 (org-require-autoloaded-modules)
18682 (if (fboundp 'customize-menu-create)
18683 (progn
18684 (easy-menu-change
18685 '("Org") "Customize"
18686 `(["Browse Org group" org-customize t]
18687 "--"
18688 ,(customize-menu-create 'org)
18689 ["Set" Custom-set t]
18690 ["Save" Custom-save t]
18691 ["Reset to Current" Custom-reset-current t]
18692 ["Reset to Saved" Custom-reset-saved t]
18693 ["Reset to Standard Settings" Custom-reset-standard t]))
18695 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18697 ;;;; Miscellaneous stuff
18699 ;;; Generally useful functions
18701 (defun org-get-at-bol (property)
18702 "Get text property PROPERTY at beginning of line."
18703 (get-text-property (point-at-bol) property))
18705 (defun org-find-text-property-in-string (prop s)
18706 "Return the first non-nil value of property PROP in string S."
18707 (or (get-text-property 0 prop s)
18708 (get-text-property (or (next-single-property-change 0 prop s) 0)
18709 prop s)))
18711 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18712 "Display the given MESSAGE as a warning."
18713 (if (fboundp 'display-warning)
18714 (display-warning 'org message
18715 (if (featurep 'xemacs) 'warning :warning))
18716 (let ((buf (get-buffer-create "*Org warnings*")))
18717 (with-current-buffer buf
18718 (goto-char (point-max))
18719 (insert "Warning (Org): " message)
18720 (unless (bolp)
18721 (newline)))
18722 (display-buffer buf)
18723 (sit-for 0))))
18725 (defun org-eval (form)
18726 "Eval FORM and return result."
18727 (condition-case error
18728 (eval form)
18729 (error (format "%%![Error: %s]" error))))
18731 (defun org-in-commented-line ()
18732 "Is point in a line starting with `#'?"
18733 (equal (char-after (point-at-bol)) ?#))
18735 (defun org-in-indented-comment-line ()
18736 "Is point in a line starting with `#' after some white space?"
18737 (save-excursion
18738 (save-match-data
18739 (goto-char (point-at-bol))
18742 (defun org-in-verbatim-emphasis ()
18743 (save-match-data
18744 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18746 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18747 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18748 (if (and marker (marker-buffer marker)
18749 (buffer-live-p (marker-buffer marker)))
18750 (progn
18751 (org-pop-to-buffer-same-window (marker-buffer marker))
18752 (if (or (> marker (point-max)) (< marker (point-min)))
18753 (widen))
18754 (goto-char marker)
18755 (org-show-context 'org-goto))
18756 (if bookmark
18757 (bookmark-jump bookmark)
18758 (error "Cannot find location"))))
18760 (defun org-quote-csv-field (s)
18761 "Quote field for inclusion in CSV material."
18764 s))
18766 (defun org-force-self-insert (N)
18767 "Needed to enforce self-insert under remapping."
18768 (interactive "p")
18769 (self-insert-command N))
18771 (defun org-string-width (s)
18772 "Compute width of string, ignoring invisible characters.
18773 This ignores character with invisibility property `org-link', and also
18774 characters with property `org-cwidth', because these will become invisible
18775 upon the next fontification round."
18776 (let (b l)
18777 (when (or (eq t buffer-invisibility-spec)
18778 (assq 'org-link buffer-invisibility-spec))
18779 (while (setq b (text-property-any 0 (length s)
18780 'invisible 'org-link s))
18781 (setq s (concat (substring s 0 b)
18782 (substring s (or (next-single-property-change
18783 b 'invisible s) (length s)))))))
18784 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18785 (setq s (concat (substring s 0 b)
18786 (substring s (or (next-single-property-change
18787 b 'org-cwidth s) (length s))))))
18788 (setq l (string-width s) b -1)
18789 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18790 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18791 l))
18793 (defun org-shorten-string (s maxlength)
18794 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18795 If the string is shorter or has length MAXLENGTH, just return the
18796 original string. If it is longer, the functions finds a space in the
18797 string, breaks this string off at that locations and adds three dots
18798 as ellipsis. Including the ellipsis, the string will not be longer
18799 than MAXLENGTH. If finding a good breaking point in the string does
18800 not work, the string is just chopped off in the middle of a word
18801 if necessary."
18802 (if (<= (length s) maxlength)
18803 s
18804 (let* ((n (max (- maxlength 4) 1))
18806 (if (string-match re s)
18807 (concat (match-string 1 s) "...")
18808 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18810 (defun org-get-indentation (&optional line)
18811 "Get the indentation of the current line, interpreting tabs.
18812 When LINE is given, assume it represents a line and compute its indentation."
18813 (if line
18814 (if (string-match "^ *" (org-remove-tabs line))
18815 (match-end 0))
18816 (save-excursion
18817 (beginning-of-line 1)
18819 (current-column))))
18821 (defun org-get-string-indentation (s)
18822 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18823 (let ((n -1) (i 0) (w tab-width) c)
18824 (catch 'exit
18825 (while (< (setq n (1+ n)) (length s))
18826 (setq c (aref s n))
18827 (cond ((= c ?\ ) (setq i (1+ i)))
18829 (t (throw 'exit t)))))
18830 i))
18832 (defun org-remove-tabs (s &optional width)
18833 "Replace tabulators in S with spaces.
18834 Assumes that s is a single line, starting in column 0."
18835 (setq width (or width tab-width))
18837 (setq s (replace-match
18838 (make-string
18839 (- (* width (/ (+ (match-beginning 0) width) width))
18840 (match-beginning 0)) ?\ )
18841 t t s)))
18842 s)
18844 (defun org-fix-indentation (line ind)
18845 "Fix indentation in LINE.
18846 IND is a cons cell with target and minimum indentation.
18847 If the current indentation in LINE is smaller than the minimum,
18848 leave it alone. If it is larger than ind, set it to the target."
18849 (let* ((l (org-remove-tabs line))
18850 (i (org-get-indentation l))
18851 (i1 (car ind)) (i2 (cdr ind)))
18852 (if (>= i i2) (setq l (substring line i2)))
18853 (if (> i1 0)
18854 (concat (make-string i1 ?\ ) l)
18855 l)))
18857 (defun org-remove-indentation (code &optional n)
18858 "Remove the maximum common indentation from the lines in CODE.
18859 N may optionally be the number of spaces to remove."
18860 (with-temp-buffer
18861 (insert code)
18862 (org-do-remove-indentation n)
18863 (buffer-string)))
18865 (defun org-do-remove-indentation (&optional n)
18866 "Remove the maximum common indentation from the buffer."
18867 (untabify (point-min) (point-max))
18868 (let ((min 10000) re)
18869 (if n
18870 (setq min n)
18871 (goto-char (point-min))
18873 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18874 (unless (or (= min 0) (= min 10000))
18876 (goto-char (point-min))
18877 (while (re-search-forward re nil t)
18878 (replace-match "")
18879 (end-of-line 1))
18880 min)))
18882 (defun org-fill-template (template alist)
18883 "Find each %key of ALIST in TEMPLATE and replace it."
18884 (let ((case-fold-search nil)
18885 entry key value)
18886 (setq alist (sort (copy-sequence alist)
18887 (lambda (a b) (< (length (car a)) (length (car b))))))
18888 (while (setq entry (pop alist))
18889 (setq template
18890 (replace-regexp-in-string
18891 (concat "%" (regexp-quote (car entry)))
18892 (cdr entry) template t t)))
18893 template))
18895 (defun org-base-buffer (buffer)
18896 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18897 (if (not buffer)
18898 buffer
18899 (or (buffer-base-buffer buffer)
18900 buffer)))
18902 (defun org-trim (s)
18903 "Remove whitespace at beginning and end of string."
18906 s)
18908 (defun org-wrap (string &optional width lines)
18909 "Wrap string to either a number of lines, or a width in characters.
18910 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18911 that costs. If there is a word longer than WIDTH, the text is actually
18912 wrapped to the length of that word.
18913 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18914 many lines, whatever width that takes.
18915 The return value is a list of lines, without newlines at the end."
18917 (maxword (apply 'max (mapcar 'org-string-width words)))
18918 w ll)
18919 (cond (width
18920 (org-do-wrap words (max maxword width)))
18921 (lines
18922 (setq w maxword)
18923 (setq ll (org-do-wrap words maxword))
18924 (if (<= (length ll) lines)
18925 ll
18926 (setq ll words)
18927 (while (> (length ll) lines)
18928 (setq w (1+ w))
18929 (setq ll (org-do-wrap words w)))
18930 ll))
18931 (t (error "Cannot wrap this")))))
18933 (defun org-do-wrap (words width)
18934 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18935 (let (lines line)
18936 (while words
18937 (setq line (pop words))
18938 (while (and words (< (+ (length line) (length (car words))) width))
18939 (setq line (concat line " " (pop words))))
18940 (setq lines (push line lines)))
18941 (nreverse lines)))
18943 (defun org-split-string (string &optional separators)
18944 "Splits STRING into substrings at SEPARATORS.
18945 No empty strings are returned if there are matches at the beginning
18946 and end of string."
18948 (start 0)
18949 notfirst
18950 (list nil))
18951 (while (and (string-match rexp string
18952 (if (and notfirst
18953 (= start (match-beginning 0))
18954 (< start (length string)))
18955 (1+ start) start))
18956 (< (match-beginning 0) (length string)))
18957 (setq notfirst t)
18958 (or (eq (match-beginning 0) 0)
18959 (and (eq (match-beginning 0) (match-end 0))
18960 (eq (match-beginning 0) start))
18961 (setq list
18962 (cons (substring string start (match-beginning 0))
18963 list)))
18964 (setq start (match-end 0)))
18965 (or (eq start (length string))
18966 (setq list
18967 (cons (substring string start)
18968 list)))
18969 (nreverse list)))
18971 (defun org-quote-vert (s)
18973 (while (string-match "|" s)
18975 s)
18977 (defun org-uuidgen-p (s)
18978 "Is S an ID created by UUIDGEN?"
18979 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18981 (defun org-context ()
18982 "Return a list of contexts of the current cursor position.
18983 If several contexts apply, all are returned.
18984 Each context entry is a list with a symbol naming the context, and
18985 two positions indicating start and end of the context. Possible
18986 contexts are:
18988 :headline anywhere in a headline
18989 :headline-stars on the leading stars in a headline
18990 :todo-keyword on a TODO keyword (including DONE) in a headline
18991 :tags on the TAGS in a headline
18992 :priority on the priority cookie in a headline
18993 :item on the first line of a plain list item
18994 :item-bullet on the bullet/number of a plain list item
18995 :checkbox on the checkbox in a plain list item
18996 :table in an org-mode table
18997 :table-special on a special filed in a table
18998 :table-table in a table.el table
18999 :link on a hyperlink
19000 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19001 :target on a <<target>>
19002 :radio-target on a <<<radio-target>>>
19003 :latex-fragment on a LaTeX fragment
19004 :latex-preview on a LaTeX fragment with overlayed preview image
19006 This function expects the position to be visible because it uses font-lock
19007 faces as a help to recognize the following contexts: :table-special, :link,
19008 and :keyword."
19009 (let* ((f (get-text-property (point) 'face))
19010 (faces (if (listp f) f (list f)))
19011 (p (point)) clist o)
19012 ;; First the large context
19013 (cond
19014 ((org-on-heading-p t)
19015 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19016 (when (progn
19017 (beginning-of-line 1)
19018 (looking-at org-todo-line-tags-regexp))
19019 (push (org-point-in-group p 1 :headline-stars) clist)
19020 (push (org-point-in-group p 2 :todo-keyword) clist)
19021 (push (org-point-in-group p 4 :tags) clist))
19022 (goto-char p)
19025 (push (org-point-in-group p 0 :priority) clist)))
19027 ((org-at-item-p)
19028 (push (org-point-in-group p 2 :item-bullet) clist)
19029 (push (list :item (point-at-bol)
19030 (save-excursion (org-end-of-item) (point)))
19031 clist)
19032 (and (org-at-item-checkbox-p)
19033 (push (org-point-in-group p 0 :checkbox) clist)))
19035 ((org-at-table-p)
19036 (push (list :table (org-table-begin) (org-table-end)) clist)
19037 (if (memq 'org-formula faces)
19038 (push (list :table-special
19039 (previous-single-property-change p 'face)
19040 (next-single-property-change p 'face)) clist)))
19041 ((org-at-table-p 'any)
19042 (push (list :table-table) clist)))
19043 (goto-char p)
19045 ;; Now the small context
19046 (cond
19047 ((org-at-timestamp-p)
19048 (push (org-point-in-group p 0 :timestamp) clist))
19049 ((memq 'org-link faces)
19050 (push (list :link
19051 (previous-single-property-change p 'face)
19052 (next-single-property-change p 'face)) clist))
19053 ((memq 'org-special-keyword faces)
19054 (push (list :keyword
19055 (previous-single-property-change p 'face)
19056 (next-single-property-change p 'face)) clist))
19057 ((org-on-target-p)
19058 (push (org-point-in-group p 0 :target) clist)
19059 (goto-char (1- (match-beginning 0)))
19060 (if (looking-at org-radio-target-regexp)
19061 (push (org-point-in-group p 0 :radio-target) clist))
19062 (goto-char p))
19063 ((setq o (car (delq nil
19064 (mapcar
19065 (lambda (x)
19066 (if (memq x org-latex-fragment-image-overlays) x))
19067 (overlays-at (point))))))
19068 (push (list :latex-fragment
19069 (overlay-start o) (overlay-end o)) clist)
19070 (push (list :latex-preview
19071 (overlay-start o) (overlay-end o)) clist))
19072 ((org-inside-LaTeX-fragment-p)
19073 ;; FIXME: positions wrong.
19074 (push (list :latex-fragment (point) (point)) clist)))
19076 (setq clist (nreverse (delq nil clist)))
19077 clist))
19079 ;; FIXME: Compare with at-regexp-p Do we need both?
19080 (defun org-in-regexp (re &optional nlines visually)
19081 "Check if point is inside a match of regexp.
19082 Normally only the current line is checked, but you can include NLINES extra
19083 lines both before and after point into the search.
19084 If VISUALLY is set, require that the cursor is not after the match but
19085 really on, so that the block visually is on the match."
19086 (catch 'exit
19087 (let ((pos (point))
19088 (eol (point-at-eol (+ 1 (or nlines 0))))
19089 (inc (if visually 1 0)))
19090 (save-excursion
19091 (beginning-of-line (- 1 (or nlines 0)))
19092 (while (re-search-forward re eol t)
19093 (if (and (<= (match-beginning 0) pos)
19094 (>= (+ inc (match-end 0)) pos))
19095 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19097 (defun org-at-regexp-p (regexp)
19098 "Is point inside a match of REGEXP in the current line?"
19099 (catch 'exit
19100 (save-excursion
19101 (let ((pos (point)) (end (point-at-eol)))
19102 (beginning-of-line 1)
19103 (while (re-search-forward regexp end t)
19104 (if (and (<= (match-beginning 0) pos)
19105 (>= (match-end 0) pos))
19106 (throw 'exit t)))
19107 nil))))
19109 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19110 "Non-nil when point is between matches of START-RE and END-RE.
19112 Also return a non-nil value when point is on one of the matches.
19114 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19115 buffer positions. Default values are the positions of headlines
19116 surrounding the point.
19118 The functions returns a cons cell whose car (resp. cdr) is the
19119 position before START-RE (resp. after END-RE)."
19120 (save-match-data
19121 (let ((pos (point))
19122 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19123 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19124 beg end)
19125 (save-excursion
19126 ;; Point is on a block when on START-RE or if START-RE can be
19127 ;; found before it...
19128 (and (or (org-at-regexp-p start-re)
19129 (re-search-backward start-re limit-up t))
19130 (setq beg (match-beginning 0))
19131 ;; ... and END-RE after it...
19132 (goto-char (match-end 0))
19133 (re-search-forward end-re limit-down t)
19134 (> (setq end (match-end 0)) pos)
19135 ;; ... without another START-RE in-between.
19136 (goto-char (match-beginning 0))
19137 (not (re-search-backward start-re (1+ beg) t))
19138 ;; Return value.
19139 (cons beg end))))))
19141 (defun org-in-block-p (names)
19142 "Is point inside any block whose name belongs to NAMES?
19144 NAMES is a list of strings containing names of blocks."
19145 (save-match-data
19146 (catch 'exit
19147 (let ((case-fold-search t)
19148 (lim-up (save-excursion (outline-previous-heading)))
19149 (lim-down (save-excursion (outline-next-heading))))
19150 (mapc (lambda (name)
19151 (let ((n (regexp-quote name)))
19152 (when (org-between-regexps-p
19155 lim-up lim-down)
19156 (throw 'exit t))))
19157 names))
19158 nil)))
19160 (defun org-occur-in-agenda-files (regexp &optional nlines)
19161 "Call `multi-occur' with buffers for all agenda files."
19163 (let* ((files (org-agenda-files))
19164 (tnames (mapcar 'file-truename files))
19165 (extra org-agenda-text-search-extra-files)
19166 f)
19167 (when (eq (car extra) 'agenda-archives)
19168 (setq extra (cdr extra))
19169 (setq files (org-add-archive-files files)))
19170 (while (setq f (pop extra))
19171 (unless (member (file-truename f) tnames)
19172 (add-to-list 'files f 'append)
19173 (add-to-list 'tnames (file-truename f) 'append)))
19174 (multi-occur
19175 (mapcar (lambda (x)
19176 (with-current-buffer
19177 (or (get-file-buffer x) (find-file-noselect x))
19178 (widen)
19179 (current-buffer)))
19180 files)
19181 regexp)))
19183 (if (boundp 'occur-mode-find-occurrence-hook)
19184 ;; Emacs 23
19185 (add-hook 'occur-mode-find-occurrence-hook
19186 (lambda ()
19187 (when (org-mode-p)
19188 (org-reveal))))
19189 ;; Emacs 22
19190 (defadvice occur-mode-goto-occurrence
19191 (after org-occur-reveal activate)
19192 (and (org-mode-p) (org-reveal)))
19193 (defadvice occur-mode-goto-occurrence-other-window
19194 (after org-occur-reveal activate)
19195 (and (org-mode-p) (org-reveal)))
19196 (defadvice occur-mode-display-occurrence
19197 (after org-occur-reveal activate)
19198 (when (org-mode-p)
19199 (let ((pos (occur-mode-find-occurrence)))
19200 (with-current-buffer (marker-buffer pos)
19201 (save-excursion
19202 (goto-char pos)
19203 (org-reveal)))))))
19205 (defun org-occur-link-in-agenda-files ()
19206 "Create a link and search for it in the agendas.
19207 The link is not stored in `org-stored-links', it is just created
19208 for the search purpose."
19209 (interactive)
19210 (let ((link (condition-case nil
19211 (org-store-link nil)
19212 (error "Unable to create a link to here"))))
19213 (org-occur-in-agenda-files (regexp-quote link))))
19215 (defun org-uniquify (list)
19216 "Remove duplicate elements from LIST."
19217 (let (res)
19218 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19219 res))
19221 (defun org-delete-all (elts list)
19222 "Remove all elements in ELTS from LIST."
19223 (while elts
19224 (setq list (delete (pop elts) list)))
19225 list)
19227 (defun org-count (cl-item cl-seq)
19228 "Count the number of occurrences of ITEM in SEQ.
19229 Taken from `count' in cl-seq.el with all keyword arguments removed."
19230 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19231 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19232 (while (< cl-start cl-end)
19233 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19234 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19235 (setq cl-start (1+ cl-start)))
19236 cl-count))
19238 (defun org-remove-if (predicate seq)
19239 "Remove everything from SEQ that fulfills PREDICATE."
19240 (let (res e)
19241 (while seq
19242 (setq e (pop seq))
19243 (if (not (funcall predicate e)) (push e res)))
19244 (nreverse res)))
19246 (defun org-remove-if-not (predicate seq)
19247 "Remove everything from SEQ that does not fulfill PREDICATE."
19248 (let (res e)
19249 (while seq
19250 (setq e (pop seq))
19251 (if (funcall predicate e) (push e res)))
19252 (nreverse res)))
19254 (defun org-back-over-empty-lines ()
19255 "Move backwards over whitespace, to the beginning of the first empty line.
19256 Returns the number of empty lines passed."
19257 (let ((pos (point)))
19258 (if (cdr (assoc 'heading org-blank-before-new-entry))
19260 (unless (eobp)
19261 (forward-line -1)))
19262 (beginning-of-line 2)
19263 (goto-char (min (point) pos))
19264 (count-lines (point) pos)))
19266 (defun org-skip-whitespace ()
19269 (defun org-point-in-group (point group &optional context)
19270 "Check if POINT is in match-group GROUP.
19271 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19272 match. If the match group does not exist or point is not inside it,
19273 return nil."
19274 (and (match-beginning group)
19275 (>= point (match-beginning group))
19276 (<= point (match-end group))
19277 (if context
19278 (list context (match-beginning group) (match-end group))
19279 t)))
19281 (defun org-switch-to-buffer-other-window (&rest args)
19282 "Switch to buffer in a second window on the current frame.
19283 In particular, do not allow pop-up frames.
19284 Returns the newly created buffer."
19285 (let (pop-up-frames special-display-buffer-names special-display-regexps
19286 special-display-function)
19287 (apply 'switch-to-buffer-other-window args)))
19289 (defun org-combine-plists (&rest plists)
19290 "Create a single property list from all plists in PLISTS.
19291 The process starts by copying the first list, and then setting properties
19292 from the other lists. Settings in the last list are the most significant
19293 ones and overrule settings in the other lists."
19294 (let ((rtn (copy-sequence (pop plists)))
19295 p v ls)
19296 (while plists
19297 (setq ls (pop plists))
19298 (while ls
19299 (setq p (pop ls) v (pop ls))
19300 (setq rtn (plist-put rtn p v))))
19301 rtn))
19303 (defun org-move-line-down (arg)
19304 "Move the current line down. With prefix argument, move it past ARG lines."
19305 (interactive "p")
19306 (let ((col (current-column))
19307 beg end pos)
19308 (beginning-of-line 1) (setq beg (point))
19309 (beginning-of-line 2) (setq end (point))
19310 (beginning-of-line (+ 1 arg))
19311 (setq pos (move-marker (make-marker) (point)))
19312 (insert (delete-and-extract-region beg end))
19313 (goto-char pos)
19314 (org-move-to-column col)))
19316 (defun org-move-line-up (arg)
19317 "Move the current line up. With prefix argument, move it past ARG lines."
19318 (interactive "p")
19319 (let ((col (current-column))
19320 beg end pos)
19321 (beginning-of-line 1) (setq beg (point))
19322 (beginning-of-line 2) (setq end (point))
19323 (beginning-of-line (- arg))
19324 (setq pos (move-marker (make-marker) (point)))
19325 (insert (delete-and-extract-region beg end))
19326 (goto-char pos)
19327 (org-move-to-column col)))
19329 (defun org-replace-escapes (string table)
19330 "Replace %-escapes in STRING with values in TABLE.
19332 The sequences in STRING may contain normal field width and padding information,
19334 so values can contain further %-escapes if they are define later in TABLE."
19335 (let ((tbl (copy-alist table))
19336 (case-fold-search nil)
19337 (pchg 0)
19338 e re rpl)
19339 (while (setq e (pop tbl))
19340 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19341 (when (and (cdr e) (string-match re (cdr e)))
19342 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19343 (safe "SREF"))
19344 (add-text-properties 0 3 (list 'sref sref) safe)
19345 (setcdr e (replace-match safe t t (cdr e)))))
19346 (while (string-match re string)
19347 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19348 (cdr e)))
19349 (setq string (replace-match rpl t t string))))
19350 (while (setq pchg (next-property-change pchg string))
19351 (let ((sref (get-text-property pchg 'sref string)))
19352 (when (and sref (string-match "SREF" string pchg))
19353 (setq string (replace-match sref t t string)))))
19354 string))
19356 (defun org-sublist (list start end)
19357 "Return a section of LIST, from START to END.
19358 Counting starts at 1."
19359 (let (rtn (c start))
19360 (setq list (nthcdr (1- start) list))
19361 (while (and list (<= c end))
19362 (push (pop list) rtn)
19363 (setq c (1+ c)))
19364 (nreverse rtn)))
19366 (defun org-find-base-buffer-visiting (file)
19367 "Like `find-buffer-visiting' but always return the base buffer and
19368 not an indirect buffer."
19369 (let ((buf (or (get-file-buffer file)
19370 (find-buffer-visiting file))))
19371 (if buf
19372 (or (buffer-base-buffer buf) buf)
19373 nil)))
19375 (defun org-image-file-name-regexp (&optional extensions)
19376 "Return regexp matching the file names of images.
19377 If EXTENSIONS is given, only match these."
19378 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19379 (image-file-name-regexp)
19380 (let ((image-file-name-extensions
19381 (or extensions
19382 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19383 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19385 (regexp-opt (nconc (mapcar 'upcase
19386 image-file-name-extensions)
19387 image-file-name-extensions)
19388 t)
19391 (defun org-file-image-p (file &optional extensions)
19392 "Return non-nil if FILE is an image."
19393 (save-match-data
19394 (string-match (org-image-file-name-regexp extensions) file)))
19396 (defun org-get-cursor-date ()
19397 "Return the date at cursor in as a time.
19398 This works in the calendar and in the agenda, anywhere else it just
19399 returns the current time."
19400 (let (date day defd)
19401 (cond
19402 ((eq major-mode 'calendar-mode)
19403 (setq date (calendar-cursor-to-date)
19404 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19405 ((eq major-mode 'org-agenda-mode)
19406 (setq day (get-text-property (point) 'day))
19407 (if day
19408 (setq date (calendar-gregorian-from-absolute day)
19409 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19410 (nth 2 date))))))
19411 (or defd (current-time))))
19413 (defvar org-agenda-action-marker (make-marker)
19414 "Marker pointing to the entry for the next agenda action.")
19416 (defun org-mark-entry-for-agenda-action ()
19417 "Mark the current entry as target of an agenda action.
19418 Agenda actions are actions executed from the agenda with the key `k',
19419 which make use of the date at the cursor."
19420 (interactive)
19421 (move-marker org-agenda-action-marker
19422 (save-excursion (org-back-to-heading t) (point))
19423 (current-buffer))
19424 (message
19425 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19427 (defun org-mark-subtree ()
19428 "Mark the current subtree.
19429 This puts point at the start of the current subtree, and mark at the end.
19431 If point is in an inline task, mark that task instead."
19432 (interactive)
19433 (let ((inline-task-p
19434 (and (featurep 'org-inlinetask)
19435 (org-inlinetask-in-task-p)))
19436 (beg))
19437 ;; Get beginning of subtree
19438 (cond
19439 (inline-task-p (org-inlinetask-goto-beginning))
19440 ((org-at-heading-p) (beginning-of-line))
19441 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19442 (setq beg (point))
19443 ;; Get end of it
19444 (if inline-task-p
19445 (org-inlinetask-goto-end)
19446 (org-end-of-subtree))
19447 ;; Mark zone
19448 (push-mark (point) nil t)
19449 (goto-char beg)))
19451 ;;; Paragraph filling stuff.
19452 ;; We want this to be just right, so use the full arsenal.
19454 (defun org-indent-line-function ()
19455 "Indent line depending on context."
19456 (interactive)
19457 (let* ((pos (point))
19458 (itemp (org-at-item-p))
19459 (case-fold-search t)
19461 (inline-task-p (and (featurep 'org-inlinetask)
19462 (org-inlinetask-in-task-p)))
19463 (inline-re (and inline-task-p
19464 (org-inlinetask-outline-regexp)))
19465 column)
19466 (beginning-of-line 1)
19467 (cond
19468 ;; Comments
19469 ((looking-at "# ") (setq column 0))
19470 ;; Headings
19471 ((looking-at org-outline-regexp) (setq column 0))
19472 ;; Included files
19474 ;; Footnote definition
19475 ((looking-at org-footnote-definition-re) (setq column 0))
19476 ;; Literal examples
19478 (setq column (org-get-indentation))) ; do nothing
19479 ;; Lists
19480 ((ignore-errors (goto-char (org-in-item-p)))
19481 (setq column (if itemp
19482 (org-get-indentation)
19483 (org-list-item-body-column (point))))
19484 (goto-char pos))
19485 ;; Drawers
19487 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19488 (save-excursion
19489 (goto-char (1- (match-beginning 1)))
19490 (setq column (current-column))))
19491 ;; Special blocks
19493 (save-excursion
19494 (re-search-backward
19496 (setq column (org-get-indentation (match-string 0))))
19499 (save-excursion
19501 (setq column
19502 (cond ((equal (downcase (match-string 1)) "src")
19503 ;; src blocks: let `org-edit-src-exit' handle them
19504 (org-get-indentation))
19505 ((equal (downcase (match-string 1)) "example")
19506 (max (org-get-indentation)
19507 (org-get-indentation (match-string 0))))
19508 (t
19509 (org-get-indentation (match-string 0))))))
19510 ;; This line has nothing special, look at the previous relevant
19511 ;; line to compute indentation
19512 (t
19513 (beginning-of-line 0)
19514 (while (and (not (bobp))
19515 (not (looking-at org-drawer-regexp))
19516 ;; When point started in an inline task, do not move
19517 ;; above task starting line.
19518 (not (and inline-task-p (looking-at inline-re)))
19519 ;; Skip drawers, blocks, empty lines, verbatim,
19520 ;; comments, tables, footnotes definitions, lists,
19521 ;; inline tasks.
19523 (re-search-backward org-drawer-regexp nil t))
19527 (looking-at org-footnote-definition-re)
19528 (and (ignore-errors (goto-char (org-in-item-p)))
19529 (goto-char
19530 (org-list-get-top-point (org-list-struct))))
19531 (and (not inline-task-p)
19532 (featurep 'org-inlinetask)
19533 (org-inlinetask-in-task-p)
19534 (or (org-inlinetask-goto-beginning) t))))
19535 (beginning-of-line 0))
19536 (cond
19537 ;; There was an heading above.
19539 (if (not org-adapt-indentation)
19540 (setq column 0)
19541 (goto-char (match-end 0))
19542 (setq column (current-column))))
19543 ;; A drawer had started and is unfinished
19544 ((looking-at org-drawer-regexp)
19545 (goto-char (1- (match-beginning 1)))
19546 (setq column (current-column)))
19547 ;; Else, nothing noticeable found: get indentation and go on.
19548 (t (setq column (org-get-indentation))))))
19549 ;; Now apply indentation and move cursor accordingly
19550 (goto-char pos)
19551 (if (<= (current-column) (current-indentation))
19552 (org-indent-line-to column)
19553 (save-excursion (org-indent-line-to column)))
19554 ;; Special polishing for properties, see `org-property-format'
19555 (setq column (current-column))
19556 (beginning-of-line 1)
19557 (if (looking-at
19559 (replace-match (concat (match-string 1)
19560 (format org-property-format
19561 (match-string 2) (match-string 3)))
19562 t t))
19563 (org-move-to-column column)))
19565 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19566 "Variable to store copy of `adaptive-fill-regexp'.
19567 Since `adaptive-fill-regexp' is set to never match, we need to
19568 store a backup of its value before entering `org-mode' so that
19569 the functionality can be provided as a fall-back.")
19571 (defun org-set-autofill-regexps ()
19572 (interactive)
19573 ;; In the paragraph separator we include headlines, because filling
19574 ;; text in a line directly attached to a headline would otherwise
19575 ;; fill the headline as well.
19578 ;; The paragraph starter includes hand-formatted lists.
19579 (org-set-local
19580 'paragraph-start
19581 (concat
19590 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19591 ;; But only if the user has not turned off tables or fixed-width regions
19592 (org-set-local
19593 'auto-fill-inhibit-regexp
19594 (concat org-outline-regexp
19597 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19598 (concat
19600 (if org-enable-table-editor "|" "")
19601 (if org-enable-fixed-width-editor ":" "")
19602 "]"))))
19603 ;; We use our own fill-paragraph function, to make sure that tables
19604 ;; and fixed-width regions are not wrapped. That function will pass
19605 ;; through to `fill-paragraph' when appropriate.
19606 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19607 ;; Prevent auto-fill from inserting unwanted new items.
19608 (org-set-local 'fill-nobreak-predicate
19609 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19610 fill-nobreak-predicate
19611 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19612 ;; Adaptive filling: To get full control, first make sure that
19613 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19614 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19615 (org-set-local 'org-adaptive-fill-regexp-backup
19616 adaptive-fill-regexp))
19618 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19619 (org-set-local 'adaptive-fill-function
19620 'org-adaptive-fill-function)
19621 (org-set-local
19622 'align-mode-rules-list
19623 '((org-in-buffer-settings
19625 (modes . '(org-mode))))))
19627 (defun org-fill-item-nobreak-p ()
19628 "Non-nil when a line break at point would insert a new item."
19629 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19631 (defun org-fill-paragraph (&optional justify)
19632 "Re-align a table, pass through to fill-paragraph if no table."
19633 (let ((table-p (org-at-table-p))
19634 (table.el-p (org-at-table.el-p))
19635 (itemp (org-in-item-p)))
19636 (cond ((and (equal (char-after (point-at-bol)) ?*)
19637 (save-excursion (goto-char (point-at-bol))
19638 (looking-at org-outline-regexp)))
19639 t) ; skip headlines
19640 (table.el-p t) ; skip table.el tables
19641 (table-p (org-table-align) t) ; align Org tables
19642 (itemp ; align text in items
19643 (let* ((struct (save-excursion (goto-char itemp)
19644 (org-list-struct)))
19645 (parents (org-list-parents-alist struct))
19646 (children (org-list-get-children itemp struct parents))
19647 beg end prev next prefix)
19648 ;; Determine in which part of item point is: before
19649 ;; first child, after last child, between two
19650 ;; sub-lists, or simply in item if there's no child.
19651 (cond
19652 ((not children)
19653 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19654 beg itemp
19655 end (org-list-get-item-end itemp struct)))
19656 ((< (point) (setq next (car children)))
19657 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19658 beg itemp
19659 end next))
19660 ((> (point) (setq prev (car (last children))))
19661 (setq beg (org-list-get-item-end prev struct)
19662 end (org-list-get-item-end itemp struct)
19663 prefix (save-excursion
19664 (goto-char beg)
19666 (make-string (current-column) ?\ ))))
19667 (t (catch 'exit
19668 (while (setq next (pop children))
19669 (if (> (point) next)
19670 (setq prev next)
19671 (setq beg (org-list-get-item-end prev struct)
19672 end next
19673 prefix (save-excursion
19674 (goto-char beg)
19676 (make-string (current-column) ?\ )))
19677 (throw 'exit nil))))))
19678 ;; Use `fill-paragraph' with buffer narrowed to item
19679 ;; without any child, and with our computed PREFIX.
19680 (flet ((fill-context-prefix (from to &optional flr) prefix))
19681 (save-restriction
19682 (narrow-to-region beg end)
19683 (save-excursion (fill-paragraph justify)))) t))
19684 ;; Special case where point is not in a list but is on
19685 ;; a paragraph adjacent to a list: make sure this paragraph
19686 ;; doesn't get merged with the end of the list by narrowing
19687 ;; buffer first.
19688 ((save-excursion (forward-paragraph -1)
19689 (setq itemp (org-in-item-p)))
19690 (let ((struct (save-excursion (goto-char itemp)
19691 (org-list-struct))))
19692 (save-restriction
19693 (narrow-to-region (org-list-get-bottom-point struct)
19694 (save-excursion (forward-paragraph 1)
19695 (point)))
19696 (fill-paragraph justify) t)))
19697 ;; Else simply call `fill-paragraph'.
19698 (t nil))))
19700 ;; For reference, this is the default value of adaptive-fill-regexp
19703 (defun org-adaptive-fill-function ()
19704 "Return a fill prefix for org-mode files."
19705 (let (itemp)
19706 (save-excursion
19707 (cond
19708 ;; Comment line
19710 (match-string-no-properties 0))
19711 ;; Plain list item
19712 ((org-at-item-p)
19713 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19714 ;; Point is in a list after `backward-paragraph': original
19715 ;; point wasn't in the list, or filling would have been taken
19716 ;; care of by `org-auto-fill-function', but the list and the
19717 ;; real paragraph are not separated by a blank line. Thus, move
19718 ;; point after the list to go back to real paragraph and
19719 ;; determine fill-prefix.
19720 ((setq itemp (org-in-item-p))
19721 (goto-char itemp)
19722 (let* ((struct (org-list-struct))
19723 (bottom (org-list-get-bottom-point struct)))
19724 (goto-char bottom)
19725 (make-string (org-get-indentation) ?\ )))
19726 ;; Other text
19727 ((looking-at org-adaptive-fill-regexp-backup)
19728 (match-string-no-properties 0))))))
19730 (defun org-auto-fill-function ()
19731 "Auto-fill function."
19732 (let (itemp prefix)
19733 ;; When in a list, compute an appropriate fill-prefix and make
19734 ;; sure it will be used by `do-auto-fill'.
19735 (if (setq itemp (org-in-item-p))
19736 (progn
19737 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19738 (flet ((fill-context-prefix (from to &optional flr) prefix))
19739 (do-auto-fill)))
19740 ;; Else just use `do-auto-fill'.
19741 (do-auto-fill))))
19743 ;;; Other stuff.
19745 (defun org-toggle-fixed-width-section (arg)
19746 "Toggle the fixed-width export.
19747 If there is no active region, the QUOTE keyword at the current headline is
19748 inserted or removed. When present, it causes the text between this headline
19749 and the next to be exported as fixed-width text, and unmodified.
19750 If there is an active region, this command adds or removes a colon as the
19751 first character of this line. If the first character of a line is a colon,
19752 this line is also exported in fixed-width font."
19753 (interactive "P")
19754 (let* ((cc 0)
19755 (regionp (org-region-active-p))
19756 (beg (if regionp (region-beginning) (point)))
19757 (end (if regionp (region-end)))
19758 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19759 (case-fold-search nil)
19761 off)
19762 (if regionp
19763 (save-excursion
19764 (goto-char beg)
19765 (setq cc (current-column))
19766 (beginning-of-line 1)
19767 (setq off (looking-at re))
19768 (while (> nlines 0)
19769 (setq nlines (1- nlines))
19770 (beginning-of-line 1)
19771 (cond
19772 (arg
19773 (org-move-to-column cc t)
19775 (forward-line -1))
19776 ((and off (looking-at re))
19777 (replace-match "" t t nil 1))
19778 ((not off) (org-move-to-column cc t) (insert ": ")))
19779 (forward-line 1)))
19780 (save-excursion
19781 (org-back-to-heading)
19782 (if (looking-at (concat org-outline-regexp
19784 (replace-match "" t t nil 1)
19785 (if (looking-at org-outline-regexp)
19786 (progn
19787 (goto-char (match-end 0))
19788 (insert org-quote-string " "))))))))
19790 (defun org-reftex-citation ()
19791 "Use reftex-citation to insert a citation into the buffer.
19792 This looks for a line like
19794 #+BIBLIOGRAPHY: foo plain option:-d
19796 and derives from it that foo.bib is the bibliography file relevant
19797 for this document. It then installs the necessary environment for RefTeX
19798 to work in this buffer and calls `reftex-citation' to insert a citation
19799 into the buffer.
19801 Export of such citations to both LaTeX and HTML is handled by the contributed
19802 package org-exp-bibtex by Taru Karttunen."
19803 (interactive)
19804 (let ((reftex-docstruct-symbol 'rds)
19806 rds bib)
19807 (save-excursion
19808 (save-restriction
19809 (widen)
19810 (let ((case-fold-search t)
19812 (if (not (save-excursion
19813 (or (re-search-forward re nil t)
19814 (re-search-backward re nil t))))
19815 (error "No bibliography defined in file")
19816 (setq bib (concat (match-string 1) ".bib")
19817 rds (list (list 'bib bib)))))))
19818 (call-interactively 'reftex-citation)))
19820 ;;;; Functions extending outline functionality
19822 (defun org-beginning-of-line (&optional arg)
19823 "Go to the beginning of the current line. If that is invisible, continue
19824 to a visible line beginning. This makes the function of C-a more intuitive.
19825 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19826 first attempt, and only move to after the tags when the cursor is already
19827 beyond the end of the headline."
19828 (interactive "P")
19829 (let ((pos (point))
19830 (special (if (consp org-special-ctrl-a/e)
19831 (car org-special-ctrl-a/e)
19832 org-special-ctrl-a/e))
19833 refpos)
19834 (if (org-bound-and-true-p line-move-visual)
19835 (beginning-of-visual-line 1)
19836 (beginning-of-line 1))
19837 (if (and arg (fboundp 'move-beginning-of-line))
19838 (call-interactively 'move-beginning-of-line)
19839 (if (bobp)
19840 nil
19841 (backward-char 1)
19842 (if (org-truely-invisible-p)
19843 (while (and (not (bobp)) (org-truely-invisible-p))
19844 (backward-char 1)
19845 (beginning-of-line 1))
19846 (forward-char 1))))
19847 (when special
19848 (cond
19849 ((and (looking-at org-complex-heading-regexp)
19850 (= (char-after (match-end 1)) ?\ ))
19851 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19852 (point-at-eol)))
19853 (goto-char
19854 (if (eq special t)
19855 (cond ((> pos refpos) refpos)
19856 ((= pos (point)) refpos)
19857 (t (point)))
19858 (cond ((> pos (point)) (point))
19859 ((not (eq last-command this-command)) (point))
19860 (t refpos)))))
19861 ((org-at-item-p)
19862 (goto-char
19863 (if (eq special t)
19864 (cond ((> pos (match-end 0)) (match-end 0))
19865 ((= pos (point)) (match-end 0))
19866 (t (point)))
19867 (cond ((> pos (point)) (point))
19868 ((not (eq last-command this-command)) (point))
19869 (t (match-end 0))))))))
19870 (org-no-warnings
19871 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19873 (defun org-end-of-line (&optional arg)
19874 "Go to the end of the line.
19875 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19876 first attempt, and only move to after the tags when the cursor is already
19877 beyond the end of the headline."
19878 (interactive "P")
19879 (let ((special (if (consp org-special-ctrl-a/e)
19880 (cdr org-special-ctrl-a/e)
19881 org-special-ctrl-a/e)))
19882 (if (or (not special)
19883 (not (org-on-heading-p))
19884 arg)
19885 (call-interactively
19886 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19887 ((fboundp 'move-end-of-line) 'move-end-of-line)
19888 (t 'end-of-line)))
19889 (let ((pos (point)))
19890 (beginning-of-line 1)
19892 (if (eq special t)
19893 (if (or (< pos (match-beginning 1))
19894 (= pos (match-end 0)))
19895 (goto-char (match-beginning 1))
19896 (goto-char (match-end 0)))
19897 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19898 (goto-char (match-end 0))
19899 (goto-char (match-beginning 1))))
19900 (call-interactively (if (fboundp 'move-end-of-line)
19901 'move-end-of-line
19902 'end-of-line)))))
19903 (org-no-warnings
19904 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19906 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19907 (define-key org-mode-map "\C-e" 'org-end-of-line)
19909 (defun org-backward-sentence (&optional arg)
19910 "Go to beginning of sentence, or beginning of table field.
19911 This will call `backward-sentence' or `org-table-beginning-of-field',
19912 depending on context."
19913 (interactive "P")
19914 (cond
19915 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19916 (t (call-interactively 'backward-sentence))))
19918 (defun org-forward-sentence (&optional arg)
19919 "Go to end of sentence, or end of table field.
19920 This will call `forward-sentence' or `org-table-end-of-field',
19921 depending on context."
19922 (interactive "P")
19923 (cond
19924 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19925 (t (call-interactively 'forward-sentence))))
19927 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19928 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19930 (defun org-kill-line (&optional arg)
19931 "Kill line, to tags or end of line."
19932 (interactive "P")
19933 (cond
19934 ((or (not org-special-ctrl-k)
19935 (bolp)
19936 (not (org-on-heading-p)))
19937 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19938 org-ctrl-k-protect-subtree)
19939 (if (or (eq org-ctrl-k-protect-subtree 'error)
19940 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19941 (error "C-k aborted - would kill hidden subtree")))
19942 (call-interactively 'kill-line))
19944 (kill-region (point) (match-beginning 1))
19945 (org-set-tags nil t))
19946 (t (kill-region (point) (point-at-eol)))))
19948 (define-key org-mode-map "\C-k" 'org-kill-line)
19950 (defun org-yank (&optional arg)
19951 "Yank. If the kill is a subtree, treat it specially.
19952 This command will look at the current kill and check if is a single
19953 subtree, or a series of subtrees[1]. If it passes the test, and if the
19954 cursor is at the beginning of a line or after the stars of a currently
19955 empty headline, then the yank is handled specially. How exactly depends
19956 on the value of the following variables, both set by default.
19958 org-yank-folded-subtrees
19959 When set, the subtree(s) will be folded after insertion, but only
19960 if doing so would now swallow text after the yanked text.
19962 org-yank-adjusted-subtrees
19963 When set, the subtree will be promoted or demoted in order to
19964 fit into the local outline tree structure, which means that the level
19965 will be adjusted so that it becomes the smaller one of the two
19966 *visible* surrounding headings.
19968 Any prefix to this command will cause `yank' to be called directly with
19970 will just
19971 plainly yank the text as it is.
19973 \[1] The test checks if the first non-white line is a heading
19974 and if there are no other headings with fewer stars."
19975 (interactive "P")
19976 (org-yank-generic 'yank arg))
19978 (defun org-yank-generic (command arg)
19979 "Perform some yank-like command.
19981 This function implements the behavior described in the `org-yank'
19982 documentation. However, it has been generalized to work for any
19983 interactive command with similar behavior."
19985 ;; pretend to be command COMMAND
19986 (setq this-command command)
19988 (if arg
19989 (call-interactively command)
19991 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19992 (and (org-kill-is-subtree-p)
19993 (or (bolp)
19995 (string-match
19997 (buffer-substring (point-at-bol) (point)))))))
19998 swallowp)
19999 (cond
20000 ((and subtreep org-yank-folded-subtrees)
20001 (let ((beg (point))
20002 end)
20003 (if (and subtreep org-yank-adjusted-subtrees)
20004 (org-paste-subtree nil nil 'for-yank)
20005 (call-interactively command))
20007 (setq end (point))
20008 (goto-char beg)
20009 (when (and (bolp) subtreep
20010 (not (setq swallowp
20011 (org-yank-folding-would-swallow-text beg end))))
20012 (org-with-limited-levels
20013 (or (looking-at org-outline-regexp)
20014 (re-search-forward org-outline-regexp-bol end t))
20015 (while (and (< (point) end) (looking-at org-outline-regexp))
20016 (hide-subtree)
20017 (org-cycle-show-empty-lines 'folded)
20018 (condition-case nil
20019 (outline-forward-same-level 1)
20020 (error (goto-char end))))))
20021 (when swallowp
20022 (message
20023 "Inserted text not folded because that would swallow text"))
20025 (goto-char end)
20027 (beginning-of-line 1)
20028 (push-mark beg 'nomsg)))
20029 ((and subtreep org-yank-adjusted-subtrees)
20030 (let ((beg (point-at-bol)))
20031 (org-paste-subtree nil nil 'for-yank)
20032 (push-mark beg 'nomsg)))
20033 (t
20034 (call-interactively command))))))
20036 (defun org-yank-folding-would-swallow-text (beg end)
20037 "Would hide-subtree at BEG swallow any text after END?"
20038 (let (level)
20039 (org-with-limited-levels
20040 (save-excursion
20041 (goto-char beg)
20042 (when (or (looking-at org-outline-regexp)
20043 (re-search-forward org-outline-regexp-bol end t))
20044 (setq level (org-outline-level)))
20045 (goto-char end)
20047 (if (or (eobp)
20048 (and (bolp) (looking-at org-outline-regexp)
20049 (<= (org-outline-level) level)))
20050 nil ; Nothing would be swallowed
20051 t))))) ; something would swallow
20053 (define-key org-mode-map "\C-y" 'org-yank)
20055 (defun org-truely-invisible-p ()
20056 "Check if point is at a character currently not visible.
20057 This version does not only check the character property, but also
20058 `visible-mode'."
20059 ;; Early versions of noutline don't have `outline-invisible-p'.
20060 (if (org-bound-and-true-p visible-mode)
20061 nil
20062 (outline-invisible-p)))
20064 (defun org-invisible-p2 ()
20065 "Check if point is at a character currently not visible."
20066 (save-excursion
20067 (if (and (eolp) (not (bobp))) (backward-char 1))
20068 ;; Early versions of noutline don't have `outline-invisible-p'.
20069 (outline-invisible-p)))
20071 (defun org-back-to-heading (&optional invisible-ok)
20072 "Call `outline-back-to-heading', but provide a better error message."
20073 (condition-case nil
20074 (outline-back-to-heading invisible-ok)
20075 (error (error "Before first headline at position %d in buffer %s"
20076 (point) (current-buffer)))))
20078 (defun org-beginning-of-defun ()
20079 "Go to the beginning of the subtree, i.e. back to the heading."
20080 (org-back-to-heading))
20081 (defun org-end-of-defun ()
20082 "Go to the end of the subtree."
20083 (org-end-of-subtree nil t))
20085 (defun org-before-first-heading-p ()
20086 "Before first heading?"
20087 (save-excursion
20088 (end-of-line)
20089 (null (re-search-backward org-outline-regexp-bol nil t))))
20091 (defun org-on-heading-p (&optional ignored)
20092 (outline-on-heading-p t))
20093 (defun org-at-heading-p (&optional ignored)
20094 (outline-on-heading-p t))
20096 (defun org-point-at-end-of-empty-headline ()
20097 "If point is at the end of an empty headline, return t, else nil.
20098 If the heading only contains a TODO keyword, it is still still considered
20099 empty."
20101 (save-excursion
20102 (beginning-of-line 1)
20103 (let ((case-fold-search nil))
20106 (defun org-at-heading-or-item-p ()
20107 (or (org-on-heading-p) (org-at-item-p)))
20109 (defun org-on-target-p ()
20110 (or (org-in-regexp org-radio-target-regexp)
20111 (org-in-regexp org-target-regexp)))
20113 (defun org-up-heading-all (arg)
20114 "Move to the heading line of which the present line is a subheading.
20115 This function considers both visible and invisible heading lines.
20116 With argument, move up ARG levels."
20117 (if (fboundp 'outline-up-heading-all)
20118 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20119 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20121 (defun org-up-heading-safe ()
20122 "Move to the heading line of which the present line is a subheading.
20123 This version will not throw an error. It will return the level of the
20124 headline found, or nil if no higher level is found.
20126 Also, this function will be a lot faster than `outline-up-heading',
20127 because it relies on stars being the outline starters. This can really
20128 make a significant difference in outlines with very many siblings."
20129 (let (start-level re)
20130 (org-back-to-heading t)
20131 (setq start-level (funcall outline-level))
20132 (if (equal start-level 1)
20133 nil
20135 (if (re-search-backward re nil t)
20136 (funcall outline-level)))))
20138 (defun org-first-sibling-p ()
20139 "Is this heading the first child of its parents?"
20140 (interactive)
20141 (let ((re org-outline-regexp-bol)
20142 level l)
20143 (unless (org-at-heading-p t)
20144 (error "Not at a heading"))
20145 (setq level (funcall outline-level))
20146 (save-excursion
20147 (if (not (re-search-backward re nil t))
20148 t
20149 (setq l (funcall outline-level))
20150 (< l level)))))
20152 (defun org-goto-sibling (&optional previous)
20153 "Goto the next sibling, even if it is invisible.
20154 When PREVIOUS is set, go to the previous sibling instead. Returns t
20155 when a sibling was found. When none is found, return nil and don't
20156 move point."
20157 (let ((fun (if previous 're-search-backward 're-search-forward))
20158 (pos (point))
20159 (re org-outline-regexp-bol)
20160 level l)
20161 (when (condition-case nil (org-back-to-heading t) (error nil))
20162 (setq level (funcall outline-level))
20163 (catch 'exit
20164 (or previous (forward-char 1))
20165 (while (funcall fun re nil t)
20166 (setq l (funcall outline-level))
20167 (when (< l level) (goto-char pos) (throw 'exit nil))
20168 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20169 (goto-char pos)
20170 nil))))
20172 (defun org-show-siblings ()
20173 "Show all siblings of the current headline."
20174 (save-excursion
20175 (while (org-goto-sibling) (org-flag-heading nil)))
20176 (save-excursion
20177 (while (org-goto-sibling 'previous)
20178 (org-flag-heading nil))))
20180 (defun org-goto-first-child ()
20181 "Goto the first child, even if it is invisible.
20182 Return t when a child was found. Otherwise don't move point and
20183 return nil."
20184 (let (level (pos (point)) (re org-outline-regexp-bol))
20185 (when (condition-case nil (org-back-to-heading t) (error nil))
20186 (setq level (outline-level))
20187 (forward-char 1)
20188 (if (and (re-search-forward re nil t) (> (outline-level) level))
20189 (progn (goto-char (match-beginning 0)) t)
20190 (goto-char pos) nil))))
20192 (defun org-show-hidden-entry ()
20193 "Show an entry where even the heading is hidden."
20194 (save-excursion
20195 (org-show-entry)))
20197 (defun org-flag-heading (flag &optional entry)
20198 "Flag the current heading. FLAG non-nil means make invisible.
20199 When ENTRY is non-nil, show the entire entry."
20200 (save-excursion
20201 (org-back-to-heading t)
20202 ;; Check if we should show the entire entry
20203 (if entry
20204 (progn
20205 (org-show-entry)
20206 (save-excursion
20207 (and (outline-next-heading)
20208 (org-flag-heading nil))))
20209 (outline-flag-region (max (point-min) (1- (point)))
20210 (save-excursion (outline-end-of-heading) (point))
20211 flag))))
20213 (defun org-get-next-sibling ()
20214 "Move to next heading of the same level, and return point.
20215 If there is no such heading, return nil.
20216 This is like outline-next-sibling, but invisible headings are ok."
20217 (let ((level (funcall outline-level)))
20218 (outline-next-heading)
20219 (while (and (not (eobp)) (> (funcall outline-level) level))
20220 (outline-next-heading))
20221 (if (or (eobp) (< (funcall outline-level) level))
20222 nil
20223 (point))))
20225 (defun org-get-last-sibling ()
20226 "Move to previous heading of the same level, and return point.
20227 If there is no such heading, return nil."
20228 (let ((opoint (point))
20229 (level (funcall outline-level)))
20230 (outline-previous-heading)
20231 (when (and (/= (point) opoint) (outline-on-heading-p t))
20232 (while (and (> (funcall outline-level) level)
20233 (not (bobp)))
20234 (outline-previous-heading))
20235 (if (< (funcall outline-level) level)
20236 nil
20237 (point)))))
20239 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20240 ;; This contains an exact copy of the original function, but it uses
20241 ;; `org-back-to-heading', to make it work also in invisible
20242 ;; trees. And is uses an invisible-OK argument.
20243 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20244 ;; Furthermore, when used inside Org, finding the end of a large subtree
20245 ;; with many children and grandchildren etc, this can be much faster
20246 ;; than the outline version.
20247 (org-back-to-heading invisible-OK)
20248 (let ((first t)
20249 (level (funcall outline-level)))
20250 (if (and (org-mode-p) (< level 1000))
20251 ;; A true heading (not a plain list item), in Org-mode
20252 ;; This means we can easily find the end by looking
20253 ;; only for the right number of stars. Using a regexp to do
20254 ;; this is so much faster than using a Lisp loop.
20256 (forward-char 1)
20257 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20258 ;; something else, do it the slow way
20259 (while (and (not (eobp))
20260 (or first (> (funcall outline-level) level)))
20261 (setq first nil)
20262 (outline-next-heading)))
20263 (unless to-heading
20265 (progn
20266 ;; Go to end of line before heading
20267 (forward-char -1)
20269 ;; leave blank line before heading
20270 (forward-char -1))))))
20271 (point))
20273 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20274 "Use Org version in org-mode, for dramatic speed-up."
20275 (if (org-mode-p)
20276 (progn
20277 (org-end-of-subtree nil t)
20278 (unless (eobp) (backward-char 1)))
20279 ad-do-it))
20281 (defun org-end-of-meta-data-and-drawers ()
20282 "Jump to the first text after meta data and drawers in the current entry.
20283 This will move over empty lines, lines with planning time stamps,
20284 clocking lines, and drawers."
20285 (org-back-to-heading t)
20286 (let ((end (save-excursion (outline-next-heading) (point)))
20289 (forward-line 1)
20290 (while (re-search-forward re end t)
20291 (if (not (match-end 1))
20292 ;; empty or planning line
20293 (forward-line 1)
20294 ;; a drawer, find the end
20296 (forward-line 1)))
20298 (point)))
20300 (defun org-forward-same-level (arg &optional invisible-ok)
20301 "Move forward to the arg'th subheading at same level as this one.
20302 Stop at the first and last subheadings of a superior heading.
20303 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20304 it wil also look at invisible ones."
20305 (interactive "p")
20306 (org-back-to-heading invisible-ok)
20307 (org-on-heading-p)
20308 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20310 l)
20311 (forward-char 1)
20312 (while (> arg 0)
20313 (while (and (re-search-forward re nil 'move)
20314 (setq l (- (match-end 0) (match-beginning 0) 1))
20315 (= l level)
20316 (not invisible-ok)
20317 (progn (backward-char 1) (outline-invisible-p)))
20318 (if (< l level) (setq arg 1)))
20319 (setq arg (1- arg)))
20320 (beginning-of-line 1)))
20322 (defun org-backward-same-level (arg &optional invisible-ok)
20323 "Move backward to the arg'th subheading at same level as this one.
20324 Stop at the first and last subheadings of a superior heading."
20325 (interactive "p")
20326 (org-back-to-heading)
20327 (org-on-heading-p)
20328 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20330 l)
20331 (while (> arg 0)
20332 (while (and (re-search-backward re nil 'move)
20333 (setq l (- (match-end 0) (match-beginning 0) 1))
20334 (= l level)
20335 (not invisible-ok)
20336 (outline-invisible-p))
20337 (if (< l level) (setq arg 1)))
20338 (setq arg (1- arg)))))
20340 (defun org-show-subtree ()
20341 "Show everything after this heading at deeper levels."
20342 (outline-flag-region
20343 (point)
20344 (save-excursion
20345 (org-end-of-subtree t t))
20346 nil))
20348 (defun org-show-entry ()
20349 "Show the body directly following this heading.
20350 Show the heading too, if it is currently invisible."
20351 (interactive)
20352 (save-excursion
20353 (condition-case nil
20354 (progn
20355 (org-back-to-heading t)
20356 (outline-flag-region
20357 (max (point-min) (1- (point)))
20358 (save-excursion
20359 (if (re-search-forward
20361 (match-beginning 1)
20362 (point-max)))
20363 nil)
20364 (org-cycle-hide-drawers 'children))
20365 (error nil))))
20367 (defun org-make-options-regexp (kwds &optional extra)
20368 "Make a regular expression for keyword lines."
20369 (concat
20370 "^"
20377 ;; Make isearch reveal the necessary context
20378 (defun org-isearch-end ()
20379 "Reveal context after isearch exits."
20380 (when isearch-success ; only if search was successful
20381 (if (featurep 'xemacs)
20382 ;; Under XEmacs, the hook is run in the correct place,
20383 ;; we directly show the context.
20384 (org-show-context 'isearch)
20385 ;; In Emacs the hook runs *before* restoring the overlays.
20386 ;; So we have to use a one-time post-command-hook to do this.
20387 ;; (Emacs 22 has a special variable, see function `org-mode')
20388 (unless (and (boundp 'isearch-mode-end-hook-quit)
20389 isearch-mode-end-hook-quit)
20390 ;; Only when the isearch was not quitted.
20391 (org-add-hook 'post-command-hook 'org-isearch-post-command
20392 'append 'local)))))
20394 (defun org-isearch-post-command ()
20395 "Remove self from hook, and show context."
20396 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20397 (org-show-context 'isearch))
20400 ;;;; Integration with and fixes for other packages
20402 ;;; Imenu support
20404 (defvar org-imenu-markers nil
20405 "All markers currently used by Imenu.")
20406 (make-variable-buffer-local 'org-imenu-markers)
20408 (defun org-imenu-new-marker (&optional pos)
20409 "Return a new marker for use by Imenu, and remember the marker."
20410 (let ((m (make-marker)))
20411 (move-marker m (or pos (point)))
20412 (push m org-imenu-markers)
20413 m))
20415 (defun org-imenu-get-tree ()
20416 "Produce the index for Imenu."
20417 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20418 (setq org-imenu-markers nil)
20419 (let* ((n org-imenu-depth)
20420 (re (concat "^" (org-get-limited-outline-regexp)))
20421 (subs (make-vector (1+ n) nil))
20422 (last-level 0)
20423 m level head)
20424 (save-excursion
20425 (save-restriction
20426 (widen)
20427 (goto-char (point-max))
20428 (while (re-search-backward re nil t)
20429 (setq level (org-reduced-level (funcall outline-level)))
20430 (when (<= level n)
20431 (looking-at org-complex-heading-regexp)
20432 (setq head (org-link-display-format
20433 (org-match-string-no-properties 4))
20434 m (org-imenu-new-marker))
20435 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20436 (if (>= level last-level)
20437 (push (cons head m) (aref subs level))
20438 (push (cons head (aref subs (1+ level))) (aref subs level))
20439 (loop for i from (1+ level) to n do (aset subs i nil)))
20440 (setq last-level level)))))
20441 (aref subs 1)))
20443 (eval-after-load "imenu"
20444 '(progn
20445 (add-hook 'imenu-after-jump-hook
20446 (lambda ()
20447 (if (org-mode-p)
20448 (org-show-context 'org-goto))))))
20450 (defun org-link-display-format (link)
20451 "Replace a link with either the description, or the link target
20452 if no description is present"
20453 (save-match-data
20454 (if (string-match org-bracket-link-analytic-regexp link)
20455 (replace-match (if (match-end 5)
20456 (match-string 5 link)
20457 (concat (match-string 1 link)
20458 (match-string 3 link)))
20459 nil t link)
20460 link)))
20462 (defun org-toggle-link-display ()
20463 "Toggle the literal or descriptive display of links."
20464 (interactive)
20465 (if org-link-display-descriptive
20466 (progn (org-remove-from-invisibility-spec '(org-link))
20467 (org-restart-font-lock)
20468 (setq org-link-display-descriptive nil))
20469 (progn (add-to-invisibility-spec '(org-link))
20470 (org-restart-font-lock)
20471 (setq org-link-display-descriptive t))))
20473 ;; Speedbar support
20475 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20476 "Overlay marking the agenda restriction line in speedbar.")
20477 (overlay-put org-speedbar-restriction-lock-overlay
20478 'face 'org-agenda-restriction-lock)
20479 (overlay-put org-speedbar-restriction-lock-overlay
20480 'help-echo "Agendas are currently limited to this item.")
20481 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20483 (defun org-speedbar-set-agenda-restriction ()
20484 "Restrict future agenda commands to the location at point in speedbar.
20486 (interactive)
20487 (require 'org-agenda)
20488 (let (p m tp np dir txt)
20489 (cond
20490 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20491 'org-imenu t))
20492 (setq m (get-text-property p 'org-imenu-marker))
20493 (with-current-buffer (marker-buffer m)
20494 (goto-char m)
20495 (org-agenda-set-restriction-lock 'subtree)))
20496 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20497 'speedbar-function 'speedbar-find-file))
20498 (setq tp (previous-single-property-change
20499 (1+ p) 'speedbar-function)
20500 np (next-single-property-change
20501 tp 'speedbar-function)
20502 dir (speedbar-line-directory)
20503 txt (buffer-substring-no-properties (or tp (point-min))
20504 (or np (point-max))))
20505 (with-current-buffer (find-file-noselect
20506 (let ((default-directory dir))
20507 (expand-file-name txt)))
20508 (unless (org-mode-p)
20509 (error "Cannot restrict to non-Org-mode file"))
20510 (org-agenda-set-restriction-lock 'file)))
20511 (t (error "Don't know how to restrict Org-mode's agenda")))
20512 (move-overlay org-speedbar-restriction-lock-overlay
20513 (point-at-bol) (point-at-eol))
20514 (setq current-prefix-arg nil)
20515 (org-agenda-maybe-redo)))
20517 (eval-after-load "speedbar"
20518 '(progn
20519 (speedbar-add-supported-extension ".org")
20520 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20521 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20522 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20523 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20524 (add-hook 'speedbar-visiting-tag-hook
20525 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20527 ;;; Fixes and Hacks for problems with other packages
20529 ;; Make flyspell not check words in links, to not mess up our keymap
20530 (defun org-mode-flyspell-verify ()
20531 "Don't let flyspell put overlays at active buttons, or on
20532 {todo,all-time,additional-option-like}-keywords."
20533 (let ((pos (max (1- (point)) (point-min)))
20534 (word (thing-at-point 'word)))
20535 (and (not (get-text-property pos 'keymap))
20536 (not (get-text-property pos 'org-no-flyspell))
20537 (not (member word org-todo-keywords-1))
20538 (not (member word org-all-time-keywords))
20539 (not (member word org-additional-option-like-keywords)))))
20541 (defun org-remove-flyspell-overlays-in (beg end)
20542 "Remove flyspell overlays in region."
20543 (and (org-bound-and-true-p flyspell-mode)
20544 (fboundp 'flyspell-delete-region-overlays)
20545 (flyspell-delete-region-overlays beg end))
20546 (add-text-properties beg end '(org-no-flyspell t)))
20548 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20549 (eval-after-load "bookmark"
20550 '(if (boundp 'bookmark-after-jump-hook)
20551 ;; We can use the hook
20552 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20553 ;; Hook not available, use advice
20554 (defadvice bookmark-jump (after org-make-visible activate)
20555 "Make the position visible."
20556 (org-bookmark-jump-unhide))))
20558 ;; Make sure saveplace shows the location if it was hidden
20559 (eval-after-load "saveplace"
20560 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20561 "Make the position visible."
20562 (org-bookmark-jump-unhide)))
20564 ;; Make sure ecb shows the location if it was hidden
20565 (eval-after-load "ecb"
20566 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20567 "Make hierarchy visible when jumping into location from ECB tree buffer."
20568 (if (org-mode-p)
20569 (org-show-context))))
20571 (defun org-bookmark-jump-unhide ()
20572 "Unhide the current position, to show the bookmark location."
20573 (and (org-mode-p)
20574 (or (outline-invisible-p)
20575 (save-excursion (goto-char (max (point-min) (1- (point))))
20576 (outline-invisible-p)))
20577 (org-show-context 'bookmark-jump)))
20579 ;; Make session.el ignore our circular variable
20580 (eval-after-load "session"
20581 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20583 ;;;; Experimental code
20585 (defun org-closed-in-range ()
20586 "Sparse tree of items closed in a certain time range.
20587 Still experimental, may disappear in the future."
20588 (interactive)
20589 ;; Get the time interval from the user.
20590 (let* ((time1 (org-float-time
20591 (org-read-date nil 'to-time nil "Starting date: ")))
20592 (time2 (org-float-time
20593 (org-read-date nil 'to-time nil "End date:")))
20594 ;; callback function
20595 (callback (lambda ()
20596 (let ((time
20597 (org-float-time
20598 (apply 'encode-time
20599 (org-parse-time-string
20600 (match-string 1))))))
20601 ;; check if time in interval
20602 (and (>= time time1) (<= time time2))))))
20603 ;; make tree, check each match with the callback
20606 ;;;; Finish up
20608 (provide 'org)
20610 (run-hooks 'org-load-hook)
20612 ;;; org.el ends here