| blob | 850accc5cf1b2e22901668287b6c4c9bc191f42b |
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)
5841 beg end
5843 ;; also remove line-prefix and wrap-prefix properties
5845 invisible t intangible t
5846 line-prefix t wrap-prefix t
5847 org-no-flyspell t org-emphasis t)
5849 invisible t intangible t
5850 org-no-flyspell t org-emphasis t)))
5860 "Remove specific display properties that have been added by font lock.
5861 The will remove the raise properties that are used to show superscripts
5862 and subscripts."
5872 "Add raise properties to sub/superscripts."
5876 org-match-substring-regexp
5877 org-match-substring-with-braces-regexp)
5878 limit t)
5888 ;; FIXME: Should we go back one character here, for a_b^c
5889 ;; (goto-char (1- pos)) ;????????????????????
5891 t
5893 'display
5909 t)))))
5911 ;;;; Visibility cycling, including org-goto and indirect buffer
5913 ;;; Cycling
5920 ;;;###autoload
5925 "TAB-action and visibility cycling for Org-mode.
5927 This is the command invoked in Org-mode by the TAB key. Its main purpose
5928 is outline visibility cycling, but it also invokes other actions
5929 in special contexts.
5931 - When this function is called with a prefix argument, rotate the entire
5932 buffer through 3 states (global cycling)
5933 1. OVERVIEW: Show only top-level headlines.
5934 2. CONTENTS: Show all headlines of all levels, but no body text.
5935 3. SHOW ALL: Show everything.
5936 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5937 determined by the variable `org-startup-folded', and by any VISIBILITY
5938 properties in the buffer.
5939 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5940 including any drawers.
5942 - When inside a table, re-align the table and move to the next field.
5944 - When point is at the beginning of a headline, rotate the subtree started
5945 by this line through 3 different states (local cycling)
5946 1. FOLDED: Only the main headline is shown.
5947 2. CHILDREN: The main headline and the direct children are shown.
5948 From this state, you can move to one of the children
5949 and zoom in further.
5950 3. SUBTREE: Show the entire subtree, including body text.
5951 If there is no subtree, switch directly from CHILDREN to FOLDED.
5953 - When point is at the beginning of an empty headline and the variable
5954 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5955 of the headline by demoting and promoting it to likely levels. This
5956 speeds up creation document structure by pressing TAB once or several
5957 times right after creating a new headline.
5959 - When there is a numeric prefix, go up to a heading with level ARG, do
5960 a `show-subtree' and return to the previous cursor position. If ARG
5961 is negative, go up that many levels.
5963 - When point is not at the beginning of a headline, execute the global
5964 binding for TAB, which is re-indenting the line. See the option
5965 `org-cycle-emulate-tab' for details.
5967 - Special case: if point is at the beginning of the buffer and there is
5968 no headline in line 1, this function will act as if called with prefix arg
5969 (C-u TAB, same as S-TAB) also when called without prefix arg.
5970 But only if also the variable `org-cycle-global-at-bob' is t."
5980 org-inlinetask-min-level
5985 limit-level)))
5988 outline-regexp
5996 org-cycle-hook))
6000 ;; special case: use global cycling
6014 ;; Table: enter it or move to the next field.
6025 ;; Global cycling: delegate to `org-cycle-internal-global'.
6028 ;; Drawers: delegate to `org-flag-drawer'.
6036 ;; Show-subtree, ARG levels up from here.
6044 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6050 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6057 ;; From there: TAB emulation and template completion.
6081 t
6090 "Do the global cycling action."
6094 ;; We just created the overview - now do table of contents
6095 ;; This can be slow in very large buffers, so indicate action
6105 ;; We just showed the table of contents - now show everything
6113 ;; Default action: go to overview
6121 "Do the local cycling action."
6123 ;; First, determine end of headline (EOH), end of subtree or item
6124 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6148 ;; Determine end invisible part of buffer (EOL)
6150 ;; XEmacs doesn't have `next-single-char-property-change'
6160 ;; Find out what to do next and set `this-command'
6163 ;; Nothing is hidden behind this heading
6175 org-cycle-skip-children-state-if-no-children))))
6176 ;; Entire subtree is hidden in one line: children view
6182 ;; Fold every list in subtree to top-level items.
6204 ;; We just showed the children, or no children are there,
6205 ;; now show everything.
6212 ;; Default action: hide the subtree.
6219 ;;;###autoload
6221 "Cycle the global visibility. For details see `org-cycle'.
6223 With a numeric prefix, show all headlines up to that level."
6239 "Set the visibility required by startup options and properties."
6254 "Switch subtree visibilities according to :VISIBILITY: property."
6261 nil t)
6285 ;; This function uses outline-regexp instead of the more fundamental
6286 ;; org-outline-regexp so that org-cycle-global works outside of Org
6287 ;; buffers, where outline-regexp is needed.
6289 "Switch to overview mode, showing only top-level headlines.
6290 Really, this shows all headlines with level equal or greater than the level
6291 of the first headline in the buffer. This is important, because if the
6292 first headline is not level one, then (hide-sublevels 1) gives confusing
6293 results."
6304 "Show all headlines in the buffer, like a table of contents.
6305 With numerical argument N, show content up to level N."
6308 ;; Visit all headings and show their offspring
6315 t)
6324 "Adjust the window after a change in outline visibility.
6325 This function is the default value of the hook `org-cycle-hook'."
6335 "Remove outline overlays that do not contain non-white stuff."
6345 "Fix visibility issues after moving a subtree."
6346 ;; First, find a reasonable region to look at:
6347 ;; Start two siblings above, end three below
6365 ;; Properly fold already folded siblings
6376 "Show empty lines above all visible headlines.
6377 The region to be covered depends on STATE when called through
6378 `org-cycle-hook'. Lisp program can use t for STATE to get the
6379 entire buffer covered. Note that an empty line is only shown if there
6380 are at least `org-cycle-separator-lines' empty lines before the headline."
6390 beg end b e)
6414 ;; Never hide empty lines at the end of the file.
6424 "Move to the parent and re-show empty lines before visible headlines."
6430 "Return `org-agenda-files' list, plus all open org-mode files.
6431 This is useful for operations that need to scan all of a user's
6432 open and agenda-wise Org files."
6440 files))
6443 "Return the beginning position of the current entry."
6447 "Return the end position of the current entry."
6451 "Re-hide all drawers after a visibility state change."
6477 "Is the end of the current subtree visible?"
6482 "Move cursor to the first headline and recenter the headline.
6483 Optional argument N means put the headline into the Nth line of the window."
6489 ;;; Saving and restoring visibility
6492 "Return a list of the locations of all outline overlays.
6493 These are overlays with the `invisible' property value `outline'.
6494 The return value is a list of cons cells, with start and stop
6495 positions for each overlay.
6496 If USE-MARKERS is set, return the positions as markers."
6514 "Create visibility overlays for all positions in DATA.
6515 DATA should have been made by `org-outline-overlay-data'."
6524 data)))))
6526 ;;; Folding of blocks
6537 "Call FUNCTION at the head of all source blocks in the current buffer.
6538 Optional arguments START and END can be used to limit the range."
6550 "Toggle the visibility of all blocks in the current buffer."
6554 "Fold all blocks in the current buffer."
6560 "Unfold all blocks in the current buffer."
6566 "Toggle visibility of block at point."
6577 "Toggle the visibility of the current block."
6584 ov)
6600 ;; make the block accessible to isearch
6602 ov 'isearch-open-invisible
6613 ;; org-tab-after-check-for-cycling-hook
6615 ;; Remove overlays when changing major mode
6620 ;;; Org-goto
6626 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6642 nil)
6643 (org-defkey map "q" 'org-goto-quit)
6644 (org-defkey map "n" 'outline-next-visible-heading)
6645 (org-defkey map "p" 'outline-previous-visible-heading)
6646 (org-defkey map "f" 'outline-forward-same-level)
6647 (org-defkey map "b" 'outline-backward-same-level)
6648 (org-defkey map "u" 'outline-up-heading))
6649 (org-defkey map "/" 'org-occur)
6650 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6651 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6652 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6653 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6654 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6655 map))
6657 (defconst org-goto-help
6658 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6659 RET=jump to location [Q]uit and return to previous location
6660 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6662 (defvar org-goto-start-pos) ; dynamically scoped parameter
6664 ;; FIXME: Docstring does not mention both interfaces
6665 (defun org-goto (&optional alternative-interface)
6666 "Look up a different location in the current file, keeping current visibility.
6668 When you want look-up or go to a different location in a document, the
6669 fastest way is often to fold the entire buffer and then dive into the tree.
6670 This method has the disadvantage, that the previous location will be folded,
6671 which may not be what you want.
6673 This command works around this by showing a copy of the current buffer
6674 in an indirect buffer, in overview mode. You can dive into the tree in
6675 that copy, use org-occur and incremental search to find a location.
6676 When pressing RET or `Q', the command returns to the original buffer in
6677 which the visibility is still unchanged. After RET is will also jump to
6678 the location selected in the indirect buffer and expose the headline
6679 hierarchy above."
6680 (interactive "P")
6681 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6682 (org-refile-use-outline-path t)
6683 (org-refile-target-verify-function nil)
6684 (interface
6685 (if (not alternative-interface)
6686 org-goto-interface
6687 (if (eq org-goto-interface 'outline)
6688 'outline-path-completion
6689 'outline)))
6690 (org-goto-start-pos (point))
6691 (selected-point
6692 (if (eq interface 'outline)
6693 (car (org-get-location (current-buffer) org-goto-help))
6694 (let ((pa (org-refile-get-location "Goto")))
6695 (org-refile-check-position pa)
6696 (nth 3 pa)))))
6697 (if selected-point
6698 (progn
6699 (org-mark-ring-push org-goto-start-pos)
6700 (goto-char selected-point)
6701 (if (or (outline-invisible-p) (org-invisible-p2))
6702 (org-show-context 'org-goto)))
6703 (message "Quit"))))
6705 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6706 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6707 (defvar org-goto-local-auto-isearch-map) ; defined below
6709 (defun org-get-location (buf help)
6710 "Let the user select a location in the Org-mode buffer BUF.
6711 This function uses a recursive edit. It returns the selected position
6712 or nil."
6713 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6714 (isearch-hide-immediately nil)
6715 (isearch-search-fun-function
6716 (lambda () 'org-goto-local-search-headings))
6717 (org-goto-selected-point org-goto-exit-command)
6718 (pop-up-frames nil)
6719 (special-display-buffer-names nil)
6720 (special-display-regexps nil)
6721 (special-display-function nil))
6722 (save-excursion
6723 (save-window-excursion
6724 (delete-other-windows)
6725 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6726 (org-pop-to-buffer-same-window
6727 (condition-case nil
6728 (make-indirect-buffer (current-buffer) "*org-goto*")
6729 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6730 (with-output-to-temp-buffer "*Help*"
6731 (princ help))
6732 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6733 (setq buffer-read-only nil)
6734 (let ((org-startup-truncated t)
6735 (org-startup-folded nil)
6736 (org-startup-align-all-tables nil))
6737 (org-mode)
6738 (org-overview))
6739 (setq buffer-read-only t)
6740 (if (and (boundp 'org-goto-start-pos)
6741 (integer-or-marker-p org-goto-start-pos))
6742 (let ((org-show-hierarchy-above t)
6743 (org-show-siblings t)
6744 (org-show-following-heading t))
6745 (goto-char org-goto-start-pos)
6746 (and (outline-invisible-p) (org-show-context)))
6747 (goto-char (point-min)))
6748 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6749 (message "Select location and press RET")
6750 (use-local-map org-goto-map)
6751 (recursive-edit)
6752 ))
6753 (kill-buffer "*org-goto*")
6754 (cons org-goto-selected-point org-goto-exit-command)))
6756 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6757 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6758 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6759 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6761 (defun org-goto-local-search-headings (string bound noerror)
6762 "Search and make sure that any matches are in headlines."
6763 (catch 'return
6764 (while (if isearch-forward
6765 (search-forward string bound noerror)
6766 (search-backward string bound noerror))
6767 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6768 (and (member :headline context)
6769 (not (member :tags context))))
6770 (throw 'return (point))))))
6772 (defun org-goto-local-auto-isearch ()
6773 "Start isearch."
6774 (interactive)
6775 (goto-char (point-min))
6776 (let ((keys (this-command-keys)))
6777 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6778 (isearch-mode t)
6779 (isearch-process-search-char (string-to-char keys)))))
6781 (defun org-goto-ret (&optional arg)
6782 "Finish `org-goto' by going to the new location."
6783 (interactive "P")
6784 (setq org-goto-selected-point (point)
6785 org-goto-exit-command 'return)
6786 (throw 'exit nil))
6788 (defun org-goto-left ()
6789 "Finish `org-goto' by going to the new location."
6790 (interactive)
6791 (if (org-on-heading-p)
6792 (progn
6793 (beginning-of-line 1)
6794 (setq org-goto-selected-point (point)
6795 org-goto-exit-command 'left)
6796 (throw 'exit nil))
6797 (error "Not on a heading")))
6799 (defun org-goto-right ()
6800 "Finish `org-goto' by going to the new location."
6801 (interactive)
6802 (if (org-on-heading-p)
6803 (progn
6804 (setq org-goto-selected-point (point)
6805 org-goto-exit-command 'right)
6806 (throw 'exit nil))
6807 (error "Not on a heading")))
6809 (defun org-goto-quit ()
6810 "Finish `org-goto' without cursor motion."
6811 (interactive)
6812 (setq org-goto-selected-point nil)
6813 (setq org-goto-exit-command 'quit)
6814 (throw 'exit nil))
6816 ;;; Indirect buffer display of subtrees
6818 (defvar org-indirect-dedicated-frame nil
6819 "This is the frame being used for indirect tree display.")
6820 (defvar org-last-indirect-buffer nil)
6822 (defun org-tree-to-indirect-buffer (&optional arg)
6823 "Create indirect buffer and narrow it to current subtree.
6824 With numerical prefix ARG, go up to this level and then take that tree.
6825 If ARG is negative, go up that many levels.
6826 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6827 indirect buffer previously made with this command, to avoid proliferation of
6828 indirect buffers. However, when you call the command with a \
6830 when `org-indirect-buffer-display' is `new-frame', the last buffer
6831 is kept so that you can work with several indirect buffers at the same time.
6832 If `org-indirect-buffer-display' is `dedicated-frame', the \
6834 requests that a new frame be made for the new buffer, so that the dedicated
6835 frame is not changed."
6836 (interactive "P")
6837 (let ((cbuf (current-buffer))
6838 (cwin (selected-window))
6839 (pos (point))
6840 beg end level heading ibuf)
6841 (save-excursion
6842 (org-back-to-heading t)
6843 (when (numberp arg)
6844 (setq level (org-outline-level))
6845 (if (< arg 0) (setq arg (+ level arg)))
6846 (while (> (setq level (org-outline-level)) arg)
6847 (outline-up-heading 1 t)))
6848 (setq beg (point)
6849 heading (org-get-heading))
6850 (org-end-of-subtree t t)
6851 (if (org-on-heading-p) (backward-char 1))
6852 (setq end (point)))
6853 (if (and (buffer-live-p org-last-indirect-buffer)
6854 (not (eq org-indirect-buffer-display 'new-frame))
6855 (not arg))
6856 (kill-buffer org-last-indirect-buffer))
6857 (setq ibuf (org-get-indirect-buffer cbuf)
6858 org-last-indirect-buffer ibuf)
6859 (cond
6860 ((or (eq org-indirect-buffer-display 'new-frame)
6861 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6862 (select-frame (make-frame))
6863 (delete-other-windows)
6864 (org-pop-to-buffer-same-window ibuf)
6865 (org-set-frame-title heading))
6866 ((eq org-indirect-buffer-display 'dedicated-frame)
6867 (raise-frame
6868 (select-frame (or (and org-indirect-dedicated-frame
6869 (frame-live-p org-indirect-dedicated-frame)
6870 org-indirect-dedicated-frame)
6871 (setq org-indirect-dedicated-frame (make-frame)))))
6872 (delete-other-windows)
6873 (org-pop-to-buffer-same-window ibuf)
6874 (org-set-frame-title (concat "Indirect: " heading)))
6875 ((eq org-indirect-buffer-display 'current-window)
6876 (org-pop-to-buffer-same-window ibuf))
6877 ((eq org-indirect-buffer-display 'other-window)
6878 (pop-to-buffer ibuf))
6879 (t (error "Invalid value")))
6880 (if (featurep 'xemacs)
6881 (save-excursion (org-mode) (turn-on-font-lock)))
6882 (narrow-to-region beg end)
6883 (show-all)
6884 (goto-char pos)
6885 (and (window-live-p cwin) (select-window cwin))))
6887 (defun org-get-indirect-buffer (&optional buffer)
6888 (setq buffer (or buffer (current-buffer)))
6889 (let ((n 1) (base (buffer-name buffer)) bname)
6890 (while (buffer-live-p
6891 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6892 (setq n (1+ n)))
6893 (condition-case nil
6894 (make-indirect-buffer buffer bname 'clone)
6895 (error (make-indirect-buffer buffer bname)))))
6897 (defun org-set-frame-title (title)
6898 "Set the title of the current frame to the string TITLE."
6899 ;; FIXME: how to name a single frame in XEmacs???
6900 (unless (featurep 'xemacs)
6901 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6903 ;;;; Structure editing
6905 ;;; Inserting headlines
6907 (defun org-previous-line-empty-p ()
6908 (save-excursion
6909 (and (not (bobp))
6910 (or (beginning-of-line 0) t)
6911 (save-match-data
6914 (defun org-insert-heading (&optional force-heading invisible-ok)
6915 "Insert a new heading or item with same depth at point.
6916 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6917 If point is at the beginning of a headline, insert a sibling before the
6918 current headline. If point is not at the beginning, split the line,
6919 create the new headline with the text in the current line after point
6920 \(but see also the variable `org-M-RET-may-split-line').
6922 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6923 This is important for non-interactive uses of the command."
6924 (interactive "P")
6925 (if (or (= (buffer-size) 0)
6926 (and (not (save-excursion
6927 (and (ignore-errors (org-back-to-heading invisible-ok))
6928 (org-on-heading-p))))
6929 (or force-heading (not (org-in-item-p)))))
6930 (progn
6932 (run-hooks 'org-insert-heading-hook))
6933 (when (or force-heading (not (org-insert-item)))
6934 (let* ((empty-line-p nil)
6935 (level nil)
6936 (on-heading (org-on-heading-p))
6937 (head (save-excursion
6938 (condition-case nil
6939 (progn
6940 (org-back-to-heading invisible-ok)
6941 (when (and (not on-heading)
6942 (featurep 'org-inlinetask)
6943 (integerp org-inlinetask-min-level)
6944 (>= (length (match-string 0))
6945 org-inlinetask-min-level))
6946 ;; Find a heading level before the inline task
6947 (while (and (setq level (org-up-heading-safe))
6948 (>= level org-inlinetask-min-level)))
6949 (if (org-on-heading-p)
6950 (org-back-to-heading invisible-ok)
6951 (error "This should not happen")))
6952 (setq empty-line-p (org-previous-line-empty-p))
6953 (match-string 0))
6954 (error "*"))))
6955 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6956 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6957 pos hide-previous previous-pos)
6958 (cond
6959 ((and (org-on-heading-p) (bolp)
6960 (or (bobp)
6961 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6962 ;; insert before the current line
6963 (open-line (if blank 2 1)))
6964 ((and (bolp)
6965 (not org-insert-heading-respect-content)
6966 (or (bobp)
6967 (save-excursion
6968 (backward-char 1) (not (outline-invisible-p)))))
6969 ;; insert right here
6970 nil)
6971 (t
6972 ;; somewhere in the line
6973 (save-excursion
6974 (setq previous-pos (point-at-bol))
6975 (end-of-line)
6976 (setq hide-previous (outline-invisible-p)))
6977 (and org-insert-heading-respect-content (org-show-subtree))
6978 (let ((split
6979 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6980 (save-excursion
6981 (let ((p (point)))
6982 (goto-char (point-at-bol))
6983 (and (looking-at org-complex-heading-regexp)
6984 (> p (match-beginning 4)))))))
6985 tags pos)
6986 (cond
6987 (org-insert-heading-respect-content
6988 (org-end-of-subtree nil t)
6989 (when (featurep 'org-inlinetask)
6990 (while (and (not (eobp))
6992 (>= (length (match-string 1))
6993 org-inlinetask-min-level))
6994 (org-end-of-subtree nil t)))
6995 (or (bolp) (newline))
6996 (or (org-previous-line-empty-p)
6997 (and blank (newline)))
6998 (open-line 1))
6999 ((org-on-heading-p)
7000 (when hide-previous
7001 (show-children)
7002 (org-show-entry))
7004 (setq tags (and (match-end 2) (match-string 2)))
7005 (and (match-end 1)
7006 (delete-region (match-beginning 1) (match-end 1)))
7007 (setq pos (point-at-bol))
7008 (or split (end-of-line 1))
7009 (delete-horizontal-space)
7011 (buffer-substring (point-at-bol) (point)))
7012 (insert " "))
7013 (newline (if blank 2 1))
7014 (when tags
7015 (save-excursion
7016 (goto-char pos)
7017 (end-of-line 1)
7018 (insert " " tags)
7019 (org-set-tags nil 'align))))
7020 (t
7021 (or split (end-of-line 1))
7022 (newline (if blank 2 1)))))))
7023 (insert head) (just-one-space)
7024 (setq pos (point))
7025 (end-of-line 1)
7026 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7027 (when (and org-insert-heading-respect-content hide-previous)
7028 (save-excursion
7029 (goto-char previous-pos)
7030 (hide-subtree)))
7031 (run-hooks 'org-insert-heading-hook)))))
7033 (defun org-get-heading (&optional no-tags no-todo)
7034 "Return the heading of the current entry, without the stars.
7035 When NO-TAGS is non-nil, don't include tags.
7036 When NO-TODO is non-nil, don't include TODO keywords."
7037 (save-excursion
7038 (org-back-to-heading t)
7039 (cond
7040 ((and no-tags no-todo)
7041 (looking-at org-complex-heading-regexp)
7042 (match-string 4))
7043 (no-tags
7045 (match-string 1))
7046 (no-todo
7049 (match-string 2))
7051 (match-string 1)))))
7053 (defun org-heading-components ()
7054 "Return the components of the current heading.
7055 This is a list with the following elements:
7056 - the level as an integer
7057 - the reduced level, different if `org-odd-levels-only' is set.
7058 - the TODO keyword, or nil
7059 - the priority character, like ?A, or nil if no priority is given
7060 - the headline text itself, or the tags string if no headline text
7061 - the tags string, or nil."
7062 (save-excursion
7063 (org-back-to-heading t)
7064 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7065 (list (length (match-string 1))
7066 (org-reduced-level (length (match-string 1)))
7067 (org-match-string-no-properties 2)
7068 (and (match-end 3) (aref (match-string 3) 2))
7069 (org-match-string-no-properties 4)
7070 (org-match-string-no-properties 5)))))
7072 (defun org-get-entry ()
7073 "Get the entry text, after heading, entire subtree."
7074 (save-excursion
7075 (org-back-to-heading t)
7076 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7078 (defun org-insert-heading-after-current ()
7079 "Insert a new heading with same level as current, after current subtree."
7080 (interactive)
7081 (org-back-to-heading)
7082 (org-insert-heading)
7083 (org-move-subtree-down)
7084 (end-of-line 1))
7086 (defun org-insert-heading-respect-content ()
7087 (interactive)
7088 (let ((org-insert-heading-respect-content t))
7089 (org-insert-heading t)))
7091 (defun org-insert-todo-heading-respect-content (&optional force-state)
7092 (interactive "P")
7093 (let ((org-insert-heading-respect-content t))
7094 (org-insert-todo-heading force-state t)))
7096 (defun org-insert-todo-heading (arg &optional force-heading)
7097 "Insert a new heading with the same level and TODO state as current heading.
7098 If the heading has no TODO state, or if the state is DONE, use the first
7099 state (TODO by default). Also with prefix arg, force first state."
7100 (interactive "P")
7101 (when (or force-heading (not (org-insert-item 'checkbox)))
7102 (org-insert-heading force-heading)
7103 (save-excursion
7104 (org-back-to-heading)
7105 (outline-previous-heading)
7106 (looking-at org-todo-line-regexp))
7107 (let*
7108 ((new-mark-x
7109 (if (or arg
7110 (not (match-beginning 2))
7111 (member (match-string 2) org-done-keywords))
7112 (car org-todo-keywords-1)
7113 (match-string 2)))
7114 (new-mark
7115 (or
7116 (run-hook-with-args-until-success
7117 'org-todo-get-default-hook new-mark-x nil)
7118 new-mark-x)))
7119 (beginning-of-line 1)
7120 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7121 (if org-treat-insert-todo-heading-as-state-change
7122 (org-todo new-mark)
7123 (insert new-mark " "))))
7124 (when org-provide-todo-statistics
7125 (org-update-parent-todo-statistics))))
7127 (defun org-insert-subheading (arg)
7128 "Insert a new subheading and demote it.
7129 Works for outline headings and for plain lists alike."
7130 (interactive "P")
7131 (org-insert-heading arg)
7132 (cond
7133 ((org-on-heading-p) (org-do-demote))
7134 ((org-at-item-p) (org-indent-item))))
7136 (defun org-insert-todo-subheading (arg)
7137 "Insert a new subheading with TODO keyword or checkbox and demote it.
7138 Works for outline headings and for plain lists alike."
7139 (interactive "P")
7140 (org-insert-todo-heading arg)
7141 (cond
7142 ((org-on-heading-p) (org-do-demote))
7143 ((org-at-item-p) (org-indent-item))))
7145 ;;; Promotion and Demotion
7147 (defvar org-after-demote-entry-hook nil
7148 "Hook run after an entry has been demoted.
7149 The cursor will be at the beginning of the entry.
7150 When a subtree is being demoted, the hook will be called for each node.")
7152 (defvar org-after-promote-entry-hook nil
7153 "Hook run after an entry has been promoted.
7154 The cursor will be at the beginning of the entry.
7155 When a subtree is being promoted, the hook will be called for each node.")
7157 (defun org-promote-subtree ()
7158 "Promote the entire subtree.
7159 See also `org-promote'."
7160 (interactive)
7161 (save-excursion
7162 (org-with-limited-levels (org-map-tree 'org-promote)))
7163 (org-fix-position-after-promote))
7165 (defun org-demote-subtree ()
7166 "Demote the entire subtree. See `org-demote'.
7167 See also `org-promote'."
7168 (interactive)
7169 (save-excursion
7170 (org-with-limited-levels (org-map-tree 'org-demote)))
7171 (org-fix-position-after-promote))
7174 (defun org-do-promote ()
7175 "Promote the current heading higher up the tree.
7176 If the region is active in `transient-mark-mode', promote all headings
7177 in the region."
7178 (interactive)
7179 (save-excursion
7180 (if (org-region-active-p)
7181 (org-map-region 'org-promote (region-beginning) (region-end))
7182 (org-promote)))
7183 (org-fix-position-after-promote))
7185 (defun org-do-demote ()
7186 "Demote the current heading lower down the tree.
7187 If the region is active in `transient-mark-mode', demote all headings
7188 in the region."
7189 (interactive)
7190 (save-excursion
7191 (if (org-region-active-p)
7192 (org-map-region 'org-demote (region-beginning) (region-end))
7193 (org-demote)))
7194 (org-fix-position-after-promote))
7196 (defun org-fix-position-after-promote ()
7197 "Make sure that after pro/demotion cursor position is right."
7198 (let ((pos (point)))
7199 (when (save-excursion
7200 (beginning-of-line 1)
7201 (looking-at org-todo-line-regexp)
7202 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7203 (cond ((eobp) (insert " "))
7204 ((eolp) (insert " "))
7205 ((equal (char-after) ?\ ) (forward-char 1))))))
7207 (defun org-current-level ()
7208 "Return the level of the current entry, or nil if before the first headline.
7209 The level is the number of stars at the beginning of the headline."
7210 (save-excursion
7211 (org-with-limited-levels
7212 (ignore-errors
7213 (org-back-to-heading t)
7214 (funcall outline-level)))))
7216 (defun org-get-previous-line-level ()
7217 "Return the outline depth of the last headline before the current line.
7218 Returns 0 for the first headline in the buffer, and nil if before the
7219 first headline."
7220 (let ((current-level (org-current-level))
7221 (prev-level (when (> (line-number-at-pos) 1)
7222 (save-excursion
7223 (beginning-of-line 0)
7224 (org-current-level)))))
7225 (cond ((null current-level) nil) ; Before first headline
7226 ((null prev-level) 0) ; At first headline
7227 (prev-level))))
7229 (defun org-reduced-level (l)
7230 "Compute the effective level of a heading.
7231 This takes into account the setting of `org-odd-levels-only'."
7232 (cond
7233 ((zerop l) 0)
7234 (org-odd-levels-only (1+ (floor (/ l 2))))
7235 (t l)))
7237 (defun org-level-increment ()
7238 "Return the number of stars that will be added or removed at a
7239 time to headlines when structure editing, based on the value of
7240 `org-odd-levels-only'."
7241 (if org-odd-levels-only 2 1))
7243 (defun org-get-valid-level (level &optional change)
7244 "Rectify a level change under the influence of `org-odd-levels-only'
7245 LEVEL is a current level, CHANGE is by how much the level should be
7246 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7247 even level numbers will become the next higher odd number."
7248 (if org-odd-levels-only
7249 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7250 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7251 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7252 (max 1 (+ level (or change 0)))))
7254 (if (boundp 'define-obsolete-function-alias)
7255 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7256 (define-obsolete-function-alias 'org-get-legal-level
7257 'org-get-valid-level)
7258 (define-obsolete-function-alias 'org-get-legal-level
7259 'org-get-valid-level "23.1")))
7261 (defun org-promote ()
7262 "Promote the current heading higher up the tree.
7263 If the region is active in `transient-mark-mode', promote all headings
7264 in the region."
7265 (org-back-to-heading t)
7266 (let* ((level (save-match-data (funcall outline-level)))
7267 (after-change-functions (remove 'flyspell-after-change-function
7268 after-change-functions))
7269 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7270 (diff (abs (- level (length up-head) -1))))
7271 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7272 (replace-match up-head nil t)
7273 ;; Fixup tag positioning
7274 (and org-auto-align-tags (org-set-tags nil t))
7275 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7276 (run-hooks 'org-after-promote-entry-hook)))
7278 (defun org-demote ()
7279 "Demote the current heading lower down the tree.
7280 If the region is active in `transient-mark-mode', demote all headings
7281 in the region."
7282 (org-back-to-heading t)
7283 (let* ((level (save-match-data (funcall outline-level)))
7284 (after-change-functions (remove 'flyspell-after-change-function
7285 after-change-functions))
7286 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7287 (diff (abs (- level (length down-head) -1))))
7288 (replace-match down-head nil t)
7289 ;; Fixup tag positioning
7290 (and org-auto-align-tags (org-set-tags nil t))
7291 (if org-adapt-indentation (org-fixup-indentation diff))
7292 (run-hooks 'org-after-demote-entry-hook)))
7294 (defun org-cycle-level ()
7295 "Cycle the level of an empty headline through possible states.
7296 This goes first to child, then to parent, level, then up the hierarchy.
7297 After top level, it switches back to sibling level."
7298 (interactive)
7299 (let ((org-adapt-indentation nil))
7300 (when (org-point-at-end-of-empty-headline)
7301 (setq this-command 'org-cycle-level) ; Only needed for caching
7302 (let ((cur-level (org-current-level))
7303 (prev-level (org-get-previous-line-level)))
7304 (cond
7305 ;; If first headline in file, promote to top-level.
7306 ((= prev-level 0)
7307 (loop repeat (/ (- cur-level 1) (org-level-increment))
7308 do (org-do-promote)))
7309 ;; If same level as prev, demote one.
7310 ((= prev-level cur-level)
7311 (org-do-demote))
7312 ;; If parent is top-level, promote to top level if not already.
7313 ((= prev-level 1)
7314 (loop repeat (/ (- cur-level 1) (org-level-increment))
7315 do (org-do-promote)))
7316 ;; If top-level, return to prev-level.
7317 ((= cur-level 1)
7318 (loop repeat (/ (- prev-level 1) (org-level-increment))
7319 do (org-do-demote)))
7320 ;; If less than prev-level, promote one.
7321 ((< cur-level prev-level)
7322 (org-do-promote))
7323 ;; If deeper than prev-level, promote until higher than
7324 ;; prev-level.
7325 ((> cur-level prev-level)
7326 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7327 do (org-do-promote))))
7328 t))))
7330 (defun org-map-tree (fun)
7331 "Call FUN for every heading underneath the current one."
7332 (org-back-to-heading)
7333 (let ((level (funcall outline-level)))
7334 (save-excursion
7335 (funcall fun)
7336 (while (and (progn
7337 (outline-next-heading)
7338 (> (funcall outline-level) level))
7339 (not (eobp)))
7340 (funcall fun)))))
7342 (defun org-map-region (fun beg end)
7343 "Call FUN for every heading between BEG and END."
7344 (let ((org-ignore-region t))
7345 (save-excursion
7346 (setq end (copy-marker end))
7347 (goto-char beg)
7348 (if (and (re-search-forward org-outline-regexp-bol nil t)
7349 (< (point) end))
7350 (funcall fun))
7351 (while (and (progn
7352 (outline-next-heading)
7353 (< (point) end))
7354 (not (eobp)))
7355 (funcall fun)))))
7357 (defun org-fixup-indentation (diff)
7358 "Change the indentation in the current entry by DIFF.
7359 However, if any line in the current entry has no indentation, or if it
7360 would end up with no indentation after the change, nothing at all is done."
7361 (save-excursion
7362 (let ((end (save-excursion (outline-next-heading)
7363 (point-marker)))
7364 (prohibit (if (> diff 0)
7367 col)
7368 (unless (save-excursion (end-of-line 1)
7369 (re-search-forward prohibit end t))
7370 (while (and (< (point) end)
7372 (goto-char (match-end 0))
7373 (setq col (current-column))
7374 (if (< diff 0) (replace-match ""))
7375 (org-indent-to-column (+ diff col))))
7376 (move-marker end nil))))
7378 (defun org-convert-to-odd-levels ()
7379 "Convert an org-mode file with all levels allowed to one with odd levels.
7380 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7381 level 5 etc."
7382 (interactive)
7383 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7384 (let ((outline-level 'org-outline-level)
7385 (org-odd-levels-only nil) n)
7386 (save-excursion
7387 (goto-char (point-min))
7389 (setq n (- (length (match-string 0)) 2))
7390 (while (>= (setq n (1- n)) 0)
7391 (org-demote))
7392 (end-of-line 1))))))
7394 (defun org-convert-to-oddeven-levels ()
7395 "Convert an org-mode file with only odd levels to one with odd/even levels.
7396 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7397 file contains a section with an even level, conversion would
7398 destroy the structure of the file. An error is signaled in this
7399 case."
7400 (interactive)
7401 (goto-char (point-min))
7402 ;; First check if there are no even levels
7404 (org-show-context t)
7405 (error "Not all levels are odd in this file. Conversion not possible"))
7406 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7407 (let ((outline-regexp org-outline-regexp)
7408 (outline-level 'org-outline-level)
7409 (org-odd-levels-only nil) n)
7410 (save-excursion
7411 (goto-char (point-min))
7413 (setq n (/ (1- (length (match-string 0))) 2))
7414 (while (>= (setq n (1- n)) 0)
7415 (org-promote))
7416 (end-of-line 1))))))
7418 (defun org-tr-level (n)
7419 "Make N odd if required."
7420 (if org-odd-levels-only (1+ (/ n 2)) n))
7422 ;;; Vertical tree motion, cutting and pasting of subtrees
7424 (defun org-move-subtree-up (&optional arg)
7425 "Move the current subtree up past ARG headlines of the same level."
7426 (interactive "p")
7427 (org-move-subtree-down (- (prefix-numeric-value arg))))
7429 (defun org-move-subtree-down (&optional arg)
7430 "Move the current subtree down past ARG headlines of the same level."
7431 (interactive "p")
7432 (setq arg (prefix-numeric-value arg))
7433 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7434 'org-get-last-sibling))
7435 (ins-point (make-marker))
7436 (cnt (abs arg))
7437 (col (current-column))
7438 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7439 ;; Select the tree
7440 (org-back-to-heading)
7441 (setq beg0 (point))
7442 (save-excursion
7443 (setq ne-beg (org-back-over-empty-lines))
7444 (setq beg (point)))
7445 (save-match-data
7446 (save-excursion (outline-end-of-heading)
7447 (setq folded (outline-invisible-p)))
7448 (outline-end-of-subtree))
7449 (outline-next-heading)
7450 (setq ne-end (org-back-over-empty-lines))
7451 (setq end (point))
7452 (goto-char beg0)
7453 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7454 ;; include less whitespace
7455 (save-excursion
7456 (goto-char beg)
7457 (forward-line (- ne-beg ne-end))
7458 (setq beg (point))))
7459 ;; Find insertion point, with error handling
7460 (while (> cnt 0)
7461 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7462 (progn (goto-char beg0)
7463 (error "Cannot move past superior level or buffer limit")))
7464 (setq cnt (1- cnt)))
7465 (if (> arg 0)
7466 ;; Moving forward - still need to move over subtree
7467 (progn (org-end-of-subtree t t)
7468 (save-excursion
7469 (org-back-over-empty-lines)
7470 (or (bolp) (newline)))))
7471 (setq ne-ins (org-back-over-empty-lines))
7472 (move-marker ins-point (point))
7473 (setq txt (buffer-substring beg end))
7474 (org-save-markers-in-region beg end)
7475 (delete-region beg end)
7476 (org-remove-empty-overlays-at beg)
7477 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7478 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7480 (let ((bbb (point)))
7481 (insert-before-markers txt)
7482 (org-reinstall-markers-in-region bbb)
7483 (move-marker ins-point bbb))
7485 (setq ins-end (point))
7486 (goto-char ins-point)
7487 (org-skip-whitespace)
7488 (when (and (< arg 0)
7489 (org-first-sibling-p)
7490 (> ne-ins ne-beg))
7491 ;; Move whitespace back to beginning
7492 (save-excursion
7493 (goto-char ins-end)
7494 (let ((kill-whole-line t))
7495 (kill-line (- ne-ins ne-beg)) (point)))
7497 (move-marker ins-point nil)
7498 (if folded
7499 (hide-subtree)
7500 (org-show-entry)
7501 (show-children)
7502 (org-cycle-hide-drawers 'children))
7503 (org-clean-visibility-after-subtree-move)
7504 ;; move back to the initial column we were at
7505 (move-to-column col)))
7507 (defvar org-subtree-clip ""
7508 "Clipboard for cut and paste of subtrees.
7509 This is actually only a copy of the kill, because we use the normal kill
7510 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7512 (defvar org-subtree-clip-folded nil
7513 "Was the last copied subtree folded?
7514 This is used to fold the tree back after pasting.")
7516 (defun org-cut-subtree (&optional n)
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 cutting it."
7520 (interactive "p")
7521 (org-copy-subtree n 'cut))
7523 (defun org-copy-subtree (&optional n cut force-store-markers)
7524 "Cut the current subtree into the clipboard.
7525 With prefix arg N, cut this many sequential subtrees.
7526 This is a short-hand for marking the subtree and then copying it.
7527 If CUT is non-nil, actually cut the subtree.
7528 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7529 of some markers in the region, even if CUT is non-nil. This is
7530 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7531 (interactive "p")
7532 (let (beg end folded (beg0 (point)))
7533 (if (org-called-interactively-p 'any)
7534 (org-back-to-heading nil) ; take what looks like a subtree
7535 (org-back-to-heading t)) ; take what is really there
7536 (org-back-over-empty-lines)
7537 (setq beg (point))
7539 (save-match-data
7540 (save-excursion (outline-end-of-heading)
7541 (setq folded (outline-invisible-p)))
7542 (condition-case nil
7543 (org-forward-same-level (1- n) t)
7544 (error nil))
7545 (org-end-of-subtree t t))
7546 (org-back-over-empty-lines)
7547 (setq end (point))
7548 (goto-char beg0)
7549 (when (> end beg)
7550 (setq org-subtree-clip-folded folded)
7551 (when (or cut force-store-markers)
7552 (org-save-markers-in-region beg end))
7553 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7554 (setq org-subtree-clip (current-kill 0))
7555 (message "%s: Subtree(s) with %d characters"
7556 (if cut "Cut" "Copied")
7557 (length org-subtree-clip)))))
7559 (defun org-paste-subtree (&optional level tree for-yank)
7560 "Paste the clipboard as a subtree, with modification of headline level.
7561 The entire subtree is promoted or demoted in order to match a new headline
7562 level.
7564 If the cursor is at the beginning of a headline, the same level as
7565 that headline is used to paste the tree
7567 If not, the new level is derived from the *visible* headings
7568 before and after the insertion point, and taken to be the inferior headline
7569 level of the two. So if the previous visible heading is level 3 and the
7570 next is level 4 (or vice versa), level 4 will be used for insertion.
7571 This makes sure that the subtree remains an independent subtree and does
7572 not swallow low level entries.
7574 You can also force a different level, either by using a numeric prefix
7575 argument, or by inserting the heading marker by hand. For example, if the
7578 If optional TREE is given, use this text instead of the kill ring.
7580 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7581 move back over whitespace before inserting, and move point to the end of
7582 the inserted text when done."
7583 (interactive "P")
7584 (setq tree (or tree (and kill-ring (current-kill 0))))
7585 (unless (org-kill-is-subtree-p tree)
7586 (error "%s"
7587 (substitute-command-keys
7589 (org-with-limited-levels
7590 (let* ((visp (not (outline-invisible-p)))
7591 (txt tree)
7593 (old-level (if (string-match org-outline-regexp-bol txt)
7594 (- (match-end 0) (match-beginning 0) 1)
7595 -1))
7596 (force-level (cond (level (prefix-numeric-value level))
7598 (string-match
7600 (point-at-bol) (point))))
7601 (- (match-end 1) (match-beginning 1)))
7602 ((and (bolp)
7603 (looking-at org-outline-regexp))
7604 (- (match-end 0) (point) 1))
7605 (t nil)))
7606 (previous-level (save-excursion
7607 (condition-case nil
7608 (progn
7609 (outline-previous-visible-heading 1)
7610 (if (looking-at ^re_)
7611 (- (match-end 0) (match-beginning 0) 1)
7612 1))
7613 (error 1))))
7614 (next-level (save-excursion
7615 (condition-case nil
7616 (progn
7617 (or (looking-at org-outline-regexp)
7618 (outline-next-visible-heading 1))
7619 (if (looking-at ^re_)
7620 (- (match-end 0) (match-beginning 0) 1)
7621 1))
7622 (error 1))))
7623 (new-level (or force-level (max previous-level next-level)))
7624 (shift (if (or (= old-level -1)
7625 (= new-level -1)
7626 (= old-level new-level))
7627 0
7628 (- new-level old-level)))
7629 (delta (if (> shift 0) -1 1))
7630 (func (if (> shift 0) 'org-demote 'org-promote))
7631 (org-odd-levels-only nil)
7632 beg end newend)
7633 ;; Remove the forced level indicator
7634 (if force-level
7635 (delete-region (point-at-bol) (point)))
7636 ;; Paste
7637 (beginning-of-line (if (bolp) 1 2))
7638 (unless for-yank (org-back-over-empty-lines))
7639 (setq beg (point))
7640 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7641 (insert-before-markers txt)
7643 (setq newend (point))
7644 (org-reinstall-markers-in-region beg)
7645 (setq end (point))
7646 (goto-char beg)
7648 (setq beg (point))
7649 (if (and (outline-invisible-p) visp)
7650 (save-excursion (outline-show-heading)))
7651 ;; Shift if necessary
7652 (unless (= shift 0)
7653 (save-restriction
7654 (narrow-to-region beg end)
7655 (while (not (= shift 0))
7656 (org-map-region func (point-min) (point-max))
7657 (setq shift (+ delta shift)))
7658 (goto-char (point-min))
7659 (setq newend (point-max))))
7660 (when (or (org-called-interactively-p 'interactive) for-yank)
7661 (message "Clipboard pasted as level %d subtree" new-level))
7662 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7663 kill-ring
7664 (eq org-subtree-clip (current-kill 0))
7665 org-subtree-clip-folded)
7666 ;; The tree was folded before it was killed/copied
7667 (hide-subtree))
7668 (and for-yank (goto-char newend)))))
7670 (defun org-kill-is-subtree-p (&optional txt)
7671 "Check if the current kill is an outline subtree, or a set of trees.
7672 Returns nil if kill does not start with a headline, or if the first
7673 headline level is not the largest headline level in the tree.
7674 So this will actually accept several entries of equal levels as well,
7675 which is OK for `org-paste-subtree'.
7676 If optional TXT is given, check this string instead of the current kill."
7677 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7678 (re (org-get-limited-outline-regexp))
7679 (^re (concat "^" re))
7680 (start-level (and kill
7681 (string-match
7683 kill)
7684 (- (match-end 2) (match-beginning 2) 1)))
7685 (start (1+ (or (match-beginning 2) -1))))
7686 (if (not start-level)
7687 (progn
7688 nil) ;; does not even start with a heading
7689 (catch 'exit
7690 (while (setq start (string-match ^re kill (1+ start)))
7691 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7692 (throw 'exit nil)))
7693 t))))
7695 (defvar org-markers-to-move nil
7696 "Markers that should be moved with a cut-and-paste operation.
7697 Those markers are stored together with their positions relative to
7698 the start of the region.")
7700 (defun org-save-markers-in-region (beg end)
7701 "Check markers in region.
7702 If these markers are between BEG and END, record their position relative
7703 to BEG, so that after moving the block of text, we can put the markers back
7704 into place.
7705 This function gets called just before an entry or tree gets cut from the
7706 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7707 called immediately, to move the markers with the entries."
7708 (setq org-markers-to-move nil)
7709 (when (featurep 'org-clock)
7710 (org-clock-save-markers-for-cut-and-paste beg end))
7711 (when (featurep 'org-agenda)
7712 (org-agenda-save-markers-for-cut-and-paste beg end)))
7714 (defun org-check-and-save-marker (marker beg end)
7715 "Check if MARKER is between BEG and END.
7716 If yes, remember the marker and the distance to BEG."
7717 (when (and (marker-buffer marker)
7718 (equal (marker-buffer marker) (current-buffer)))
7719 (if (and (>= marker beg) (< marker end))
7720 (push (cons marker (- marker beg)) org-markers-to-move))))
7722 (defun org-reinstall-markers-in-region (beg)
7723 "Move all remembered markers to their position relative to BEG."
7724 (mapc (lambda (x)
7725 (move-marker (car x) (+ beg (cdr x))))
7726 org-markers-to-move)
7727 (setq org-markers-to-move nil))
7729 (defun org-narrow-to-subtree ()
7730 "Narrow buffer to the current subtree."
7731 (interactive)
7732 (save-excursion
7733 (save-match-data
7734 (org-with-limited-levels
7735 (narrow-to-region
7736 (progn (org-back-to-heading t) (point))
7737 (progn (org-end-of-subtree t t)
7738 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7739 (point)))))))
7741 (defun org-narrow-to-block ()
7742 "Narrow buffer to the current block."
7743 (interactive)
7744 (let* ((case-fold-search t)
7747 (if blockp
7748 (narrow-to-region (car blockp) (cdr blockp))
7749 (error "Not in a block"))))
7751 (eval-when-compile
7752 (defvar org-property-drawer-re))
7754 (defvar org-property-start-re) ;; defined below
7755 (defun org-clone-subtree-with-time-shift (n &optional shift)
7756 "Clone the task (subtree) at point N times.
7757 The clones will be inserted as siblings.
7759 In interactive use, the user will be prompted for the number of
7760 clones to be produced, and for a time SHIFT, which may be a
7761 repeater as used in time stamps, for example `+3d'.
7763 When a valid repeater is given and the entry contains any time
7764 stamps, the clones will become a sequence in time, with time
7765 stamps in the subtree shifted for each clone produced. If SHIFT
7766 is nil or the empty string, time stamps will be left alone. The
7767 ID property of the original subtree is removed.
7769 If the original subtree did contain time stamps with a repeater,
7770 the following will happen:
7771 - the repeater will be removed in each clone
7772 - an additional clone will be produced, with the current, unshifted
7773 date(s) in the entry.
7774 - the original entry will be placed *after* all the clones, with
7775 repeater intact.
7776 - the start days in the repeater in the original entry will be shifted
7777 to past the last clone.
7778 I this way you can spell out a number of instances of a repeating task,
7779 and still retain the repeater to cover future instances of the task."
7780 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7781 (let (beg end template task idprop
7782 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7783 (if (not (and (integerp n) (> n 0)))
7784 (error "Invalid number of replications %s" n))
7787 shift)))
7788 (error "Invalid shift specification %s" shift))
7789 (when doshift
7790 (setq shift-n (string-to-number (match-string 1 shift))
7791 shift-what (cdr (assoc (match-string 2 shift)
7792 '(("d" . day) ("w" . week)
7793 ("m" . month) ("y" . year))))))
7794 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7795 (setq nmin 1 nmax n)
7796 (org-back-to-heading t)
7797 (setq beg (point))
7798 (setq idprop (org-entry-get nil "ID"))
7799 (org-end-of-subtree t t)
7801 (setq end (point))
7802 (setq template (buffer-substring beg end))
7803 ;; Remove clocks and empty drawers
7804 (with-temp-buffer
7805 (insert template)
7806 (goto-char (point-min))
7807 (while (re-search-forward
7809 (replace-match "")
7810 (kill-whole-line))
7811 (goto-char (point-min))
7812 (while (re-search-forward
7814 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7815 (setq template (buffer-substring (point-min) (point-max))))
7816 (when (and doshift
7818 (delete-region beg end)
7819 (setq end beg)
7820 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7821 (goto-char end)
7822 (loop for n from nmin to nmax do
7823 ;; prepare clone
7824 (with-temp-buffer
7825 (insert template)
7826 (org-mode)
7827 (goto-char (point-min))
7828 (and idprop (if org-clone-delete-id
7829 (org-entry-delete nil "ID")
7830 (org-id-get-create t)))
7831 (while (re-search-forward org-property-start-re nil t)
7832 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7833 (goto-char (point-min))
7834 (when doshift
7835 (while (re-search-forward org-ts-regexp-both nil t)
7836 (org-timestamp-change (* n shift-n) shift-what))
7837 (unless (= n n-no-remove)
7838 (goto-char (point-min))
7839 (while (re-search-forward org-ts-regexp nil t)
7840 (save-excursion
7841 (goto-char (match-beginning 0))
7843 (delete-region (match-beginning 1) (match-end 1)))))))
7844 (setq task (buffer-string)))
7845 (insert task))
7846 (goto-char beg)))
7848 ;;; Outline Sorting
7850 (defun org-sort (with-case)
7851 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7852 Optional argument WITH-CASE means sort case-sensitively.
7853 With a double prefix argument, also remove duplicate entries."
7854 (interactive "P")
7855 (cond
7856 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7857 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7858 (t
7859 (org-call-with-arg 'org-sort-entries with-case))))
7861 (defun org-sort-remove-invisible (s)
7862 (remove-text-properties 0 (length s) org-rm-props s)
7863 (while (string-match org-bracket-link-regexp s)
7864 (setq s (replace-match (if (match-end 2)
7865 (match-string 3 s)
7866 (match-string 1 s)) t t s)))
7867 s)
7869 (defvar org-priority-regexp) ; defined later in the file
7871 (defvar org-after-sorting-entries-or-items-hook nil
7872 "Hook that is run after a bunch of entries or items have been sorted.
7873 When children are sorted, the cursor is in the parent line when this
7874 hook gets called. When a region or a plain list is sorted, the cursor
7875 will be in the first entry of the sorted region/list.")
7877 (defun org-sort-entries
7878 (&optional with-case sorting-type getkey-func compare-func property)
7879 "Sort entries on a certain level of an outline tree.
7880 If there is an active region, the entries in the region are sorted.
7881 Else, if the cursor is before the first entry, sort the top-level items.
7882 Else, the children of the entry at point are sorted.
7884 Sorting can be alphabetically, numerically, by date/time as given by
7885 a time stamp, by a property or by priority.
7887 The command prompts for the sorting type unless it has been given to the
7888 function through the SORTING-TYPE argument, which needs to be a character,
7889 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7890 precise meaning of each character:
7892 n Numerically, by converting the beginning of the entry/item to a number.
7893 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7894 t By date/time, either the first active time stamp in the entry, or, if
7895 none exist, by the first inactive one.
7896 s By the scheduled date/time.
7897 d By deadline date/time.
7898 c By creation time, which is assumed to be the first inactive time stamp
7899 at the beginning of a line.
7900 p By priority according to the cookie.
7901 r By the value of a property.
7903 Capital letters will reverse the sort order.
7905 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7906 called with point at the beginning of the record. It must return either
7907 a string or a number that should serve as the sorting key for that record.
7909 Comparing entries ignores case by default. However, with an optional argument
7910 WITH-CASE, the sorting considers case as well."
7911 (interactive "P")
7912 (let ((case-func (if with-case 'identity 'downcase))
7913 start beg end stars re re2
7914 txt what tmp)
7915 ;; Find beginning and end of region to sort
7916 (cond
7917 ((org-region-active-p)
7918 ;; we will sort the region
7919 (setq end (region-end)
7920 what "region")
7921 (goto-char (region-beginning))
7922 (if (not (org-on-heading-p)) (outline-next-heading))
7923 (setq start (point)))
7924 ((or (org-on-heading-p)
7925 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7926 ;; we will sort the children of the current headline
7927 (org-back-to-heading)
7928 (setq start (point)
7929 end (progn (org-end-of-subtree t t)
7931 (org-back-over-empty-lines)
7932 (point))
7933 what "children")
7934 (goto-char start)
7935 (show-subtree)
7936 (outline-next-heading))
7937 (t
7938 ;; we will sort the top-level entries in this file
7939 (goto-char (point-min))
7940 (or (org-on-heading-p) (outline-next-heading))
7941 (setq start (point))
7942 (goto-char (point-max))
7943 (beginning-of-line 1)
7945 ;; File ends in a non-white line
7946 (end-of-line 1)
7948 (setq end (point-max))
7949 (setq what "top-level")
7950 (goto-char start)
7951 (show-all)))
7953 (setq beg (point))
7954 (if (>= beg end) (error "Nothing to sort"))
7957 (setq stars (match-string 1)
7958 re (concat "^" (regexp-quote stars) " +")
7960 txt (buffer-substring beg end))
7962 (if (and (not (equal stars "*")) (string-match re2 txt))
7963 (error "Region to sort contains a level above the first entry"))
7965 (unless sorting-type
7966 (message
7967 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7969 A/N/T/S/D/C/P/O/F means reversed:"
7970 what)
7971 (setq sorting-type (read-char-exclusive))
7973 (and (= (downcase sorting-type) ?f)
7974 (setq getkey-func
7975 (org-icompleting-read "Sort using function: "
7976 obarray 'fboundp t nil nil))
7977 (setq getkey-func (intern getkey-func)))
7979 (and (= (downcase sorting-type) ?r)
7980 (setq property
7981 (org-icompleting-read "Property: "
7982 (mapcar 'list (org-buffer-property-keys t))
7983 nil t))))
7985 (message "Sorting entries...")
7987 (save-restriction
7988 (narrow-to-region start end)
7989 (let ((dcst (downcase sorting-type))
7990 (case-fold-search nil)
7991 (now (current-time)))
7992 (sort-subr
7993 (/= dcst sorting-type)
7994 ;; This function moves to the beginning character of the "record" to
7995 ;; be sorted.
7996 (lambda nil
7997 (if (re-search-forward re nil t)
7998 (goto-char (match-beginning 0))
7999 (goto-char (point-max))))
8000 ;; This function moves to the last character of the "record" being
8001 ;; sorted.
8002 (lambda nil
8003 (save-match-data
8004 (condition-case nil
8005 (outline-forward-same-level 1)
8006 (error
8007 (goto-char (point-max))))))
8008 ;; This function returns the value that gets sorted against.
8009 (lambda nil
8010 (cond
8011 ((= dcst ?n)
8012 (if (looking-at org-complex-heading-regexp)
8013 (string-to-number (match-string 4))
8014 nil))
8015 ((= dcst ?a)
8016 (if (looking-at org-complex-heading-regexp)
8017 (funcall case-func (match-string 4))
8018 nil))
8019 ((= dcst ?t)
8020 (let ((end (save-excursion (outline-next-heading) (point))))
8021 (if (or (re-search-forward org-ts-regexp end t)
8022 (re-search-forward org-ts-regexp-both end t))
8023 (org-time-string-to-seconds (match-string 0))
8024 (org-float-time now))))
8025 ((= dcst ?c)
8026 (let ((end (save-excursion (outline-next-heading) (point))))
8027 (if (re-search-forward
8029 end t)
8030 (org-time-string-to-seconds (match-string 0))
8031 (org-float-time now))))
8032 ((= dcst ?s)
8033 (let ((end (save-excursion (outline-next-heading) (point))))
8034 (if (re-search-forward org-scheduled-time-regexp end t)
8035 (org-time-string-to-seconds (match-string 1))
8036 (org-float-time now))))
8037 ((= dcst ?d)
8038 (let ((end (save-excursion (outline-next-heading) (point))))
8039 (if (re-search-forward org-deadline-time-regexp end t)
8040 (org-time-string-to-seconds (match-string 1))
8041 (org-float-time now))))
8042 ((= dcst ?p)
8043 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8044 (string-to-char (match-string 2))
8045 org-default-priority))
8046 ((= dcst ?r)
8047 (or (org-entry-get nil property) ""))
8048 ((= dcst ?o)
8049 (if (looking-at org-complex-heading-regexp)
8050 (- 9999 (length (member (match-string 2)
8051 org-todo-keywords-1)))))
8052 ((= dcst ?f)
8053 (if getkey-func
8054 (progn
8055 (setq tmp (funcall getkey-func))
8056 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8057 tmp)
8058 (error "Invalid key function `%s'" getkey-func)))
8059 (t (error "Invalid sorting type `%c'" sorting-type))))
8060 nil
8061 (cond
8062 ((= dcst ?a) 'string<)
8063 ((= dcst ?f) compare-func)
8064 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8065 (t nil)))))
8066 (run-hooks 'org-after-sorting-entries-or-items-hook)
8067 (message "Sorting entries...done")))
8069 (defun org-do-sort (table what &optional with-case sorting-type)
8070 "Sort TABLE of WHAT according to SORTING-TYPE.
8071 The user will be prompted for the SORTING-TYPE if the call to this
8072 function does not specify it. WHAT is only for the prompt, to indicate
8073 what is being sorted. The sorting key will be extracted from
8074 the car of the elements of the table.
8075 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8076 (unless sorting-type
8077 (message
8078 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8079 what)
8080 (setq sorting-type (read-char-exclusive)))
8081 (let ((dcst (downcase sorting-type))
8082 extractfun comparefun)
8083 ;; Define the appropriate functions
8084 (cond
8085 ((= dcst ?n)
8086 (setq extractfun 'string-to-number
8087 comparefun (if (= dcst sorting-type) '< '>)))
8088 ((= dcst ?a)
8089 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8090 (lambda(x) (downcase (org-sort-remove-invisible x))))
8091 comparefun (if (= dcst sorting-type)
8092 'string<
8093 (lambda (a b) (and (not (string< a b))
8094 (not (string= a b)))))))
8095 ((= dcst ?t)
8096 (setq extractfun
8097 (lambda (x)
8098 (if (or (string-match org-ts-regexp x)
8099 (string-match org-ts-regexp-both x))
8100 (org-float-time
8101 (org-time-string-to-time (match-string 0 x)))
8102 0))
8103 comparefun (if (= dcst sorting-type) '< '>)))
8104 (t (error "Invalid sorting type `%c'" sorting-type)))
8106 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8107 table)
8108 (lambda (a b) (funcall comparefun (car a) (car b))))))
8111 ;;; The orgstruct minor mode
8113 ;; Define a minor mode which can be used in other modes in order to
8114 ;; integrate the org-mode structure editing commands.
8116 ;; This is really a hack, because the org-mode structure commands use
8117 ;; keys which normally belong to the major mode. Here is how it
8118 ;; works: The minor mode defines all the keys necessary to operate the
8119 ;; structure commands, but wraps the commands into a function which
8120 ;; tests if the cursor is currently at a headline or a plain list
8121 ;; item. If that is the case, the structure command is used,
8122 ;; temporarily setting many Org-mode variables like regular
8123 ;; expressions for filling etc. However, when any of those keys is
8124 ;; used at a different location, function uses `key-binding' to look
8125 ;; up if the key has an associated command in another currently active
8126 ;; keymap (minor modes, major mode, global), and executes that
8127 ;; command. There might be problems if any of the keys is otherwise
8128 ;; used as a prefix key.
8130 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8131 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8132 ;; addresses this by checking explicitly for both bindings.
8134 (defvar orgstruct-mode-map (make-sparse-keymap)
8135 "Keymap for the minor `orgstruct-mode'.")
8137 (defvar org-local-vars nil
8138 "List of local variables, for use by `orgstruct-mode'.")
8140 ;;;###autoload
8141 (define-minor-mode orgstruct-mode
8142 "Toggle the minor mode `orgstruct-mode'.
8143 This mode is for using Org-mode structure commands in other
8144 modes. The following keys behave as if Org-mode were active, if
8145 the cursor is on a headline, or on a plain list item (both as
8146 defined by Org-mode).
8148 M-up Move entry/item up
8149 M-down Move entry/item down
8150 M-left Promote
8151 M-right Demote
8152 M-S-up Move entry/item up
8153 M-S-down Move entry/item down
8154 M-S-left Promote subtree
8155 M-S-right Demote subtree
8156 M-q Fill paragraph and items like in Org-mode
8157 C-c ^ Sort entries
8158 C-c - Cycle list bullet
8159 TAB Cycle item visibility
8160 M-RET Insert new heading/item
8161 S-M-RET Insert new TODO heading / Checkbox item
8162 C-c C-c Set tags / toggle checkbox"
8163 nil " OrgStruct" nil
8164 (org-load-modules-maybe)
8165 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8167 ;;;###autoload
8168 (defun turn-on-orgstruct ()
8169 "Unconditionally turn on `orgstruct-mode'."
8170 (orgstruct-mode 1))
8172 (defun orgstruct++-mode (&optional arg)
8173 "Toggle `orgstruct-mode', the enhanced version of it.
8174 In addition to setting orgstruct-mode, this also exports all indentation
8175 and autofilling variables from org-mode into the buffer. It will also
8176 recognize item context in multiline items.
8177 Note that turning off orgstruct-mode will *not* remove the
8178 indentation/paragraph settings. This can only be done by refreshing the
8180 (interactive "P")
8181 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8182 (if (< arg 1)
8183 (orgstruct-mode -1)
8184 (orgstruct-mode 1)
8185 (let (var val)
8186 (mapc
8187 (lambda (x)
8188 (when (string-match
8190 (symbol-name (car x)))
8191 (setq var (car x) val (nth 1 x))
8192 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8193 org-local-vars)
8194 (org-set-local 'orgstruct-is-++ t))))
8196 (defvar orgstruct-is-++ nil
8197 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8198 (make-variable-buffer-local 'orgstruct-is-++)
8200 ;;;###autoload
8201 (defun turn-on-orgstruct++ ()
8202 "Unconditionally turn on `orgstruct++-mode'."
8203 (orgstruct++-mode 1))
8205 (defun orgstruct-error ()
8206 "Error when there is no default binding for a structure key."
8207 (interactive)
8208 (error "This key has no function outside structure elements"))
8210 (defun orgstruct-setup ()
8211 "Setup orgstruct keymaps."
8212 (let ((nfunc 0)
8213 (bindings
8214 (list
8215 '([(meta up)] org-metaup)
8216 '([(meta down)] org-metadown)
8217 '([(meta left)] org-metaleft)
8218 '([(meta right)] org-metaright)
8219 '([(meta shift up)] org-shiftmetaup)
8220 '([(meta shift down)] org-shiftmetadown)
8221 '([(meta shift left)] org-shiftmetaleft)
8222 '([(meta shift right)] org-shiftmetaright)
8223 '([?\e (up)] org-metaup)
8224 '([?\e (down)] org-metadown)
8225 '([?\e (left)] org-metaleft)
8226 '([?\e (right)] org-metaright)
8227 '([?\e (shift up)] org-shiftmetaup)
8228 '([?\e (shift down)] org-shiftmetadown)
8229 '([?\e (shift left)] org-shiftmetaleft)
8230 '([?\e (shift right)] org-shiftmetaright)
8231 '([(shift up)] org-shiftup)
8232 '([(shift down)] org-shiftdown)
8233 '([(shift left)] org-shiftleft)
8234 '([(shift right)] org-shiftright)
8235 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8236 '("\M-q" fill-paragraph)
8237 '("\C-c^" org-sort)
8238 '("\C-c-" org-cycle-list-bullet)))
8239 elt key fun cmd)
8240 (while (setq elt (pop bindings))
8241 (setq nfunc (1+ nfunc))
8242 (setq key (org-key (car elt))
8243 fun (nth 1 elt)
8244 cmd (orgstruct-make-binding fun nfunc key))
8245 (org-defkey orgstruct-mode-map key cmd))
8247 ;; Special treatment needed for TAB and RET
8248 (org-defkey orgstruct-mode-map [(tab)]
8249 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8250 (org-defkey orgstruct-mode-map "\C-i"
8251 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8253 (org-defkey orgstruct-mode-map "\M-\C-m"
8254 (orgstruct-make-binding 'org-insert-heading 105
8255 "\M-\C-m" [(meta return)]))
8256 (org-defkey orgstruct-mode-map [(meta return)]
8257 (orgstruct-make-binding 'org-insert-heading 106
8258 [(meta return)] "\M-\C-m"))
8260 (org-defkey orgstruct-mode-map [(shift meta return)]
8261 (orgstruct-make-binding 'org-insert-todo-heading 107
8262 [(meta return)] "\M-\C-m"))
8264 (org-defkey orgstruct-mode-map "\e\C-m"
8265 (orgstruct-make-binding 'org-insert-heading 108
8266 "\e\C-m" [?\e (return)]))
8267 (org-defkey orgstruct-mode-map [?\e (return)]
8268 (orgstruct-make-binding 'org-insert-heading 109
8269 [?\e (return)] "\e\C-m"))
8270 (org-defkey orgstruct-mode-map [?\e (shift return)]
8271 (orgstruct-make-binding 'org-insert-todo-heading 110
8272 [?\e (return)] "\e\C-m"))
8274 (unless org-local-vars
8275 (setq org-local-vars (org-get-local-variables)))
8277 t))
8279 (defun orgstruct-make-binding (fun n &rest keys)
8280 "Create a function for binding in the structure minor mode.
8281 FUN is the command to call inside a table. N is used to create a unique
8282 command name. KEYS are keys that should be checked in for a command
8283 to execute outside of tables."
8284 (eval
8285 (list 'defun
8286 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8287 '(arg)
8289 "Outside of structure, run the binding of `"
8290 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8291 "'.")
8292 '(interactive "p")
8293 (list 'if
8294 `(org-context-p 'headline 'item
8295 (and orgstruct-is-++
8296 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8297 'item-body))
8298 (list 'org-run-like-in-org-mode (list 'quote fun))
8299 (list 'let '(orgstruct-mode)
8300 (list 'call-interactively
8301 (append '(or)
8302 (mapcar (lambda (k)
8303 (list 'key-binding k))
8304 keys)
8305 '('orgstruct-error))))))))
8307 (defun org-context-p (&rest contexts)
8308 "Check if local context is any of CONTEXTS.
8309 Possible values in the list of contexts are `table', `headline', and `item'."
8310 (let ((pos (point)))
8311 (goto-char (point-at-bol))
8312 (prog1 (or (and (memq 'table contexts)
8314 (and (memq 'headline contexts)
8315 (looking-at org-outline-regexp))
8316 (and (memq 'item contexts)
8318 (and (memq 'item-body contexts)
8319 (org-in-item-p)))
8320 (goto-char pos))))
8322 (defun org-get-local-variables ()
8323 "Return a list of all local variables in an org-mode buffer."
8324 (let (varlist)
8325 (with-current-buffer (get-buffer-create "*Org tmp*")
8326 (erase-buffer)
8327 (org-mode)
8328 (setq varlist (buffer-local-variables)))
8329 (kill-buffer "*Org tmp*")
8330 (delq nil
8331 (mapcar
8332 (lambda (x)
8333 (setq x
8334 (if (symbolp x)
8335 (list x)
8336 (list (car x) (list 'quote (cdr x)))))
8337 (if (string-match
8338 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8339 (symbol-name (car x)))
8340 x nil))
8341 varlist))))
8343 (defun org-clone-local-variables (from-buffer &optional regexp)
8344 "Clone local variables from FROM-BUFFER.
8345 Optional argument REGEXP selects variables to clone."
8346 (mapc
8347 (lambda (pair)
8348 (and (symbolp (car pair))
8349 (or (null regexp)
8350 (string-match regexp (symbol-name (car pair))))
8351 (set (make-local-variable (car pair))
8352 (cdr pair))))
8353 (buffer-local-variables from-buffer)))
8355 ;;;###autoload
8356 (defun org-run-like-in-org-mode (cmd)
8357 "Run a command, pretending that the current buffer is in Org-mode.
8358 This will temporarily bind local variables that are typically bound in
8359 Org-mode to the values they have in Org-mode, and then interactively
8360 call CMD."
8361 (org-load-modules-maybe)
8362 (unless org-local-vars
8363 (setq org-local-vars (org-get-local-variables)))
8364 (eval (list 'let org-local-vars
8365 (list 'call-interactively (list 'quote cmd)))))
8367 ;;;; Archiving
8369 (defun org-get-category (&optional pos force-refresh)
8370 "Get the category applying to position POS."
8371 (if force-refresh (org-refresh-category-properties))
8372 (let ((pos (or pos (point))))
8373 (or (get-text-property pos 'org-category)
8374 (progn (org-refresh-category-properties)
8375 (get-text-property pos 'org-category)))))
8377 (defun org-refresh-category-properties ()
8378 "Refresh category text properties in the buffer."
8379 (let ((def-cat (cond
8380 ((null org-category)
8381 (if buffer-file-name
8382 (file-name-sans-extension
8383 (file-name-nondirectory buffer-file-name))
8384 "???"))
8385 ((symbolp org-category) (symbol-name org-category))
8386 (t org-category)))
8387 beg end cat pos optionp)
8388 (org-unmodified
8389 (save-excursion
8390 (save-restriction
8391 (widen)
8392 (goto-char (point-min))
8393 (put-text-property (point) (point-max) 'org-category def-cat)
8394 (while (re-search-forward
8396 (setq pos (match-end 0)
8397 optionp (equal (char-after (match-beginning 0)) ?#)
8398 cat (org-trim (match-string 2)))
8399 (if optionp
8400 (setq beg (point-at-bol) end (point-max))
8401 (org-back-to-heading t)
8402 (setq beg (point) end (org-end-of-subtree t t)))
8403 (put-text-property beg end 'org-category cat)
8404 (goto-char pos)))))))
8407 ;;;; Link Stuff
8409 ;;; Link abbreviations
8411 (defun org-link-expand-abbrev (link)
8412 "Apply replacements as defined in `org-link-abbrev-alist."
8414 (let* ((key (match-string 1 link))
8415 (as (or (assoc key org-link-abbrev-alist-local)
8416 (assoc key org-link-abbrev-alist)))
8417 (tag (and (match-end 2) (match-string 3 link)))
8418 rpl)
8419 (if (not as)
8420 link
8421 (setq rpl (cdr as))
8422 (cond
8423 ((symbolp rpl) (funcall rpl tag))
8424 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8425 ((string-match "%h" rpl)
8426 (replace-match (url-hexify-string (or tag "")) t t rpl))
8427 (t (concat rpl tag)))))
8428 link))
8430 ;;; Storing and inserting links
8432 (defvar org-insert-link-history nil
8433 "Minibuffer history for links inserted with `org-insert-link'.")
8435 (defvar org-stored-links nil
8436 "Contains the links stored with `org-store-link'.")
8438 (defvar org-store-link-plist nil
8439 "Plist with info about the most recently link created with `org-store-link'.")
8441 (defvar org-link-protocols nil
8442 "Link protocols added to Org-mode using `org-add-link-type'.")
8444 (defvar org-store-link-functions nil
8445 "List of functions that are called to create and store a link.
8446 Each function will be called in turn until one returns a non-nil
8447 value. Each function should check if it is responsible for creating
8448 this link (for example by looking at the major mode).
8449 If not, it must exit and return nil.
8450 If yes, it should return a non-nil value after a calling
8451 `org-store-link-props' with a list of properties and values.
8452 Special properties are:
8456 This is obligatory as well.
8457 :description Optional default description for the second pair
8458 of brackets in an Org-mode link. The user can still change
8459 this when inserting this link into an Org-mode buffer.
8461 In addition to these, any additional properties can be specified
8462 and then used in remember templates.")
8464 (defun org-add-link-type (type &optional follow export)
8465 "Add TYPE to the list of `org-link-types'.
8466 Re-compute all regular expressions depending on `org-link-types'
8468 FOLLOW and EXPORT are two functions.
8470 FOLLOW should take the link path as the single argument and do whatever
8471 is necessary to follow the link, for example find a file or display
8472 a mail message.
8474 EXPORT should format the link path for export to one of the export formats.
8475 It should be a function accepting three arguments:
8478 desc the description of the link, if any, or a description added by
8479 org-export-normalize-links if there is none
8480 format the export format, a symbol like `html' or `latex' or `ascii'..
8482 The function may use the FORMAT information to return different values
8483 depending on the format. The return value will be put literally into
8484 the exported file. If the return value is nil, this means Org should
8485 do what it normally does with links which do not have EXPORT defined.
8487 Org-mode has a built-in default for exporting links. If you are happy with
8488 this default, there is no need to define an export function for the link
8489 type. For a simple example of an export function, see `org-bbdb.el'."
8490 (add-to-list 'org-link-types type t)
8491 (org-make-link-regexps)
8492 (if (assoc type org-link-protocols)
8493 (setcdr (assoc type org-link-protocols) (list follow export))
8494 (push (list type follow export) org-link-protocols)))
8496 (defvar org-agenda-buffer-name)
8498 ;;;###autoload
8499 (defun org-store-link (arg)
8501 This link is added to `org-stored-links' and can later be inserted
8504 For some link types, a prefix arg is interpreted:
8505 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8506 For file links, arg negates `org-context-in-file-links'."
8507 (interactive "P")
8508 (org-load-modules-maybe)
8509 (setq org-store-link-plist nil) ; reset
8510 (org-with-limited-levels
8511 (let (link cpltxt desc description search txt custom-id agenda-link)
8512 (cond
8514 ((run-hook-with-args-until-success 'org-store-link-functions)
8515 (setq link (plist-get org-store-link-plist :link)
8516 desc (or (plist-get org-store-link-plist :description) link)))
8518 ((equal (buffer-name) "*Org Edit Src Example*")
8519 (let (label gc)
8520 (while (or (not label)
8521 (save-excursion
8522 (save-restriction
8523 (widen)
8524 (goto-char (point-min))
8525 (re-search-forward
8526 (regexp-quote (format org-coderef-label-format label))
8527 nil t))))
8528 (when label (message "Label exists already") (sit-for 2))
8529 (setq label (read-string "Code line label: " label)))
8530 (end-of-line 1)
8531 (setq link (format org-coderef-label-format label))
8532 (setq gc (- 79 (length link)))
8533 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8534 (insert link)
8535 (setq link (concat "(" label ")") desc nil)))
8537 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8538 ;; We are in the agenda, link to referenced location
8539 (let ((m (or (get-text-property (point) 'org-hd-marker)
8540 (get-text-property (point) 'org-marker))))
8541 (when m
8542 (org-with-point-at m
8543 (setq agenda-link
8544 (if (org-called-interactively-p 'any)
8545 (call-interactively 'org-store-link)
8546 (org-store-link nil)))))))
8548 ((eq major-mode 'calendar-mode)
8549 (let ((cd (calendar-cursor-to-date)))
8550 (setq link
8551 (format-time-string
8552 (car org-time-stamp-formats)
8553 (apply 'encode-time
8554 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8555 nil nil nil))))
8556 (org-store-link-props :type "calendar" :date cd)))
8558 ((eq major-mode 'w3-mode)
8559 (setq cpltxt (if (and (buffer-name)
8560 (not (string-match "Untitled" (buffer-name))))
8561 (buffer-name)
8562 (url-view-url t))
8563 link (org-make-link (url-view-url t)))
8564 (org-store-link-props :type "w3" :url (url-view-url t)))
8566 ((eq major-mode 'w3m-mode)
8567 (setq cpltxt (or w3m-current-title w3m-current-url)
8568 link (org-make-link w3m-current-url))
8569 (org-store-link-props :type "w3m" :url (url-view-url t)))
8571 ((setq search (run-hook-with-args-until-success
8572 'org-create-file-search-functions))
8573 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8574 "::" search))
8575 (setq cpltxt (or description link)))
8577 ((eq major-mode 'image-mode)
8578 (setq cpltxt (concat "file:"
8579 (abbreviate-file-name buffer-file-name))
8580 link (org-make-link cpltxt))
8581 (org-store-link-props :type "image" :file buffer-file-name))
8583 ((eq major-mode 'dired-mode)
8584 ;; link to the file in the current line
8585 (let ((file (dired-get-filename nil t)))
8586 (setq file (if file
8587 (abbreviate-file-name
8588 (expand-file-name (dired-get-filename nil t)))
8589 ;; otherwise, no file so use current directory.
8590 default-directory))
8591 (setq cpltxt (concat "file:" file)
8592 link (org-make-link cpltxt))))
8594 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8595 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8596 (cond
8598 (setq cpltxt
8599 (concat "file:"
8600 (abbreviate-file-name
8601 (buffer-file-name (buffer-base-buffer)))
8602 "::" (match-string 1))
8603 link (org-make-link cpltxt)))
8604 ((and (featurep 'org-id)
8605 (or (eq org-link-to-org-use-id t)
8606 (and (eq org-link-to-org-use-id 'create-if-interactive)
8607 (org-called-interactively-p 'any))
8608 (and (eq org-link-to-org-use-id
8609 'create-if-interactive-and-no-custom-id)
8610 (org-called-interactively-p 'any)
8611 (not custom-id))
8612 (and org-link-to-org-use-id
8613 (org-entry-get nil "ID"))))
8614 ;; We can make a link using the ID.
8615 (setq link (condition-case nil
8616 (prog1 (org-id-store-link)
8617 (setq desc (plist-get org-store-link-plist
8618 :description)))
8619 (error
8620 ;; probably before first headline, link to file only
8621 (concat "file:"
8622 (abbreviate-file-name
8623 (buffer-file-name (buffer-base-buffer))))))))
8624 (t
8625 ;; Just link to current headline
8626 (setq cpltxt (concat "file:"
8627 (abbreviate-file-name
8628 (buffer-file-name (buffer-base-buffer)))))
8629 ;; Add a context search string
8630 (when (org-xor org-context-in-file-links arg)
8631 (setq txt (cond
8632 ((org-on-heading-p) nil)
8633 ((org-region-active-p)
8634 (buffer-substring (region-beginning) (region-end)))
8635 (t nil)))
8637 (setq cpltxt
8638 (concat cpltxt "::"
8639 (condition-case nil
8640 (org-make-org-heading-search-string txt)
8641 (error "")))
8642 desc (or (nth 4 (ignore-errors
8643 (org-heading-components))) "NONE"))))
8645 (setq cpltxt (substring cpltxt 0 -2)))
8646 (setq link (org-make-link cpltxt)))))
8648 ((buffer-file-name (buffer-base-buffer))
8649 ;; Just link to this file here.
8650 (setq cpltxt (concat "file:"
8651 (abbreviate-file-name
8652 (buffer-file-name (buffer-base-buffer)))))
8653 ;; Add a context string
8654 (when (org-xor org-context-in-file-links arg)
8655 (setq txt (if (org-region-active-p)
8656 (buffer-substring (region-beginning) (region-end))
8657 (buffer-substring (point-at-bol) (point-at-eol))))
8658 ;; Only use search option if there is some text.
8660 (setq cpltxt
8661 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8662 desc "NONE")))
8663 (setq link (org-make-link cpltxt)))
8665 ((org-called-interactively-p 'interactive)
8666 (error "Cannot link to a buffer which is not visiting a file"))
8668 (t (setq link nil)))
8670 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8671 (setq link (or link cpltxt)
8672 desc (or desc cpltxt))
8673 (if (equal desc "NONE") (setq desc nil))
8675 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8676 (progn
8677 (setq org-stored-links
8678 (cons (list link desc) org-stored-links))
8679 (message "Stored: %s" (or desc link))
8680 (when custom-id
8681 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8682 "::#" custom-id))
8683 (setq org-stored-links
8684 (cons (list link desc) org-stored-links))))
8685 (or agenda-link (and link (org-make-link-string link desc)))))))
8687 (defun org-store-link-props (&rest plist)
8688 "Store link properties, extract names and addresses."
8689 (let (x adr)
8690 (when (setq x (plist-get plist :from))
8691 (setq adr (mail-extract-address-components x))
8692 (setq plist (plist-put plist :fromname (car adr)))
8693 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8694 (when (setq x (plist-get plist :to))
8695 (setq adr (mail-extract-address-components x))
8696 (setq plist (plist-put plist :toname (car adr)))
8697 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8698 (let ((from (plist-get plist :from))
8699 (to (plist-get plist :to)))
8700 (when (and from to org-from-is-user-regexp)
8701 (setq plist
8702 (plist-put plist :fromto
8703 (if (string-match org-from-is-user-regexp from)
8704 (concat "to %t")
8705 (concat "from %f"))))))
8706 (setq org-store-link-plist plist))
8708 (defun org-add-link-props (&rest plist)
8709 "Add these properties to the link property list."
8710 (let (key value)
8711 (while plist
8712 (setq key (pop plist) value (pop plist))
8713 (setq org-store-link-plist
8714 (plist-put org-store-link-plist key value)))))
8716 (defun org-email-link-description (&optional fmt)
8717 "Return the description part of an email link.
8718 This takes information from `org-store-link-plist' and formats it
8719 according to FMT (default from `org-email-link-description-format')."
8720 (setq fmt (or fmt org-email-link-description-format))
8721 (let* ((p org-store-link-plist)
8722 (to (plist-get p :toaddress))
8723 (from (plist-get p :fromaddress))
8724 (table
8725 (list
8726 (cons "%c" (plist-get p :fromto))
8727 (cons "%F" (plist-get p :from))
8728 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8729 (cons "%T" (plist-get p :to))
8730 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8731 (cons "%s" (plist-get p :subject))
8732 (cons "%d" (plist-get p :date))
8733 (cons "%m" (plist-get p :message-id)))))
8734 (when (string-match "%c" fmt)
8735 ;; Check if the user wrote this message
8736 (if (and org-from-is-user-regexp from to
8737 (save-match-data (string-match org-from-is-user-regexp from)))
8738 (setq fmt (replace-match "to %t" t t fmt))
8739 (setq fmt (replace-match "from %f" t t fmt))))
8740 (org-replace-escapes fmt table)))
8742 (defun org-make-org-heading-search-string (&optional string heading)
8743 "Make search string for STRING or current headline."
8744 (interactive)
8745 (let ((s (or string (org-get-heading)))
8746 (lines org-context-in-file-links))
8747 (unless (and string (not heading))
8748 ;; We are using a headline, clean up garbage in there.
8749 (if (string-match org-todo-regexp s)
8750 (setq s (replace-match "" t t s)))
8752 (setq s (replace-match "" t t s)))
8753 (setq s (org-trim s))
8756 (setq s (replace-match "" t t s)))
8757 (while (string-match org-ts-regexp s)
8758 (setq s (replace-match "" t t s))))
8759 (or string (setq s (concat "*" s))) ; Add * for headlines
8760 (when (and string (integerp lines) (> lines 0))
8762 (when (< lines (length slines))
8763 (setq s (mapconcat
8764 'identity
8765 (reverse (nthcdr (- (length slines) lines)
8769 (defun org-make-link (&rest strings)
8770 "Concatenate STRINGS."
8771 (apply 'concat strings))
8773 (defun org-make-link-string (link &optional description)
8774 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8776 (error "Empty link"))
8777 (when (and description
8778 (stringp description)
8780 (setq description nil))
8781 (when (stringp description)
8782 ;; Remove brackets from the description, they are fatal.
8784 (setq description (replace-match "{" t t description)))
8786 (setq description (replace-match "}" t t description))))
8787 (when (equal link description)
8788 ;; No description needed, it is identical
8789 (setq description nil))
8790 (when (and (not description)
8791 (not (string-match (org-image-file-name-regexp) link))
8792 (not (equal link (org-link-escape link))))
8793 (setq description (org-extract-attributes link)))
8794 (setq link
8795 (cond ((string-match (org-image-file-name-regexp) link) link)
8796 ((string-match org-link-types-re link)
8797 (concat (match-string 1 link)
8798 (org-link-escape (substring link (match-end 1)))))
8799 (t (org-link-escape link))))
8800 (concat "[[" link "]"
8801 (if description (concat "[" description "]") "")
8802 "]"))
8804 (defconst org-link-escape-chars
8805 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8806 "List of characters that should be escaped in link.
8807 This is the list that is used for internal purposes.")
8809 (defvar org-url-encoding-use-url-hexify nil)
8811 (defconst org-link-escape-chars-browser
8812 '(?\ )
8813 "List of escapes for characters that are problematic in links.
8814 This is the list that is used before handing over to the browser.")
8816 (defun org-link-escape (text &optional table merge)
8817 "Return percent escaped representation of TEXT.
8818 TEXT is a string with the text to escape.
8819 Optional argument TABLE is a list with characters that should be
8820 escaped. When nil, `org-link-escape-chars' is used.
8821 If optional argument MERGE is set, merge TABLE into
8822 `org-link-escape-chars'."
8823 (if (and org-url-encoding-use-url-hexify (not table))
8824 (url-hexify-string text)
8825 (cond
8826 ((and table merge)
8827 (mapc (lambda (defchr)
8828 (unless (member defchr table)
8829 (setq table (cons defchr table)))) org-link-escape-chars))
8830 ((null table)
8831 (setq table org-link-escape-chars)))
8832 (mapconcat
8833 (lambda (char)
8834 (if (or (member char table)
8835 (< char 32) (= char 37) (> char 126))
8836 (mapconcat (lambda (sequence-element)
8837 (format "%%%.2X" sequence-element))
8838 (or (encode-coding-char char 'utf-8)
8839 (error "Unable to percent escape character: %s"
8840 (char-to-string char))) "")
8841 (char-to-string char))) text "")))
8843 (defun org-link-unescape (str)
8844 "Unhex hexified unicode strings as returned from the JavaScript function
8845 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8846 (unless (and (null str) (string= "" str))
8847 (let ((pos 0) (case-fold-search t) unhexed)
8849 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8850 (setq str (replace-match unhexed t t str))
8851 (setq pos (+ pos (length unhexed))))))
8852 str)
8854 (defun org-link-unescape-compound (hex)
8855 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8856 Note: this function also decodes single byte encodings like
8858 (save-match-data
8859 (let* ((bytes (cdr (split-string hex "%")))
8860 (ret "")
8861 (eat 0)
8862 (sum 0))
8863 (while bytes
8864 (let* ((val (string-to-number (pop bytes) 16))
8865 (shift-xor
8866 (if (= 0 eat)
8867 (cond
8868 ((>= val 252) (cons 6 252))
8869 ((>= val 248) (cons 5 248))
8870 ((>= val 240) (cons 4 240))
8871 ((>= val 224) (cons 3 224))
8872 ((>= val 192) (cons 2 192))
8873 (t (cons 0 0)))
8874 (cons 6 128))))
8875 (if (>= val 192) (setq eat (car shift-xor)))
8876 (setq val (logxor val (cdr shift-xor)))
8877 (setq sum (+ (lsh sum (car shift-xor)) val))
8878 (if (> eat 0) (setq eat (- eat 1)))
8879 (cond
8880 ((= 0 eat) ;multi byte
8881 (setq ret (concat ret (org-char-to-string sum)))
8882 (setq sum 0))
8883 ((not bytes) ; single byte(s)
8884 (setq ret (org-link-unescape-single-byte-sequence hex))))
8885 )) ;; end (while bytes
8886 ret )))
8888 (defun org-link-unescape-single-byte-sequence (hex)
8889 "Unhexify hex-encoded single byte character sequences."
8890 (mapconcat (lambda (byte)
8891 (char-to-string (string-to-number byte 16)))
8892 (cdr (split-string hex "%")) ""))
8894 (defun org-xor (a b)
8895 "Exclusive or."
8896 (if a (not b) b))
8898 (defun org-fixup-message-id-for-http (s)
8899 "Replace special characters in a message id, so it can be used in an http query."
8900 (when (string-match "%" s)
8901 (setq s (mapconcat (lambda (c)
8902 (if (eq c ?%)
8903 "%25"
8904 (char-to-string c)))
8905 s "")))
8906 (while (string-match "<" s)
8907 (setq s (replace-match "%3C" t t s)))
8908 (while (string-match ">" s)
8909 (setq s (replace-match "%3E" t t s)))
8910 (while (string-match "@" s)
8911 (setq s (replace-match "%40" t t s)))
8912 s)
8914 ;;;###autoload
8915 (defun org-insert-link-global ()
8916 "Insert a link like Org-mode does.
8917 This command can be called in any mode to insert a link in Org-mode syntax."
8918 (interactive)
8919 (org-load-modules-maybe)
8920 (org-run-like-in-org-mode 'org-insert-link))
8922 (defun org-insert-link (&optional complete-file link-location)
8923 "Insert a link. At the prompt, enter the link.
8925 Completion can be used to insert any of the link protocol prefixes like
8926 http or ftp in use.
8928 The history can be used to select a link previously stored with
8929 `org-store-link'. When the empty string is entered (i.e. if you just
8930 press RET at the prompt), the link defaults to the most recently
8931 stored link. As SPC triggers completion in the minibuffer, you need to
8932 use M-SPC or C-q SPC to force the insertion of a space character.
8934 You will also be prompted for a description, and if one is given, it will
8935 be displayed in the buffer instead of the link.
8937 If there is already a link at point, this command will allow you to edit link
8938 and description parts.
8941 be selected using completion. The path to the file will be relative to the
8942 current directory if the file is in the current directory or a subdirectory.
8943 Otherwise, the link will be the absolute path as completed in the minibuffer
8944 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8945 option `org-link-file-path-type'.
8948 the current directory or below.
8951 `org-keep-stored-link-after-insertion'.
8953 If `org-make-link-description-function' is non-nil, this function will be
8954 called with the link target, and the result will be the default
8955 link description.
8957 If the LINK-LOCATION parameter is non-nil, this value will be
8958 used as the link location instead of reading one interactively."
8959 (interactive "P")
8960 (let* ((wcf (current-window-configuration))
8961 (region (if (org-region-active-p)
8962 (buffer-substring (region-beginning) (region-end))))
8963 (remove (and region (list (region-beginning) (region-end))))
8964 (desc region)
8965 tmphist ; byte-compile incorrectly complains about this
8966 (link link-location)
8967 entry file all-prefixes)
8968 (cond
8969 (link-location) ; specified by arg, just use it.
8970 ((org-in-regexp org-bracket-link-regexp 1)
8971 ;; We do have a link at point, and we are going to edit it.
8972 (setq remove (list (match-beginning 0) (match-end 0)))
8973 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8974 (setq link (read-string "Link: "
8975 (org-link-unescape
8976 (org-match-string-no-properties 1)))))
8977 ((or (org-in-regexp org-angle-link-re)
8978 (org-in-regexp org-plain-link-re))
8979 ;; Convert to bracket link
8980 (setq remove (list (match-beginning 0) (match-end 0))
8981 link (read-string "Link: "
8982 (org-remove-angle-brackets (match-string 0)))))
8983 ((member complete-file '((4) (16)))
8984 ;; Completing read for file names.
8985 (setq link (org-file-complete-link complete-file)))
8986 (t
8987 ;; Read link, with completion for stored links.
8988 (with-output-to-temp-buffer "*Org Links*"
8989 (princ "Insert a link.
8991 (when org-stored-links
8993 (princ (mapconcat
8994 (lambda (x)
8995 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8997 (let ((cw (selected-window)))
8998 (select-window (get-buffer-window "*Org Links*" 'visible))
8999 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
9000 (unless (pos-visible-in-window-p (point-max))
9001 (org-fit-window-to-buffer))
9002 (and (window-live-p cw) (select-window cw)))
9003 ;; Fake a link history, containing the stored links.
9004 (setq tmphist (append (mapcar 'car org-stored-links)
9005 org-insert-link-history))
9006 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9007 (mapcar 'car org-link-abbrev-alist)
9008 org-link-types))
9009 (unwind-protect
9010 (progn
9011 (setq link
9012 (let ((org-completion-use-ido nil)
9013 (org-completion-use-iswitchb nil))
9014 (org-completing-read
9015 "Link: "
9016 (append
9017 (mapcar (lambda (x) (list (concat x ":")))
9018 all-prefixes)
9019 (mapcar 'car org-stored-links))
9020 nil nil nil
9021 'tmphist
9022 (car (car org-stored-links)))))
9024 (error "No link selected"))
9025 (if (or (member link all-prefixes)
9026 (and (equal ":" (substring link -1))
9027 (member (substring link 0 -1) all-prefixes)
9028 (setq link (substring link 0 -1))))
9029 (setq link (org-link-try-special-completion link))))
9030 (set-window-configuration wcf)
9031 (kill-buffer "*Org Links*"))
9032 (setq entry (assoc link org-stored-links))
9033 (or entry (push link org-insert-link-history))
9034 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9035 (not org-keep-stored-link-after-insertion))
9036 (setq org-stored-links (delq (assoc link org-stored-links)
9037 org-stored-links)))
9038 (setq desc (or desc (nth 1 entry)))))
9040 (if (string-match org-plain-link-re link)
9041 ;; URL-like link, normalize the use of angular brackets.
9042 (setq link (org-make-link (org-remove-angle-brackets link))))
9044 ;; Check if we are linking to the current file with a search option
9045 ;; If yes, simplify the link by using only the search option.
9046 (when (and buffer-file-name
9048 (let* ((path (match-string 1 link))
9049 (case-fold-search nil)
9050 (search (match-string 2 link)))
9051 (save-match-data
9052 (if (equal (file-truename buffer-file-name) (file-truename path))
9053 ;; We are linking to this same file, with a search option
9054 (setq link search)))))
9056 ;; Check if we can/should use a relative path. If yes, simplify the link
9058 (let* ((type (match-string 1 link))
9059 (path (match-string 2 link))
9060 (origpath path)
9061 (case-fold-search nil))
9062 (cond
9063 ((or (eq org-link-file-path-type 'absolute)
9064 (equal complete-file '(16)))
9065 (setq path (abbreviate-file-name (expand-file-name path))))
9066 ((eq org-link-file-path-type 'noabbrev)
9067 (setq path (expand-file-name path)))
9068 ((eq org-link-file-path-type 'relative)
9069 (setq path (file-relative-name path)))
9070 (t
9071 (save-match-data
9072 (if (string-match (concat "^" (regexp-quote
9073 (expand-file-name
9074 (file-name-as-directory
9075 default-directory))))
9076 (expand-file-name path))
9077 ;; We are linking a file with relative path name.
9078 (setq path (substring (expand-file-name path)
9079 (match-end 0)))
9080 (setq path (abbreviate-file-name (expand-file-name path)))))))
9081 (setq link (concat type path))
9082 (if (equal desc origpath)
9083 (setq desc path))))
9085 (if org-make-link-description-function
9086 (setq desc (funcall org-make-link-description-function link desc)))
9088 (setq desc (read-string "Description: " desc))
9090 (if remove (apply 'delete-region remove))
9091 (insert (org-make-link-string link desc))))
9093 (defun org-link-try-special-completion (type)
9094 "If there is completion support for link type TYPE, offer it."
9095 (let ((fun (intern (concat "org-" type "-complete-link"))))
9096 (if (functionp fun)
9097 (funcall fun)
9098 (read-string "Link (no completion support): " (concat type ":")))))
9100 (defun org-file-complete-link (&optional arg)
9101 "Create a file link using completion."
9102 (let (file link)
9103 (setq file (read-file-name "File: "))
9104 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9105 (pwd1 (file-name-as-directory (abbreviate-file-name
9106 (expand-file-name ".")))))
9107 (cond
9108 ((equal arg '(16))
9109 (setq link (org-make-link
9110 "file:"
9111 (abbreviate-file-name (expand-file-name file)))))
9113 (setq link (org-make-link "file:" (match-string 1 file))))
9115 (expand-file-name file))
9116 (setq link (org-make-link
9117 "file:" (match-string 1 (expand-file-name file)))))
9118 (t (setq link (org-make-link "file:" file)))))
9119 link))
9121 (defun org-completing-read (&rest args)
9122 "Completing-read with SPACE being a normal character."
9123 (let ((minibuffer-local-completion-map
9124 (copy-keymap minibuffer-local-completion-map)))
9125 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9126 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9127 (apply 'org-icompleting-read args)))
9129 (defun org-completing-read-no-i (&rest args)
9130 (let (org-completion-use-ido org-completion-use-iswitchb)
9131 (apply 'org-completing-read args)))
9133 (defun org-iswitchb-completing-read (prompt choices &rest args)
9134 "Use iswitch as a completing-read replacement to choose from choices.
9135 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9136 from."
9137 (let* ((iswitchb-use-virtual-buffers nil)
9138 (iswitchb-make-buflist-hook
9139 (lambda ()
9140 (setq iswitchb-temp-buflist choices))))
9141 (iswitchb-read-buffer prompt)))
9143 (defun org-icompleting-read (&rest args)
9144 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9145 (org-without-partial-completion
9146 (if (and org-completion-use-ido
9147 (fboundp 'ido-completing-read)
9148 (boundp 'ido-mode) ido-mode
9149 (listp (second args)))
9150 (let ((ido-enter-matching-directory nil))
9151 (apply 'ido-completing-read (concat (car args))
9152 (if (consp (car (nth 1 args)))
9153 (mapcar 'car (nth 1 args))
9154 (nth 1 args))
9155 (cddr args)))
9156 (if (and org-completion-use-iswitchb
9157 (boundp 'iswitchb-mode) iswitchb-mode
9158 (listp (second args)))
9159 (apply 'org-iswitchb-completing-read (concat (car args))
9160 (if (consp (car (nth 1 args)))
9161 (mapcar 'car (nth 1 args))
9162 (nth 1 args))
9163 (cddr args))
9164 (apply 'completing-read args)))))
9166 (defun org-extract-attributes (s)
9167 "Extract the attributes cookie from a string and set as text property."
9168 (let (a attr (start 0) key value)
9169 (save-match-data
9171 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9173 (setq key (match-string 1 a) value (match-string 2 a)
9174 start (match-end 0)
9175 attr (plist-put attr (intern key) value))))
9176 (org-add-props s nil 'org-attr attr))
9177 s))
9179 (defun org-extract-attributes-from-string (tag)
9180 (let (key value attr)
9182 (setq key (match-string 1 tag) value (match-string 2 tag)
9183 tag (replace-match "" t t tag)
9184 attr (plist-put attr (intern key) value)))
9185 (cons tag attr)))
9187 (defun org-attributes-to-string (plist)
9188 "Format a property list into an HTML attribute list."
9189 (let ((s "") key value)
9190 (while plist
9191 (setq key (pop plist) value (pop plist))
9192 (and value
9194 s))
9196 ;;; Opening/following a link
9198 (defvar org-link-search-failed nil)
9200 (defvar org-open-link-functions nil
9201 "Hook for functions finding a plain text link.
9202 These functions must take a single argument, the link content.
9203 They will be called for links that look like [[link text][description]]
9207 These functions will be called *before* Org attempts to resolve the
9208 link by doing text searches in the current buffer - so if you want a
9210 handle this as a special case.
9212 When the function does handle the link, it must return a non-nil value.
9213 If it decides that it is not responsible for this link, it must return
9214 nil to indicate that that Org-mode can continue with other options
9215 like exact and fuzzy text search.")
9217 (defun org-next-link ()
9218 "Move forward to the next link.
9219 If the link is in hidden text, expose it."
9220 (interactive)
9221 (when (and org-link-search-failed (eq this-command last-command))
9222 (goto-char (point-min))
9223 (message "Link search wrapped back to beginning of buffer"))
9224 (setq org-link-search-failed nil)
9225 (let* ((pos (point))
9226 (ct (org-context))
9227 (a (assoc :link ct)))
9228 (if a (goto-char (nth 2 a)))
9229 (if (re-search-forward org-any-link-re nil t)
9230 (progn
9231 (goto-char (match-beginning 0))
9232 (if (outline-invisible-p) (org-show-context)))
9233 (goto-char pos)
9234 (setq org-link-search-failed t)
9235 (error "No further link found"))))
9237 (defun org-previous-link ()
9238 "Move backward to the previous link.
9239 If the link is in hidden text, expose it."
9240 (interactive)
9241 (when (and org-link-search-failed (eq this-command last-command))
9242 (goto-char (point-max))
9243 (message "Link search wrapped back to end of buffer"))
9244 (setq org-link-search-failed nil)
9245 (let* ((pos (point))
9246 (ct (org-context))
9247 (a (assoc :link ct)))
9248 (if a (goto-char (nth 1 a)))
9249 (if (re-search-backward org-any-link-re nil t)
9250 (progn
9251 (goto-char (match-beginning 0))
9252 (if (outline-invisible-p) (org-show-context)))
9253 (goto-char pos)
9254 (setq org-link-search-failed t)
9255 (error "No further link found"))))
9257 (defun org-translate-link (s)
9258 "Translate a link string if a translation function has been defined."
9259 (if (and org-link-translation-function
9260 (fboundp org-link-translation-function)
9262 (progn
9263 (setq s (funcall org-link-translation-function
9264 (match-string 1) (match-string 2)))
9265 (concat (car s) ":" (cdr s)))
9266 s))
9268 (defun org-translate-link-from-planner (type path)
9269 "Translate a link from Emacs Planner syntax so that Org can follow it.
9270 This is still an experimental function, your mileage may vary."
9271 (cond
9272 ((member type '("http" "https" "news" "ftp"))
9273 ;; standard Internet links are the same.
9274 nil)
9275 ((and (equal type "irc") (string-match "^//" path))
9276 ;; Planner has two / at the beginning of an irc link, we have 1.
9277 ;; We should have zero, actually....
9278 (setq path (substring path 1)))
9279 ((and (equal type "lisp") (string-match "^/" path))
9280 ;; Planner has a slash, we do not.
9281 (setq type "elisp" path (substring path 1)))
9283 ;; A typical message link. Planner has the id after the final slash,
9284 ;; we separate it with a hash mark
9285 (setq path (concat (match-string 1 path) "#"
9286 (org-remove-angle-brackets (match-string 2 path)))))
9287 )
9288 (cons type path))
9290 (defun org-find-file-at-mouse (ev)
9291 "Open file link or URL at mouse."
9292 (interactive "e")
9293 (mouse-set-point ev)
9294 (org-open-at-point 'in-emacs))
9296 (defun org-open-at-mouse (ev)
9297 "Open file link or URL at mouse.
9298 See the docstring of `org-open-file' for details."
9299 (interactive "e")
9300 (mouse-set-point ev)
9301 (if (eq major-mode 'org-agenda-mode)
9302 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9303 (org-open-at-point))
9305 (defvar org-window-config-before-follow-link nil
9306 "The window configuration before following a link.
9307 This is saved in case the need arises to restore it.")
9309 (defvar org-open-link-marker (make-marker)
9310 "Marker pointing to the location where `org-open-at-point; was called.")
9312 ;;;###autoload
9313 (defun org-open-at-point-global ()
9314 "Follow a link like Org-mode does.
9315 This command can be called in any mode to follow a link that has
9316 Org-mode syntax."
9317 (interactive)
9318 (org-run-like-in-org-mode 'org-open-at-point))
9320 ;;;###autoload
9321 (defun org-open-link-from-string (s &optional arg reference-buffer)
9322 "Open a link in the string S, as if it was in Org-mode."
9324 (let ((reference-buffer (or reference-buffer (current-buffer))))
9325 (with-temp-buffer
9326 (let ((org-inhibit-startup t))
9327 (org-mode)
9328 (insert s)
9329 (goto-char (point-min))
9330 (when reference-buffer
9331 (setq org-link-abbrev-alist-local
9332 (with-current-buffer reference-buffer
9333 org-link-abbrev-alist-local)))
9334 (org-open-at-point arg reference-buffer)))))
9336 (defvar org-open-at-point-functions nil
9337 "Hook that is run when following a link at point.
9339 Functions in this hook must return t if they identify and follow
9340 a link at point. If they don't find anything interesting at point,
9341 they must return nil.")
9343 (defun org-open-at-point (&optional arg reference-buffer)
9344 "Open link at or after point.
9345 If there is no link at point, this function will search forward up to
9346 the end of the current line.
9347 Normally, files will be opened by an appropriate application. If the
9348 optional prefix argument ARG is non-nil, Emacs will visit the file.
9349 With a double prefix argument, try to open outside of Emacs, in the
9350 application the system uses for this file type."
9351 (interactive "P")
9352 ;; if in a code block, then open the block's results
9353 (unless (call-interactively #'org-babel-open-src-block-result)
9354 (org-load-modules-maybe)
9355 (move-marker org-open-link-marker (point))
9356 (setq org-window-config-before-follow-link (current-window-configuration))
9357 (org-remove-occur-highlights nil nil t)
9358 (cond
9359 ((and (org-on-heading-p)
9360 (not (org-in-regexp
9365 (not (get-text-property (point) 'org-linked-text)))
9366 (or (org-offer-links-in-entry arg)
9367 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9368 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9369 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9370 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9371 (not (org-in-regexp org-bracket-link-regexp)))
9372 (org-footnote-action))
9373 (t
9374 (let (type path link line search (pos (point)))
9375 (catch 'match
9376 (save-excursion
9378 (when (org-in-regexp org-bracket-link-regexp 1)
9379 (setq link (org-extract-attributes
9380 (org-link-unescape (org-match-string-no-properties 1))))
9382 (setq link (replace-match " " t t link)))
9383 (setq link (org-link-expand-abbrev link))
9384 (cond
9385 ((or (file-name-absolute-p link)
9387 (setq type "file" path link))
9388 ((string-match org-link-re-with-space3 link)
9389 (setq type (match-string 1 link) path (match-string 2 link)))
9390 (t (setq type "thisfile" path link)))
9391 (throw 'match t)))
9393 (when (get-text-property (point) 'org-linked-text)
9394 (setq type "thisfile"
9395 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9396 (1+ (point)) (point))
9397 path (buffer-substring
9398 (or (previous-single-property-change pos 'org-linked-text)
9399 (point-min))
9400 (or (next-single-property-change pos 'org-linked-text)
9401 (point-max))))
9402 (throw 'match t))
9404 (save-excursion
9405 (when (or (org-in-regexp org-angle-link-re)
9406 (org-in-regexp org-plain-link-re))
9407 (setq type (match-string 1) path (match-string 2))
9408 (throw 'match t)))
9409 (save-excursion
9411 (setq type "tags"
9412 path (match-string 1))
9413 (while (string-match ":" path)
9414 (setq path (replace-match "+" t t path)))
9415 (throw 'match t)))
9417 (setq type "tree-match"
9418 path (match-string 1))
9419 (throw 'match t)))
9420 (unless path
9421 (error "No link found"))
9423 ;; switch back to reference buffer
9424 ;; needed when if called in a temporary buffer through
9425 ;; org-open-link-from-string
9426 (with-current-buffer (or reference-buffer (current-buffer))
9428 ;; Remove any trailing spaces in path
9430 (setq path (replace-match "" t t path)))
9431 (if (and org-link-translation-function
9432 (fboundp org-link-translation-function))
9433 ;; Check if we need to translate the link
9434 (let ((tmp (funcall org-link-translation-function type path)))
9435 (setq type (car tmp) path (cdr tmp))))
9437 (cond
9439 ((assoc type org-link-protocols)
9440 (funcall (nth 1 (assoc type org-link-protocols)) path))
9442 ((equal type "mailto")
9443 (let ((cmd (car org-link-mailto-program))
9444 (args (cdr org-link-mailto-program)) args1
9445 (address path) (subject "") a)
9447 (setq address (match-string 1 path)
9448 subject (org-link-escape (match-string 2 path))))
9449 (while args
9450 (cond
9451 ((not (stringp (car args))) (push (pop args) args1))
9452 (t (setq a (pop args))
9453 (if (string-match "%a" a)
9454 (setq a (replace-match address t t a)))
9455 (if (string-match "%s" a)
9456 (setq a (replace-match subject t t a)))
9457 (push a args1))))
9458 (apply cmd (nreverse args1))))
9460 ((member type '("http" "https" "ftp" "news"))
9461 (browse-url (concat type ":" (org-link-escape
9462 path org-link-escape-chars-browser))))
9464 ((string= type "doi")
9465 (browse-url (concat "http://dx.doi.org/"
9466 (org-link-escape
9467 path org-link-escape-chars-browser))))
9469 ((member type '("message"))
9470 (browse-url (concat type ":" path)))
9472 ((string= type "tags")
9473 (org-tags-view arg path))
9475 ((string= type "tree-match")
9478 ((string= type "file")
9480 (setq line (string-to-number (match-string 1 path))
9481 path (substring path 0 (match-beginning 0)))
9483 (setq search (match-string 1 path)
9484 path (substring path 0 (match-beginning 0)))))
9485 (if (string-match "[*?{]" (file-name-nondirectory path))
9486 (dired path)
9487 (org-open-file path arg line search)))
9489 ((string= type "shell")
9490 (let ((cmd path))
9491 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9492 (string-match org-confirm-shell-link-not-regexp cmd))
9493 (not org-confirm-shell-link-function)
9494 (funcall org-confirm-shell-link-function
9496 (org-add-props cmd nil
9497 'face 'org-warning))))
9498 (progn
9499 (message "Executing %s" cmd)
9500 (shell-command cmd))
9501 (error "Abort"))))
9503 ((string= type "elisp")
9504 (let ((cmd path))
9505 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9506 (string-match org-confirm-elisp-link-not-regexp cmd))
9507 (not org-confirm-elisp-link-function)
9508 (funcall org-confirm-elisp-link-function
9510 (org-add-props cmd nil
9511 'face 'org-warning))))
9512 (message "%s => %s" cmd
9513 (if (equal (string-to-char cmd) ?\()
9514 (eval (read cmd))
9515 (call-interactively (read cmd))))
9516 (error "Abort"))))
9518 ((and (string= type "thisfile")
9519 (run-hook-with-args-until-success
9520 'org-open-link-functions path)))
9522 ((string= type "thisfile")
9523 (if arg
9524 (switch-to-buffer-other-window
9525 (org-get-buffer-for-internal-link (current-buffer)))
9526 (org-mark-ring-push))
9527 (let ((cmd `(org-link-search
9528 ,path
9529 ,(cond ((equal arg '(4)) ''occur)
9530 ((equal arg '(16)) ''org-occur)
9531 (t nil))
9532 ,pos)))
9533 (condition-case nil (eval cmd)
9534 (error (progn (widen) (eval cmd))))))
9536 (t
9537 (browse-url-at-point)))))))
9538 (move-marker org-open-link-marker nil)
9539 (run-hook-with-args 'org-follow-link-hook)))
9541 (defun org-offer-links-in-entry (&optional nth zero)
9542 "Offer links in the current entry and follow the selected link.
9543 If there is only one link, follow it immediately as well.
9544 If NTH is an integer, immediately pick the NTH link found.
9545 If ZERO is a string, check also this string for a link, and if
9546 there is one, offer it as link number zero."
9550 (cnt ?0)
9551 (in-emacs (if (integerp nth) nil nth))
9552 have-zero end links link c)
9553 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9554 (push (match-string 0 zero) links)
9555 (setq cnt (1- cnt) have-zero t))
9556 (save-excursion
9557 (org-back-to-heading t)
9558 (setq end (save-excursion (outline-next-heading) (point)))
9559 (while (re-search-forward re end t)
9560 (push (match-string 0) links))
9561 (setq links (org-uniquify (reverse links))))
9563 (cond
9564 ((null links)
9565 (message "No links"))
9566 ((equal (length links) 1)
9567 (setq link (list (car links))))
9568 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9569 (setq link (nth (if have-zero nth (1- nth)) links)))
9570 (t ; we have to select a link
9571 (save-excursion
9572 (save-window-excursion
9573 (delete-other-windows)
9574 (with-output-to-temp-buffer "*Select Link*"
9575 (mapc (lambda (l)
9576 (if (not (string-match org-bracket-link-regexp l))
9578 (org-remove-angle-brackets l)))
9579 (if (match-end 3)
9581 (match-string 3 l) (match-string 1 l)))
9583 (match-string 1 l))))))
9584 links))
9585 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9586 (message "Select link to open, RET to open all:")
9587 (setq c (read-char-exclusive))
9588 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9589 (when (equal c ?q) (error "Abort"))
9590 (if (equal c ?\C-m)
9591 (setq link links)
9592 (setq nth (- c ?0))
9593 (if have-zero (setq nth (1+ nth)))
9594 (unless (and (integerp nth) (>= (length links) nth))
9595 (error "Invalid link selection"))
9596 (setq link (list (nth (1- nth) links))))))
9597 (if link
9598 (let ((buf (current-buffer)))
9599 (dolist (l link)
9600 (org-open-link-from-string l in-emacs buf))
9601 t)
9602 nil)))
9604 ;; Add special file links that specify the way of opening
9606 (org-add-link-type "file+sys" 'org-open-file-with-system)
9607 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9608 (defun org-open-file-with-system (path)
9609 "Open file at PATH using the system way of opening it."
9610 (org-open-file path 'system))
9611 (defun org-open-file-with-emacs (path)
9612 "Open file at PATH in Emacs."
9613 (org-open-file path 'emacs))
9614 (defun org-remove-file-link-modifiers ()
9615 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9616 (goto-char (point-min))
9618 (org-if-unprotected
9619 (replace-match "file:" t t))))
9620 (eval-after-load "org-exp"
9621 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9622 'org-remove-file-link-modifiers))
9624 ;;;; Time estimates
9626 (defun org-get-effort (&optional pom)
9627 "Get the effort estimate for the current entry."
9628 (org-entry-get pom org-effort-property))
9630 ;;; File search
9632 (defvar org-create-file-search-functions nil
9633 "List of functions to construct the right search string for a file link.
9634 These functions are called in turn with point at the location to
9635 which the link should point.
9637 A function in the hook should first test if it would like to
9638 handle this file type, for example by checking the `major-mode'
9639 or the file extension. If it decides not to handle this file, it
9640 should just return nil to give other functions a chance. If it
9641 does handle the file, it must return the search string to be used
9642 when following the link. The search string will be part of the
9643 file link, given after a double colon, and `org-open-at-point'
9644 will automatically search for it. If special measures must be
9645 taken to make the search successful, another function should be
9646 added to the companion hook `org-execute-file-search-functions',
9647 which see.
9649 A function in this hook may also use `setq' to set the variable
9650 `description' to provide a suggestion for the descriptive text to
9651 be used for this link when it gets inserted into an Org-mode
9654 (defvar org-execute-file-search-functions nil
9655 "List of functions to execute a file search triggered by a link.
9657 Functions added to this hook must accept a single argument, the
9658 search string that was part of the file link, the part after the
9659 double colon. The function must first check if it would like to
9660 handle this search, for example by checking the `major-mode' or
9661 the file extension. If it decides not to handle this search, it
9662 should just return nil to give other functions a chance. If it
9663 does handle the search, it must return a non-nil value to keep
9664 other functions from trying.
9666 Each function can access the current prefix argument through the
9667 variable `current-prefix-argument'. Note that a single prefix is
9668 used to force opening a link in Emacs, so it may be good to only
9669 use a numeric or double prefix to guide the search function.
9671 In case this is needed, a function in this hook can also restore
9672 the window configuration before `org-open-at-point' was called using:
9674 (set-window-configuration org-window-config-before-follow-link)")
9676 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9677 (defun org-link-search (s &optional type avoid-pos)
9678 "Search for a link search option.
9679 If S is surrounded by forward slashes, it is interpreted as a
9680 regular expression. In org-mode files, this will create an `org-occur'
9681 sparse tree. In ordinary files, `occur' will be used to list matches.
9682 If the current buffer is in `dired-mode', grep will be used to search
9683 in all files. If AVOID-POS is given, ignore matches near that position."
9684 (let ((case-fold-search t)
9688 org-emphasis-alist)
9690 (pos (point))
9691 (pre nil) (post nil)
9692 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9693 (cond
9694 ;; First check if there are any special search functions
9695 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9696 ;; Now try the builtin stuff
9697 ((and (equal (string-to-char s0) ?#)
9698 (> (length s0) 1)
9699 (save-excursion
9700 (goto-char (point-min))
9701 (and
9702 (re-search-forward
9704 (setq type 'dedicated
9705 pos (match-beginning 0))))
9706 ;; There is an exact target for this
9707 (goto-char pos)
9708 (org-back-to-heading t)))
9709 ((save-excursion
9710 (goto-char (point-min))
9711 (and
9712 (re-search-forward
9713 (concat "<<" (regexp-quote s0) ">>") nil t)
9714 (setq type 'dedicated
9715 pos (match-beginning 0))))
9716 ;; There is an exact target for this
9717 (goto-char pos))
9719 (save-excursion
9720 (goto-char (point-min))
9721 (and
9722 (re-search-forward
9723 (concat "[^[]" (regexp-quote
9724 (format org-coderef-label-format
9725 (match-string 1 s0))))
9726 nil t)
9727 (setq type 'dedicated
9728 pos (1+ (match-beginning 0))))))
9729 ;; There is a coderef target for this
9730 (goto-char pos))
9732 ;; A regular expression
9733 (cond
9734 ((org-mode-p)
9735 (org-occur (match-string 1 s)))
9736 ;;((eq major-mode 'dired-mode)
9737 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9738 (t (org-do-occur (match-string 1 s)))))
9739 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9740 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9741 (goto-char (point-min))
9742 (cond
9743 ((let (case-fold-search)
9744 (re-search-forward (format org-complex-heading-regexp-format
9745 (regexp-quote s))
9746 nil t))
9747 ;; OK, found a match
9748 (setq type 'dedicated)
9749 (goto-char (match-beginning 0)))
9750 ((and (not org-link-search-inhibit-query)
9751 (eq org-link-search-must-match-exact-headline 'query-to-create)
9752 (y-or-n-p "No match - create this as a new heading? "))
9753 (goto-char (point-max))
9754 (or (bolp) (newline))
9756 (beginning-of-line 0))
9757 (t
9758 (goto-char pos)
9759 (error "No match"))))
9760 (t
9761 ;; A normal search string
9762 (when (equal (string-to-char s) ?*)
9763 ;; Anchor on headlines, post may include tags.
9766 s (substring s 1)))
9767 (remove-text-properties
9768 0 (length s)
9769 '(face nil mouse-face nil keymap nil fontified nil) s)
9770 ;; Make a series of regular expressions to find a match
9779 re4 (concat "[^a-zA-Z_]" re4_)
9781 re1 (concat pre re2 post)
9782 re3 (concat pre (if pre re4_ re4) post)
9783 re5 (concat pre ".*" re4)
9784 re2 (concat pre re2)
9785 re2a (concat pre (if pre re2a_ re2a))
9786 re4 (concat pre (if pre re4_ re4))
9790 ))
9791 (cond
9792 ((eq type 'org-occur) (org-occur reall))
9793 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9794 (t (goto-char (point-min))
9795 (setq type 'fuzzy)
9796 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9797 (org-search-not-self 1 re1 nil t)
9798 (org-search-not-self 1 re2 nil t)
9799 (org-search-not-self 1 re2a nil t)
9800 (org-search-not-self 1 re3 nil t)
9801 (org-search-not-self 1 re4 nil t)
9802 (org-search-not-self 1 re5 nil t)
9803 )
9804 (goto-char (match-beginning 1))
9805 (goto-char pos)
9806 (error "No match"))))))
9807 (and (org-mode-p) (org-show-context 'link-search))
9808 type))
9810 (defun org-search-not-self (group &rest args)
9811 "Execute `re-search-forward', but only accept matches that do not
9812 enclose the position of `org-open-link-marker'."
9813 (let ((m org-open-link-marker))
9814 (catch 'exit
9815 (while (apply 're-search-forward args)
9816 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9817 (goto-char (match-end group))
9818 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9819 (> (match-beginning 0) (marker-position m))
9820 (< (match-end 0) (marker-position m)))
9821 (save-match-data
9822 (or (not (org-in-regexp
9823 org-bracket-link-analytic-regexp 1))
9824 (not (match-end 4)) ; no description
9825 (and (<= (match-beginning 4) (point))
9826 (>= (match-end 4) (point))))))
9827 (throw 'exit (point))))))))
9829 (defun org-get-buffer-for-internal-link (buffer)
9830 "Return a buffer to be used for displaying the link target of internal links."
9831 (cond
9832 ((not org-display-internal-link-with-indirect-buffer)
9833 buffer)
9834 ((string-match "(Clone)$" (buffer-name buffer))
9835 (message "Buffer is already a clone, not making another one")
9836 ;; we also do not modify visibility in this case
9837 buffer)
9838 (t ; make a new indirect buffer for displaying the link
9839 (let* ((bn (buffer-name buffer))
9840 (ibn (concat bn "(Clone)"))
9841 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9842 (with-current-buffer ib (org-overview))
9843 ib))))
9845 (defun org-do-occur (regexp &optional cleanup)
9846 "Call the Emacs command `occur'.
9847 If CLEANUP is non-nil, remove the printout of the regular expression
9848 in the *Occur* buffer. This is useful if the regex is long and not useful
9849 to read."
9850 (occur regexp)
9851 (when cleanup
9852 (let ((cwin (selected-window)) win beg end)
9853 (when (setq win (get-buffer-window "*Occur*"))
9854 (select-window win))
9855 (goto-char (point-min))
9856 (when (re-search-forward "match[a-z]+" nil t)
9857 (setq beg (match-end 0))
9859 (setq end (1- (match-beginning 0)))))
9860 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9861 (goto-char (point-min))
9862 (select-window cwin))))
9864 ;;; The mark ring for links jumps
9866 (defvar org-mark-ring nil
9867 "Mark ring for positions before jumps in Org-mode.")
9868 (defvar org-mark-ring-last-goto nil
9869 "Last position in the mark ring used to go back.")
9870 ;; Fill and close the ring
9871 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9872 (loop for i from 1 to org-mark-ring-length do
9873 (push (make-marker) org-mark-ring))
9874 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9875 org-mark-ring)
9877 (defun org-mark-ring-push (&optional pos buffer)
9878 "Put the current position or POS into the mark ring and rotate it."
9879 (interactive)
9880 (setq pos (or pos (point)))
9881 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9882 (move-marker (car org-mark-ring)
9883 (or pos (point))
9884 (or buffer (current-buffer)))
9885 (message "%s"
9886 (substitute-command-keys
9889 (defun org-mark-ring-goto (&optional n)
9890 "Jump to the previous position in the mark ring.
9891 With prefix arg N, jump back that many stored positions. When
9892 called several times in succession, walk through the entire ring.
9893 Org-mode commands jumping to a different position in the current file,
9894 or to another Org-mode file, automatically push the old position
9895 onto the ring."
9896 (interactive "p")
9897 (let (p m)
9898 (if (eq last-command this-command)
9899 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9900 (setq p org-mark-ring))
9901 (setq org-mark-ring-last-goto p)
9902 (setq m (car p))
9903 (org-pop-to-buffer-same-window (marker-buffer m))
9904 (goto-char m)
9905 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9907 (defun org-remove-angle-brackets (s)
9908 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9909 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9910 s)
9911 (defun org-add-angle-brackets (s)
9912 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9913 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9914 s)
9915 (defun org-remove-double-quotes (s)
9918 s)
9920 ;;; Following specific links
9922 (defun org-follow-timestamp-link ()
9923 (cond
9924 ((org-at-date-range-p t)
9925 (let ((org-agenda-start-on-weekday)
9926 (t1 (match-string 1))
9927 (t2 (match-string 2)))
9928 (setq t1 (time-to-days (org-time-string-to-time t1))
9929 t2 (time-to-days (org-time-string-to-time t2)))
9930 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9931 ((org-at-timestamp-p t)
9932 (org-agenda-list nil (time-to-days (org-time-string-to-time
9933 (substring (match-string 1) 0 10)))
9934 1))
9935 (t (error "This should not happen"))))
9938 ;;; Following file links
9939 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9940 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9941 (declare-function mailcap-mime-info
9942 "mailcap" (string &optional request no-decode))
9943 (defvar org-wait nil)
9944 (defun org-open-file (path &optional in-emacs line search)
9945 "Open the file at PATH.
9946 First, this expands any special file name abbreviations. Then the
9947 configuration variable `org-file-apps' is checked if it contains an
9948 entry for this file type, and if yes, the corresponding command is launched.
9950 If no application is found, Emacs simply visits the file.
9952 With optional prefix argument IN-EMACS, Emacs will visit the file.
9954 prefix arg, Org tries to avoid opening in Emacs
9955 and to use an external application to visit the file.
9957 Optional LINE specifies a line to go to, optional SEARCH a string
9958 to search for. If LINE or SEARCH is given, the file will be
9959 opened in Emacs, unless an entry from org-file-apps that makes
9960 use of groups in a regexp matches.
9962 If you want to change the way frames are used when following a
9963 link, please customize `org-link-frame-setup'.
9965 If the file does not exist, an error is thrown."
9966 (let* ((file (if (equal path "")
9967 buffer-file-name
9968 (substitute-in-file-name (expand-file-name path))))
9969 (file-apps (append org-file-apps (org-default-apps)))
9970 (apps (org-remove-if
9971 'org-file-apps-entry-match-against-dlink-p file-apps))
9972 (apps-dlink (org-remove-if-not
9973 'org-file-apps-entry-match-against-dlink-p file-apps))
9974 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9975 (dirp (if remp nil (file-directory-p file)))
9976 (file (if (and dirp org-open-directory-means-index-dot-org)
9977 (concat (file-name-as-directory file) "index.org")
9978 file))
9979 (a-m-a-p (assq 'auto-mode apps))
9980 (dfile (downcase file))
9981 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9982 (link (cond ((and (eq line nil)
9983 (eq search nil))
9984 file)
9985 (line
9986 (concat file "::" (number-to-string line)))
9987 (search
9988 (concat file "::" search))))
9989 (dlink (downcase link))
9990 (old-buffer (current-buffer))
9991 (old-pos (point))
9992 (old-mode major-mode)
9993 ext cmd link-match-data)
9995 (setq ext (match-string 1 dfile))
9997 (setq ext (match-string 1 dfile))))
9998 (cond
9999 ((member in-emacs '((16) system))
10000 (setq cmd (cdr (assoc 'system apps))))
10001 (in-emacs (setq cmd 'emacs))
10002 (t
10003 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10004 (and dirp (cdr (assoc 'directory apps)))
10005 ; first, try matching against apps-dlink
10006 ; if we get a match here, store the match data for later
10007 (let ((match (assoc-default dlink apps-dlink
10008 'string-match)))
10009 (if match
10010 (progn (setq link-match-data (match-data))
10011 match)
10012 (progn (setq in-emacs (or in-emacs line search))
10013 nil))) ; if we have no match in apps-dlink,
10014 ; always open the file in emacs if line or search
10015 ; is given (for backwards compatibility)
10016 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10017 'string-match)
10018 (cdr (assoc ext apps))
10019 (cdr (assoc t apps))))))
10020 (when (eq cmd 'system)
10021 (setq cmd (cdr (assoc 'system apps))))
10022 (when (eq cmd 'default)
10023 (setq cmd (cdr (assoc t apps))))
10024 (when (eq cmd 'mailcap)
10025 (require 'mailcap)
10026 (mailcap-parse-mailcaps)
10027 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10028 (command (mailcap-mime-info mime-type)))
10029 (if (stringp command)
10030 (setq cmd command)
10031 (setq cmd 'emacs))))
10032 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10033 (not (file-exists-p file))
10034 (not org-open-non-existing-files))
10035 (error "No such file: %s" file))
10036 (cond
10038 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10040 (setq cmd (replace-match "%s" t t cmd)))
10041 (while (string-match "%s" cmd)
10042 (setq cmd (replace-match
10043 (save-match-data
10044 (shell-quote-argument
10045 (convert-standard-filename file)))
10046 t t cmd)))
10048 ;; Replace "%1", "%2" etc. in command with group matches from regex
10049 (save-match-data
10050 (let ((match-index 1)
10051 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10052 (set-match-data link-match-data)
10053 (while (<= match-index number-of-groups)
10054 (let ((regex (concat "%" (number-to-string match-index)))
10055 (replace-with (match-string match-index dlink)))
10056 (while (string-match regex cmd)
10057 (setq cmd (replace-match replace-with t t cmd))))
10058 (setq match-index (+ match-index 1)))))
10060 (save-window-excursion
10061 (start-process-shell-command cmd nil cmd)
10062 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10063 ))
10064 ((or (stringp cmd)
10065 (eq cmd 'emacs))
10066 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10067 (widen)
10068 (if line (org-goto-line line)
10069 (if search (org-link-search search))))
10070 ((consp cmd)
10071 (let ((file (convert-standard-filename file)))
10072 (save-match-data
10073 (set-match-data link-match-data)
10074 (eval cmd))))
10075 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10076 (and (org-mode-p) (eq old-mode 'org-mode)
10077 (or (not (equal old-buffer (current-buffer)))
10078 (not (equal old-pos (point))))
10079 (org-mark-ring-push old-pos old-buffer))))
10081 (defun org-file-apps-entry-match-against-dlink-p (entry)
10082 "This function returns non-nil if `entry' uses a regular
10083 expression which should be matched against the whole link by
10084 org-open-file.
10086 It assumes that is the case when the entry uses a regular
10087 expression which has at least one grouping construct and the
10088 action is either a lisp form or a command string containing
10089 '%1', i.e. using at least one subexpression match as a
10090 parameter."
10091 (let ((selector (car entry))
10092 (action (cdr entry)))
10093 (if (stringp selector)
10094 (and (> (regexp-opt-depth selector) 0)
10095 (or (and (stringp action)
10096 (string-match "%[0-9]" action))
10097 (consp action)))
10098 nil)))
10100 (defun org-default-apps ()
10101 "Return the default applications for this operating system."
10102 (cond
10103 ((eq system-type 'darwin)
10104 org-file-apps-defaults-macosx)
10105 ((eq system-type 'windows-nt)
10106 org-file-apps-defaults-windowsnt)
10107 (t org-file-apps-defaults-gnu)))
10109 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10110 "Convert extensions to regular expressions in the cars of LIST.
10111 Also, weed out any non-string entries, because the return value is used
10112 only for regexp matching.
10113 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10114 point to the symbol `emacs', indicating that the file should
10115 be opened in Emacs."
10116 (append
10117 (delq nil
10118 (mapcar (lambda (x)
10119 (if (not (stringp (car x)))
10120 nil
10122 x
10124 list))
10125 (if add-auto-mode
10126 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10128 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10129 (defun org-file-remote-p (file)
10130 "Test whether FILE specifies a location on a remote system.
10131 Return non-nil if the location is indeed remote.
10135 (cond ((fboundp 'file-remote-p)
10136 (file-remote-p file))
10137 ((fboundp 'tramp-handle-file-remote-p)
10138 (tramp-handle-file-remote-p file))
10139 ((and (boundp 'ange-ftp-name-format)
10140 (string-match (car ange-ftp-name-format) file))
10141 t)
10142 (t nil)))
10145 ;;;; Refiling
10147 (defun org-get-org-file ()
10148 "Read a filename, with default directory `org-directory'."
10149 (let ((default (or org-default-notes-file remember-data-file)))
10150 (read-file-name (format "File name [%s]: " default)
10151 (file-name-as-directory org-directory)
10152 default)))
10154 (defun org-notes-order-reversed-p ()
10155 "Check if the current file should receive notes in reversed order."
10156 (cond
10157 ((not org-reverse-note-order) nil)
10158 ((eq t org-reverse-note-order) t)
10159 ((not (listp org-reverse-note-order)) nil)
10160 (t (catch 'exit
10161 (let ((all org-reverse-note-order)
10162 entry)
10163 (while (setq entry (pop all))
10164 (if (string-match (car entry) buffer-file-name)
10165 (throw 'exit (cdr entry))))
10166 nil)))))
10168 (defvar org-refile-target-table nil
10169 "The list of refile targets, created by `org-refile'.")
10171 (defvar org-agenda-new-buffers nil
10172 "Buffers created to visit agenda files.")
10174 (defvar org-refile-cache nil
10175 "Cache for refile targets.")
10177 (defvar org-refile-markers nil
10178 "All the markers used for caching refile locations.")
10180 (defun org-refile-marker (pos)
10181 "Get a new refile marker, but only if caching is in use."
10182 (if (not org-refile-use-cache)
10183 pos
10184 (let ((m (make-marker)))
10185 (move-marker m pos)
10186 (push m org-refile-markers)
10187 m)))
10189 (defun org-refile-cache-clear ()
10190 "Clear the refile cache and disable all the markers."
10191 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10192 (setq org-refile-markers nil)
10193 (setq org-refile-cache nil)
10194 (message "Refile cache has been cleared"))
10196 (defun org-refile-cache-check-set (set)
10197 "Check if all the markers in the cache still have live buffers."
10198 (let (marker)
10199 (catch 'exit
10200 (while (and set (setq marker (nth 3 (pop set))))
10201 ;; if org-refile-use-outline-path is 'file, marker may be nil
10202 (when (and marker (null (marker-buffer marker)))
10203 (message "not found") (sit-for 3)
10204 (throw 'exit nil)))
10205 t)))
10207 (defun org-refile-cache-put (set &rest identifiers)
10208 "Push the refile targets SET into the cache, under IDENTIFIERS."
10209 (let* ((key (sha1 (prin1-to-string identifiers)))
10210 (entry (assoc key org-refile-cache)))
10211 (if entry
10212 (setcdr entry set)
10213 (push (cons key set) org-refile-cache))))
10215 (defun org-refile-cache-get (&rest identifiers)
10216 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10217 (cond
10218 ((not org-refile-cache) nil)
10219 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10220 (t
10221 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10222 org-refile-cache))))
10223 (and set (org-refile-cache-check-set set) set)))))
10225 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10226 "Produce a table with refile targets."
10227 (let ((case-fold-search nil)
10228 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10229 (entries (or org-refile-targets '((nil . (:level . 1)))))
10230 targets tgs txt re files f desc descre fast-path-p level pos0)
10231 (message "Getting targets...")
10232 (with-current-buffer (or default-buffer (current-buffer))
10233 (while (setq entry (pop entries))
10234 (setq files (car entry) desc (cdr entry))
10235 (setq fast-path-p nil)
10236 (cond
10237 ((null files) (setq files (list (current-buffer))))
10238 ((eq files 'org-agenda-files)
10239 (setq files (org-agenda-files 'unrestricted)))
10240 ((and (symbolp files) (fboundp files))
10241 (setq files (funcall files)))
10242 ((and (symbolp files) (boundp files))
10243 (setq files (symbol-value files))))
10244 (if (stringp files) (setq files (list files)))
10245 (cond
10246 ((eq (car desc) :tag)
10248 ((eq (car desc) :todo)
10250 ((eq (car desc) :regexp)
10251 (setq descre (cdr desc)))
10252 ((eq (car desc) :level)
10254 (if org-odd-levels-only
10255 (1- (* 2 (cdr desc)))
10256 (cdr desc)))
10258 ((eq (car desc) :maxlevel)
10259 (setq fast-path-p t)
10261 (if org-odd-levels-only
10262 (1- (* 2 (cdr desc)))
10263 (cdr desc)))
10265 (t (error "Bad refiling target description %s" desc)))
10266 (while (setq f (pop files))
10267 (with-current-buffer
10268 (if (bufferp f) f (org-get-agenda-file-buffer f))
10269 (or
10270 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10271 (progn
10272 (if (bufferp f) (setq f (buffer-file-name
10273 (buffer-base-buffer f))))
10274 (setq f (and f (expand-file-name f)))
10275 (if (eq org-refile-use-outline-path 'file)
10276 (push (list (file-name-nondirectory f) f nil nil) tgs))
10277 (save-excursion
10278 (save-restriction
10279 (widen)
10280 (goto-char (point-min))
10281 (while (re-search-forward descre nil t)
10282 (goto-char (setq pos0 (point-at-bol)))
10283 (catch 'next
10284 (when org-refile-target-verify-function
10285 (save-match-data
10286 (or (funcall org-refile-target-verify-function)
10287 (throw 'next t))))
10288 (when (and (looking-at org-complex-heading-regexp)
10289 (not (member (match-string 4) excluded-entries)))
10290 (setq level (org-reduced-level
10291 (- (match-end 1) (match-beginning 1)))
10292 txt (org-link-display-format (match-string 4))
10294 re (format org-complex-heading-regexp-format
10295 (regexp-quote (match-string 4))))
10296 (when org-refile-use-outline-path
10297 (setq txt (mapconcat
10298 'org-protect-slash
10299 (append
10300 (if (eq org-refile-use-outline-path
10301 'file)
10302 (list (file-name-nondirectory
10303 (buffer-file-name
10304 (buffer-base-buffer))))
10305 (if (eq org-refile-use-outline-path
10306 'full-file-path)
10307 (list (buffer-file-name
10308 (buffer-base-buffer)))))
10309 (org-get-outline-path fast-path-p
10310 level txt)
10311 (list txt))
10312 "/")))
10313 (push (list txt f re (org-refile-marker (point)))
10314 tgs)))
10315 (when (= (point) pos0)
10316 ;; verification function has not moved point
10317 (goto-char (point-at-eol))))))))
10318 (when org-refile-use-cache
10319 (org-refile-cache-put tgs (buffer-file-name) descre))
10320 (setq targets (append tgs targets))
10321 ))))
10322 (message "Getting targets...done")
10323 (nreverse targets)))
10325 (defun org-protect-slash (s)
10326 (while (string-match "/" s)
10328 s)
10330 (defvar org-olpa (make-vector 20 nil))
10332 (defun org-get-outline-path (&optional fastp level heading)
10333 "Return the outline path to the current entry, as a list.
10335 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10336 routine which makes outline path derivations for an entire file,
10337 avoiding backtracing. Refile target collection makes use of that."
10338 (if fastp
10339 (progn
10340 (if (> level 19)
10341 (error "Outline path failure, more than 19 levels"))
10342 (loop for i from level upto 19 do
10343 (aset org-olpa i nil))
10344 (prog1
10345 (delq nil (append org-olpa nil))
10346 (aset org-olpa level heading)))
10347 (let (rtn case-fold-search)
10348 (save-excursion
10349 (save-restriction
10350 (widen)
10351 (while (org-up-heading-safe)
10352 (when (looking-at org-complex-heading-regexp)
10353 (push (org-match-string-no-properties 4) rtn)))
10354 rtn)))))
10356 (defun org-format-outline-path (path &optional width prefix)
10357 "Format the outline path PATH for display.
10358 Width is the maximum number of characters that is available.
10359 Prefix is a prefix to be included in the returned string,
10360 such as the file name."
10361 (setq width (or width 79))
10362 (if prefix (setq width (- width (length prefix))))
10363 (if (not path)
10364 (or prefix "")
10365 (let* ((nsteps (length path))
10366 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10367 (maxwidth (if (<= total-width width)
10368 10000 ;; everything fits
10369 ;; we need to shorten the level headings
10370 (/ (- width nsteps) nsteps)))
10371 (org-odd-levels-only nil)
10372 (n 0)
10373 (total (1+ (length prefix))))
10374 (setq maxwidth (max maxwidth 10))
10375 (concat prefix
10376 (mapconcat
10377 (lambda (h)
10378 (setq n (1+ n))
10379 (if (and (= n nsteps) (< maxwidth 10000))
10380 (setq maxwidth (- total-width total)))
10381 (if (< (length h) maxwidth)
10382 (progn (setq total (+ total (length h) 1)) h)
10383 (setq h (substring h 0 (- maxwidth 2))
10384 total (+ total maxwidth 1))
10386 (setq h (substring h 0 (match-beginning 0))))
10387 (setq h (concat h "..")))
10388 (org-add-props h nil 'face
10389 (nth (% (1- n) org-n-level-faces)
10390 org-level-faces))
10391 h)
10392 path "/")))))
10394 (defun org-display-outline-path (&optional file current)
10395 "Display the current outline path in the echo area."
10396 (interactive "P")
10397 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10398 (case-fold-search nil)
10399 (path (and (org-mode-p) (org-get-outline-path))))
10400 (if current (setq path (append path
10401 (save-excursion
10402 (org-back-to-heading t)
10403 (if (looking-at org-complex-heading-regexp)
10404 (list (match-string 4)))))))
10405 (message "%s"
10406 (org-format-outline-path
10407 path
10408 (1- (frame-width))
10409 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10411 (defvar org-refile-history nil
10412 "History for refiling operations.")
10414 (defvar org-after-refile-insert-hook nil
10415 "Hook run after `org-refile' has inserted its stuff at the new location.
10416 Note that this is still *before* the stuff will be removed from
10417 the *old* location.")
10419 (defvar org-capture-last-stored-marker)
10420 (defun org-refile (&optional goto default-buffer rfloc)
10421 "Move the entry or entries at point to another heading.
10422 The list of target headings is compiled using the information in
10423 `org-refile-targets', which see.
10425 At the target location, the entry is filed as a subitem of the target
10426 heading. Depending on `org-reverse-note-order', the new subitem will
10427 either be the first or the last subitem.
10429 If there is an active region, all entries in that region will be moved.
10430 However, the region must fulfill the requirement that the first heading
10431 is the first one sets the top-level of the moved text - at most siblings
10432 below it are allowed.
10434 With prefix arg GOTO, the command will only visit the target location
10435 and not actually move anything.
10438 go to the location where the last refiling operation has put the subtree.
10439 With a prefix argument of `2', refile to the running clock.
10441 RFLOC can be a refile location obtained in a different way.
10443 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10445 If you are using target caching (see `org-refile-use-cache'),
10446 You have to clear the target cache in order to find new targets.
10447 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10448 prefix argument (`C-u C-u C-u C-c C-w')."
10450 (interactive "P")
10451 (if (member goto '(0 (64)))
10452 (org-refile-cache-clear)
10453 (let* ((cbuf (current-buffer))
10454 (regionp (org-region-active-p))
10455 (region-start (and regionp (region-beginning)))
10456 (region-end (and regionp (region-end)))
10457 (region-length (and regionp (- region-end region-start)))
10458 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10459 pos it nbuf file re level reversed)
10460 (setq last-command nil)
10461 (when regionp
10462 (goto-char region-start)
10463 (or (bolp) (goto-char (point-at-bol)))
10464 (setq region-start (point))
10465 (unless (or (org-kill-is-subtree-p
10466 (buffer-substring region-start region-end))
10467 (prog1 org-refile-active-region-within-subtree
10468 (org-toggle-heading)))
10469 (error "The region is not a (sequence of) subtree(s)")))
10470 (if (equal goto '(16))
10471 (org-refile-goto-last-stored)
10472 (when (or
10473 (and (equal goto 2)
10474 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10475 (prog1
10476 (setq it (list (or org-clock-heading "running clock")
10477 (buffer-file-name
10478 (marker-buffer org-clock-hd-marker))
10479 ""
10480 (marker-position org-clock-hd-marker)))
10481 (setq goto nil)))
10482 (setq it (or rfloc
10483 (save-excursion
10484 (org-back-to-heading t)
10485 (org-refile-get-location
10486 (cond (goto "Goto")
10487 (regionp "Refile region to")
10488 (t "Refile subtree to")) default-buffer
10489 org-refile-allow-creating-parent-nodes)))))
10490 (setq file (nth 1 it)
10491 re (nth 2 it)
10492 pos (nth 3 it))
10493 (if (and (not goto)
10494 pos
10495 (equal (buffer-file-name) file)
10496 (if regionp
10497 (and (>= pos region-start)
10498 (<= pos region-end))
10499 (and (>= pos (point))
10500 (< pos (save-excursion
10501 (org-end-of-subtree t t))))))
10502 (error "Cannot refile to position inside the tree or region"))
10504 (setq nbuf (or (find-buffer-visiting file)
10505 (find-file-noselect file)))
10506 (if goto
10507 (progn
10508 (org-pop-to-buffer-same-window nbuf)
10509 (goto-char pos)
10510 (org-show-context 'org-goto))
10511 (if regionp
10512 (progn
10513 (org-kill-new (buffer-substring region-start region-end))
10514 (org-save-markers-in-region region-start region-end))
10515 (org-copy-subtree 1 nil t))
10516 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10517 (find-file-noselect file)))
10518 (setq reversed (org-notes-order-reversed-p))
10519 (save-excursion
10520 (save-restriction
10521 (widen)
10522 (if pos
10523 (progn
10524 (goto-char pos)
10525 (looking-at org-outline-regexp)
10526 (setq level (org-get-valid-level (funcall outline-level) 1))
10527 (goto-char
10528 (if reversed
10529 (or (outline-next-heading) (point-max))
10530 (or (save-excursion (org-get-next-sibling))
10531 (org-end-of-subtree t t)
10532 (point-max)))))
10533 (setq level 1)
10534 (if (not reversed)
10535 (goto-char (point-max))
10536 (goto-char (point-min))
10537 (or (outline-next-heading) (goto-char (point-max)))))
10538 (if (not (bolp)) (newline))
10539 (org-paste-subtree level)
10540 (when org-log-refile
10541 (org-add-log-setup 'refile nil nil 'findpos
10542 org-log-refile)
10543 (unless (eq org-log-refile 'note)
10544 (save-excursion (org-add-log-note))))
10545 (and org-auto-align-tags (org-set-tags nil t))
10546 (bookmark-set "org-refile-last-stored")
10547 ;; If we are refiling for capture, make sure that the
10548 ;; last-capture pointers point here
10549 (when (org-bound-and-true-p org-refile-for-capture)
10550 (bookmark-set "org-capture-last-stored-marker")
10551 (move-marker org-capture-last-stored-marker (point)))
10552 (if (fboundp 'deactivate-mark) (deactivate-mark))
10553 (run-hooks 'org-after-refile-insert-hook))))
10554 (if regionp
10555 (delete-region (point) (+ (point) region-length))
10556 (org-cut-subtree))
10557 (when (featurep 'org-inlinetask)
10558 (org-inlinetask-remove-END-maybe))
10559 (setq org-markers-to-move nil)
10562 (defun org-refile-goto-last-stored ()
10563 "Go to the location where the last refile was stored."
10564 (interactive)
10565 (bookmark-jump "org-refile-last-stored")
10566 (message "This is the location of the last refile"))
10568 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10569 "Prompt the user for a refile location, using PROMPT.
10570 PROMPT should not be suffixed with a colon and a space, because
10571 this function appends the default value from
10572 `org-refile-history' automatically, if that is not empty."
10573 (let ((org-refile-targets org-refile-targets)
10574 (org-refile-use-outline-path org-refile-use-outline-path)
10575 excluded-entries)
10576 (when (and (eq major-mode 'org-mode)
10577 (not org-refile-use-cache))
10578 (org-map-tree
10579 (lambda()
10580 (setq excluded-entries
10581 (append excluded-entries (list (org-get-heading t t)))))))
10582 (setq org-refile-target-table
10583 (org-refile-get-targets default-buffer excluded-entries)))
10584 (unless org-refile-target-table
10585 (error "No refile targets"))
10586 (let* ((prompt (concat prompt
10587 (and (car org-refile-history)
10588 (concat " (default " (car org-refile-history) ")"))
10589 ": "))
10590 (cbuf (current-buffer))
10591 (partial-completion-mode nil)
10592 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10593 (cfunc (if (and org-refile-use-outline-path
10594 org-outline-path-complete-in-steps)
10595 'org-olpath-completing-read
10596 'org-icompleting-read))
10597 (extra (if org-refile-use-outline-path "/" ""))
10598 (filename (and cfn (expand-file-name cfn)))
10599 (tbl (mapcar
10600 (lambda (x)
10601 (if (and (not (member org-refile-use-outline-path
10602 '(file full-file-path)))
10603 (not (equal filename (nth 1 x))))
10604 (cons (concat (car x) extra " ("
10605 (file-name-nondirectory (nth 1 x)) ")")
10606 (cdr x))
10607 (cons (concat (car x) extra) (cdr x))))
10608 org-refile-target-table))
10609 (completion-ignore-case t)
10610 pa answ parent-target child parent old-hist)
10611 (setq old-hist org-refile-history)
10612 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10613 nil 'org-refile-history (car org-refile-history)))
10614 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10615 (org-refile-check-position pa)
10616 (if pa
10617 (progn
10618 (when (or (not org-refile-history)
10619 (not (eq old-hist org-refile-history))
10620 (not (equal (car pa) (car org-refile-history))))
10621 (setq org-refile-history
10622 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10623 org-refile-history
10624 (cdr org-refile-history))))
10625 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10626 (pop org-refile-history)))
10627 pa)
10629 (progn
10630 (setq parent (match-string 1 answ)
10631 child (match-string 2 answ))
10632 (setq parent-target (or (assoc parent tbl)
10633 (assoc (concat parent "/") tbl)))
10634 (when (and parent-target
10635 (or (eq new-nodes t)
10636 (and (eq new-nodes 'confirm)
10638 child)))))
10639 (org-refile-new-child parent-target child)))
10640 (error "Invalid target location")))))
10642 (defun org-refile-check-position (refile-pointer)
10643 "Check if the refile pointer matches the readline to which it points."
10644 (let* ((file (nth 1 refile-pointer))
10645 (re (nth 2 refile-pointer))
10646 (pos (nth 3 refile-pointer))
10647 buffer)
10648 (when (org-string-nw-p re)
10649 (setq buffer (if (markerp pos)
10650 (marker-buffer pos)
10651 (or (find-buffer-visiting file)
10652 (find-file-noselect file))))
10653 (with-current-buffer buffer
10654 (save-excursion
10655 (save-restriction
10656 (widen)
10657 (goto-char pos)
10658 (beginning-of-line 1)
10659 (unless (org-looking-at-p re)
10660 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10662 (defun org-refile-new-child (parent-target child)
10663 "Use refile target PARENT-TARGET to add new CHILD below it."
10664 (unless parent-target
10665 (error "Cannot find parent for new node"))
10666 (let ((file (nth 1 parent-target))
10667 (pos (nth 3 parent-target))
10668 level)
10669 (with-current-buffer (or (find-buffer-visiting file)
10670 (find-file-noselect file))
10671 (save-excursion
10672 (save-restriction
10673 (widen)
10674 (if pos
10675 (goto-char pos)
10676 (goto-char (point-max))
10677 (if (not (bolp)) (newline)))
10678 (when (looking-at org-outline-regexp)
10679 (setq level (funcall outline-level))
10680 (org-end-of-subtree t t))
10681 (org-back-over-empty-lines)
10683 (if pos (org-get-valid-level level 1) 1) ?*)
10685 (beginning-of-line 0)
10686 (list (concat (car parent-target) "/" child) file "" (point)))))))
10688 (defun org-olpath-completing-read (prompt collection &rest args)
10689 "Read an outline path like a file name."
10690 (let ((thetable collection)
10691 (org-completion-use-ido nil) ; does not work with ido.
10692 (org-completion-use-iswitchb nil)) ; or iswitchb
10693 (apply
10694 'org-icompleting-read prompt
10695 (lambda (string predicate &optional flag)
10696 (let (rtn r f (l (length string)))
10697 (cond
10698 ((eq flag nil)
10699 ;; try completion
10700 (try-completion string thetable))
10701 ((eq flag t)
10702 ;; all-completions
10703 (setq rtn (all-completions string thetable predicate))
10704 (mapcar
10705 (lambda (x)
10706 (setq r (substring x l))
10707 (if (string-match " ([^)]*)$" x)
10708 (setq f (match-string 0 x))
10709 (setq f ""))
10710 (if (string-match "/" r)
10711 (concat string (substring r 0 (match-end 0)) f)
10712 x))
10713 rtn))
10714 ((eq flag 'lambda)
10715 ;; exact match?
10716 (assoc string thetable)))
10717 ))
10718 args)))
10720 ;;;; Dynamic blocks
10722 (defun org-find-dblock (name)
10723 "Find the first dynamic block with name NAME in the buffer.
10724 If not found, stay at current position and return nil."
10725 (let (pos)
10726 (save-excursion
10727 (goto-char (point-min))
10729 nil t)
10730 (match-beginning 0))))
10731 (if pos (goto-char pos))
10732 pos))
10734 (defconst org-dblock-start-re
10736 "Matches the start line of a dynamic block, with parameters.")
10739 "Matches the end of a dynamic block.")
10741 (defun org-create-dblock (plist)
10742 "Create a dynamic block section, with parameters taken from PLIST.
10743 PLIST must contain a :name entry which is used as name of the block."
10745 (end-of-line 1)
10746 (newline))
10747 (let ((col (current-column))
10748 (name (plist-get plist :name)))
10749 (insert "#+BEGIN: " name)
10750 (while plist
10751 (if (eq (car plist) :name)
10752 (setq plist (cddr plist))
10753 (insert " " (prin1-to-string (pop plist)))))
10755 (beginning-of-line -2)))
10757 (defun org-prepare-dblock ()
10758 "Prepare dynamic block for refresh.
10759 This empties the block, puts the cursor at the insert position and returns
10760 the property list including an extra property :name with the block name."
10761 (unless (looking-at org-dblock-start-re)
10762 (error "Not at a dynamic block"))
10763 (let* ((begdel (1+ (match-end 0)))
10764 (name (org-no-properties (match-string 1)))
10765 (params (append (list :name name)
10766 (read (concat "(" (match-string 3) ")")))))
10767 (save-excursion
10768 (beginning-of-line 1)
10770 (setq params (plist-put params :indentation-column (current-column))))
10771 (unless (re-search-forward org-dblock-end-re nil t)
10772 (error "Dynamic block not terminated"))
10773 (setq params
10774 (append params
10775 (list :content (buffer-substring
10776 begdel (match-beginning 0)))))
10777 (delete-region begdel (match-beginning 0))
10778 (goto-char begdel)
10779 (open-line 1)
10780 params))
10782 (defun org-map-dblocks (&optional command)
10783 "Apply COMMAND to all dynamic blocks in the current buffer.
10784 If COMMAND is not given, use `org-update-dblock'."
10785 (let ((cmd (or command 'org-update-dblock)))
10786 (save-excursion
10787 (goto-char (point-min))
10788 (while (re-search-forward org-dblock-start-re nil t)
10789 (goto-char (match-beginning 0))
10790 (save-excursion
10791 (condition-case nil
10792 (funcall cmd)
10793 (error (message "Error during update of dynamic block"))))
10794 (unless (re-search-forward org-dblock-end-re nil t)
10795 (error "Dynamic block not terminated"))))))
10797 (defun org-dblock-update (&optional arg)
10798 "User command for updating dynamic blocks.
10799 Update the dynamic block at point. With prefix ARG, update all dynamic
10800 blocks in the buffer."
10801 (interactive "P")
10802 (if arg
10803 (org-update-all-dblocks)
10804 (or (looking-at org-dblock-start-re)
10805 (org-beginning-of-dblock))
10806 (org-update-dblock)))
10808 (defun org-update-dblock ()
10809 "Update the dynamic block at point.
10810 This means to empty the block, parse for parameters and then call
10811 the correct writing function."
10812 (interactive)
10813 (save-window-excursion
10814 (let* ((pos (point))
10815 (line (org-current-line))
10816 (params (org-prepare-dblock))
10817 (name (plist-get params :name))
10818 (indent (plist-get params :indentation-column))
10819 (cmd (intern (concat "org-dblock-write:" name))))
10820 (message "Updating dynamic block `%s' at line %d..." name line)
10821 (funcall cmd params)
10822 (message "Updating dynamic block `%s' at line %d...done" name line)
10823 (goto-char pos)
10824 (when (and indent (> indent 0))
10825 (setq indent (make-string indent ?\ ))
10826 (save-excursion
10827 (org-beginning-of-dblock)
10828 (forward-line 1)
10829 (while (not (looking-at org-dblock-end-re))
10830 (insert indent)
10831 (beginning-of-line 2))
10832 (when (looking-at org-dblock-end-re)
10834 (replace-match ""))
10835 (insert indent)))))))
10837 (defun org-beginning-of-dblock ()
10838 "Find the beginning of the dynamic block at point.
10839 Error if there is no such block at point."
10840 (let ((pos (point))
10841 beg)
10842 (end-of-line 1)
10843 (if (and (re-search-backward org-dblock-start-re nil t)
10844 (setq beg (match-beginning 0))
10845 (re-search-forward org-dblock-end-re nil t)
10846 (> (match-end 0) pos))
10847 (goto-char beg)
10848 (goto-char pos)
10849 (error "Not in a dynamic block"))))
10851 (defun org-update-all-dblocks ()
10852 "Update all dynamic blocks in the buffer.
10853 This function can be used in a hook."
10854 (interactive)
10855 (when (org-mode-p)
10856 (org-map-dblocks 'org-update-dblock)))
10859 ;;;; Completion
10861 (defconst org-additional-option-like-keywords
10862 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10863 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10864 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10865 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10866 "BEGIN:" "END:"
10867 "ORGTBL" "TBLFM:" "TBLNAME:"
10868 "BEGIN_EXAMPLE" "END_EXAMPLE"
10869 "BEGIN_QUOTE" "END_QUOTE"
10870 "BEGIN_VERSE" "END_VERSE"
10871 "BEGIN_CENTER" "END_CENTER"
10872 "BEGIN_SRC" "END_SRC"
10873 "BEGIN_RESULT" "END_RESULT"
10874 "SOURCE:" "SRCNAME:" "FUNCTION:"
10875 "RESULTS:" "DATA:"
10876 "HEADER:" "HEADERS:"
10877 "BABEL:"
10878 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10879 "CAPTION:" "LABEL:"
10880 "SETUPFILE:"
10881 "INCLUDE:"
10882 "BIND:"
10883 "MACRO:"))
10885 (defcustom org-structure-template-alist
10886 '(
10899 ("L" "#+latex: "
10903 ("H" "#+html: "
10906 ("A" "#+ascii: ")
10907 ("i" "#+index: ?"
10908 "#+index: ?")
10909 ("I" "#+include %file ?"
10911 )
10912 "Structure completion elements.
10913 This is a list of abbreviation keys and values. The value gets inserted
10914 if you type `<' followed by the key and then press the completion key,
10915 usually `M-TAB'. %file will be replaced by a file name after prompting
10916 for the file using completion. The cursor will be placed at the position
10917 of the `?` in the template.
10918 There are two templates for each key, the first uses the original Org syntax,
10919 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10920 the default when the /org-mtags.el/ module has been loaded. See also the
10921 variable `org-mtags-prefer-muse-templates'.
10922 This is an experimental feature, it is undecided if it is going to stay in."
10923 :group 'org-completion
10924 :type '(repeat
10925 (string :tag "Key")
10926 (string :tag "Template")
10927 (string :tag "Muse Template")))
10929 (defun org-try-structure-completion ()
10930 "Try to complete a structure template before point.
10932 expands them."
10933 (let ((l (buffer-substring (point-at-bol) (point)))
10934 a)
10937 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10938 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10939 (match-beginning 1)) a)
10940 t)))
10942 (defun org-complete-expand-structure-template (start cell)
10943 "Expand a structure template."
10944 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10945 (rpl (nth (if musep 2 1) cell))
10946 (ind ""))
10947 (delete-region start (point))
10949 (cond
10950 ((bolp))
10952 (setq ind (buffer-substring (point-at-bol) (point))))
10953 (t (newline))))
10954 (setq start (point))
10955 (if (string-match "%file" rpl)
10956 (setq rpl (replace-match
10957 (concat
10959 (save-match-data
10960 (abbreviate-file-name (read-file-name "Include file: ")))
10962 t t rpl)))
10965 (insert rpl)
10968 ;;;; TODO, DEADLINE, Comments
10970 (defun org-toggle-comment ()
10971 "Change the COMMENT state of an entry."
10972 (interactive)
10973 (save-excursion
10974 (org-back-to-heading)
10975 (let (case-fold-search)
10976 (if (looking-at (concat org-outline-regexp
10978 (replace-match "" t t nil 1)
10979 (if (looking-at org-outline-regexp)
10980 (progn
10981 (goto-char (match-end 0))
10982 (insert org-comment-string " ")))))))
10984 (defvar org-last-todo-state-is-todo nil
10985 "This is non-nil when the last TODO state change led to a TODO state.
10986 If the last change removed the TODO tag or switched to DONE, then
10987 this is nil.")
10989 (defvar org-setting-tags nil) ; dynamically skipped
10991 (defvar org-todo-setup-filter-hook nil
10992 "Hook for functions that pre-filter todo specs.
10993 Each function takes a todo spec and returns either nil or the spec
10994 transformed into canonical form." )
10996 (defvar org-todo-get-default-hook nil
10997 "Hook for functions that get a default item for todo.
10998 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10999 nil or a string to be used for the todo mark." )
11001 (defvar org-agenda-headline-snapshot-before-repeat)
11003 (defun org-current-effective-time ()
11004 "Return current time adjusted for `org-extend-today-until' variable"
11005 (let* ((ct (org-current-time))
11006 (dct (decode-time ct))
11007 (ct1
11008 (if (and org-use-effective-time
11009 (< (nth 2 dct) org-extend-today-until))
11010 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11011 ct)))
11012 ct1))
11014 (defun org-todo-yesterday (&optional arg)
11015 "Like `org-todo' but the time of change will be 23:59 of yesterday"
11016 (interactive "P")
11017 (let* ((hour (third (decode-time
11018 (org-current-time))))
11019 (org-extend-today-until (1+ hour)))
11020 (org-todo arg)))
11022 (defun org-todo (&optional arg)
11023 "Change the TODO state of an item.
11024 The state of an item is given by a keyword at the start of the heading,
11025 like
11026 *** TODO Write paper
11027 *** DONE Call mom
11029 The different keywords are specified in the variable `org-todo-keywords'.
11031 So for this example: when the item starts with TODO, it is changed to DONE.
11032 When it starts with DONE, the DONE is removed. And when neither TODO nor
11033 DONE are present, add TODO at the beginning of the heading.
11036 state.
11037 With numeric prefix arg, switch to that state.
11039 keywords (nextset).
11042 For calling through lisp, arg is also interpreted in the following way:
11043 'none -> empty state
11045 'done -> switch to DONE
11046 'nextset -> switch to the next set of keywords
11047 'previousset -> switch to the previous set of keywords
11049 really is a member of `org-todo-keywords'."
11050 (interactive "P")
11051 (if (equal arg '(16)) (setq arg 'nextset))
11052 (let ((org-blocker-hook org-blocker-hook)
11053 (case-fold-search nil))
11054 (when (equal arg '(64))
11055 (setq arg nil org-blocker-hook nil))
11056 (when (and org-blocker-hook
11057 (or org-inhibit-blocking
11058 (org-entry-get nil "NOBLOCKING")))
11059 (setq org-blocker-hook nil))
11060 (save-excursion
11061 (catch 'exit
11062 (org-back-to-heading t)
11063 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11065 (looking-at " *"))
11066 (let* ((match-data (match-data))
11067 (startpos (point-at-bol))
11068 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11069 (org-log-done org-log-done)
11070 (org-log-repeat org-log-repeat)
11071 (org-todo-log-states org-todo-log-states)
11072 (this (match-string 1))
11073 (hl-pos (match-beginning 0))
11074 (head (org-get-todo-sequence-head this))
11075 (ass (assoc head org-todo-kwd-alist))
11076 (interpret (nth 1 ass))
11077 (done-word (nth 3 ass))
11078 (final-done-word (nth 4 ass))
11079 (last-state (or this ""))
11080 (completion-ignore-case t)
11081 (member (member this org-todo-keywords-1))
11082 (tail (cdr member))
11083 (state (cond
11084 ((and org-todo-key-trigger
11085 (or (and (equal arg '(4))
11086 (eq org-use-fast-todo-selection 'prefix))
11087 (and (not arg) org-use-fast-todo-selection
11088 (not (eq org-use-fast-todo-selection
11089 'prefix)))))
11090 ;; Use fast selection
11091 (org-fast-todo-selection))
11092 ((and (equal arg '(4))
11093 (or (not org-use-fast-todo-selection)
11094 (not org-todo-key-trigger)))
11095 ;; Read a state with completion
11096 (org-icompleting-read
11097 "State: " (mapcar (lambda(x) (list x))
11098 org-todo-keywords-1)
11099 nil t))
11100 ((eq arg 'right)
11101 (if this
11102 (if tail (car tail) nil)
11103 (car org-todo-keywords-1)))
11104 ((eq arg 'left)
11105 (if (equal member org-todo-keywords-1)
11106 nil
11107 (if this
11108 (nth (- (length org-todo-keywords-1)
11109 (length tail) 2)
11110 org-todo-keywords-1)
11111 (org-last org-todo-keywords-1))))
11112 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11113 (setq arg nil))) ; hack to fall back to cycling
11114 (arg
11115 ;; user or caller requests a specific state
11116 (cond
11117 ((equal arg "") nil)
11118 ((eq arg 'none) nil)
11119 ((eq arg 'done) (or done-word (car org-done-keywords)))
11120 ((eq arg 'nextset)
11121 (or (car (cdr (member head org-todo-heads)))
11122 (car org-todo-heads)))
11123 ((eq arg 'previousset)
11124 (let ((org-todo-heads (reverse org-todo-heads)))
11125 (or (car (cdr (member head org-todo-heads)))
11126 (car org-todo-heads))))
11127 ((car (member arg org-todo-keywords-1)))
11128 ((stringp arg)
11129 (error "State `%s' not valid in this file" arg))
11130 ((nth (1- (prefix-numeric-value arg))
11131 org-todo-keywords-1))))
11132 ((null member) (or head (car org-todo-keywords-1)))
11133 ((equal this final-done-word) nil) ;; -> make empty
11134 ((null tail) nil) ;; -> first entry
11135 ((memq interpret '(type priority))
11136 (if (eq this-command last-command)
11137 (car tail)
11138 (if (> (length tail) 0)
11139 (or done-word (car org-done-keywords))
11140 nil)))
11141 (t
11142 (car tail))))
11143 (state (or
11144 (run-hook-with-args-until-success
11145 'org-todo-get-default-hook state last-state)
11146 state))
11147 (next (if state (concat " " state " ") " "))
11148 (change-plist (list :type 'todo-state-change :from this :to state
11149 :position startpos))
11150 dolog now-done-p)
11151 (when org-blocker-hook
11152 (setq org-last-todo-state-is-todo
11153 (not (member this org-done-keywords)))
11154 (unless (save-excursion
11155 (save-match-data
11156 (org-with-wide-buffer
11157 (run-hook-with-args-until-failure
11158 'org-blocker-hook change-plist))))
11159 (if (org-called-interactively-p 'interactive)
11160 (error "TODO state change from %s to %s blocked" this state)
11161 ;; fail silently
11162 (message "TODO state change from %s to %s blocked" this state)
11163 (throw 'exit nil))))
11164 (store-match-data match-data)
11165 (replace-match next t t)
11166 (unless (pos-visible-in-window-p hl-pos)
11167 (message "TODO state changed to %s" (org-trim next)))
11168 (unless head
11169 (setq head (org-get-todo-sequence-head state)
11170 ass (assoc head org-todo-kwd-alist)
11171 interpret (nth 1 ass)
11172 done-word (nth 3 ass)
11173 final-done-word (nth 4 ass)))
11174 (when (memq arg '(nextset previousset))
11175 (message "Keyword-Set %d/%d: %s"
11176 (- (length org-todo-sets) -1
11177 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11178 (length org-todo-sets)
11179 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11180 (setq org-last-todo-state-is-todo
11181 (not (member state org-done-keywords)))
11182 (setq now-done-p (and (member state org-done-keywords)
11183 (not (member this org-done-keywords))))
11184 (and logging (org-local-logging logging))
11185 (when (and (or org-todo-log-states org-log-done)
11186 (not (eq org-inhibit-logging t))
11187 (not (memq arg '(nextset previousset))))
11188 ;; we need to look at recording a time and note
11189 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11190 (nth 2 (assoc this org-todo-log-states))))
11191 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11192 (setq dolog 'time))
11193 (when (and state
11194 (member state org-not-done-keywords)
11195 (not (member this org-not-done-keywords)))
11196 ;; This is now a todo state and was not one before
11197 ;; If there was a CLOSED time stamp, get rid of it.
11198 (org-add-planning-info nil nil 'closed))
11199 (when (and now-done-p org-log-done)
11200 ;; It is now done, and it was not done before
11201 (org-add-planning-info 'closed (org-current-effective-time))
11202 (if (and (not dolog) (eq 'note org-log-done))
11203 (org-add-log-setup 'done state this 'findpos 'note)))
11204 (when (and state dolog)
11205 ;; This is a non-nil state, and we need to log it
11206 (org-add-log-setup 'state state this 'findpos dolog)))
11207 ;; Fixup tag positioning
11208 (org-todo-trigger-tag-changes state)
11209 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11210 (when org-provide-todo-statistics
11211 (org-update-parent-todo-statistics))
11212 (run-hooks 'org-after-todo-state-change-hook)
11213 (if (and arg (not (member state org-done-keywords)))
11214 (setq head (org-get-todo-sequence-head state)))
11215 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11216 ;; Do we need to trigger a repeat?
11217 (when now-done-p
11218 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11219 ;; This is for the agenda, take a snapshot of the headline.
11220 (save-match-data
11221 (setq org-agenda-headline-snapshot-before-repeat
11222 (org-get-heading))))
11223 (org-auto-repeat-maybe state))
11224 ;; Fixup cursor location if close to the keyword
11225 (if (and (outline-on-heading-p)
11226 (not (bolp))
11227 (save-excursion (beginning-of-line 1)
11228 (looking-at org-todo-line-regexp))
11229 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11230 (progn
11231 (goto-char (or (match-end 2) (match-end 1)))
11232 (and (looking-at " ") (just-one-space))))
11233 (when org-trigger-hook
11234 (save-excursion
11235 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11237 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11238 "Block turning an entry into a TODO, using the hierarchy.
11239 This checks whether the current task should be blocked from state
11240 changes. Such blocking occurs when:
11242 1. The task has children which are not all in a completed state.
11244 2. A task has a parent with the property :ORDERED:, and there
11245 are siblings prior to the current task with incomplete
11246 status.
11248 3. The parent of the task is blocked because it has siblings that should
11249 be done first, or is child of a block grandparent TODO entry."
11251 (if (not org-enforce-todo-dependencies)
11252 t ; if locally turned off don't block
11253 (catch 'dont-block
11254 ;; If this is not a todo state change, or if this entry is already DONE,
11255 ;; do not block
11256 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11257 (member (plist-get change-plist :from)
11258 (cons 'done org-done-keywords))
11259 (member (plist-get change-plist :to)
11260 (cons 'todo org-not-done-keywords))
11261 (not (plist-get change-plist :to)))
11262 (throw 'dont-block t))
11263 ;; If this task has children, and any are undone, it's blocked
11264 (save-excursion
11265 (org-back-to-heading t)
11266 (let ((this-level (funcall outline-level)))
11267 (outline-next-heading)
11268 (let ((child-level (funcall outline-level)))
11269 (while (and (not (eobp))
11270 (> child-level this-level))
11271 ;; this todo has children, check whether they are all
11272 ;; completed
11273 (if (and (not (org-entry-is-done-p))
11274 (org-entry-is-todo-p))
11275 (throw 'dont-block nil))
11276 (outline-next-heading)
11277 (setq child-level (funcall outline-level))))))
11278 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11279 ;; any previous siblings are undone, it's blocked
11280 (save-excursion
11281 (org-back-to-heading t)
11282 (let* ((pos (point))
11283 (parent-pos (and (org-up-heading-safe) (point))))
11284 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11285 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11286 (forward-line 1)
11287 (re-search-forward org-not-done-heading-regexp pos t))
11288 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11289 ;; Search further up the hierarchy, to see if an anchestor is blocked
11290 (while t
11291 (goto-char parent-pos)
11292 (if (not (looking-at org-not-done-heading-regexp))
11293 (throw 'dont-block t)) ; do not block, parent is not a TODO
11294 (setq pos (point))
11295 (setq parent-pos (and (org-up-heading-safe) (point)))
11296 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11297 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11298 (forward-line 1)
11299 (re-search-forward org-not-done-heading-regexp pos t))
11300 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11302 (defcustom org-track-ordered-property-with-tag nil
11303 "Should the ORDERED property also be shown as a tag?
11304 The ORDERED property decides if an entry should require subtasks to be
11305 completed in sequence. Since a property is not very visible, setting
11306 this option means that toggling the ORDERED property with the command
11307 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11308 not relevant for the behavior, but it makes things more visible.
11310 Note that toggling the tag with tags commands will not change the property
11311 and therefore not influence behavior!
11313 This can be t, meaning the tag ORDERED should be used, It can also be a
11314 string to select a different tag for this task."
11315 :group 'org-todo
11316 :type '(choice
11317 (const :tag "No tracking" nil)
11318 (const :tag "Track with ORDERED tag" t)
11319 (string :tag "Use other tag")))
11321 (defun org-toggle-ordered-property ()
11322 "Toggle the ORDERED property of the current entry.
11323 For better visibility, you can track the value of this property with a tag.
11324 See variable `org-track-ordered-property-with-tag'."
11325 (interactive)
11326 (let* ((t1 org-track-ordered-property-with-tag)
11327 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11328 (save-excursion
11329 (org-back-to-heading)
11330 (if (org-entry-get nil "ORDERED")
11331 (progn
11332 (org-delete-property "ORDERED")
11333 (and tag (org-toggle-tag tag 'off))
11334 (message "Subtasks can be completed in arbitrary order"))
11335 (org-entry-put nil "ORDERED" "t")
11336 (and tag (org-toggle-tag tag 'on))
11337 (message "Subtasks must be completed in sequence")))))
11339 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11340 (defun org-block-todo-from-checkboxes (change-plist)
11341 "Block turning an entry into a TODO, using checkboxes.
11342 This checks whether the current task should be blocked from state
11343 changes because there are unchecked boxes in this entry."
11344 (if (not org-enforce-todo-checkbox-dependencies)
11345 t ; if locally turned off don't block
11346 (catch 'dont-block
11347 ;; If this is not a todo state change, or if this entry is already DONE,
11348 ;; do not block
11349 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11350 (member (plist-get change-plist :from)
11351 (cons 'done org-done-keywords))
11352 (member (plist-get change-plist :to)
11353 (cons 'todo org-not-done-keywords))
11354 (not (plist-get change-plist :to)))
11355 (throw 'dont-block t))
11356 ;; If this task has checkboxes that are not checked, it's blocked
11357 (save-excursion
11358 (org-back-to-heading t)
11359 (let ((beg (point)) end)
11360 (outline-next-heading)
11361 (setq end (point))
11362 (goto-char beg)
11364 end t)
11365 (progn
11366 (if (boundp 'org-blocked-by-checkboxes)
11367 (setq org-blocked-by-checkboxes t))
11368 (throw 'dont-block nil)))))
11369 t))) ; do not block
11371 (defun org-entry-blocked-p ()
11372 "Is the current entry blocked?"
11373 (if (org-entry-get nil "NOBLOCKING")
11374 nil ;; Never block this entry
11375 (not
11376 (run-hook-with-args-until-failure
11377 'org-blocker-hook
11378 (list :type 'todo-state-change
11379 :position (point)
11380 :from 'todo
11381 :to 'done)))))
11383 (defun org-update-statistics-cookies (all)
11384 "Update the statistics cookie, either from TODO or from checkboxes.
11385 This should be called with the cursor in a line with a statistics cookie."
11386 (interactive "P")
11387 (if all
11388 (progn
11389 (org-update-checkbox-count 'all)
11390 (org-map-entries 'org-update-parent-todo-statistics))
11391 (if (not (org-on-heading-p))
11392 (org-update-checkbox-count)
11393 (let ((pos (move-marker (make-marker) (point)))
11394 end l1 l2)
11395 (ignore-errors (org-back-to-heading t))
11396 (if (not (org-on-heading-p))
11397 (org-update-checkbox-count)
11398 (setq l1 (org-outline-level))
11399 (setq end (save-excursion
11400 (outline-next-heading)
11401 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11402 (point)))
11403 (if (and (save-excursion
11404 (re-search-forward
11406 (not (save-excursion (re-search-forward
11408 (org-update-checkbox-count)
11409 (if (and l2 (> l2 l1))
11410 (progn
11411 (goto-char end)
11412 (org-update-parent-todo-statistics))
11413 (goto-char pos)
11414 (beginning-of-line 1)
11415 (while (re-search-forward
11417 (point-at-eol) t)
11418 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11419 (goto-char pos)
11420 (move-marker pos nil)))))
11422 (defvar org-entry-property-inherited-from) ;; defined below
11423 (defun org-update-parent-todo-statistics ()
11424 "Update any statistics cookie in the parent of the current headline.
11425 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11426 the entire subtree and this will travel up the hierarchy and update
11427 statistics everywhere."
11428 (let* ((prop (save-excursion (org-up-heading-safe)
11429 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11430 (recursive (or (not org-hierarchical-todo-statistics)
11432 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11433 0))
11434 (first t)
11436 level ltoggle l1 new ndel
11437 (cnt-all 0) (cnt-done 0) is-percent kwd
11438 checkbox-beg ov ovs ove cookie-present)
11439 (catch 'exit
11440 (save-excursion
11441 (beginning-of-line 1)
11442 (setq ltoggle (funcall outline-level))
11443 ;; Three situations are to consider:
11445 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11446 ;; to the top-level ancestor on the headline;
11448 ;; 2. If parent has "recursive" property, repeat up to the
11449 ;; headline setting that property, taking inheritance into
11450 ;; account;
11452 ;; 3. Else, move up to direct parent and proceed only once.
11453 (while (and (setq level (org-up-heading-safe))
11454 (or recursive first)
11455 (>= (point) lim))
11456 (setq first nil cookie-present nil)
11457 (unless (and level
11458 (not (string-match
11460 (downcase (or (org-entry-get nil "COOKIE_DATA")
11461 "")))))
11462 (throw 'exit nil))
11463 (while (re-search-forward box-re (point-at-eol) t)
11464 (setq cnt-all 0 cnt-done 0 cookie-present t)
11465 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11466 (save-match-data
11467 (unless (outline-next-heading) (throw 'exit nil))
11468 (while (and (looking-at org-complex-heading-regexp)
11469 (> (setq l1 (length (match-string 1))) level))
11470 (setq kwd (and (or recursive (= l1 ltoggle))
11471 (match-string 2)))
11472 (if (or (eq org-provide-todo-statistics 'all-headlines)
11473 (and (listp org-provide-todo-statistics)
11474 (or (member kwd org-provide-todo-statistics)
11475 (member kwd org-done-keywords))))
11476 (setq cnt-all (1+ cnt-all))
11477 (if (eq org-provide-todo-statistics t)
11478 (and kwd (setq cnt-all (1+ cnt-all)))))
11479 (and (member kwd org-done-keywords)
11480 (setq cnt-done (1+ cnt-done)))
11481 (outline-next-heading)))
11482 (setq new
11483 (if is-percent
11484 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11485 (format "[%d/%d]" cnt-done cnt-all))
11486 ndel (- (match-end 0) checkbox-beg))
11487 ;; handle overlays when updating cookie from column view
11488 (when (setq ov (car (overlays-at checkbox-beg)))
11489 (setq ovs (overlay-start ov) ove (overlay-end ov))
11490 (delete-overlay ov))
11491 (goto-char checkbox-beg)
11492 (insert new)
11493 (delete-region (point) (+ (point) ndel))
11494 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11495 (when ov (move-overlay ov ovs ove)))
11496 (when cookie-present
11497 (run-hook-with-args 'org-after-todo-statistics-hook
11498 cnt-done (- cnt-all cnt-done))))))
11499 (run-hooks 'org-todo-statistics-hook)))
11501 (defvar org-after-todo-statistics-hook nil
11502 "Hook that is called after a TODO statistics cookie has been updated.
11503 Each function is called with two arguments: the number of not-done entries
11504 and the number of done entries.
11506 For example, the following function, when added to this hook, will switch
11507 an entry to DONE when all children are done, and back to TODO when new
11508 entries are set to a TODO status. Note that this hook is only called
11509 when there is a statistics cookie in the headline!
11511 (defun org-summary-todo (n-done n-not-done)
11513 (let (org-log-done org-log-states) ; turn off logging
11515 ")
11517 (defvar org-todo-statistics-hook nil
11518 "Hook that is run whenever Org thinks TODO statistics should be updated.
11519 This hook runs even if there is no statistics cookie present, in which case
11520 `org-after-todo-statistics-hook' would not run.")
11522 (defun org-todo-trigger-tag-changes (state)
11523 "Apply the changes defined in `org-todo-state-tags-triggers'."
11524 (let ((l org-todo-state-tags-triggers)
11525 changes)
11526 (when (or (not state) (equal state ""))
11527 (setq changes (append changes (cdr (assoc "" l)))))
11528 (when (and (stringp state) (> (length state) 0))
11529 (setq changes (append changes (cdr (assoc state l)))))
11530 (when (member state org-not-done-keywords)
11531 (setq changes (append changes (cdr (assoc 'todo l)))))
11532 (when (member state org-done-keywords)
11533 (setq changes (append changes (cdr (assoc 'done l)))))
11534 (dolist (c changes)
11535 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11537 (defun org-local-logging (value)
11538 "Get logging settings from a property VALUE."
11539 (let* (words w a)
11540 ;; directly set the variables, they are already local.
11541 (setq org-log-done nil
11542 org-log-repeat nil
11543 org-todo-log-states nil)
11544 (setq words (org-split-string value))
11545 (while (setq w (pop words))
11546 (cond
11547 ((setq a (assoc w org-startup-options))
11548 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11549 (set (nth 1 a) (nth 2 a))))
11550 ((setq a (org-extract-log-state-settings w))
11551 (and (member (car a) org-todo-keywords-1)
11552 (push a org-todo-log-states)))))))
11554 (defun org-get-todo-sequence-head (kwd)
11555 "Return the head of the TODO sequence to which KWD belongs.
11556 If KWD is not set, check if there is a text property remembering the
11557 right sequence."
11558 (let (p)
11559 (cond
11560 ((not kwd)
11561 (or (get-text-property (point-at-bol) 'org-todo-head)
11562 (progn
11563 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11564 nil (point-at-eol)))
11565 (get-text-property p 'org-todo-head))))
11566 ((not (member kwd org-todo-keywords-1))
11567 (car org-todo-keywords-1))
11568 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11570 (defun org-fast-todo-selection ()
11571 "Fast TODO keyword selection with single keys.
11572 Returns the new TODO keyword, or nil if no state change should occur."
11573 (let* ((fulltable org-todo-key-alist)
11574 (done-keywords org-done-keywords) ;; needed for the faces.
11575 (maxlen (apply 'max (mapcar
11576 (lambda (x)
11577 (if (stringp (car x)) (string-width (car x)) 0))
11578 fulltable)))
11579 (expert nil)
11580 (fwidth (+ maxlen 3 1 3))
11581 (ncol (/ (- (window-width) 4) fwidth))
11582 tg cnt e c tbl
11583 groups ingroup)
11584 (save-excursion
11585 (save-window-excursion
11586 (if expert
11587 (set-buffer (get-buffer-create " *Org todo*"))
11588 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11589 (erase-buffer)
11590 (org-set-local 'org-done-keywords done-keywords)
11591 (setq tbl fulltable cnt 0)
11592 (while (setq e (pop tbl))
11593 (cond
11594 ((equal e '(:startgroup))
11595 (push '() groups) (setq ingroup t)
11596 (when (not (= cnt 0))
11597 (setq cnt 0)
11599 (insert "{ "))
11600 ((equal e '(:endgroup))
11601 (setq ingroup nil cnt 0)
11603 ((equal e '(:newline))
11604 (when (not (= cnt 0))
11605 (setq cnt 0)
11607 (setq e (car tbl))
11608 (while (equal (car tbl) '(:newline))
11610 (setq tbl (cdr tbl)))))
11611 (t
11612 (setq tg (car e) c (cdr e))
11613 (if ingroup (push tg (car groups)))
11614 (setq tg (org-add-props tg nil 'face
11615 (org-get-todo-face tg)))
11616 (if (and (= cnt 0) (not ingroup)) (insert " "))
11617 (insert "[" c "] " tg (make-string
11618 (- fwidth 4 (length tg)) ?\ ))
11619 (when (= (setq cnt (1+ cnt)) ncol)
11621 (if ingroup (insert " "))
11622 (setq cnt 0)))))
11624 (goto-char (point-min))
11625 (if (not expert) (org-fit-window-to-buffer))
11626 (message "[a-z..]:Set [SPC]:clear")
11627 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11628 (cond
11629 ((or (= c ?\C-g)
11630 (and (= c ?q) (not (rassoc c fulltable))))
11631 (setq quit-flag t))
11632 ((= c ?\ ) nil)
11633 ((setq e (rassoc c fulltable) tg (car e))
11634 tg)
11635 (t (setq quit-flag t)))))))
11637 (defun org-entry-is-todo-p ()
11638 (member (org-get-todo-state) org-not-done-keywords))
11640 (defun org-entry-is-done-p ()
11641 (member (org-get-todo-state) org-done-keywords))
11643 (defun org-get-todo-state ()
11644 (save-excursion
11645 (org-back-to-heading t)
11646 (and (looking-at org-todo-line-regexp)
11647 (match-end 2)
11648 (match-string 2))))
11650 (defun org-at-date-range-p (&optional inactive-ok)
11651 "Is the cursor inside a date range?"
11652 (interactive)
11653 (save-excursion
11654 (catch 'exit
11655 (let ((pos (point)))
11657 (skip-chars-backward "<[")
11658 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11659 (>= (match-end 0) pos)
11660 (throw 'exit t))
11662 (skip-chars-backward "<[")
11663 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11664 (>= (match-end 0) pos)
11665 (throw 'exit t)))
11666 nil)))
11668 (defun org-get-repeat (&optional tagline)
11669 "Check if there is a deadline/schedule with repeater in this entry."
11670 (save-match-data
11671 (save-excursion
11672 (org-back-to-heading t)
11673 (and (re-search-forward (if tagline
11675 org-repeat-re)
11676 (org-entry-end-position) t)
11677 (match-string-no-properties 1)))))
11679 (defvar org-last-changed-timestamp)
11680 (defvar org-last-inserted-timestamp)
11681 (defvar org-log-post-message)
11682 (defvar org-log-note-purpose)
11683 (defvar org-log-note-how)
11684 (defvar org-log-note-extra)
11685 (defun org-auto-repeat-maybe (done-word)
11686 "Check if the current headline contains a repeated deadline/schedule.
11687 If yes, set TODO state back to what it was and change the base date
11688 of repeating deadline/scheduled time stamps to new date.
11689 This function is run automatically after each state change to a DONE state."
11690 ;; last-state is dynamically scoped into this function
11691 (let* ((repeat (org-get-repeat))
11692 (aa (assoc last-state org-todo-kwd-alist))
11693 (interpret (nth 1 aa))
11694 (head (nth 2 aa))
11695 (whata '(("d" . day) ("m" . month) ("y" . year)))
11696 (msg "Entry repeats: ")
11697 (org-log-done nil)
11698 (org-todo-log-states nil)
11699 re type n what ts time to-state)
11700 (when repeat
11701 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11702 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11703 org-todo-repeat-to-state))
11704 (unless (and to-state (member to-state org-todo-keywords-1))
11705 (setq to-state (if (eq interpret 'type) last-state head)))
11706 (org-todo to-state)
11707 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11708 (org-entry-put nil "LAST_REPEAT" (format-time-string
11709 (org-time-stamp-format t t))))
11710 (when org-log-repeat
11711 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11712 (memq 'org-add-log-note post-command-hook))
11713 ;; OK, we are already setup for some record
11714 (if (eq org-log-repeat 'note)
11715 ;; make sure we take a note, not only a time stamp
11716 (setq org-log-note-how 'note))
11717 ;; Set up for taking a record
11718 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11719 last-state
11720 'findpos org-log-repeat)))
11721 (org-back-to-heading t)
11722 (org-add-planning-info nil nil 'closed)
11726 (while (re-search-forward
11727 re (save-excursion (outline-next-heading) (point)) t)
11728 (setq type (if (match-end 1) org-scheduled-string
11729 (if (match-end 3) org-deadline-string "Plain:"))
11730 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11732 (setq n (string-to-number (match-string 2 ts))
11733 what (match-string 3 ts))
11734 (if (equal what "w") (setq n (* n 7) what "d"))
11735 ;; Preparation, see if we need to modify the start date for the change
11736 (when (match-end 1)
11737 (setq time (save-match-data (org-time-string-to-time ts)))
11738 (cond
11739 ((equal (match-string 1 ts) ".")
11740 ;; Shift starting date to today
11741 (org-timestamp-change
11742 (- (org-today) (time-to-days time))
11743 'day))
11744 ((equal (match-string 1 ts) "+")
11745 (let ((nshiftmax 10) (nshift 0))
11746 (while (or (= nshift 0)
11747 (<= (time-to-days time)
11748 (time-to-days (current-time))))
11749 (when (= (incf nshift) nshiftmax)
11750 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11751 (error "Abort")))
11752 (org-timestamp-change n (cdr (assoc what whata)))
11753 (org-at-timestamp-p t)
11754 (setq ts (match-string 1))
11755 (setq time (save-match-data (org-time-string-to-time ts)))))
11756 (org-timestamp-change (- n) (cdr (assoc what whata)))
11757 ;; rematch, so that we have everything in place for the real shift
11758 (org-at-timestamp-p t)
11759 (setq ts (match-string 1))
11761 (org-timestamp-change n (cdr (assoc what whata)))
11762 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11763 (setq org-log-post-message msg)
11764 (message "%s" msg))))
11766 (defun org-show-todo-tree (arg)
11767 "Make a compact tree which shows all headlines marked with TODO.
11768 The tree will show the lines where the regexp matches, and all higher
11769 headlines above the match.
11771 With a numeric prefix N, construct a sparse tree for the Nth element
11772 of `org-todo-keywords-1'."
11773 (interactive "P")
11774 (let ((case-fold-search nil)
11775 (kwd-re
11776 (cond ((null arg) org-not-done-regexp)
11777 ((equal arg '(4))
11778 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11779 (mapcar 'list org-todo-keywords-1))))
11783 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11784 (regexp-quote (nth (1- (prefix-numeric-value arg))
11785 org-todo-keywords-1)))
11786 (t (error "Invalid prefix argument: %s" arg)))))
11787 (message "%d TODO entries found"
11788 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11790 (defun org-deadline (&optional remove time)
11792 With argument REMOVE, remove any deadline from the item.
11793 With argument TIME, set the deadline at the corresponding date. TIME
11795 (interactive "P")
11796 (let* ((old-date (org-entry-get nil "DEADLINE"))
11797 (repeater (and old-date
11798 (string-match
11800 old-date)
11801 (match-string 1 old-date))))
11802 (if remove
11803 (progn
11804 (when (and old-date org-log-redeadline)
11805 (org-add-log-setup 'deldeadline nil old-date 'findpos
11806 org-log-redeadline))
11807 (org-remove-timestamp-with-keyword org-deadline-string)
11808 (message "Item no longer has a deadline."))
11809 (org-add-planning-info 'deadline time 'closed)
11810 (when (and old-date org-log-redeadline
11811 (not (equal old-date
11812 (substring org-last-inserted-timestamp 1 -1))))
11813 (org-add-log-setup 'redeadline nil old-date 'findpos
11814 org-log-redeadline))
11815 (when repeater
11816 (save-excursion
11817 (org-back-to-heading t)
11818 (when (re-search-forward (concat org-deadline-string " "
11819 org-last-inserted-timestamp)
11820 (save-excursion
11821 (outline-next-heading) (point)) t)
11822 (goto-char (1- (match-end 0)))
11823 (insert " " repeater)
11824 (setq org-last-inserted-timestamp
11825 (concat (substring org-last-inserted-timestamp 0 -1)
11826 " " repeater
11827 (substring org-last-inserted-timestamp -1))))))
11828 (message "Deadline on %s" org-last-inserted-timestamp))))
11830 (defun org-schedule (&optional remove time)
11831 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11832 With argument REMOVE, remove any scheduling date from the item.
11833 With argument TIME, scheduled at the corresponding date. TIME can
11835 (interactive "P")
11836 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11837 (repeater (and old-date
11838 (string-match
11840 old-date)
11841 (match-string 1 old-date))))
11842 (if remove
11843 (progn
11844 (when (and old-date org-log-reschedule)
11845 (org-add-log-setup 'delschedule nil old-date 'findpos
11846 org-log-reschedule))
11847 (org-remove-timestamp-with-keyword org-scheduled-string)
11848 (message "Item is no longer scheduled."))
11849 (org-add-planning-info 'scheduled time 'closed)
11850 (when (and old-date org-log-reschedule
11851 (not (equal old-date
11852 (substring org-last-inserted-timestamp 1 -1))))
11853 (org-add-log-setup 'reschedule nil old-date 'findpos
11854 org-log-reschedule))
11855 (when repeater
11856 (save-excursion
11857 (org-back-to-heading t)
11858 (when (re-search-forward (concat org-scheduled-string " "
11859 org-last-inserted-timestamp)
11860 (save-excursion
11861 (outline-next-heading) (point)) t)
11862 (goto-char (1- (match-end 0)))
11863 (insert " " repeater)
11864 (setq org-last-inserted-timestamp
11865 (concat (substring org-last-inserted-timestamp 0 -1)
11866 " " repeater
11867 (substring org-last-inserted-timestamp -1))))))
11868 (message "Scheduled to %s" org-last-inserted-timestamp))))
11870 (defun org-get-scheduled-time (pom &optional inherit)
11871 "Get the scheduled time as a time tuple, of a format suitable
11872 for calling org-schedule with, or if there is no scheduling,
11873 returns nil."
11874 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11875 (when time
11876 (apply 'encode-time (org-parse-time-string time)))))
11878 (defun org-get-deadline-time (pom &optional inherit)
11879 "Get the deadline as a time tuple, of a format suitable for
11880 calling org-deadline with, or if there is no scheduling, returns
11881 nil."
11882 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11883 (when time
11884 (apply 'encode-time (org-parse-time-string time)))))
11886 (defun org-remove-timestamp-with-keyword (keyword)
11887 "Remove all time stamps with KEYWORD in the current entry."
11889 beg)
11890 (save-excursion
11891 (org-back-to-heading t)
11892 (setq beg (point))
11893 (outline-next-heading)
11894 (while (re-search-backward re beg t)
11895 (replace-match "")
11897 (equal (char-before) ?\ ))
11898 (backward-delete-char 1)
11900 (point-at-bol) (point-at-eol)))
11901 (delete-region (point-at-bol)
11902 (min (point-max) (1+ (point-at-eol))))))))))
11904 (defun org-add-planning-info (what &optional time &rest remove)
11905 "Insert new timestamp with keyword in the line directly after the headline.
11906 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11907 If non is given, the user is prompted for a date.
11908 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11909 be removed."
11910 (interactive)
11911 (let (org-time-was-given org-end-time-was-given ts
11912 end default-time default-input)
11914 (catch 'exit
11915 (when (and (memq what '(scheduled deadline))
11916 (or (not time)
11917 (and (stringp time)
11918 (string-match "^[-+]+[0-9]" time))))
11919 ;; Try to get a default date/time from existing timestamp
11920 (save-excursion
11921 (org-back-to-heading t)
11922 (setq end (save-excursion (outline-next-heading) (point)))
11923 (when (re-search-forward (if (eq what 'scheduled)
11924 org-scheduled-time-regexp
11925 org-deadline-time-regexp)
11926 end t)
11927 (setq ts (match-string 1)
11928 default-time
11929 (apply 'encode-time (org-parse-time-string ts))
11930 default-input (and ts (org-get-compact-tod ts))))))
11931 (when what
11932 (setq time
11933 (if (and (stringp time)
11934 (string-match "^[-+]+[0-9]" time))
11935 ;; This is a relative time, set the proper date
11936 (apply 'encode-time
11937 (org-read-date-analyze
11938 time default-time (decode-time default-time)))
11939 ;; If necessary, get the time from the user
11940 (or time (org-read-date nil 'to-time nil nil
11941 default-time default-input)))))
11943 (when (and org-insert-labeled-timestamps-at-point
11944 (member what '(scheduled deadline)))
11945 (insert
11946 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11947 (org-insert-time-stamp time org-time-was-given
11948 nil nil nil (list org-end-time-was-given))
11949 (setq what nil))
11950 (save-excursion
11951 (save-restriction
11952 (let (col list elt ts buffer-invisibility-spec)
11953 (org-back-to-heading t)
11955 (goto-char (match-end 1))
11956 (setq col (current-column))
11957 (goto-char (match-end 0))
11959 (when (and (not what)
11960 (not (looking-at
11962 org-keyword-time-not-clock-regexp))))
11963 ;; Nothing to add, nothing to remove...... :-)
11964 (throw 'exit nil))
11965 (if (and (not (looking-at org-outline-regexp))
11968 (not (equal (match-string 1) org-clock-string)))
11969 (narrow-to-region (match-beginning 0) (match-end 0))
11971 (backward-char 1)
11972 (narrow-to-region (point) (point))
11973 (and org-adapt-indentation (org-indent-to-column col)))
11974 ;; Check if we have to remove something.
11975 (setq list (cons what remove))
11976 (while list
11977 (setq elt (pop list))
11978 (when (or (and (eq elt 'scheduled)
11979 (re-search-forward org-scheduled-time-regexp nil t))
11980 (and (eq elt 'deadline)
11981 (re-search-forward org-deadline-time-regexp nil t))
11982 (and (eq elt 'closed)
11983 (re-search-forward org-closed-time-regexp nil t)))
11984 (replace-match "")
11985 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11987 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11988 (when what
11989 (insert
11990 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11991 (cond ((eq what 'scheduled) org-scheduled-string)
11992 ((eq what 'deadline) org-deadline-string)
11993 ((eq what 'closed) org-closed-string))
11994 " ")
11995 (setq ts (org-insert-time-stamp
11996 time
11997 (or org-time-was-given
11998 (and (eq what 'closed) org-log-done-with-time))
11999 (eq what 'closed)
12000 nil nil (list org-end-time-was-given)))
12001 (insert
12002 (if (not (or (bolp) (eq (char-before) ?\ )
12003 (memq (char-after) '(32 10))
12004 (eobp))) " " ""))
12005 (end-of-line 1))
12006 (goto-char (point-min))
12007 (widen)
12010 (delete-region (1- (point)) (point-at-eol)))
12011 ts))))))
12013 (defvar org-log-note-marker (make-marker))
12014 (defvar org-log-note-purpose nil)
12015 (defvar org-log-note-state nil)
12016 (defvar org-log-note-previous-state nil)
12017 (defvar org-log-note-how nil)
12018 (defvar org-log-note-extra nil)
12019 (defvar org-log-note-window-configuration nil)
12020 (defvar org-log-note-return-to (make-marker))
12021 (defvar org-log-note-effective-time nil
12022 "Remembered current time so that dynamically scoped
12023 `org-extend-today-until' affects tha timestamps in state change
12024 log")
12026 (defvar org-log-post-message nil
12027 "Message to be displayed after a log note has been stored.
12028 The auto-repeater uses this.")
12030 (defun org-add-note ()
12031 "Add a note to the current entry.
12032 This is done in the same way as adding a state change note."
12033 (interactive)
12034 (org-add-log-setup 'note nil nil 'findpos nil))
12036 (defvar org-property-end-re)
12037 (defun org-add-log-setup (&optional purpose state prev-state
12038 findpos how extra)
12039 "Set up the post command hook to take a note.
12040 If this is about to TODO state change, the new state is expected in STATE.
12041 When FINDPOS is non-nil, find the correct position for the note in
12042 the current entry. If not, assume that it can be inserted at point.
12043 HOW is an indicator what kind of note should be created.
12044 EXTRA is additional text that will be inserted into the notes buffer."
12045 (let* ((org-log-into-drawer (org-log-into-drawer))
12046 (drawer (cond ((stringp org-log-into-drawer)
12047 org-log-into-drawer)
12048 (org-log-into-drawer "LOGBOOK")
12049 (t nil))))
12050 (save-restriction
12051 (save-excursion
12052 (when findpos
12053 (org-back-to-heading t)
12054 (narrow-to-region (point) (save-excursion
12055 (outline-next-heading) (point)))
12059 (goto-char (match-end 0))
12060 (cond
12061 (drawer
12063 nil t)
12064 (progn
12065 (goto-char (match-end 0))
12066 (or org-log-states-order-reversed
12067 (and (re-search-forward org-property-end-re nil t)
12068 (goto-char (1- (match-beginning 0))))))
12070 (beginning-of-line 0)
12071 (org-indent-line-function)
12072 (beginning-of-line 2)
12073 (org-indent-line-function)
12074 (end-of-line 0)))
12075 ((and org-log-state-notes-insert-after-drawers
12076 (save-excursion
12077 (forward-line) (looking-at org-drawer-regexp)))
12078 (forward-line)
12079 (while (looking-at org-drawer-regexp)
12080 (goto-char (match-end 0))
12081 (re-search-forward org-property-end-re (point-max) t)
12082 (forward-line))
12083 (forward-line -1)))
12084 (unless org-log-states-order-reversed
12086 (org-skip-over-state-notes)
12088 (move-marker org-log-note-marker (point))
12089 (setq org-log-note-purpose purpose
12090 org-log-note-state state
12091 org-log-note-previous-state prev-state
12092 org-log-note-how how
12093 org-log-note-extra extra
12094 org-log-note-effective-time (org-current-effective-time))
12095 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12097 (defun org-skip-over-state-notes ()
12098 "Skip past the list of State notes in an entry."
12100 (when (ignore-errors (goto-char (org-in-item-p)))
12101 (let* ((struct (org-list-struct))
12102 (prevs (org-list-prevs-alist struct)))
12104 (goto-char (or (org-list-get-next-item (point) struct prevs)
12105 (org-list-get-item-end (point) struct)))))))
12107 (defun org-add-log-note (&optional purpose)
12108 "Pop up a window for taking a note, and add this note later at point."
12109 (remove-hook 'post-command-hook 'org-add-log-note)
12110 (setq org-log-note-window-configuration (current-window-configuration))
12111 (delete-other-windows)
12112 (move-marker org-log-note-return-to (point))
12113 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12114 (goto-char org-log-note-marker)
12115 (org-switch-to-buffer-other-window "*Org Note*")
12116 (erase-buffer)
12117 (if (memq org-log-note-how '(time state))
12118 (let (current-prefix-arg) (org-store-log-note))
12119 (let ((org-inhibit-startup t)) (org-mode))
12120 (insert (format "# Insert note for %s.
12122 (cond
12123 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12124 ((eq org-log-note-purpose 'done) "closed todo item")
12125 ((eq org-log-note-purpose 'state)
12127 (or org-log-note-previous-state "")
12128 (or org-log-note-state "")))
12129 ((eq org-log-note-purpose 'reschedule)
12130 "rescheduling")
12131 ((eq org-log-note-purpose 'delschedule)
12132 "no longer scheduled")
12133 ((eq org-log-note-purpose 'redeadline)
12134 "changing deadline")
12135 ((eq org-log-note-purpose 'deldeadline)
12136 "removing deadline")
12137 ((eq org-log-note-purpose 'refile)
12138 "refiling")
12139 ((eq org-log-note-purpose 'note)
12140 "this entry")
12141 (t (error "This should not happen")))))
12142 (if org-log-note-extra (insert org-log-note-extra))
12143 (org-set-local 'org-finish-function 'org-store-log-note)
12144 (run-hooks 'org-log-buffer-setup-hook)))
12146 (defvar org-note-abort nil) ; dynamically scoped
12147 (defun org-store-log-note ()
12148 "Finish taking a log note, and insert it to where it belongs."
12149 (let ((txt (buffer-string))
12150 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12151 lines ind bul)
12152 (kill-buffer (current-buffer))
12154 (setq txt (replace-match "" t t txt)))
12156 (setq txt (replace-match "" t t txt)))
12159 (setq note
12160 (org-replace-escapes
12161 note
12162 (list (cons "%u" (user-login-name))
12163 (cons "%U" user-full-name)
12164 (cons "%t" (format-time-string
12165 (org-time-stamp-format 'long 'inactive)
12166 org-log-note-effective-time))
12167 (cons "%T" (format-time-string
12168 (org-time-stamp-format 'long nil)
12169 org-log-note-effective-time))
12170 (cons "%s" (if org-log-note-state
12172 ""))
12173 (cons "%S" (if org-log-note-previous-state
12177 (push note lines))
12178 (when (or current-prefix-arg org-note-abort)
12179 (when org-log-into-drawer
12180 (org-remove-empty-drawer-at
12181 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12182 org-log-note-marker))
12183 (setq lines nil))
12184 (when lines
12185 (with-current-buffer (marker-buffer org-log-note-marker)
12186 (save-excursion
12187 (goto-char org-log-note-marker)
12188 (move-marker org-log-note-marker nil)
12189 (end-of-line 1)
12191 (setq ind (save-excursion
12192 (if (ignore-errors (goto-char (org-in-item-p)))
12193 (let ((struct (org-list-struct)))
12194 (org-list-get-ind
12195 (org-list-get-top-point struct) struct))
12197 (cond
12198 ((and (org-at-heading-p)
12199 org-adapt-indentation)
12200 (1+ (org-current-level)))
12201 ((org-at-heading-p) 0)
12202 (t (org-get-indentation))))))
12203 (setq bul (org-list-bullet-string "-"))
12204 (org-indent-line-to ind)
12205 (insert bul (pop lines))
12206 (let ((ind-body (+ (length bul) ind)))
12207 (while lines
12209 (org-indent-line-to ind-body)
12210 (insert (pop lines))))
12211 (message "Note stored")
12212 (org-back-to-heading t)
12213 (org-cycle-hide-drawers 'children)))))
12214 (set-window-configuration org-log-note-window-configuration)
12215 (with-current-buffer (marker-buffer org-log-note-return-to)
12216 (goto-char org-log-note-return-to))
12217 (move-marker org-log-note-return-to nil)
12218 (and org-log-post-message (message "%s" org-log-post-message)))
12220 (defun org-remove-empty-drawer-at (drawer pos)
12221 "Remove an empty drawer DRAWER at position POS.
12222 POS may also be a marker."
12223 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12224 (save-excursion
12225 (save-restriction
12226 (widen)
12227 (goto-char pos)
12228 (if (org-in-regexp
12230 (replace-match ""))))))
12232 (defun org-sparse-tree (&optional arg)
12233 "Create a sparse tree, prompt for the details.
12234 This command can create sparse trees. You first need to select the type
12235 of match used to create the tree:
12237 t Show all TODO entries.
12238 T Show entries with a specific TODO keyword.
12239 m Show entries selected by a tags/property match.
12240 p Enter a property name and its value (both with completion on existing
12241 names/values) and show entries with that property.
12242 r Show entries matching a regular expression (`/' can be used as well)
12243 d Show deadlines due within `org-deadline-warning-days'.
12244 b Show deadlines and scheduled items before a date.
12245 a Show deadlines and scheduled items after a date."
12246 (interactive "P")
12247 (let (ans kwd value)
12248 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12249 (setq ans (read-char-exclusive))
12250 (cond
12251 ((equal ans ?d)
12252 (call-interactively 'org-check-deadlines))
12253 ((equal ans ?b)
12254 (call-interactively 'org-check-before-date))
12255 ((equal ans ?a)
12256 (call-interactively 'org-check-after-date))
12257 ((equal ans ?t)
12258 (org-show-todo-tree nil))
12259 ((equal ans ?T)
12260 (org-show-todo-tree '(4)))
12261 ((member ans '(?T ?m))
12262 (call-interactively 'org-match-sparse-tree))
12263 ((member ans '(?p ?P))
12264 (setq kwd (org-icompleting-read "Property: "
12265 (mapcar 'list (org-buffer-property-keys))))
12266 (setq value (org-icompleting-read "Value: "
12267 (mapcar 'list (org-property-values kwd))))
12270 (org-match-sparse-tree arg (concat kwd "=" value)))
12271 ((member ans '(?r ?R ?/))
12272 (call-interactively 'org-occur))
12275 (defvar org-occur-highlights nil
12276 "List of overlays used for occur matches.")
12277 (make-variable-buffer-local 'org-occur-highlights)
12278 (defvar org-occur-parameters nil
12279 "Parameters of the active org-occur calls.
12280 This is a list, each call to org-occur pushes as cons cell,
12281 containing the regular expression and the callback, onto the list.
12282 The list can contain several entries if `org-occur' has been called
12283 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12284 will only contain one set of parameters. When the highlights are
12285 removed (for example with `C-c C-c', or with the next edit (depending
12286 on `org-remove-highlights-with-change'), this variable is emptied
12287 as well.")
12288 (make-variable-buffer-local 'org-occur-parameters)
12290 (defun org-occur (regexp &optional keep-previous callback)
12291 "Make a compact tree which shows all matches of REGEXP.
12292 The tree will show the lines where the regexp matches, and all higher
12293 headlines above the match. It will also show the heading after the match,
12294 to make sure editing the matching entry is easy.
12295 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12296 call to `org-occur' will be kept, to allow stacking of calls to this
12297 command.
12298 If CALLBACK is non-nil, it is a function which is called to confirm
12299 that the match should indeed be shown."
12301 (when (equal regexp "")
12302 (error "Regexp cannot be empty"))
12303 (unless keep-previous
12304 (org-remove-occur-highlights nil nil t))
12305 (push (cons regexp callback) org-occur-parameters)
12306 (let ((cnt 0))
12307 (save-excursion
12308 (goto-char (point-min))
12309 (if (or (not keep-previous) ; do not want to keep
12310 (not org-occur-highlights)) ; no previous matches
12311 ;; hide everything
12312 (org-overview))
12313 (while (re-search-forward regexp nil t)
12314 (when (or (not callback)
12315 (save-match-data (funcall callback)))
12316 (setq cnt (1+ cnt))
12317 (when org-highlight-sparse-tree-matches
12318 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12319 (org-show-context 'occur-tree))))
12320 (when org-remove-highlights-with-change
12321 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12322 nil 'local))
12323 (unless org-sparse-tree-open-archived-trees
12324 (org-hide-archived-subtrees (point-min) (point-max)))
12325 (run-hooks 'org-occur-hook)
12326 (if (org-called-interactively-p 'interactive)
12327 (message "%d match(es) for regexp %s" cnt regexp))
12328 cnt))
12330 (defun org-occur-next-match (&optional n reset)
12331 "Function for `next-error-function' to find sparse tree matches.
12332 N is the number of matches to move, when negative move backwards.
12333 RESET is entirely ignored - this function always goes back to the
12334 starting point when no match is found."
12335 (let* ((limit (if (< n 0) (point-min) (point-max)))
12336 (search-func (if (< n 0)
12337 'previous-single-char-property-change
12338 'next-single-char-property-change))
12339 (n (abs n))
12340 (pos (point))
12341 p1)
12342 (catch 'exit
12343 (while (setq p1 (funcall search-func (point) 'org-type))
12344 (when (equal p1 limit)
12345 (goto-char pos)
12346 (error "No more matches"))
12347 (when (equal (get-char-property p1 'org-type) 'org-occur)
12348 (setq n (1- n))
12349 (when (= n 0)
12350 (goto-char p1)
12351 (throw 'exit (point))))
12352 (goto-char p1))
12353 (goto-char p1)
12354 (error "No more matches"))))
12356 (defun org-show-context (&optional key)
12357 "Make sure point and context are visible.
12358 How much context is shown depends upon the variables
12359 `org-show-hierarchy-above', `org-show-following-heading'. and
12360 `org-show-siblings'."
12361 (let ((heading-p (org-on-heading-p t))
12362 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12363 (following-p (org-get-alist-option org-show-following-heading key))
12364 (entry-p (org-get-alist-option org-show-entry-below key))
12365 (siblings-p (org-get-alist-option org-show-siblings key)))
12366 (catch 'exit
12367 ;; Show heading or entry text
12368 (if (and heading-p (not entry-p))
12369 (org-flag-heading nil) ; only show the heading
12370 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12371 (org-show-hidden-entry))) ; show entire entry
12372 (when following-p
12373 ;; Show next sibling, or heading below text
12374 (save-excursion
12375 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12376 (org-flag-heading nil))))
12377 (when siblings-p (org-show-siblings))
12378 (when hierarchy-p
12379 ;; show all higher headings, possibly with siblings
12380 (save-excursion
12381 (while (and (condition-case nil
12382 (progn (org-up-heading-all 1) t)
12383 (error nil))
12384 (not (bobp)))
12385 (org-flag-heading nil)
12386 (when siblings-p (org-show-siblings))))))))
12388 (defvar org-reveal-start-hook nil
12389 "Hook run before revealing a location.")
12391 (defun org-reveal (&optional siblings)
12392 "Show current entry, hierarchy above it, and the following headline.
12393 This can be used to show a consistent set of context around locations
12394 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12395 not t for the search context.
12397 With optional argument SIBLINGS, on each level of the hierarchy all
12398 siblings are shown. This repairs the tree structure to what it would
12399 look like when opened with hierarchical calls to `org-cycle'.
12401 go to the parent and show the
12402 entire tree."
12403 (interactive "P")
12404 (run-hooks 'org-reveal-start-hook)
12405 (let ((org-show-hierarchy-above t)
12406 (org-show-following-heading t)
12407 (org-show-siblings (if siblings t org-show-siblings)))
12408 (org-show-context nil))
12409 (when (equal siblings '(16))
12410 (save-excursion
12411 (when (org-up-heading-safe)
12412 (org-show-subtree)
12413 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12415 (defun org-highlight-new-match (beg end)
12416 "Highlight from BEG to END and mark the highlight is an occur headline."
12417 (let ((ov (make-overlay beg end)))
12418 (overlay-put ov 'face 'secondary-selection)
12419 (overlay-put ov 'org-type 'org-occur)
12420 (push ov org-occur-highlights)))
12422 (defun org-remove-occur-highlights (&optional beg end noremove)
12423 "Remove the occur highlights from the buffer.
12424 BEG and END are ignored. If NOREMOVE is nil, remove this function
12425 from the `before-change-functions' in the current buffer."
12426 (interactive)
12427 (unless org-inhibit-highlight-removal
12428 (mapc 'delete-overlay org-occur-highlights)
12429 (setq org-occur-highlights nil)
12430 (setq org-occur-parameters nil)
12431 (unless noremove
12432 (remove-hook 'before-change-functions
12433 'org-remove-occur-highlights 'local))))
12435 ;;;; Priorities
12438 "Regular expression matching the priority indicator.")
12440 (defvar org-remove-priority-next-time nil)
12442 (defun org-priority-up ()
12443 "Increase the priority of the current item."
12444 (interactive)
12445 (org-priority 'up))
12447 (defun org-priority-down ()
12448 "Decrease the priority of the current item."
12449 (interactive)
12450 (org-priority 'down))
12452 (defun org-priority (&optional action)
12453 "Change the priority of an item by ARG.
12454 ACTION can be `set', `up', `down', or a character."
12455 (interactive)
12456 (unless org-enable-priority-commands
12457 (error "Priority commands are disabled"))
12458 (setq action (or action 'set))
12459 (let (current new news have remove)
12460 (save-excursion
12461 (org-back-to-heading t)
12462 (if (looking-at org-priority-regexp)
12463 (setq current (string-to-char (match-string 2))
12464 have t))
12465 (cond
12466 ((eq action 'remove)
12467 (setq remove t new ?\ ))
12468 ((or (eq action 'set)
12469 (if (featurep 'xemacs) (characterp action) (integerp action)))
12470 (if (not (eq action 'set))
12471 (setq new action)
12472 (message "Priority %c-%c, SPC to remove: "
12473 org-highest-priority org-lowest-priority)
12474 (save-match-data
12475 (setq new (read-char-exclusive))))
12476 (if (and (= (upcase org-highest-priority) org-highest-priority)
12477 (= (upcase org-lowest-priority) org-lowest-priority))
12478 (setq new (upcase new)))
12479 (cond ((equal new ?\ ) (setq remove t))
12480 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12481 (error "Priority must be between `%c' and `%c'"
12482 org-highest-priority org-lowest-priority))))
12483 ((eq action 'up)
12484 (setq new (if have
12485 (1- current) ; normal cycling
12486 ;; last priority was empty
12487 (if (eq last-command this-command)
12488 org-lowest-priority ; wrap around empty to lowest
12489 ;; default
12490 (if org-priority-start-cycle-with-default
12491 org-default-priority
12492 (1- org-default-priority))))))
12493 ((eq action 'down)
12494 (setq new (if have
12495 (1+ current) ; normal cycling
12496 ;; last priority was empty
12497 (if (eq last-command this-command)
12498 org-highest-priority ; wrap around empty to highest
12499 ;; default
12500 (if org-priority-start-cycle-with-default
12501 org-default-priority
12502 (1+ org-default-priority))))))
12503 (t (error "Invalid action")))
12504 (if (or (< (upcase new) org-highest-priority)
12505 (> (upcase new) org-lowest-priority))
12506 (if (and (memq action '(up down))
12507 (not have) (not (eq last-command this-command)))
12508 ;; `new' is from default priority
12509 (error
12510 "The default can not be set, see `org-default-priority' why")
12511 ;; normal cycling: `new' is beyond highest/lowest priority
12512 ;; and is wrapped around to the empty priority
12513 (setq remove t)))
12514 (setq news (format "%c" new))
12515 (if have
12516 (if remove
12517 (replace-match "" t t nil 1)
12518 (replace-match news t t nil 2))
12519 (if remove
12520 (error "No priority cookie found in line")
12521 (let ((case-fold-search nil))
12522 (looking-at org-todo-line-regexp))
12523 (if (match-end 2)
12524 (progn
12525 (goto-char (match-end 2))
12526 (insert " [#" news "]"))
12527 (goto-char (match-beginning 3))
12528 (insert "[#" news "] "))))
12529 (org-preserve-lc (org-set-tags nil 'align)))
12530 (if remove
12531 (message "Priority removed")
12532 (message "Priority of current item set to %s" news))))
12534 (defun org-get-priority (s)
12535 "Find priority cookie and return priority."
12536 (if (functionp org-get-priority-function)
12537 (funcall org-get-priority-function)
12538 (save-match-data
12539 (if (not (string-match org-priority-regexp s))
12540 (* 1000 (- org-lowest-priority org-default-priority))
12541 (* 1000 (- org-lowest-priority
12542 (string-to-char (match-string 2 s))))))))
12544 ;;;; Tags
12546 (defvar org-agenda-archives-mode)
12547 (defvar org-map-continue-from nil
12548 "Position from where mapping should continue.
12549 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12551 (defvar org-scanner-tags nil
12552 "The current tag list while the tags scanner is running.")
12553 (defvar org-trust-scanner-tags nil
12554 "Should `org-get-tags-at' use the tags for the scanner.
12555 This is for internal dynamical scoping only.
12556 When this is non-nil, the function `org-get-tags-at' will return the value
12557 of `org-scanner-tags' instead of building the list by itself. This
12558 can lead to large speed-ups when the tags scanner is used in a file with
12559 many entries, and when the list of tags is retrieved, for example to
12560 obtain a list of properties. Building the tags list for each entry in such
12561 a file becomes an N^2 operation - but with this variable set, it scales
12562 as N.")
12564 (defun org-scan-tags (action matcher &optional todo-only)
12565 "Scan headline tags with inheritance and produce output ACTION.
12567 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12568 or `agenda' to produce an entry list for an agenda view. It can also be
12569 a Lisp form or a function that should be called at each matched headline, in
12570 this case the return value is a list of all return values from these calls.
12572 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12573 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12574 only lines with a TODO keyword are included in the output."
12575 (require 'org-agenda)
12578 (org-re
12580 (props (list 'face 'default
12581 'done-face 'org-agenda-done
12582 'undone-face 'default
12583 'mouse-face 'highlight
12584 'org-not-done-regexp org-not-done-regexp
12585 'org-todo-regexp org-todo-regexp
12586 'help-echo
12587 (format "mouse-2 or RET jump to org file %s"
12588 (abbreviate-file-name
12589 (or (buffer-file-name (buffer-base-buffer))
12590 (buffer-name (buffer-base-buffer)))))))
12591 (case-fold-search nil)
12592 (org-map-continue-from nil)
12593 lspos tags tags-list
12594 (tags-alist (list (cons 0 org-file-tags)))
12595 (llast 0) rtn rtn1 level category i txt
12596 todo marker entry priority)
12597 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12598 (setq action (list 'lambda nil action)))
12599 (save-excursion
12600 (goto-char (point-min))
12601 (when (eq action 'sparse-tree)
12602 (org-overview)
12603 (org-remove-occur-highlights))
12604 (while (re-search-forward re nil t)
12605 (catch :skip
12606 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12607 tags (if (match-end 4) (org-match-string-no-properties 4)))
12608 (goto-char (setq lspos (match-beginning 0)))
12609 (setq level (org-reduced-level (funcall outline-level))
12610 category (org-get-category))
12611 (setq i llast llast level)
12612 ;; remove tag lists from same and sublevels
12613 (while (>= i level)
12614 (when (setq entry (assoc i tags-alist))
12615 (setq tags-alist (delete entry tags-alist)))
12616 (setq i (1- i)))
12617 ;; add the next tags
12618 (when tags
12619 (setq tags (org-split-string tags ":")
12620 tags-alist
12621 (cons (cons level tags) tags-alist)))
12622 ;; compile tags for current headline
12623 (setq tags-list
12624 (if org-use-tag-inheritance
12625 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12626 tags)
12627 org-scanner-tags tags-list)
12628 (when org-use-tag-inheritance
12629 (setcdr (car tags-alist)
12630 (mapcar (lambda (x)
12631 (setq x (copy-sequence x))
12632 (org-add-prop-inherited x))
12633 (cdar tags-alist))))
12634 (when (and tags org-use-tag-inheritance
12635 (or (not (eq t org-use-tag-inheritance))
12636 org-tags-exclude-from-inheritance))
12637 ;; selective inheritance, remove uninherited ones
12638 (setcdr (car tags-alist)
12639 (org-remove-uninherited-tags (cdar tags-alist))))
12640 (when (and
12642 ;; eval matcher only when the todo condition is OK
12643 (and (or (not todo-only) (member todo org-not-done-keywords))
12644 (let ((case-fold-search t)) (eval matcher)))
12646 ;; Call the skipper, but return t if it does not skip,
12647 ;; so that the `and' form continues evaluating
12648 (progn
12649 (unless (eq action 'sparse-tree) (org-agenda-skip))
12650 t)
12652 ;; Check if timestamps are deselecting this entry
12653 (or (not todo-only)
12654 (and (member todo org-not-done-keywords)
12655 (or (not org-agenda-tags-todo-honor-ignore-options)
12656 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12658 ;; Extra check for the archive tag
12659 ;; FIXME: Does the skipper already do this????
12660 (or
12661 (not (member org-archive-tag tags-list))
12662 ;; we have an archive tag, should we use this anyway?
12663 (or (not org-agenda-skip-archived-trees)
12664 (and (eq action 'agenda) org-agenda-archives-mode))))
12666 ;; select this headline
12668 (cond
12669 ((eq action 'sparse-tree)
12670 (and org-highlight-sparse-tree-matches
12671 (org-get-heading) (match-end 0)
12672 (org-highlight-new-match
12673 (match-beginning 0) (match-beginning 1)))
12674 (org-show-context 'tags-tree))
12675 ((eq action 'agenda)
12676 (setq txt (org-format-agenda-item
12677 ""
12678 (concat
12679 (if (eq org-tags-match-list-sublevels 'indented)
12680 (make-string (1- level) ?.) "")
12681 (org-get-heading))
12682 category
12683 tags-list
12684 )
12685 priority (org-get-priority txt))
12686 (goto-char lspos)
12687 (setq marker (org-agenda-new-marker))
12688 (org-add-props txt props
12689 'org-marker marker 'org-hd-marker marker 'org-category category
12690 'todo-state todo
12691 'priority priority 'type "tagsmatch")
12692 (push txt rtn))
12693 ((functionp action)
12694 (setq org-map-continue-from nil)
12695 (save-excursion
12696 (setq rtn1 (funcall action))
12697 (push rtn1 rtn)))
12698 (t (error "Invalid action")))
12700 ;; if we are to skip sublevels, jump to end of subtree
12701 (unless org-tags-match-list-sublevels
12702 (org-end-of-subtree t)
12703 (backward-char 1))))
12704 ;; Get the correct position from where to continue
12705 (if org-map-continue-from
12706 (goto-char org-map-continue-from)
12707 (and (= (point) lspos) (end-of-line 1)))))
12708 (when (and (eq action 'sparse-tree)
12709 (not org-sparse-tree-open-archived-trees))
12710 (org-hide-archived-subtrees (point-min) (point-max)))
12711 (nreverse rtn)))
12713 (defun org-remove-uninherited-tags (tags)
12714 "Remove all tags that are not inherited from the list TAGS."
12715 (cond
12716 ((eq org-use-tag-inheritance t)
12717 (if org-tags-exclude-from-inheritance
12718 (org-delete-all org-tags-exclude-from-inheritance tags)
12719 tags))
12720 ((not org-use-tag-inheritance) nil)
12721 ((stringp org-use-tag-inheritance)
12722 (delq nil (mapcar
12723 (lambda (x)
12724 (if (and (string-match org-use-tag-inheritance x)
12725 (not (member x org-tags-exclude-from-inheritance)))
12726 x nil))
12727 tags)))
12728 ((listp org-use-tag-inheritance)
12729 (delq nil (mapcar
12730 (lambda (x)
12731 (if (member x org-use-tag-inheritance) x nil))
12732 tags)))))
12734 (defvar todo-only) ;; dynamically scoped
12736 (defun org-match-sparse-tree (&optional todo-only match)
12737 "Create a sparse tree according to tags string MATCH.
12738 MATCH can contain positive and negative selection of tags, like
12740 If optional argument TODO-ONLY is non-nil, only select lines that are
12741 also TODO lines."
12742 (interactive "P")
12743 (org-prepare-agenda-buffers (list (current-buffer)))
12744 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12746 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12748 (defvar org-cached-props nil)
12749 (defun org-cached-entry-get (pom property)
12750 (if (or (eq t org-use-property-inheritance)
12751 (and (stringp org-use-property-inheritance)
12752 (string-match org-use-property-inheritance property))
12753 (and (listp org-use-property-inheritance)
12754 (member property org-use-property-inheritance)))
12755 ;; Caching is not possible, check it directly
12756 (org-entry-get pom property 'inherit)
12757 ;; Get all properties, so that we can do complicated checks easily
12758 (cdr (assoc property (or org-cached-props
12759 (setq org-cached-props
12760 (org-entry-properties pom)))))))
12762 (defun org-global-tags-completion-table (&optional files)
12763 "Return the list of all tags in all agenda buffer/files.
12764 Optional FILES argument is a list of files to which can be used
12765 instead of the agenda files."
12766 (save-excursion
12767 (org-uniquify
12768 (delq nil
12769 (apply 'append
12770 (mapcar
12771 (lambda (file)
12772 (set-buffer (find-file-noselect file))
12773 (append (org-get-buffer-tags)
12774 (mapcar (lambda (x) (if (stringp (car-safe x))
12775 (list (car-safe x)) nil))
12776 org-tag-alist)))
12777 (if (and files (car files))
12778 files
12779 (org-agenda-files))))))))
12781 (defun org-make-tags-matcher (match)
12782 "Create the TAGS/TODO matcher form for the selection string MATCH."
12783 ;; todo-only is scoped dynamically into this function, and the function
12784 ;; may change it if the matcher asks for it.
12785 (unless match
12786 ;; Get a new match request, with completion
12787 (let ((org-last-tags-completion-table
12788 (org-global-tags-completion-table)))
12789 (setq match (org-completing-read-no-i
12790 "Match: " 'org-tags-completion-function nil nil nil
12791 'org-tags-history))))
12793 ;; Parse the string and create a lisp form
12794 (let ((match0 match)
12795 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12796 minus tag mm
12797 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12798 orterms term orlist re-p str-p level-p level-op time-p
12799 prop-p pn pv po gv rest)
12800 (if (string-match "/+" match)
12801 ;; match contains also a todo-matching request
12802 (progn
12803 (setq tagsmatch (substring match 0 (match-beginning 0))
12804 todomatch (substring match (match-end 0)))
12805 (if (string-match "^!" todomatch)
12806 (setq todo-only t todomatch (substring todomatch 1)))
12808 (setq todomatch nil)))
12809 ;; only matching tags
12810 (setq tagsmatch match todomatch nil))
12812 ;; Make the tags matcher
12814 (setq tagsmatcher t)
12815 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12816 (while (setq term (pop orterms))
12818 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12819 (while (string-match re term)
12820 (setq rest (substring term (match-end 0))
12821 minus (and (match-end 1)
12822 (equal (match-string 1 term) "-"))
12823 tag (save-match-data (replace-regexp-in-string
12825 (match-string 2 term)))
12826 re-p (equal (string-to-char tag) ?{)
12827 level-p (match-end 4)
12828 prop-p (match-end 5)
12829 mm (cond
12830 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12831 (level-p
12832 (setq level-op (org-op-to-function (match-string 3 term)))
12833 `(,level-op level ,(string-to-number
12834 (match-string 4 term))))
12835 (prop-p
12836 (setq pn (match-string 5 term)
12837 po (match-string 6 term)
12838 pv (match-string 7 term)
12839 re-p (equal (string-to-char pv) ?{)
12841 time-p (save-match-data
12843 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12844 (if time-p (setq pv (org-matcher-time pv)))
12845 (setq po (org-op-to-function po (if time-p 'time str-p)))
12846 (cond
12847 ((equal pn "CATEGORY")
12848 (setq gv '(get-text-property (point) 'org-category)))
12849 ((equal pn "TODO")
12850 (setq gv 'todo))
12851 (t
12852 (setq gv `(org-cached-entry-get nil ,pn))))
12853 (if re-p
12854 (if (eq po 'org<>)
12855 `(not (string-match ,pv (or ,gv "")))
12856 `(string-match ,pv (or ,gv "")))
12857 (if str-p
12858 `(,po (or ,gv "") ,pv)
12859 `(,po (string-to-number (or ,gv ""))
12860 ,(string-to-number pv) ))))
12861 (t `(member ,tag tags-list)))
12862 mm (if minus (list 'not mm) mm)
12863 term rest)
12864 (push mm tagsmatcher))
12865 (push (if (> (length tagsmatcher) 1)
12866 (cons 'and tagsmatcher)
12867 (car tagsmatcher))
12868 orlist)
12869 (setq tagsmatcher nil))
12870 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12871 (setq tagsmatcher
12872 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12873 ;; Make the todo matcher
12875 (setq todomatcher t)
12876 (setq orterms (org-split-string todomatch "|") orlist nil)
12877 (while (setq term (pop orterms))
12878 (while (string-match re term)
12879 (setq minus (and (match-end 1)
12880 (equal (match-string 1 term) "-"))
12881 kwd (match-string 2 term)
12882 re-p (equal (string-to-char kwd) ?{)
12883 term (substring term (match-end 0))
12884 mm (if re-p
12885 `(string-match ,(substring kwd 1 -1) todo)
12886 (list 'equal 'todo kwd))
12887 mm (if minus (list 'not mm) mm))
12888 (push mm todomatcher))
12889 (push (if (> (length todomatcher) 1)
12890 (cons 'and todomatcher)
12891 (car todomatcher))
12892 orlist)
12893 (setq todomatcher nil))
12894 (setq todomatcher (if (> (length orlist) 1)
12895 (cons 'or orlist) (car orlist))))
12897 ;; Return the string and lisp forms of the matcher
12898 (setq matcher (if todomatcher
12899 (list 'and tagsmatcher todomatcher)
12900 tagsmatcher))
12901 (cons match0 matcher)))
12903 (defun org-op-to-function (op &optional stringp)
12904 "Turn an operator into the appropriate function."
12905 (setq op
12906 (cond
12907 ((equal op "<" ) '(< string< org-time<))
12908 ((equal op ">" ) '(> org-string> org-time>))
12909 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12910 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12911 ((member op '("=" "==")) '(= string= org-time=))
12912 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12913 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12915 (defun org<> (a b) (not (= a b)))
12916 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12917 (defun org-string>= (a b) (not (string< a b)))
12918 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12919 (defun org-string<> (a b) (not (string= a b)))
12920 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12921 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12922 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12923 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12924 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12925 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12926 (defun org-2ft (s)
12927 "Convert S to a floating point time.
12928 If S is already a number, just return it. If it is a string, parse
12929 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12930 (cond
12931 ((numberp s) s)
12932 ((stringp s)
12933 (condition-case nil
12934 (float-time (apply 'encode-time (org-parse-time-string s)))
12935 (error 0.)))
12936 (t 0.)))
12938 (defun org-time-today ()
12939 "Time in seconds today at 0:00.
12940 Returns the float number of seconds since the beginning of the
12941 epoch to the beginning of today (00:00)."
12942 (float-time (apply 'encode-time
12943 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12945 (defun org-matcher-time (s)
12946 "Interpret a time comparison value."
12947 (save-match-data
12948 (cond
12949 ((string= s "<now>") (float-time))
12950 ((string= s "<today>") (org-time-today))
12951 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12952 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12954 (+ (org-time-today)
12955 (* (string-to-number (match-string 1 s))
12956 (cdr (assoc (match-string 2 s)
12957 '(("d" . 86400.0) ("w" . 604800.0)
12958 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12959 (t (org-2ft s)))))
12961 (defun org-match-any-p (re list)
12962 "Does re match any element of list?"
12963 (setq list (mapcar (lambda (x) (string-match re x)) list))
12964 (delq nil list))
12966 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12967 (defvar org-tags-overlay (make-overlay 1 1))
12968 (org-detach-overlay org-tags-overlay)
12970 (defun org-get-local-tags-at (&optional pos)
12971 "Get a list of tags defined in the current headline."
12972 (org-get-tags-at pos 'local))
12974 (defun org-get-local-tags ()
12975 "Get a list of tags defined in the current headline."
12976 (org-get-tags-at nil 'local))
12978 (defun org-get-tags-at (&optional pos local)
12979 "Get a list of all headline tags applicable at POS.
12980 POS defaults to point. If tags are inherited, the list contains
12981 the targets in the same sequence as the headlines appear, i.e.
12982 the tags of the current headline come last.
12983 When LOCAL is non-nil, only return tags from the current headline,
12984 ignore inherited ones."
12985 (interactive)
12986 (if (and org-trust-scanner-tags
12987 (or (not pos) (equal pos (point)))
12988 (not local))
12989 org-scanner-tags
12990 (let (tags ltags lastpos parent)
12991 (save-excursion
12992 (save-restriction
12993 (widen)
12994 (goto-char (or pos (point)))
12995 (save-match-data
12996 (catch 'done
12997 (condition-case nil
12998 (progn
12999 (org-back-to-heading t)
13000 (while (not (equal lastpos (point)))
13001 (setq lastpos (point))
13002 (when (looking-at
13004 (setq ltags (org-split-string
13005 (org-match-string-no-properties 1) ":"))
13006 (when parent
13007 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13008 (setq tags (append
13009 (if parent
13010 (org-remove-uninherited-tags ltags)
13011 ltags)
13012 tags)))
13013 (or org-use-tag-inheritance (throw 'done t))
13014 (if local (throw 'done t))
13015 (or (org-up-heading-safe) (error nil))
13016 (setq parent t)))
13017 (error nil)))))
13018 (if local
13019 tags
13020 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13022 (defun org-add-prop-inherited (s)
13023 (add-text-properties 0 (length s) '(inherited t) s)
13024 s)
13026 (defun org-toggle-tag (tag &optional onoff)
13027 "Toggle the tag TAG for the current line.
13028 If ONOFF is `on' or `off', don't toggle but set to this state."
13029 (let (res current)
13030 (save-excursion
13031 (org-back-to-heading t)
13033 (point-at-eol) t)
13034 (progn
13035 (setq current (match-string 1))
13036 (replace-match ""))
13037 (setq current ""))
13038 (setq current (nreverse (org-split-string current ":")))
13039 (cond
13040 ((eq onoff 'on)
13041 (setq res t)
13042 (or (member tag current) (push tag current)))
13043 ((eq onoff 'off)
13044 (or (not (member tag current)) (setq current (delete tag current))))
13045 (t (if (member tag current)
13046 (setq current (delete tag current))
13047 (setq res t)
13048 (push tag current))))
13049 (end-of-line 1)
13050 (if current
13051 (progn
13052 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13053 (org-set-tags nil t))
13054 (delete-horizontal-space))
13055 (run-hooks 'org-after-tags-change-hook))
13056 res))
13058 (defun org-align-tags-here (to-col)
13059 ;; Assumes that this is a headline
13060 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13061 (beginning-of-line 1)
13063 (< pos (match-beginning 2)))
13064 (progn
13065 (setq tags-l (- (match-end 2) (match-beginning 2)))
13066 (goto-char (match-beginning 1))
13067 (insert " ")
13068 (delete-region (point) (1+ (match-beginning 2)))
13069 (setq ncol (max (1+ (current-column))
13070 (1+ col)
13071 (if (> to-col 0)
13072 to-col
13073 (- (abs to-col) tags-l))))
13074 (setq p (point))
13075 (insert (make-string (- ncol (current-column)) ?\ ))
13076 (setq ncol (current-column))
13077 (when indent-tabs-mode (tabify p (point-at-eol)))
13078 (org-move-to-column (min ncol col) t))
13079 (goto-char pos))))
13081 (defun org-set-tags-command (&optional arg just-align)
13082 "Call the set-tags command for the current entry."
13083 (interactive "P")
13084 (if (org-on-heading-p)
13085 (org-set-tags arg just-align)
13086 (save-excursion
13087 (org-back-to-heading t)
13088 (org-set-tags arg just-align))))
13090 (defun org-set-tags-to (data)
13091 "Set the tags of the current entry to DATA, replacing the current tags.
13092 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13093 If DATA is nil or the empty string, any tags will be removed."
13094 (interactive "sTags: ")
13095 (setq data
13096 (cond
13097 ((eq data nil) "")
13098 ((equal data "") "")
13099 ((stringp data)
13100 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13101 ":"))
13102 ((listp data)
13103 (concat ":" (mapconcat 'identity data ":") ":"))
13104 (t nil)))
13105 (when data
13106 (save-excursion
13107 (org-back-to-heading t)
13108 (when (looking-at org-complex-heading-regexp)
13109 (if (match-end 5)
13110 (progn
13111 (goto-char (match-beginning 5))
13112 (insert data)
13113 (delete-region (point) (point-at-eol))
13114 (org-set-tags nil 'align))
13115 (goto-char (point-at-eol))
13116 (insert " " data)
13117 (org-set-tags nil 'align)))
13118 (beginning-of-line 1)
13120 (delete-region (match-beginning 1) (match-end 1))))))
13122 (defun org-align-all-tags ()
13123 "Align the tags i all headings."
13124 (interactive)
13125 (save-excursion
13126 (or (ignore-errors (org-back-to-heading t))
13127 (outline-next-heading))
13128 (if (org-on-heading-p)
13129 (org-set-tags t)
13130 (message "No headings"))))
13132 (defvar org-indent-indentation-per-level)
13133 (defun org-set-tags (&optional arg just-align)
13134 "Set the tags for the current headline.
13135 With prefix ARG, realign all tags in headings in the current buffer."
13136 (interactive "P")
13137 (let* ((re org-outline-regexp-bol)
13138 (current (org-get-tags-string))
13139 (col (current-column))
13140 (org-setting-tags t)
13141 table current-tags inherited-tags ; computed below when needed
13142 tags p0 c0 c1 rpl di tc level)
13143 (if arg
13144 (save-excursion
13145 (goto-char (point-min))
13146 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13147 (while (re-search-forward re nil t)
13148 (org-set-tags nil t)
13149 (end-of-line 1)))
13150 (message "All tags realigned to column %d" org-tags-column))
13151 (if just-align
13152 (setq tags current)
13153 ;; Get a new set of tags from the user
13154 (save-excursion
13155 (setq table (append org-tag-persistent-alist
13156 (or org-tag-alist (org-get-buffer-tags))
13157 (and
13158 org-complete-tags-always-offer-all-agenda-tags
13159 (org-global-tags-completion-table
13160 (org-agenda-files))))
13161 org-last-tags-completion-table table
13162 current-tags (org-split-string current ":")
13163 inherited-tags (nreverse
13164 (nthcdr (length current-tags)
13165 (nreverse (org-get-tags-at))))
13166 tags
13167 (if (or (eq t org-use-fast-tag-selection)
13168 (and org-use-fast-tag-selection
13169 (delq nil (mapcar 'cdr table))))
13170 (org-fast-tag-selection
13171 current-tags inherited-tags table
13172 (if org-fast-tag-selection-include-todo
13173 org-todo-key-alist))
13174 (let ((org-add-colon-after-tag-completion t))
13175 (org-trim
13176 (org-icompleting-read "Tags: "
13177 'org-tags-completion-function
13178 nil nil current 'org-tags-history))))))
13179 (while (string-match "[-+&]+" tags)
13180 ;; No boolean logic, just a list
13181 (setq tags (replace-match ":" t t tags))))
13183 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13185 (if org-tags-sort-function
13186 (setq tags (mapconcat 'identity
13187 (sort (org-split-string
13188 tags (org-re "[^[:alnum:]_@#%]+"))
13189 org-tags-sort-function) ":")))
13192 (setq tags "")
13193 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13194 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13196 ;; Insert new tags at the correct column
13197 (beginning-of-line 1)
13198 (setq level (or (and (looking-at org-outline-regexp)
13199 (- (match-end 0) (point) 1))
13200 1))
13201 (cond
13202 ((and (equal current "") (equal tags "")))
13203 ((re-search-forward
13205 (point-at-eol) t)
13206 (if (equal tags "")
13207 (setq rpl "")
13208 (goto-char (match-beginning 0))
13209 (setq c0 (current-column)
13210 ;; compute offset for the case of org-indent-mode active
13211 di (if org-indent-mode
13212 (* (1- org-indent-indentation-per-level) (1- level))
13213 0)
13214 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13215 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13216 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13217 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13218 (replace-match rpl t t)
13219 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13220 tags)
13221 (t (error "Tags alignment failed")))
13222 (org-move-to-column col)
13223 (unless just-align
13224 (run-hooks 'org-after-tags-change-hook)))))
13226 (defun org-change-tag-in-region (beg end tag off)
13227 "Add or remove TAG for each entry in the region.
13228 This works in the agenda, and also in an org-mode buffer."
13229 (interactive
13230 (list (region-beginning) (region-end)
13231 (let ((org-last-tags-completion-table
13232 (if (org-mode-p)
13233 (org-get-buffer-tags)
13234 (org-global-tags-completion-table))))
13235 (org-icompleting-read
13236 "Tag: " 'org-tags-completion-function nil nil nil
13237 'org-tags-history))
13238 (progn
13240 (equal (read-char-exclusive) ?r))))
13241 (if (fboundp 'deactivate-mark) (deactivate-mark))
13242 (let ((agendap (equal major-mode 'org-agenda-mode))
13243 l1 l2 m buf pos newhead (cnt 0))
13244 (goto-char end)
13245 (setq l2 (1- (org-current-line)))
13246 (goto-char beg)
13247 (setq l1 (org-current-line))
13248 (loop for l from l1 to l2 do
13249 (org-goto-line l)
13250 (setq m (get-text-property (point) 'org-hd-marker))
13251 (when (or (and (org-mode-p) (org-on-heading-p))
13252 (and agendap m))
13253 (setq buf (if agendap (marker-buffer m) (current-buffer))
13254 pos (if agendap m (point)))
13255 (with-current-buffer buf
13256 (save-excursion
13257 (save-restriction
13258 (goto-char pos)
13259 (setq cnt (1+ cnt))
13260 (org-toggle-tag tag (if off 'off 'on))
13261 (setq newhead (org-get-heading)))))
13262 (and agendap (org-agenda-change-all-lines newhead m))))
13263 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13265 (defun org-tags-completion-function (string predicate &optional flag)
13266 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13267 (confirm (lambda (x) (stringp (car x)))))
13269 (setq s1 (match-string 1 string)
13270 s2 (match-string 2 string))
13271 (setq s1 "" s2 string))
13272 (cond
13273 ((eq flag nil)
13274 ;; try completion
13275 (setq rtn (try-completion s2 ctable confirm))
13276 (if (stringp rtn)
13277 (setq rtn
13278 (concat s1 s2 (substring rtn (length s2))
13279 (if (and org-add-colon-after-tag-completion
13280 (assoc rtn ctable))
13281 ":" ""))))
13282 rtn)
13283 ((eq flag t)
13284 ;; all-completions
13285 (all-completions s2 ctable confirm)
13286 )
13287 ((eq flag 'lambda)
13288 ;; exact match?
13289 (assoc s2 ctable)))
13290 ))
13292 (defun org-fast-tag-insert (kwd tags face &optional end)
13293 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13294 (insert (format "%-12s" (concat kwd ":"))
13295 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13296 (or end "")))
13298 (defun org-fast-tag-show-exit (flag)
13299 (save-excursion
13300 (org-goto-line 3)
13302 (replace-match ""))
13303 (when flag
13304 (end-of-line 1)
13305 (org-move-to-column (- (window-width) 19) t)
13306 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13308 (defun org-set-current-tags-overlay (current prefix)
13309 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13310 (if (featurep 'xemacs)
13311 (org-overlay-display org-tags-overlay (concat prefix s)
13312 'secondary-selection)
13313 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13314 (org-overlay-display org-tags-overlay (concat prefix s)))))
13316 (defvar org-last-tag-selection-key nil)
13317 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13318 "Fast tag selection with single keys.
13319 CURRENT is the current list of tags in the headline, INHERITED is the
13320 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13321 possibly with grouping information. TODO-TABLE is a similar table with
13322 TODO keywords, should these have keys assigned to them.
13323 If the keys are nil, a-z are automatically assigned.
13324 Returns the new tags string, or nil to not change the current settings."
13325 (let* ((fulltable (append table todo-table))
13326 (maxlen (apply 'max (mapcar
13327 (lambda (x)
13328 (if (stringp (car x)) (string-width (car x)) 0))
13329 fulltable)))
13330 (buf (current-buffer))
13331 (expert (eq org-fast-tag-selection-single-key 'expert))
13332 (buffer-tags nil)
13333 (fwidth (+ maxlen 3 1 3))
13334 (ncol (/ (- (window-width) 4) fwidth))
13335 (i-face 'org-done)
13336 (c-face 'org-todo)
13337 tg cnt e c char c1 c2 ntable tbl rtn
13338 ov-start ov-end ov-prefix
13339 (exit-after-next org-fast-tag-selection-single-key)
13340 (done-keywords org-done-keywords)
13341 groups ingroup)
13342 (save-excursion
13343 (beginning-of-line 1)
13344 (if (looking-at
13346 (setq ov-start (match-beginning 1)
13347 ov-end (match-end 1)
13348 ov-prefix "")
13349 (setq ov-start (1- (point-at-eol))
13350 ov-end (1+ ov-start))
13352 (setq ov-prefix
13353 (concat
13354 (buffer-substring (1- (point)) (point))
13355 (if (> (current-column) org-tags-column)
13356 " "
13357 (make-string (- org-tags-column (current-column)) ?\ ))))))
13358 (move-overlay org-tags-overlay ov-start ov-end)
13359 (save-window-excursion
13360 (if expert
13361 (set-buffer (get-buffer-create " *Org tags*"))
13362 (delete-other-windows)
13363 (split-window-vertically)
13364 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13365 (erase-buffer)
13366 (org-set-local 'org-done-keywords done-keywords)
13369 (org-fast-tag-show-exit exit-after-next)
13370 (org-set-current-tags-overlay current ov-prefix)
13371 (setq tbl fulltable char ?a cnt 0)
13372 (while (setq e (pop tbl))
13373 (cond
13374 ((equal (car e) :startgroup)
13375 (push '() groups) (setq ingroup t)
13376 (when (not (= cnt 0))
13377 (setq cnt 0)
13379 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13380 ((equal (car e) :endgroup)
13381 (setq ingroup nil cnt 0)
13383 ((equal e '(:newline))
13384 (when (not (= cnt 0))
13385 (setq cnt 0)
13387 (setq e (car tbl))
13388 (while (equal (car tbl) '(:newline))
13390 (setq tbl (cdr tbl)))))
13391 (t
13392 (setq tg (copy-sequence (car e)) c2 nil)
13393 (if (cdr e)
13394 (setq c (cdr e))
13395 ;; automatically assign a character.
13396 (setq c1 (string-to-char
13397 (downcase (substring
13398 tg (if (= (string-to-char tg) ?@) 1 0)))))
13399 (if (or (rassoc c1 ntable) (rassoc c1 table))
13400 (while (or (rassoc char ntable) (rassoc char table))
13401 (setq char (1+ char)))
13402 (setq c2 c1))
13403 (setq c (or c2 char)))
13404 (if ingroup (push tg (car groups)))
13405 (setq tg (org-add-props tg nil 'face
13406 (cond
13407 ((not (assoc tg table))
13408 (org-get-todo-face tg))
13409 ((member tg current) c-face)
13410 ((member tg inherited) i-face)
13411 (t nil))))
13412 (if (and (= cnt 0) (not ingroup)) (insert " "))
13413 (insert "[" c "] " tg (make-string
13414 (- fwidth 4 (length tg)) ?\ ))
13415 (push (cons tg c) ntable)
13416 (when (= (setq cnt (1+ cnt)) ncol)
13418 (if ingroup (insert " "))
13419 (setq cnt 0)))))
13420 (setq ntable (nreverse ntable))
13422 (goto-char (point-min))
13423 (if (not expert) (org-fit-window-to-buffer))
13424 (setq rtn
13425 (catch 'exit
13426 (while t
13427 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13428 (if (not groups) "no " "")
13429 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13430 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13431 (setq org-last-tag-selection-key c)
13432 (cond
13434 ((= c ?!)
13435 (setq groups (not groups))
13436 (goto-char (point-min))
13437 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13438 ((= c ?\C-c)
13439 (if (not expert)
13440 (org-fast-tag-show-exit
13441 (setq exit-after-next (not exit-after-next)))
13442 (setq expert nil)
13443 (delete-other-windows)
13444 (set-window-buffer (split-window-vertically) " *Org tags*")
13445 (org-switch-to-buffer-other-window " *Org tags*")
13446 (org-fit-window-to-buffer)))
13447 ((or (= c ?\C-g)
13448 (and (= c ?q) (not (rassoc c ntable))))
13449 (org-detach-overlay org-tags-overlay)
13450 (setq quit-flag t))
13451 ((= c ?\ )
13452 (setq current nil)
13453 (if exit-after-next (setq exit-after-next 'now)))
13455 (condition-case nil
13456 (setq tg (org-icompleting-read
13457 "Tag: "
13458 (or buffer-tags
13459 (with-current-buffer buf
13460 (org-get-buffer-tags)))))
13461 (quit (setq tg "")))
13463 (add-to-list 'buffer-tags (list tg))
13464 (if (member tg current)
13465 (setq current (delete tg current))
13466 (push tg current)))
13467 (if exit-after-next (setq exit-after-next 'now)))
13468 ((setq e (rassoc c todo-table) tg (car e))
13469 (with-current-buffer buf
13470 (save-excursion (org-todo tg)))
13471 (if exit-after-next (setq exit-after-next 'now)))
13472 ((setq e (rassoc c ntable) tg (car e))
13473 (if (member tg current)
13474 (setq current (delete tg current))
13475 (loop for g in groups do
13476 (if (member tg g)
13477 (mapc (lambda (x)
13478 (setq current (delete x current)))
13479 g)))
13480 (push tg current))
13481 (if exit-after-next (setq exit-after-next 'now))))
13483 ;; Create a sorted list
13484 (setq current
13485 (sort current
13486 (lambda (a b)
13487 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13488 (if (eq exit-after-next 'now) (throw 'exit t))
13489 (goto-char (point-min))
13490 (beginning-of-line 2)
13491 (delete-region (point) (point-at-eol))
13492 (org-fast-tag-insert "Current" current c-face)
13493 (org-set-current-tags-overlay current ov-prefix)
13494 (while (re-search-forward
13496 (setq tg (match-string 1))
13497 (add-text-properties
13498 (match-beginning 1) (match-end 1)
13499 (list 'face
13500 (cond
13501 ((member tg current) c-face)
13502 ((member tg inherited) i-face)
13503 (t (get-text-property (match-beginning 1) 'face))))))
13504 (goto-char (point-min)))))
13505 (org-detach-overlay org-tags-overlay)
13506 (if rtn
13507 (mapconcat 'identity current ":")
13508 nil))))
13510 (defun org-get-tags-string ()
13511 "Get the TAGS string in the current headline."
13512 (unless (org-on-heading-p t)
13513 (error "Not on a heading"))
13514 (save-excursion
13515 (beginning-of-line 1)
13517 (org-match-string-no-properties 1)
13518 "")))
13520 (defun org-get-tags ()
13521 "Get the list of tags specified in the current headline."
13522 (org-split-string (org-get-tags-string) ":"))
13524 (defun org-get-buffer-tags ()
13525 "Get a table of all tags used in the buffer, for completion."
13526 (let (tags)
13527 (save-excursion
13528 (goto-char (point-min))
13529 (while (re-search-forward
13531 (when (equal (char-after (point-at-bol 0)) ?*)
13532 (mapc (lambda (x) (add-to-list 'tags x))
13533 (org-split-string (org-match-string-no-properties 1) ":")))))
13534 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13535 (mapcar 'list tags)))
13537 ;;;; The mapping API
13539 ;;;###autoload
13540 (defun org-map-entries (func &optional match scope &rest skip)
13541 "Call FUNC at each headline selected by MATCH in SCOPE.
13543 FUNC is a function or a lisp form. The function will be called without
13544 arguments, with the cursor positioned at the beginning of the headline.
13545 The return values of all calls to the function will be collected and
13546 returned as a list.
13548 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13549 does not need to preserve point. After evaluation, the cursor will be
13550 moved to the end of the line (presumably of the headline of the
13551 processed entry) and search continues from there. Under some
13552 circumstances, this may not produce the wanted results. For example,
13553 if you have removed (e.g. archived) the current (sub)tree it could
13554 mean that the next entry will be skipped entirely. In such cases, you
13555 can specify the position from where search should continue by making
13556 FUNC set the variable `org-map-continue-from' to the desired buffer
13557 position.
13559 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13560 Only headlines that are matched by this query will be considered during
13561 the iteration. When MATCH is nil or t, all headlines will be
13562 visited by the iteration.
13564 SCOPE determines the scope of this command. It can be any of:
13566 nil The current buffer, respecting the restriction if any
13567 tree The subtree started with the entry at point
13568 region The entries within the active region, if any
13569 file The current buffer, without restriction
13570 file-with-archives
13571 The current buffer, and any archives associated with it
13572 agenda All agenda files
13573 agenda-with-archives
13574 All agenda files with any archive files associated with them
13575 \(file1 file2 ...)
13576 If this is a list, all files in the list will be scanned
13578 The remaining args are treated as settings for the skipping facilities of
13579 the scanner. The following items can be given here:
13581 archive skip trees with the archive tag.
13582 comment skip trees with the COMMENT keyword
13583 function or Emacs Lisp form:
13584 will be used as value for `org-agenda-skip-function', so whenever
13585 the function returns t, FUNC will not be called for that
13586 entry and search will continue from the point where the
13587 function leaves it.
13589 If your function needs to retrieve the tags including inherited tags
13590 at the *current* entry, you can use the value of the variable
13591 `org-scanner-tags' which will be much faster than getting the value
13592 with `org-get-tags-at'. If your function gets properties with
13593 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13594 to t around the call to `org-entry-properties' to get the same speedup.
13595 Note that if your function moves around to retrieve tags and properties at
13596 a *different* entry, you cannot use these techniques."
13597 (let* ((org-agenda-archives-mode nil) ; just to make sure
13598 (org-agenda-skip-archived-trees (memq 'archive skip))
13599 (org-agenda-skip-comment-trees (memq 'comment skip))
13600 (org-agenda-skip-function
13601 (car (org-delete-all '(comment archive) skip)))
13602 (org-tags-match-list-sublevels t)
13603 matcher file res
13604 org-todo-keywords-for-agenda
13605 org-done-keywords-for-agenda
13606 org-todo-keyword-alist-for-agenda
13607 org-drawers-for-agenda
13608 org-tag-alist-for-agenda)
13610 (cond
13611 ((eq match t) (setq matcher t))
13612 ((eq match nil) (setq matcher t))
13613 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13615 (save-excursion
13616 (save-restriction
13617 (cond ((eq scope 'tree)
13618 (org-back-to-heading t)
13619 (org-narrow-to-subtree)
13620 (setq scope nil))
13621 ((and (eq scope 'region) (org-region-active-p))
13622 (narrow-to-region (region-beginning) (region-end))
13623 (setq scope nil)))
13625 (if (not scope)
13626 (progn
13627 (org-prepare-agenda-buffers
13628 (list (buffer-file-name (current-buffer))))
13629 (setq res (org-scan-tags func matcher)))
13630 ;; Get the right scope
13631 (cond
13632 ((and scope (listp scope) (symbolp (car scope)))
13633 (setq scope (eval scope)))
13634 ((eq scope 'agenda)
13635 (setq scope (org-agenda-files t)))
13636 ((eq scope 'agenda-with-archives)
13637 (setq scope (org-agenda-files t))
13638 (setq scope (org-add-archive-files scope)))
13639 ((eq scope 'file)
13640 (setq scope (list (buffer-file-name))))
13641 ((eq scope 'file-with-archives)
13642 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13643 (org-prepare-agenda-buffers scope)
13644 (while (setq file (pop scope))
13645 (with-current-buffer (org-find-base-buffer-visiting file)
13646 (save-excursion
13647 (save-restriction
13648 (widen)
13649 (goto-char (point-min))
13650 (setq res (append res (org-scan-tags func matcher))))))))))
13651 res))
13653 ;;;; Properties
13655 ;;; Setting and retrieving properties
13657 (defconst org-special-properties
13658 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13659 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13660 "The special properties valid in Org-mode.
13662 These are properties that are not defined in the property drawer,
13663 but in some other way.")
13665 (defconst org-default-properties
13666 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13667 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13668 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13669 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13670 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13671 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13672 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13673 "Some properties that are used by Org-mode for various purposes.
13674 Being in this list makes sure that they are offered for completion.")
13677 "Regular expression matching the first line of a property drawer.")
13680 "Regular expression matching the last line of a property drawer.")
13683 "Regular expression matching the first line of a property drawer.")
13686 "Regular expression matching the first line of a property drawer.")
13688 (defconst org-property-drawer-re
13691 "Matches an entire property drawer.")
13693 (defconst org-clock-drawer-re
13696 "Matches an entire clock drawer.")
13698 (defsubst org-re-property (property)
13699 "Return a regexp matching PROPERTY.
13700 Match group 1 will be set to the value "
13703 (defun org-property-action ()
13704 "Do an action on properties."
13705 (interactive)
13706 (let (c)
13707 (org-at-property-p)
13708 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13709 (setq c (read-char-exclusive))
13710 (cond
13711 ((equal c ?s)
13712 (call-interactively 'org-set-property))
13713 ((equal c ?d)
13714 (call-interactively 'org-delete-property))
13715 ((equal c ?D)
13716 (call-interactively 'org-delete-property-globally))
13717 ((equal c ?c)
13718 (call-interactively 'org-compute-property-at-point))
13719 (t (error "No such property action %c" c)))))
13721 (defun org-set-effort (&optional value)
13722 "Set the effort property of the current entry.
13723 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13724 allowed value."
13725 (interactive "P")
13726 (if (equal value 0) (setq value 10))
13727 (let* ((completion-ignore-case t)
13728 (prop org-effort-property)
13729 (cur (org-entry-get nil prop))
13730 (allowed (org-property-get-allowed-values nil prop 'table))
13731 (existing (mapcar 'list (org-property-values prop)))
13732 rpl
13733 (val (cond
13734 ((stringp value) value)
13735 ((and allowed (integerp value))
13736 (or (car (nth (1- value) allowed))
13737 (car (org-last allowed))))
13738 (allowed
13739 (message "Select 1-9,0, [RET%s]: %s"
13740 (if cur (concat "=" cur) "")
13741 (mapconcat 'car allowed " "))
13742 (setq rpl (read-char-exclusive))
13744 cur
13745 (setq rpl (- rpl ?0))
13746 (if (equal rpl 0) (setq rpl 10))
13747 (if (and (> rpl 0) (<= rpl (length allowed)))
13748 (car (nth (1- rpl) allowed))
13749 (org-completing-read "Effort: " allowed nil))))
13750 (t
13751 (let (org-completion-use-ido org-completion-use-iswitchb)
13752 (org-completing-read
13754 (concat "[" cur "]") "")
13755 ": ")
13756 existing nil nil "" nil cur))))))
13757 (unless (equal (org-entry-get nil prop) val)
13758 (org-entry-put nil prop val))
13759 (message "%s is now %s" prop val)))
13761 (defun org-at-property-p ()
13762 "Is cursor inside a property drawer?"
13763 (save-excursion
13764 (beginning-of-line 1)
13766 (save-match-data ;; Used by calling procedures
13767 (let ((p (point))
13768 (range (unless (org-before-first-heading-p)
13769 (org-get-property-block))))
13770 (and range (<= (car range) p) (< p (cdr range))))))))
13772 (defun org-get-property-block (&optional beg end force)
13773 "Return the (beg . end) range of the body of the property drawer.
13774 BEG and END can be beginning and end of subtree, if not given
13775 they will be found.
13776 If the drawer does not exist and FORCE is non-nil, create the drawer."
13777 (catch 'exit
13778 (save-excursion
13779 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13780 (end (or end (progn (outline-next-heading) (point)))))
13781 (goto-char beg)
13782 (if (re-search-forward org-property-start-re end t)
13783 (setq beg (1+ (match-end 0)))
13784 (if force
13785 (save-excursion
13786 (org-insert-property-drawer)
13787 (setq end (progn (outline-next-heading) (point))))
13788 (throw 'exit nil))
13789 (goto-char beg)
13790 (if (re-search-forward org-property-start-re end t)
13791 (setq beg (1+ (match-end 0)))))
13792 (if (re-search-forward org-property-end-re end t)
13793 (setq end (match-beginning 0))
13794 (or force (throw 'exit nil))
13795 (goto-char beg)
13796 (setq end beg)
13797 (org-indent-line-function)
13799 (cons beg end)))))
13801 (defun org-entry-properties (&optional pom which specific)
13802 "Get all properties of the entry at point-or-marker POM.
13803 This includes the TODO keyword, the tags, time strings for deadline,
13804 scheduled, and clocking, and any additional properties defined in the
13805 entry. The return value is an alist, keys may occur multiple times
13806 if the property key was used several times.
13807 POM may also be nil, in which case the current entry is used.
13808 If WHICH is nil or `all', get all properties. If WHICH is
13809 `special' or `standard', only get that subclass. If WHICH
13810 is a string only get exactly this property. SPECIFIC can be a string, the
13811 specific property we are interested in. Specifying it can speed
13812 things up because then unnecessary parsing is avoided."
13813 (setq which (or which 'all))
13814 (org-with-point-at pom
13815 (let ((clockstr (substring org-clock-string 0 -1))
13816 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13817 (case-fold-search nil)
13818 beg end range props sum-props key key1 value string clocksum)
13819 (save-excursion
13820 (when (condition-case nil
13821 (and (org-mode-p) (org-back-to-heading t))
13822 (error nil))
13823 (setq beg (point))
13824 (setq sum-props (get-text-property (point) 'org-summaries))
13825 (setq clocksum (get-text-property (point) :org-clock-minutes))
13826 (outline-next-heading)
13827 (setq end (point))
13828 (when (memq which '(all special))
13829 ;; Get the special properties, like TODO and tags
13830 (goto-char beg)
13831 (when (and (or (not specific) (string= specific "TODO"))
13832 (looking-at org-todo-line-regexp) (match-end 2))
13833 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13834 (when (and (or (not specific) (string= specific "PRIORITY"))
13835 (looking-at org-priority-regexp))
13836 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13837 (when (or (not specific) (string= specific "FILE"))
13838 (push (cons "FILE" buffer-file-name) props))
13839 (when (and (or (not specific) (string= specific "TAGS"))
13840 (setq value (org-get-tags-string))
13842 (push (cons "TAGS" value) props))
13843 (when (and (or (not specific) (string= specific "ALLTAGS"))
13844 (setq value (org-get-tags-at)))
13845 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13846 ":"))
13847 props))
13848 (when (or (not specific) (string= specific "BLOCKED"))
13849 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13850 (when (or (not specific)
13851 (member specific
13852 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13853 "TIMESTAMP" "TIMESTAMP_IA")))
13854 (catch 'match
13855 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13856 (setq key (if (match-end 1)
13857 (substring (org-match-string-no-properties 1)
13858 0 -1))
13859 string (if (equal key clockstr)
13860 (org-no-properties
13861 (org-trim
13862 (buffer-substring
13863 (match-beginning 3) (goto-char
13864 (point-at-eol)))))
13865 (substring (org-match-string-no-properties 3)
13866 1 -1)))
13867 ;; Get the correct property name from the key. This is
13868 ;; necessary if the user has configured time keywords.
13869 (setq key1 (concat key ":"))
13870 (cond
13871 ((not key)
13872 (setq key
13873 (if (= (char-after (match-beginning 3)) ?\[)
13874 "TIMESTAMP_IA" "TIMESTAMP")))
13875 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13876 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13877 ((equal key1 org-closed-string) (setq key "CLOSED"))
13878 ((equal key1 org-clock-string) (setq key "CLOCK")))
13879 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13880 (progn
13881 (push (cons key string) props)
13882 ;; no need to search further if match is found
13883 (throw 'match t))
13884 (when (or (equal key "CLOCK") (not (assoc key props)))
13885 (push (cons key string) props))))))
13886 )
13888 (when (memq which '(all standard))
13889 ;; Get the standard properties, like :PROP: ...
13890 (setq range (org-get-property-block beg end))
13891 (when range
13892 (goto-char (car range))
13893 (while (re-search-forward
13895 (cdr range) t)
13896 (setq key (org-match-string-no-properties 1)
13897 value (org-trim (or (org-match-string-no-properties 2) "")))
13898 (unless (member key excluded)
13899 (push (cons key (or value "")) props)))))
13900 (if clocksum
13901 (push (cons "CLOCKSUM"
13902 (org-columns-number-to-string (/ (float clocksum) 60.)
13903 'add_times))
13904 props))
13905 (unless (assoc "CATEGORY" props)
13906 (push (cons "CATEGORY" (org-get-category)) props))
13907 (append sum-props (nreverse props)))))))
13909 (defun org-entry-get (pom property &optional inherit literal-nil)
13910 "Get value of PROPERTY for entry at point-or-marker POM.
13911 If INHERIT is non-nil and the entry does not have the property,
13912 then also check higher levels of the hierarchy.
13913 If INHERIT is the symbol `selective', use inheritance only if the setting
13914 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13915 If the property is present but empty, the return value is the empty string.
13916 If the property is not present at all, nil is returned.
13919 do not interpret it as the list atom nil. This is used for inheritance
13921 (org-with-point-at pom
13922 (if (and inherit (if (eq inherit 'selective)
13923 (org-property-inherit-p property)
13924 t))
13925 (org-entry-get-with-inheritance property literal-nil)
13926 (if (member property org-special-properties)
13927 ;; We need a special property. Use `org-entry-properties' to
13928 ;; retrieve it, but specify the wanted property
13929 (cdr (assoc property (org-entry-properties nil 'special property)))
13930 (let ((range (unless (org-before-first-heading-p)
13931 (org-get-property-block))))
13932 (if (and range
13933 (goto-char (car range))
13934 (re-search-forward
13935 (org-re-property property)
13936 (cdr range) t))
13937 ;; Found the property, return it.
13938 (if (match-end 1)
13939 (if literal-nil
13940 (org-match-string-no-properties 1)
13941 (org-not-nil (org-match-string-no-properties 1)))
13942 "")))))))
13944 (defun org-property-or-variable-value (var &optional inherit)
13945 "Check if there is a property fixing the value of VAR.
13946 If yes, return this value. If not, return the current value of the variable."
13947 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13949 (read prop)
13950 (symbol-value var))))
13952 (defun org-entry-delete (pom property)
13953 "Delete the property PROPERTY from entry at point-or-marker POM."
13954 (org-with-point-at pom
13955 (if (member property org-special-properties)
13956 nil ; cannot delete these properties.
13957 (let ((range (org-get-property-block)))
13958 (if (and range
13959 (goto-char (car range))
13960 (re-search-forward
13961 (org-re-property property)
13962 (cdr range) t))
13963 (progn
13964 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13965 t)
13966 nil)))))
13968 ;; Multi-values properties are properties that contain multiple values
13969 ;; These values are assumed to be single words, separated by whitespace.
13970 (defun org-entry-add-to-multivalued-property (pom property value)
13971 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13972 (let* ((old (org-entry-get pom property))
13974 (setq value (org-entry-protect-space value))
13975 (unless (member value values)
13976 (setq values (cons value values))
13977 (org-entry-put pom property
13978 (mapconcat 'identity values " ")))))
13980 (defun org-entry-remove-from-multivalued-property (pom property value)
13981 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13982 (let* ((old (org-entry-get pom property))
13984 (setq value (org-entry-protect-space value))
13985 (when (member value values)
13986 (setq values (delete value values))
13987 (org-entry-put pom property
13988 (mapconcat 'identity values " ")))))
13990 (defun org-entry-member-in-multivalued-property (pom property value)
13991 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13992 (let* ((old (org-entry-get pom property))
13994 (setq value (org-entry-protect-space value))
13995 (member value values)))
13997 (defun org-entry-get-multivalued-property (pom property)
13998 "Return a list of values in a multivalued property."
13999 (let* ((value (org-entry-get pom property))
14001 (mapcar 'org-entry-restore-space values)))
14003 (defun org-entry-put-multivalued-property (pom property &rest values)
14004 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14005 VALUES should be a list of strings. Spaces will be protected."
14006 (org-entry-put pom property
14007 (mapconcat 'org-entry-protect-space values " "))
14008 (let* ((value (org-entry-get pom property))
14010 (mapcar 'org-entry-restore-space values)))
14012 (defun org-entry-protect-space (s)
14013 "Protect spaces and newline in string S."
14014 (while (string-match " " s)
14015 (setq s (replace-match "%20" t t s)))
14017 (setq s (replace-match "%0A" t t s)))
14018 s)
14020 (defun org-entry-restore-space (s)
14021 "Restore spaces and newline in string S."
14022 (while (string-match "%20" s)
14023 (setq s (replace-match " " t t s)))
14024 (while (string-match "%0A" s)
14026 s)
14028 (defvar org-entry-property-inherited-from (make-marker)
14029 "Marker pointing to the entry from where a property was inherited.
14030 Each call to `org-entry-get-with-inheritance' will set this marker to the
14031 location of the entry where the inheritance search matched. If there was
14032 no match, the marker will point nowhere.
14033 Note that also `org-entry-get' calls this function, if the INHERIT flag
14034 is set.")
14036 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14037 "Get entry property, and search higher levels if not present.
14038 The search will stop at the first ancestor which has the property defined.
14040 should be considered as undefined (this is the meaning of nil here).
14042 (move-marker org-entry-property-inherited-from nil)
14043 (let (tmp)
14044 (unless (org-before-first-heading-p)
14045 (save-excursion
14046 (save-restriction
14047 (widen)
14048 (catch 'ex
14049 (while t
14050 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14051 (org-back-to-heading t)
14052 (move-marker org-entry-property-inherited-from (point))
14053 (throw 'ex tmp))
14054 (or (org-up-heading-safe) (throw 'ex nil)))))))
14055 (setq tmp (or tmp
14056 (cdr (assoc property org-file-properties))
14057 (cdr (assoc property org-global-properties))
14058 (cdr (assoc property org-global-properties-fixed))))
14059 (if literal-nil tmp (org-not-nil tmp))))
14061 (defvar org-property-changed-functions nil
14062 "Hook called when the value of a property has changed.
14063 Each hook function should accept two arguments, the name of the property
14064 and the new value.")
14066 (defun org-entry-put (pom property value)
14067 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14068 (org-with-point-at pom
14069 (org-back-to-heading t)
14070 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14071 range)
14072 (cond
14073 ((equal property "TODO")
14075 (not (member value org-todo-keywords-1)))
14077 (if (or (not value)
14079 (setq value 'none))
14080 (org-todo value)
14081 (org-set-tags nil 'align))
14082 ((equal property "PRIORITY")
14084 (string-to-char value) ?\ ))
14085 (org-set-tags nil 'align))
14086 ((equal property "SCHEDULED")
14087 (if (re-search-forward org-scheduled-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-schedule)))
14092 (call-interactively 'org-schedule)))
14093 ((equal property "DEADLINE")
14094 (if (re-search-forward org-deadline-time-regexp end t)
14095 (cond
14096 ((eq value 'earlier) (org-timestamp-change -1 'day))
14097 ((eq value 'later) (org-timestamp-change 1 'day))
14098 (t (call-interactively 'org-deadline)))
14099 (call-interactively 'org-deadline)))
14100 ((member property org-special-properties)
14101 (error "The %s property can not yet be set with `org-entry-put'"
14102 property))
14103 (t ; a non-special property
14104 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14105 (setq range (org-get-property-block beg end 'force))
14106 (goto-char (car range))
14107 (if (re-search-forward
14108 (org-re-property property) (cdr range) t)
14109 (progn
14110 (delete-region (match-beginning 0) (match-end 0))
14111 (goto-char (match-beginning 0)))
14112 (goto-char (cdr range))
14114 (backward-char 1)
14115 (org-indent-line-function))
14116 (insert ":" property ":")
14117 (and value (insert " " value))
14118 (org-indent-line-function)))))
14119 (run-hook-with-args 'org-property-changed-functions property value)))
14121 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14122 "Get all property keys in the current buffer.
14123 With INCLUDE-SPECIALS, also list the special properties that reflect things
14124 like tags and TODO state.
14125 With INCLUDE-DEFAULTS, also include properties that has special meaning
14126 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14127 and others.
14128 With INCLUDE-COLUMNS, also include property names given in COLUMN
14129 formats in the current buffer."
14130 (let (rtn range cfmt s p)
14131 (save-excursion
14132 (save-restriction
14133 (widen)
14134 (goto-char (point-min))
14135 (while (re-search-forward org-property-start-re nil t)
14136 (setq range (org-get-property-block))
14137 (goto-char (car range))
14138 (while (re-search-forward
14140 (cdr range) t)
14141 (add-to-list 'rtn (org-match-string-no-properties 1)))
14142 (outline-next-heading))))
14144 (when include-specials
14145 (setq rtn (append org-special-properties rtn)))
14147 (when include-defaults
14148 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14149 (add-to-list 'rtn org-effort-property))
14151 (when include-columns
14152 (save-excursion
14153 (save-restriction
14154 (widen)
14155 (goto-char (point-min))
14156 (while (re-search-forward
14158 nil t)
14159 (setq cfmt (match-string 2) s 0)
14161 cfmt s)
14162 (setq s (match-end 0)
14163 p (match-string 1 cfmt))
14164 (unless (or (equal p "ITEM")
14165 (member p org-special-properties))
14166 (add-to-list 'rtn (match-string 1 cfmt))))))))
14168 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14170 (defun org-property-values (key)
14171 "Return a list of all values of property KEY in the current buffer."
14172 (save-excursion
14173 (save-restriction
14174 (widen)
14175 (goto-char (point-min))
14176 (let ((re (org-re-property key))
14177 values)
14178 (while (re-search-forward re nil t)
14179 (add-to-list 'values (org-trim (match-string 1))))
14180 (delete "" values)))))
14182 (defun org-insert-property-drawer ()
14183 "Insert a property drawer into the current entry."
14184 (interactive)
14185 (org-back-to-heading t)
14186 (looking-at org-outline-regexp)
14187 (let ((indent (if org-adapt-indentation
14188 (- (match-end 0)(match-beginning 0))
14189 0))
14190 (beg (point))
14192 end hiddenp)
14193 (outline-next-heading)
14194 (setq end (point))
14195 (goto-char beg)
14196 (while (re-search-forward re end t))
14197 (setq hiddenp (outline-invisible-p))
14198 (end-of-line 1)
14201 (if (member (match-string 1) '("CLOCK:" ":END:"))
14202 ;; just skip this line
14203 (beginning-of-line 2)
14204 ;; Drawer start, find the end
14206 (beginning-of-line 1)))
14207 (org-skip-over-state-notes)
14209 (if (eq (char-before) ?*) (forward-char 1))
14211 (beginning-of-line 0)
14212 (org-indent-to-column indent)
14213 (beginning-of-line 2)
14214 (org-indent-to-column indent)
14215 (beginning-of-line 0)
14216 (if hiddenp
14217 (save-excursion
14218 (org-back-to-heading t)
14219 (hide-entry))
14220 (org-flag-drawer t))))
14222 (defvar org-property-set-functions-alist nil
14223 "Property set function alist.
14224 Each entry should have the following format:
14226 (PROPERTY . READ-FUNCTION)
14228 The read function will be called with the same argument as
14229 `org-completing-read'.")
14231 (defun org-set-property-function (property)
14232 "Get the function that should be used to set PROPERTY.
14233 This is computed according to `org-property-set-functions-alist'."
14234 (or (cdr (assoc property org-property-set-functions-alist))
14235 'org-completing-read))
14237 (defun org-read-property-value (property)
14238 "Read PROPERTY value from user."
14239 (let* ((completion-ignore-case t)
14240 (allowed (org-property-get-allowed-values nil property 'table))
14241 (cur (org-entry-get nil property))
14242 (prompt (concat property " value"
14244 (concat " [" cur "]") "") ": "))
14245 (set-function (org-set-property-function property))
14246 (val (if allowed
14247 (funcall set-function prompt allowed nil
14248 (not (get-text-property 0 'org-unrestricted
14249 (caar allowed))))
14250 (let (org-completion-use-ido org-completion-use-iswitchb)
14251 (funcall set-function prompt
14252 (mapcar 'list (org-property-values property))
14253 nil nil "" nil cur)))))
14254 (if (equal val "")
14255 cur
14256 val)))
14258 (defvar org-last-set-property nil)
14259 (defun org-read-property-name ()
14260 "Read a property name."
14261 (let* ((completion-ignore-case t)
14262 (keys (org-buffer-property-keys nil t t))
14263 (default-prop (or (save-excursion
14264 (save-match-data
14265 (beginning-of-line)
14267 (null (string= (match-string 1) "END"))
14268 (match-string 1))))
14269 org-last-set-property))
14270 (property (org-icompleting-read
14271 (concat "Property"
14272 (if default-prop (concat " [" default-prop "]") "")
14273 ": ")
14274 (mapcar 'list keys)
14275 nil nil nil nil
14276 default-prop
14277 )))
14278 (if (member property keys)
14279 property
14280 (or (cdr (assoc (downcase property)
14281 (mapcar (lambda (x) (cons (downcase x) x))
14282 keys)))
14283 property))))
14285 (defun org-set-property (property value)
14286 "In the current entry, set PROPERTY to VALUE.
14287 When called interactively, this will prompt for a property name, offering
14288 completion on existing and default properties. And then it will prompt
14289 for a value, offering completion either on allowed values (via an inherited
14290 xxx_ALL property) or on existing values in other instances of this property
14291 in the current file."
14292 (interactive (list nil nil))
14293 (let* ((property (or property (org-read-property-name)))
14294 (value (or value (org-read-property-value property))))
14295 (setq org-last-set-property property)
14296 ;; Possibly postprocess the inserted value:
14297 (when (assoc property org-properties-postprocess-alist)
14298 (setq value (funcall (cadr fn) value)))
14299 (unless (equal (org-entry-get nil property) value)
14300 (org-entry-put nil property value))))
14302 (defun org-delete-property (property)
14303 "In the current entry, delete PROPERTY."
14304 (interactive
14305 (let* ((completion-ignore-case t)
14306 (prop (org-icompleting-read "Property: "
14307 (org-entry-properties nil 'standard))))
14308 (list prop)))
14309 (message "Property %s %s" property
14310 (if (org-entry-delete nil property)
14311 "deleted"
14312 "was not present in the entry")))
14314 (defun org-delete-property-globally (property)
14315 "Remove PROPERTY globally, from all entries."
14316 (interactive
14317 (let* ((completion-ignore-case t)
14318 (prop (org-icompleting-read
14319 "Globally remove property: "
14320 (mapcar 'list (org-buffer-property-keys)))))
14321 (list prop)))
14322 (save-excursion
14323 (save-restriction
14324 (widen)
14325 (goto-char (point-min))
14326 (let ((cnt 0))
14327 (while (re-search-forward
14328 (org-re-property property)
14329 nil t)
14330 (setq cnt (1+ cnt))
14331 (replace-match ""))
14334 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14336 (defun org-compute-property-at-point ()
14337 "Compute the property at point.
14338 This looks for an enclosing column format, extracts the operator and
14339 then applies it to the property in the column format's scope."
14340 (interactive)
14341 (unless (org-at-property-p)
14342 (error "Not at a property"))
14343 (let ((prop (org-match-string-no-properties 2)))
14344 (org-columns-get-format-and-top-level)
14345 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14346 (error "No operator defined for property %s" prop))
14347 (org-columns-compute prop)))
14349 (defvar org-property-allowed-value-functions nil
14350 "Hook for functions supplying allowed values for a specific property.
14351 The functions must take a single argument, the name of the property, and
14353 the values, this means that these values are intended as defaults for
14354 completion, but that other values should be allowed too.
14355 The functions must return nil if they are not responsible for this
14356 property.")
14358 (defun org-property-get-allowed-values (pom property &optional table)
14359 "Get allowed values for the property PROPERTY.
14360 When TABLE is non-nil, return an alist that can directly be used for
14361 completion."
14362 (let (vals)
14363 (cond
14364 ((equal property "TODO")
14365 (setq vals (org-with-point-at pom
14366 (append org-todo-keywords-1 '("")))))
14367 ((equal property "PRIORITY")
14368 (let ((n org-lowest-priority))
14369 (while (>= n org-highest-priority)
14370 (push (char-to-string n) vals)
14371 (setq n (1- n)))))
14372 ((member property org-special-properties))
14373 ((setq vals (run-hook-with-args-until-success
14374 'org-property-allowed-value-functions property)))
14375 (t
14376 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14378 (setq vals (car (read-from-string (concat "(" vals ")"))))
14379 (setq vals (mapcar (lambda (x)
14380 (cond ((stringp x) x)
14381 ((numberp x) (number-to-string x))
14382 ((symbolp x) (symbol-name x))
14383 (t "???")))
14384 vals)))))
14385 (when (member ":ETC" vals)
14386 (setq vals (remove ":ETC" vals))
14387 (org-add-props (car vals) '(org-unrestricted t)))
14388 (if table (mapcar 'list vals) vals)))
14390 (defun org-property-previous-allowed-value (&optional previous)
14391 "Switch to the next allowed value for this property."
14392 (interactive)
14393 (org-property-next-allowed-value t))
14395 (defun org-property-next-allowed-value (&optional previous)
14396 "Switch to the next allowed value for this property."
14397 (interactive)
14398 (unless (org-at-property-p)
14399 (error "Not at a property"))
14400 (let* ((key (match-string 2))
14401 (value (match-string 3))
14402 (allowed (or (org-property-get-allowed-values (point) key)
14403 (and (member value '("[ ]" "[-]" "[X]"))
14404 '("[ ]" "[X]"))))
14405 nval)
14406 (unless allowed
14407 (error "Allowed values for this property have not been defined"))
14408 (if previous (setq allowed (reverse allowed)))
14409 (if (member value allowed)
14410 (setq nval (car (cdr (member value allowed)))))
14411 (setq nval (or nval (car allowed)))
14412 (if (equal nval value)
14413 (error "Only one allowed value for this property"))
14414 (org-at-property-p)
14415 (replace-match (concat " :" key ": " nval) t t)
14416 (org-indent-line-function)
14417 (beginning-of-line 1)
14419 (run-hook-with-args 'org-property-changed-functions key nval)))
14421 (defun org-find-olp (path &optional this-buffer)
14422 "Return a marker pointing to the entry at outline path OLP.
14423 If anything goes wrong, throw an error.
14424 You can wrap this call to catch the error like this:
14426 (condition-case msg
14427 (org-mobile-locate-entry (match-string 4))
14428 (error (nth 1 msg)))
14430 The return value will then be either a string with the error message,
14431 or a marker if everything is OK.
14433 If THIS-BUFFER is set, the outline path does not contain a file,
14434 only headings."
14435 (let* ((file (if this-buffer buffer-file-name (pop path)))
14436 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14437 (level 1)
14438 (lmin 1)
14439 (lmax 1)
14440 limit re end found pos heading cnt flevel)
14441 (unless buffer (error "File not found :%s" file))
14442 (with-current-buffer buffer
14443 (save-excursion
14444 (save-restriction
14445 (widen)
14446 (setq limit (point-max))
14447 (goto-char (point-min))
14448 (while (setq heading (pop path))
14449 (setq re (format org-complex-heading-regexp-format
14450 (regexp-quote heading)))
14451 (setq cnt 0 pos (point))
14452 (while (re-search-forward re end t)
14453 (setq level (- (match-end 1) (match-beginning 1)))
14454 (if (and (>= level lmin) (<= level lmax))
14455 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14456 (when (= cnt 0) (error "Heading not found on level %d: %s"
14457 lmax heading))
14458 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14459 lmax heading))
14460 (goto-char found)
14461 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14462 (setq end (save-excursion (org-end-of-subtree t t))))
14463 (when (org-on-heading-p)
14464 (move-marker (make-marker) (point))))))))
14466 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14467 "Find node HEADING in BUFFER.
14468 Return a marker to the heading if it was found, or nil if not.
14469 If POS-ONLY is set, return just the position instead of a marker.
14471 The heading text must match exact, but it may have a TODO keyword,
14472 a priority cookie and tags in the standard locations."
14473 (with-current-buffer (or buffer (current-buffer))
14474 (save-excursion
14475 (save-restriction
14476 (widen)
14477 (goto-char (point-min))
14478 (let (case-fold-search)
14479 (if (re-search-forward
14480 (format org-complex-heading-regexp-format
14481 (regexp-quote heading)) nil t)
14482 (if pos-only
14483 (match-beginning 0)
14484 (move-marker (make-marker) (match-beginning 0)))))))))
14486 (defun org-find-exact-heading-in-directory (heading &optional dir)
14487 "Find Org node headline HEADING in all .org files in directory DIR.
14488 When the target headline is found, return a marker to this location."
14489 (let ((files (directory-files (or dir default-directory)
14491 file visiting m buffer)
14492 (catch 'found
14493 (while (setq file (pop files))
14494 (message "trying %s" file)
14495 (setq visiting (org-find-base-buffer-visiting file))
14496 (setq buffer (or visiting (find-file-noselect file)))
14497 (setq m (org-find-exact-headline-in-buffer
14498 heading buffer))
14499 (when (and (not m) (not visiting)) (kill-buffer buffer))
14500 (and m (throw 'found m))))))
14502 (defun org-find-entry-with-id (ident)
14503 "Locate the entry that contains the ID property with exact value IDENT.
14504 IDENT can be a string, a symbol or a number, this function will search for
14505 the string representation of it.
14506 Return the position where this entry starts, or nil if there is no such entry."
14507 (interactive "sID: ")
14508 (let ((id (cond
14509 ((stringp ident) ident)
14510 ((symbol-name ident) (symbol-name ident))
14511 ((numberp ident) (number-to-string ident))
14512 (t (error "IDENT %s must be a string, symbol or number" ident))))
14513 (case-fold-search nil))
14514 (save-excursion
14515 (save-restriction
14516 (widen)
14517 (goto-char (point-min))
14518 (when (re-search-forward
14520 nil t)
14521 (org-back-to-heading t)
14522 (point))))))
14524 ;;;; Timestamps
14526 (defvar org-last-changed-timestamp nil)
14527 (defvar org-last-inserted-timestamp nil
14528 "The last time stamp inserted with `org-insert-time-stamp'.")
14529 (defvar org-time-was-given) ; dynamically scoped parameter
14530 (defvar org-end-time-was-given) ; dynamically scoped parameter
14531 (defvar org-ts-what) ; dynamically scoped parameter
14533 (defun org-time-stamp (arg &optional inactive)
14534 "Prompt for a date/time and insert a time stamp.
14535 If the user specifies a time like HH:MM, or if this command is called
14536 with a prefix argument, the time stamp will contain date and time.
14537 Otherwise, only the date will be included. All parts of a date not
14538 specified by the user will be filled in from the current date/time.
14539 So if you press just return without typing anything, the time stamp
14540 will represent the current date/time. If there is already a timestamp
14541 at the cursor, it will be modified."
14542 (interactive "P")
14543 (let* ((ts nil)
14544 (default-time
14545 ;; Default time is either today, or, when entering a range,
14546 ;; the range start.
14547 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14548 (save-excursion
14549 (re-search-backward
14551 (- (point) 20) t)))
14552 (apply 'encode-time (org-parse-time-string (match-string 1)))
14553 (current-time)))
14554 (default-input (and ts (org-get-compact-tod ts)))
14555 (repeater (save-excursion
14556 (save-match-data
14557 (beginning-of-line)
14558 (when (re-search-forward
14560 (save-excursion (progn (end-of-line) (point))) t)
14561 (match-string 0)))))
14562 org-time-was-given org-end-time-was-given time)
14563 (cond
14564 ((and (org-at-timestamp-p t)
14565 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14566 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14567 (insert "--")
14568 (setq time (let ((this-command this-command))
14569 (org-read-date arg 'totime nil nil
14570 default-time default-input)))
14571 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14572 ((org-at-timestamp-p t)
14573 (setq time (let ((this-command this-command))
14574 (org-read-date arg 'totime nil nil default-time default-input)))
14575 (when (org-at-timestamp-p t) ; just to get the match data
14576 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14577 (replace-match "")
14578 (setq org-last-changed-timestamp
14579 (org-insert-time-stamp
14580 time (or org-time-was-given arg)
14581 inactive nil nil (list org-end-time-was-given)))
14582 (when repeater (goto-char (1- (point))) (insert " " repeater)
14583 (setq org-last-changed-timestamp
14584 (concat (substring org-last-inserted-timestamp 0 -1)
14585 " " repeater ">"))))
14586 (message "Timestamp updated"))
14587 (t
14588 (setq time (let ((this-command this-command))
14589 (org-read-date arg 'totime nil nil default-time default-input)))
14590 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14591 nil nil (list org-end-time-was-given))))))
14593 ;; FIXME: can we use this for something else, like computing time differences?
14594 (defun org-get-compact-tod (s)
14595 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14596 (let* ((t1 (match-string 1 s))
14597 (h1 (string-to-number (match-string 2 s)))
14598 (m1 (string-to-number (match-string 3 s)))
14599 (t2 (and (match-end 4) (match-string 5 s)))
14600 (h2 (and t2 (string-to-number (match-string 6 s))))
14601 (m2 (and t2 (string-to-number (match-string 7 s))))
14602 dh dm)
14603 (if (not t2)
14604 t1
14605 (setq dh (- h2 h1) dm (- m2 m1))
14606 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14607 (concat t1 "+" (number-to-string dh)
14608 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14610 (defun org-time-stamp-inactive (&optional arg)
14611 "Insert an inactive time stamp.
14612 An inactive time stamp is enclosed in square brackets instead of angle
14613 brackets. It is inactive in the sense that it does not trigger agenda entries,
14614 does not link to the calendar and cannot be changed with the S-cursor keys.
14615 So these are more for recording a certain time/date."
14616 (interactive "P")
14617 (org-time-stamp arg 'inactive))
14619 (defvar org-date-ovl (make-overlay 1 1))
14620 (overlay-put org-date-ovl 'face 'org-warning)
14621 (org-detach-overlay org-date-ovl)
14623 (defvar org-ans1) ; dynamically scoped parameter
14624 (defvar org-ans2) ; dynamically scoped parameter
14626 (defvar org-plain-time-of-day-regexp) ; defined below
14628 (defvar org-overriding-default-time nil) ; dynamically scoped
14629 (defvar org-read-date-overlay nil)
14630 (defvar org-dcst nil) ; dynamically scoped
14631 (defvar org-read-date-history nil)
14632 (defvar org-read-date-final-answer nil)
14633 (defvar org-read-date-analyze-futurep nil)
14634 (defvar org-read-date-analyze-forced-year nil)
14636 (defun org-read-date (&optional with-time to-time from-string prompt
14637 default-time default-input)
14638 "Read a date, possibly a time, and make things smooth for the user.
14639 The prompt will suggest to enter an ISO date, but you can also enter anything
14640 which will at least partially be understood by `parse-time-string'.
14641 Unrecognized parts of the date will default to the current day, month, year,
14642 hour and minute. If this command is called to replace a timestamp at point,
14643 of to enter the second timestamp of a range, the default time is taken
14644 from the existing stamp. Furthermore, the command prefers the future,
14645 so if you are giving a date where the year is not given, and the day-month
14646 combination is already past in the current year, it will assume you
14647 mean next year. For details, see the manual. A few examples:
14649 3-2-5 --> 2003-02-05
14650 feb 15 --> currentyear-02-15
14651 2/15 --> currentyear-02-15
14652 sep 12 9 --> 2009-09-12
14653 12:45 --> today 12:45
14654 22 sept 0:34 --> currentyear-09-22 0:34
14655 12 --> currentyear-currentmonth-12
14656 Fri --> nearest Friday (today or later)
14657 etc.
14659 Furthermore you can specify a relative date by giving, as the *first* thing
14660 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14661 change in days weeks, months, years.
14662 With a single plus or minus, the date is relative to today. With a double
14663 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14664 +4d --> four days from today
14665 +4 --> same as above
14666 +2w --> two weeks from today
14667 ++5 --> five days from default date
14669 The function understands only English month and weekday abbreviations,
14670 but this can be configured with the variables `parse-time-months' and
14671 `parse-time-weekdays'.
14673 While prompting, a calendar is popped up - you can also select the
14674 date with the mouse (button 1). The calendar shows a period of three
14675 months. To scroll it to other months, use the keys `>' and `<'.
14676 If you don't like the calendar, turn it off with
14677 \(setq org-read-date-popup-calendar nil)
14679 With optional argument TO-TIME, the date will immediately be converted
14680 to an internal time.
14681 With an optional argument WITH-TIME, the prompt will suggest to also
14682 insert a time. Note that when WITH-TIME is not set, you can still
14683 enter a time, and this function will inform the calling routine about
14684 this change. The calling routine may then choose to change the format
14685 used to insert the time stamp into the buffer to include the time.
14686 With optional argument FROM-STRING, read from this string instead from
14687 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14688 the time/date that is used for everything that is not specified by the
14689 user."
14690 (require 'parse-time)
14691 (let* ((org-time-stamp-rounding-minutes
14692 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14693 (org-dcst org-display-custom-times)
14694 (ct (org-current-time))
14695 (def (or org-overriding-default-time default-time ct))
14696 (defdecode (decode-time def))
14697 (dummy (progn
14698 (when (< (nth 2 defdecode) org-extend-today-until)
14699 (setcar (nthcdr 2 defdecode) -1)
14700 (setcar (nthcdr 1 defdecode) 59)
14701 (setq def (apply 'encode-time defdecode)
14702 defdecode (decode-time def)))))
14703 (calendar-frame-setup nil)
14704 (calendar-setup nil)
14705 (calendar-move-hook nil)
14706 (calendar-view-diary-initially-flag nil)
14707 (calendar-view-holidays-initially-flag nil)
14708 (timestr (format-time-string
14709 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14710 (prompt (concat (if prompt (concat prompt " ") "")
14711 (format "Date+time [%s]: " timestr)))
14712 ans (org-ans0 "") org-ans1 org-ans2 final)
14714 (cond
14715 (from-string (setq ans from-string))
14716 (org-read-date-popup-calendar
14717 (save-excursion
14718 (save-window-excursion
14719 (calendar)
14720 (unwind-protect
14721 (progn
14722 (calendar-forward-day (- (time-to-days def)
14723 (calendar-absolute-from-gregorian
14724 (calendar-current-date))))
14725 (org-eval-in-calendar nil t)
14726 (let* ((old-map (current-local-map))
14727 (map (copy-keymap calendar-mode-map))
14728 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14729 (org-defkey map (kbd "RET") 'org-calendar-select)
14730 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14731 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14732 (org-defkey minibuffer-local-map [(meta shift left)]
14733 (lambda () (interactive)
14734 (org-eval-in-calendar '(calendar-backward-month 1))))
14735 (org-defkey minibuffer-local-map [(meta shift right)]
14736 (lambda () (interactive)
14737 (org-eval-in-calendar '(calendar-forward-month 1))))
14738 (org-defkey minibuffer-local-map [(meta shift up)]
14739 (lambda () (interactive)
14740 (org-eval-in-calendar '(calendar-backward-year 1))))
14741 (org-defkey minibuffer-local-map [(meta shift down)]
14742 (lambda () (interactive)
14743 (org-eval-in-calendar '(calendar-forward-year 1))))
14744 (org-defkey minibuffer-local-map [?\e (shift left)]
14745 (lambda () (interactive)
14746 (org-eval-in-calendar '(calendar-backward-month 1))))
14747 (org-defkey minibuffer-local-map [?\e (shift right)]
14748 (lambda () (interactive)
14749 (org-eval-in-calendar '(calendar-forward-month 1))))
14750 (org-defkey minibuffer-local-map [?\e (shift up)]
14751 (lambda () (interactive)
14752 (org-eval-in-calendar '(calendar-backward-year 1))))
14753 (org-defkey minibuffer-local-map [?\e (shift down)]
14754 (lambda () (interactive)
14755 (org-eval-in-calendar '(calendar-forward-year 1))))
14756 (org-defkey minibuffer-local-map [(shift up)]
14757 (lambda () (interactive)
14758 (org-eval-in-calendar '(calendar-backward-week 1))))
14759 (org-defkey minibuffer-local-map [(shift down)]
14760 (lambda () (interactive)
14761 (org-eval-in-calendar '(calendar-forward-week 1))))
14762 (org-defkey minibuffer-local-map [(shift left)]
14763 (lambda () (interactive)
14764 (org-eval-in-calendar '(calendar-backward-day 1))))
14765 (org-defkey minibuffer-local-map [(shift right)]
14766 (lambda () (interactive)
14767 (org-eval-in-calendar '(calendar-forward-day 1))))
14768 (org-defkey minibuffer-local-map ">"
14769 (lambda () (interactive)
14770 (org-eval-in-calendar '(scroll-calendar-left 1))))
14771 (org-defkey minibuffer-local-map "<"
14772 (lambda () (interactive)
14773 (org-eval-in-calendar '(scroll-calendar-right 1))))
14774 (org-defkey minibuffer-local-map "\C-v"
14775 (lambda () (interactive)
14776 (org-eval-in-calendar
14777 '(calendar-scroll-left-three-months 1))))
14778 (org-defkey minibuffer-local-map "\M-v"
14779 (lambda () (interactive)
14780 (org-eval-in-calendar
14781 '(calendar-scroll-right-three-months 1))))
14782 (run-hooks 'org-read-date-minibuffer-setup-hook)
14783 (unwind-protect
14784 (progn
14785 (use-local-map map)
14786 (add-hook 'post-command-hook 'org-read-date-display)
14787 (setq org-ans0 (read-string prompt default-input
14788 'org-read-date-history nil))
14789 ;; org-ans0: from prompt
14790 ;; org-ans1: from mouse click
14791 ;; org-ans2: from calendar motion
14792 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14793 (remove-hook 'post-command-hook 'org-read-date-display)
14794 (use-local-map old-map)
14795 (when org-read-date-overlay
14796 (delete-overlay org-read-date-overlay)
14797 (setq org-read-date-overlay nil)))))
14798 (bury-buffer "*Calendar*")))))
14800 (t ; Naked prompt only
14801 (unwind-protect
14802 (setq ans (read-string prompt default-input
14803 'org-read-date-history timestr))
14804 (when org-read-date-overlay
14805 (delete-overlay org-read-date-overlay)
14806 (setq org-read-date-overlay nil)))))
14808 (setq final (org-read-date-analyze ans def defdecode))
14810 (when org-read-date-analyze-forced-year
14811 (message "Year was forced into %s"
14812 (if org-read-date-force-compatible-dates
14813 "compatible range (1970-2037)"
14814 "range representable on this machine"))
14815 (ding))
14817 ;; One round trip to get rid of 34th of August and stuff like that....
14818 (setq final (decode-time (apply 'encode-time final)))
14820 (setq org-read-date-final-answer ans)
14822 (if to-time
14823 (apply 'encode-time final)
14824 (if (and (boundp 'org-time-was-given) org-time-was-given)
14825 (format "%04d-%02d-%02d %02d:%02d"
14826 (nth 5 final) (nth 4 final) (nth 3 final)
14827 (nth 2 final) (nth 1 final))
14828 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14830 (defvar def)
14831 (defvar defdecode)
14832 (defvar with-time)
14833 (defun org-read-date-display ()
14834 "Display the current date prompt interpretation in the minibuffer."
14835 (when org-read-date-display-live
14836 (when org-read-date-overlay
14837 (delete-overlay org-read-date-overlay))
14838 (let ((p (point)))
14839 (end-of-line 1)
14840 (while (not (equal (buffer-substring
14841 (max (point-min) (- (point) 4)) (point))
14842 " "))
14843 (insert " "))
14844 (goto-char p))
14845 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14846 " " (or org-ans1 org-ans2)))
14847 (org-end-time-was-given nil)
14848 (f (org-read-date-analyze ans def defdecode))
14849 (fmts (if org-dcst
14850 org-time-stamp-custom-formats
14851 org-time-stamp-formats))
14852 (fmt (if (or with-time
14853 (and (boundp 'org-time-was-given) org-time-was-given))
14854 (cdr fmts)
14855 (car fmts)))
14856 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14857 (when (and org-end-time-was-given
14858 (string-match org-plain-time-of-day-regexp txt))
14859 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14860 org-end-time-was-given
14861 (substring txt (match-end 0)))))
14862 (when org-read-date-analyze-futurep
14863 (setq txt (concat txt " (=>F)")))
14864 (setq org-read-date-overlay
14865 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14866 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14868 (defun org-read-date-analyze (ans def defdecode)
14869 "Analyze the combined answer of the date prompt."
14870 ;; FIXME: cleanup and comment
14871 (let ((nowdecode (decode-time (current-time)))
14872 delta deltan deltaw deltadef year month day
14873 hour minute second wday pm h2 m2 tl wday1
14874 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14875 (setq org-read-date-analyze-futurep nil
14876 org-read-date-analyze-forced-year nil)
14878 (setq ans "+0"))
14880 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14881 (setq ans (replace-match "" t t ans)
14882 deltan (car delta)
14883 deltaw (nth 1 delta)
14884 deltadef (nth 2 delta)))
14886 ;; Check if there is an iso week date in there
14887 ;; If yes, store the info and postpone interpreting it until the rest
14888 ;; of the parsing is done
14889 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14890 (setq iso-year (if (match-end 1)
14891 (org-small-year-to-year
14892 (string-to-number (match-string 1 ans))))
14893 iso-weekday (if (match-end 3)
14894 (string-to-number (match-string 3 ans)))
14895 iso-week (string-to-number (match-string 2 ans)))
14896 (setq ans (replace-match "" t t ans)))
14898 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14899 (when (string-match
14901 (setq year (if (match-end 2)
14902 (string-to-number (match-string 2 ans))
14903 (progn (setq kill-year t)
14904 (string-to-number (format-time-string "%Y"))))
14905 month (string-to-number (match-string 3 ans))
14906 day (string-to-number (match-string 4 ans)))
14907 (if (< year 100) (setq year (+ 2000 year)))
14909 t nil ans)))
14911 ;; Help matching dottet european dates
14912 (when (string-match
14913 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14914 (setq year (if (match-end 3)
14915 (string-to-number (match-string 3 ans))
14916 (progn (setq kill-year t)
14917 (string-to-number (format-time-string "%Y"))))
14918 day (string-to-number (match-string 1 ans))
14919 month (string-to-number (match-string 2 ans))
14921 t nil ans)))
14923 ;; Help matching american dates, like 5/30 or 5/30/7
14924 (when (string-match
14925 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14926 (setq year (if (match-end 4)
14927 (string-to-number (match-string 4 ans))
14928 (progn (setq kill-year t)
14929 (string-to-number (format-time-string "%Y"))))
14930 month (string-to-number (match-string 1 ans))
14931 day (string-to-number (match-string 2 ans)))
14932 (if (< year 100) (setq year (+ 2000 year)))
14934 t nil ans)))
14935 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14936 ;; If there is a time with am/pm, and *no* time without it, we convert
14937 ;; so that matching will be successful.
14938 (loop for i from 1 to 2 do ; twice, for end time as well
14941 (setq hour (string-to-number (match-string 1 ans))
14942 minute (if (match-end 3)
14943 (string-to-number (match-string 3 ans))
14944 0)
14945 pm (equal ?p
14946 (string-to-char (downcase (match-string 4 ans)))))
14947 (if (and (= hour 12) (not pm))
14948 (setq hour 0)
14949 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14950 (setq ans (replace-match (format "%02d:%02d" hour minute)
14951 t t ans))))
14953 ;; Check if a time range is given as a duration
14954 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14955 (setq hour (string-to-number (match-string 1 ans))
14956 h2 (+ hour (string-to-number (match-string 3 ans)))
14957 minute (string-to-number (match-string 2 ans))
14958 m2 (+ minute (if (match-end 5) (string-to-number
14959 (match-string 5 ans))0)))
14960 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14961 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14962 t t ans)))
14964 ;; Check if there is a time range
14965 (when (boundp 'org-end-time-was-given)
14966 (setq org-time-was-given nil)
14967 (when (and (string-match org-plain-time-of-day-regexp ans)
14968 (match-end 8))
14969 (setq org-end-time-was-given (match-string 8 ans))
14970 (setq ans (concat (substring ans 0 (match-beginning 7))
14971 (substring ans (match-end 7))))))
14973 (setq tl (parse-time-string ans)
14974 day (or (nth 3 tl) (nth 3 defdecode))
14975 month (or (nth 4 tl)
14976 (if (and org-read-date-prefer-future
14977 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14978 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14979 (nth 4 defdecode)))
14980 year (or (and (not kill-year) (nth 5 tl))
14981 (if (and org-read-date-prefer-future
14982 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14983 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14984 (nth 5 defdecode)))
14985 hour (or (nth 2 tl) (nth 2 defdecode))
14986 minute (or (nth 1 tl) (nth 1 defdecode))
14987 second (or (nth 0 tl) 0)
14988 wday (nth 6 tl))
14990 (when (and (eq org-read-date-prefer-future 'time)
14991 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14992 (equal day (nth 3 nowdecode))
14993 (equal month (nth 4 nowdecode))
14994 (equal year (nth 5 nowdecode))
14995 (nth 2 tl)
14996 (or (< (nth 2 tl) (nth 2 nowdecode))
14997 (and (= (nth 2 tl) (nth 2 nowdecode))
14998 (nth 1 tl)
14999 (< (nth 1 tl) (nth 1 nowdecode)))))
15000 (setq day (1+ day)
15001 futurep t))
15003 ;; Special date definitions below
15004 (cond
15005 (iso-week
15006 ;; There was an iso week
15007 (require 'cal-iso)
15008 (setq futurep nil)
15009 (setq year (or iso-year year)
15010 day (or iso-weekday wday 1)
15011 wday nil ; to make sure that the trigger below does not match
15012 iso-date (calendar-gregorian-from-absolute
15013 (calendar-absolute-from-iso
15014 (list iso-week day year))))
15015 ; FIXME: Should we also push ISO weeks into the future?
15016 ; (when (and org-read-date-prefer-future
15017 ; (not iso-year)
15018 ; (< (calendar-absolute-from-gregorian iso-date)
15019 ; (time-to-days (current-time))))
15020 ; (setq year (1+ year)
15021 ; iso-date (calendar-gregorian-from-absolute
15022 ; (calendar-absolute-from-iso
15023 ; (list iso-week day year)))))
15024 (setq month (car iso-date)
15025 year (nth 2 iso-date)
15026 day (nth 1 iso-date)))
15027 (deltan
15028 (setq futurep nil)
15029 (unless deltadef
15030 (let ((now (decode-time (current-time))))
15031 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15032 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15033 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15034 ((equal deltaw "m") (setq month (+ month deltan)))
15035 ((equal deltaw "y") (setq year (+ year deltan)))))
15036 ((and wday (not (nth 3 tl)))
15037 (setq futurep nil)
15038 ;; Weekday was given, but no day, so pick that day in the week
15039 ;; on or after the derived date.
15040 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15041 (unless (equal wday wday1)
15042 (setq day (+ day (% (- wday wday1 -7) 7))))))
15043 (if (and (boundp 'org-time-was-given)
15044 (nth 2 tl))
15045 (setq org-time-was-given t))
15046 (if (< year 100) (setq year (+ 2000 year)))
15047 ;; Check of the date is representable
15048 (if org-read-date-force-compatible-dates
15049 (progn
15050 (if (< year 1970)
15051 (setq year 1970 org-read-date-analyze-forced-year t))
15052 (if (> year 2037)
15053 (setq year 2037 org-read-date-analyze-forced-year t)))
15054 (condition-case nil
15055 (ignore (encode-time second minute hour day month year))
15056 (error
15057 (setq year (nth 5 defdecode))
15058 (setq org-read-date-analyze-forced-year t))))
15059 (setq org-read-date-analyze-futurep futurep)
15060 (list second minute hour day month year)))
15062 (defvar parse-time-weekdays)
15064 (defun org-read-date-get-relative (s today default)
15065 "Check string S for special relative date string.
15066 TODAY and DEFAULT are internal times, for today and for a default.
15067 Return shift list (N what def-flag)
15069 N is the number of WHATs to shift.
15070 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15071 the DEFAULT date rather than TODAY."
15072 (when (and
15073 (string-match
15074 (concat
15079 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15080 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15081 (string-to-char (substring (match-string 1 s) -1))
15082 ?+))
15083 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15084 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15085 (what (if (match-end 3) (match-string 3 s) "d"))
15086 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15087 (date (if rel default today))
15088 (wday (nth 6 (decode-time date)))
15089 delta)
15090 (if wday1
15091 (progn
15092 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15093 (if (= dir ?-) (setq delta (- delta 7)))
15094 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15095 (list delta "d" rel))
15096 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15098 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15099 "Turn a user-specified date into the internal representation.
15100 The internal representation needed by the calendar is (month day year).
15101 This is a wrapper to handle the brain-dead convention in calendar that
15102 user function argument order change dependent on argument order."
15103 (if (boundp 'calendar-date-style)
15104 (cond
15105 ((eq calendar-date-style 'american)
15106 (list arg1 arg2 arg3))
15107 ((eq calendar-date-style 'european)
15108 (list arg2 arg1 arg3))
15109 ((eq calendar-date-style 'iso)
15110 (list arg2 arg3 arg1)))
15111 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15112 (if (org-bound-and-true-p european-calendar-style)
15113 (list arg2 arg1 arg3)
15114 (list arg1 arg2 arg3)))))
15116 (defun org-eval-in-calendar (form &optional keepdate)
15117 "Eval FORM in the calendar window and return to current window.
15118 Also, store the cursor date in variable org-ans2."
15119 (let ((sf (selected-frame))
15120 (sw (selected-window)))
15121 (select-window (get-buffer-window "*Calendar*" t))
15122 (eval form)
15123 (when (and (not keepdate) (calendar-cursor-to-date))
15124 (let* ((date (calendar-cursor-to-date))
15125 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15126 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15127 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15128 (select-window sw)
15129 (org-select-frame-set-input-focus sf)))
15131 (defun org-calendar-select ()
15132 "Return to `org-read-date' with the date currently selected.
15133 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15134 (interactive)
15135 (when (calendar-cursor-to-date)
15136 (let* ((date (calendar-cursor-to-date))
15137 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15138 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15139 (if (active-minibuffer-window) (exit-minibuffer))))
15141 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15142 "Insert a date stamp for the date given by the internal TIME.
15143 WITH-HM means use the stamp format that includes the time of the day.
15144 INACTIVE means use square brackets instead of angular ones, so that the
15145 stamp will not contribute to the agenda.
15146 PRE and POST are optional strings to be inserted before and after the
15147 stamp.
15148 The command returns the inserted time stamp."
15149 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15150 stamp)
15151 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15152 (insert-before-markers (or pre ""))
15153 (when (listp extra)
15154 (setq extra (car extra))
15155 (if (and (stringp extra)
15157 (setq extra (format "-%02d:%02d"
15158 (string-to-number (match-string 1 extra))
15159 (string-to-number (match-string 2 extra))))
15160 (setq extra nil)))
15161 (when extra
15162 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15163 (insert-before-markers (setq stamp (format-time-string fmt time)))
15164 (insert-before-markers (or post ""))
15165 (setq org-last-inserted-timestamp stamp)))
15167 (defun org-toggle-time-stamp-overlays ()
15168 "Toggle the use of custom time stamp formats."
15169 (interactive)
15170 (setq org-display-custom-times (not org-display-custom-times))
15171 (unless org-display-custom-times
15172 (let ((p (point-min)) (bmp (buffer-modified-p)))
15173 (while (setq p (next-single-property-change p 'display))
15174 (if (and (get-text-property p 'display)
15175 (eq (get-text-property p 'face) 'org-date))
15176 (remove-text-properties
15177 p (setq p (next-single-property-change p 'display))
15178 '(display t))))
15179 (set-buffer-modified-p bmp)))
15180 (if (featurep 'xemacs)
15181 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15182 (org-restart-font-lock)
15183 (setq org-table-may-need-update t)
15184 (if org-display-custom-times
15185 (message "Time stamps are overlayed with custom format")
15186 (message "Time stamp overlays removed")))
15188 (defun org-display-custom-time (beg end)
15189 "Overlay modified time stamp format over timestamp between BEG and END."
15190 (let* ((ts (buffer-substring beg end))
15191 t1 w1 with-hm tf time str w2 (off 0))
15192 (save-match-data
15193 (setq t1 (org-parse-time-string ts t))
15194 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15195 (setq off (- (match-end 0) (match-beginning 0)))))
15196 (setq end (- end off))
15197 (setq w1 (- end beg)
15198 with-hm (and (nth 1 t1) (nth 2 t1))
15199 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15200 time (org-fix-decoded-time t1)
15201 str (org-add-props
15202 (format-time-string
15203 (substring tf 1 -1) (apply 'encode-time time))
15204 nil 'mouse-face 'highlight)
15205 w2 (length str))
15206 (if (not (= w2 w1))
15207 (add-text-properties (1+ beg) (+ 2 beg)
15208 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15209 (if (featurep 'xemacs)
15210 (progn
15211 (put-text-property beg end 'invisible t)
15212 (put-text-property beg end 'end-glyph (make-glyph str)))
15213 (put-text-property beg end 'display str))))
15215 (defun org-translate-time (string)
15216 "Translate all timestamps in STRING to custom format.
15217 But do this only if the variable `org-display-custom-times' is set."
15218 (when org-display-custom-times
15219 (save-match-data
15220 (let* ((start 0)
15221 (re org-ts-regexp-both)
15222 t1 with-hm inactive tf time str beg end)
15223 (while (setq start (string-match re string start))
15224 (setq beg (match-beginning 0)
15225 end (match-end 0)
15226 t1 (save-match-data
15227 (org-parse-time-string (substring string beg end) t))
15228 with-hm (and (nth 1 t1) (nth 2 t1))
15229 inactive (equal (substring string beg (1+ beg)) "[")
15230 tf (funcall (if with-hm 'cdr 'car)
15231 org-time-stamp-custom-formats)
15232 time (org-fix-decoded-time t1)
15233 str (format-time-string
15234 (concat
15235 (if inactive "[" "<") (substring tf 1 -1)
15236 (if inactive "]" ">"))
15237 (apply 'encode-time time))
15238 string (replace-match str t t string)
15239 start (+ start (length str)))))))
15240 string)
15242 (defun org-fix-decoded-time (time)
15243 "Set 0 instead of nil for the first 6 elements of time.
15244 Don't touch the rest."
15245 (let ((n 0))
15246 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15248 (defun org-days-to-time (timestamp-string)
15249 "Difference between TIMESTAMP-STRING and now in days."
15250 (- (time-to-days (org-time-string-to-time timestamp-string))
15251 (time-to-days (current-time))))
15253 (defun org-deadline-close (timestamp-string &optional ndays)
15254 "Is the time in TIMESTAMP-STRING close to the current date?"
15255 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15256 (and (< (org-days-to-time timestamp-string) ndays)
15257 (not (org-entry-is-done-p))))
15259 (defun org-get-wdays (ts)
15260 "Get the deadline lead time appropriate for timestring TS."
15261 (cond
15262 ((<= org-deadline-warning-days 0)
15263 ;; 0 or negative, enforce this value no matter what
15264 (- org-deadline-warning-days))
15266 ;; lead time is specified.
15267 (floor (* (string-to-number (match-string 1 ts))
15268 (cdr (assoc (match-string 2 ts)
15269 '(("d" . 1) ("w" . 7)
15270 ("m" . 30.4) ("y" . 365.25)))))))
15271 ;; go for the default.
15272 (t org-deadline-warning-days)))
15274 (defun org-calendar-select-mouse (ev)
15275 "Return to `org-read-date' with the date currently selected.
15276 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15277 (interactive "e")
15278 (mouse-set-point ev)
15279 (when (calendar-cursor-to-date)
15280 (let* ((date (calendar-cursor-to-date))
15281 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15282 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15283 (if (active-minibuffer-window) (exit-minibuffer))))
15285 (defun org-check-deadlines (ndays)
15286 "Check if there are any deadlines due or past due.
15287 A deadline is considered due if it happens within `org-deadline-warning-days'
15288 days from today's date. If the deadline appears in an entry marked DONE,
15289 it is not shown. The prefix arg NDAYS can be used to test that many
15291 (interactive "P")
15292 (let* ((org-warn-days
15293 (cond
15294 ((equal ndays '(4)) 100000)
15295 (ndays (prefix-numeric-value ndays))
15296 (t (abs org-deadline-warning-days))))
15297 (case-fold-search nil)
15299 (callback
15300 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15302 (message "%d deadlines past-due or due within %d days"
15303 (org-occur regexp nil callback)
15304 org-warn-days)))
15306 (defun org-check-before-date (date)
15307 "Check if there are deadlines or scheduled entries before DATE."
15308 (interactive (list (org-read-date)))
15309 (let ((case-fold-search nil)
15313 (callback
15314 (lambda () (time-less-p
15315 (org-time-string-to-time (match-string 2))
15316 (org-time-string-to-time date)))))
15317 (message "%d entries before %s"
15318 (org-occur regexp nil callback) date)))
15320 (defun org-check-after-date (date)
15321 "Check if there are deadlines or scheduled entries after DATE."
15322 (interactive (list (org-read-date)))
15323 (let ((case-fold-search nil)
15327 (callback
15328 (lambda () (not
15329 (time-less-p
15330 (org-time-string-to-time (match-string 2))
15331 (org-time-string-to-time date))))))
15332 (message "%d entries after %s"
15333 (org-occur regexp nil callback) date)))
15335 (defun org-evaluate-time-range (&optional to-buffer)
15336 "Evaluate a time range by computing the difference between start and end.
15337 Normally the result is just printed in the echo area, but with prefix arg
15338 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15339 If the time range is actually in a table, the result is inserted into the
15340 next column.
15341 For time difference computation, a year is assumed to be exactly 365
15342 days in order to avoid rounding problems."
15343 (interactive "P")
15344 (or
15345 (org-clock-update-time-maybe)
15346 (save-excursion
15347 (unless (org-at-date-range-p t)
15348 (goto-char (point-at-bol))
15349 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15350 (if (not (org-at-date-range-p t))
15351 (error "Not at a time-stamp range, and none found in current line")))
15352 (let* ((ts1 (match-string 1))
15353 (ts2 (match-string 2))
15354 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15355 (match-end (match-end 0))
15356 (time1 (org-time-string-to-time ts1))
15357 (time2 (org-time-string-to-time ts2))
15358 (t1 (org-float-time time1))
15359 (t2 (org-float-time time2))
15360 (diff (abs (- t2 t1)))
15361 (negative (< (- t2 t1) 0))
15362 ;; (ys (floor (* 365 24 60 60)))
15363 (ds (* 24 60 60))
15364 (hs (* 60 60))
15365 (fy "%dy %dd %02d:%02d")
15366 (fy1 "%dy %dd")
15367 (fd "%dd %02d:%02d")
15368 (fd1 "%dd")
15369 (fh "%02d:%02d")
15370 y d h m align)
15371 (if havetime
15372 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15373 y 0
15374 d (floor (/ diff ds)) diff (mod diff ds)
15375 h (floor (/ diff hs)) diff (mod diff hs)
15376 m (floor (/ diff 60)))
15377 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15378 y 0
15379 d (floor (+ (/ diff ds) 0.5))
15380 h 0 m 0))
15381 (if (not to-buffer)
15382 (message "%s" (org-make-tdiff-string y d h m))
15383 (if (org-at-table-p)
15384 (progn
15385 (goto-char match-end)
15386 (setq align t)
15387 (and (looking-at " *|") (goto-char (match-end 0))))
15388 (goto-char match-end))
15389 (if (looking-at
15391 (replace-match ""))
15392 (if negative (insert " -"))
15393 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15394 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15395 (insert " " (format fh h m))))
15396 (if align (org-table-align))
15397 (message "Time difference inserted")))))
15399 (defun org-make-tdiff-string (y d h m)
15400 (let ((fmt "")
15401 (l nil))
15402 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15403 l (push y l)))
15404 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15405 l (push d l)))
15406 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15407 l (push h l)))
15408 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15409 l (push m l)))
15410 (apply 'format fmt (nreverse l))))
15412 (defun org-time-string-to-time (s)
15413 (apply 'encode-time (org-parse-time-string s)))
15414 (defun org-time-string-to-seconds (s)
15415 (org-float-time (org-time-string-to-time s)))
15417 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15418 "Convert a time stamp to an absolute day number.
15419 If there is a specifier for a cyclic time stamp, get the closest date to
15420 DAYNR.
15421 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15422 The variable date is bound by the calendar when this is called."
15423 (cond
15425 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15426 daynr
15427 (+ daynr 1000)))
15429 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15430 (time-to-days (current-time))) (match-string 0 s)
15431 prefer show-all))
15432 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15434 (defun org-days-to-iso-week (days)
15435 "Return the iso week number."
15436 (require 'cal-iso)
15437 (car (calendar-iso-from-absolute days)))
15439 (defun org-small-year-to-year (year)
15440 "Convert 2-digit years into 4-digit years.
15441 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15442 The year 2000 cannot be abbreviated. Any year larger than 99
15443 is returned unchanged."
15444 (if (< year 38)
15445 (setq year (+ 2000 year))
15446 (if (< year 100)
15447 (setq year (+ 1900 year))))
15448 year)
15450 (defun org-time-from-absolute (d)
15451 "Return the time corresponding to date D.
15452 D may be an absolute day number, or a calendar-type list (month day year)."
15453 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15454 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15456 (defun org-calendar-holiday ()
15457 "List of holidays, for Diary display in Org-mode."
15458 (require 'holidays)
15459 (let ((hl (funcall
15460 (if (fboundp 'calendar-check-holidays)
15461 'calendar-check-holidays 'check-calendar-holidays) date)))
15462 (if hl (mapconcat 'identity hl "; "))))
15464 (defun org-diary-sexp-entry (sexp entry date)
15465 "Process a SEXP diary ENTRY for DATE."
15466 (require 'diary-lib)
15467 (let ((result (if calendar-debug-sexp
15468 (let ((stack-trace-on-error t))
15469 (eval (car (read-from-string sexp))))
15470 (condition-case nil
15471 (eval (car (read-from-string sexp)))
15472 (error
15473 (beep)
15474 (message "Bad sexp at line %d in %s: %s"
15475 (org-current-line)
15476 (buffer-file-name) sexp)
15477 (sleep-for 2))))))
15478 (cond ((stringp result) (split-string result "; "))
15479 ((and (consp result)
15480 (not (consp (cdr result)))
15481 (stringp (cdr result))) (cdr result))
15482 ((and (consp result)
15483 (stringp (car result))) result)
15484 (result entry)
15485 (t nil))))
15487 (defun org-diary-to-ical-string (frombuf)
15488 "Get iCalendar entries from diary entries in buffer FROMBUF.
15489 This uses the icalendar.el library."
15490 (let* ((tmpdir (if (featurep 'xemacs)
15491 (temp-directory)
15492 temporary-file-directory))
15493 (tmpfile (make-temp-name
15494 (expand-file-name "orgics" tmpdir)))
15495 buf rtn b e)
15496 (with-current-buffer frombuf
15497 (icalendar-export-region (point-min) (point-max) tmpfile)
15498 (setq buf (find-buffer-visiting tmpfile))
15499 (set-buffer buf)
15500 (goto-char (point-min))
15501 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15502 (setq b (match-beginning 0)))
15503 (goto-char (point-max))
15504 (if (re-search-backward "^END:VEVENT" nil t)
15505 (setq e (match-end 0)))
15507 (kill-buffer buf)
15508 (delete-file tmpfile)
15509 rtn))
15511 (defun org-closest-date (start current change prefer show-all)
15512 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15513 When PREFER is `past', return a date that is either CURRENT or past.
15514 When PREFER is `future', return a date that is either CURRENT or future.
15515 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15516 ;; Make the proper lists from the dates
15517 (catch 'exit
15518 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15519 dn dw sday cday n1 n2 n0
15520 d m y y1 y2 date1 date2 nmonths nm ny m2)
15522 (setq start (org-date-to-gregorian start)
15523 current (org-date-to-gregorian
15524 (if show-all
15525 current
15526 (time-to-days (current-time))))
15527 sday (calendar-absolute-from-gregorian start)
15528 cday (calendar-absolute-from-gregorian current))
15530 (if (<= cday sday) (throw 'exit sday))
15533 (setq dn (string-to-number (match-string 1 change))
15534 dw (cdr (assoc (match-string 2 change) a1)))
15535 (error "Invalid change specifier: %s" change))
15536 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15537 (cond
15538 ((eq dw 'day)
15539 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15540 n2 (+ n1 dn)))
15541 ((eq dw 'year)
15542 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15543 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15544 (setq date1 (list m d y1)
15545 n1 (calendar-absolute-from-gregorian date1)
15546 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15547 n2 (calendar-absolute-from-gregorian date2)))
15548 ((eq dw 'month)
15549 ;; approx number of month between the two dates
15550 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15551 ;; How often does dn fit in there?
15552 (setq d (nth 1 start) m (car start) y (nth 2 start)
15553 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15554 m (+ m nm)
15555 ny (floor (/ m 12))
15556 y (+ y ny)
15557 m (- m (* ny 12)))
15558 (while (> m 12) (setq m (- m 12) y (1+ y)))
15559 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15560 (setq m2 (+ m dn) y2 y)
15561 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15562 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15563 (while (<= n2 cday)
15564 (setq n1 n2 m m2 y y2)
15565 (setq m2 (+ m dn) y2 y)
15566 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15567 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15568 ;; Make sure n1 is the earlier date
15569 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15570 (if show-all
15571 (cond
15572 ((eq prefer 'past) (if (= cday n2) n2 n1))
15573 ((eq prefer 'future) (if (= cday n1) n1 n2))
15574 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15575 (cond
15576 ((eq prefer 'past) (if (= cday n2) n2 n1))
15577 ((eq prefer 'future) (if (= cday n1) n1 n2))
15578 (t (if (= cday n1) n1 n2)))))))
15580 (defun org-date-to-gregorian (date)
15581 "Turn any specification of DATE into a Gregorian date for the calendar."
15582 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15583 ((and (listp date) (= (length date) 3)) date)
15584 ((stringp date)
15585 (setq date (org-parse-time-string date))
15586 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15587 ((listp date)
15588 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15590 (defun org-parse-time-string (s &optional nodefault)
15591 "Parse the standard Org-mode time string.
15592 This should be a lot faster than the normal `parse-time-string'.
15593 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15594 hour and minute fields will be nil if not given."
15595 (if (string-match org-ts-regexp0 s)
15596 (list 0
15597 (if (or (match-beginning 8) (not nodefault))
15598 (string-to-number (or (match-string 8 s) "0")))
15599 (if (or (match-beginning 7) (not nodefault))
15600 (string-to-number (or (match-string 7 s) "0")))
15601 (string-to-number (match-string 4 s))
15602 (string-to-number (match-string 3 s))
15603 (string-to-number (match-string 2 s))
15604 nil nil nil)
15605 (error "Not a standard Org-mode time string: %s" s)))
15607 (defun org-timestamp-up (&optional arg)
15608 "Increase the date item at the cursor by one.
15609 If the cursor is on the year, change the year. If it is on the month,
15610 the day or the time, change that.
15611 With prefix ARG, change by that many units."
15612 (interactive "p")
15613 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15615 (defun org-timestamp-down (&optional arg)
15616 "Decrease the date item at the cursor by one.
15617 If the cursor is on the year, change the year. If it is on the month,
15618 the day or the time, change that.
15619 With prefix ARG, change by that many units."
15620 (interactive "p")
15621 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15623 (defun org-timestamp-up-day (&optional arg)
15624 "Increase the date in the time stamp by one day.
15625 With prefix ARG, change that many days."
15626 (interactive "p")
15627 (if (and (not (org-at-timestamp-p t))
15628 (org-on-heading-p))
15629 (org-todo 'up)
15630 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15632 (defun org-timestamp-down-day (&optional arg)
15633 "Decrease the date in the time stamp by one day.
15634 With prefix ARG, change that many days."
15635 (interactive "p")
15636 (if (and (not (org-at-timestamp-p t))
15637 (org-on-heading-p))
15638 (org-todo 'down)
15639 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15641 (defun org-at-timestamp-p (&optional inactive-ok)
15642 "Determine if the cursor is in or at a timestamp."
15643 (interactive)
15644 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15645 (pos (point))
15646 (ans (or (looking-at tsr)
15647 (save-excursion
15649 (if (> (point) (point-min)) (backward-char 1))
15650 (and (looking-at tsr)
15651 (> (- (match-end 0) pos) -1))))))
15652 (and ans
15653 (boundp 'org-ts-what)
15654 (setq org-ts-what
15655 (cond
15656 ((= pos (match-beginning 0)) 'bracket)
15657 ;; Point is considered to be "on the bracket" whether
15658 ;; it's really on it or right after it.
15659 ((or (= pos (1- (match-end 0)))
15660 (= pos (match-end 0))) 'bracket)
15661 ((org-pos-in-match-range pos 2) 'year)
15662 ((org-pos-in-match-range pos 3) 'month)
15663 ((org-pos-in-match-range pos 7) 'hour)
15664 ((org-pos-in-match-range pos 8) 'minute)
15665 ((or (org-pos-in-match-range pos 4)
15666 (org-pos-in-match-range pos 5)) 'day)
15667 ((and (> pos (or (match-end 8) (match-end 5)))
15668 (< pos (match-end 0)))
15669 (- pos (or (match-end 8) (match-end 5))))
15670 (t 'day))))
15671 ans))
15673 (defun org-toggle-timestamp-type ()
15674 "Toggle the type (<active> or [inactive]) of a time stamp."
15675 (interactive)
15676 (when (org-at-timestamp-p t)
15677 (let ((beg (match-beginning 0)) (end (match-end 0))
15678 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15679 (save-excursion
15680 (goto-char beg)
15681 (while (re-search-forward "[][<>]" end t)
15682 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15683 t t)))
15684 (message "Timestamp is now %sactive"
15685 (if (equal (char-after beg) ?<) "" "in")))))
15687 (defun org-timestamp-change (n &optional what updown)
15688 "Change the date in the time stamp at point.
15689 The date will be changed by N times WHAT. WHAT can be `day', `month',
15690 `year', `minute', `second'. If WHAT is not given, the cursor position
15691 in the timestamp determines what will be changed."
15692 (let ((origin (point)) origin-cat
15693 with-hm inactive
15694 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15695 org-ts-what
15696 extra rem
15697 ts time time0)
15698 (if (not (org-at-timestamp-p t))
15699 (error "Not at a timestamp"))
15700 (if (and (not what) (eq org-ts-what 'bracket))
15701 (org-toggle-timestamp-type)
15702 ;; Point isn't on brackets. Remember the part of the time-stamp
15703 ;; the point was in. Indeed, size of time-stamps may change,
15704 ;; but point must be kept in the same category nonetheless.
15705 (setq origin-cat org-ts-what)
15706 (if (and (not what) (not (eq org-ts-what 'day))
15707 org-display-custom-times
15708 (get-text-property (point) 'display)
15709 (not (get-text-property (1- (point)) 'display)))
15710 (setq org-ts-what 'day))
15711 (setq org-ts-what (or what org-ts-what)
15712 inactive (= (char-after (match-beginning 0)) ?\[)
15713 ts (match-string 0))
15714 (replace-match "")
15715 (if (string-match
15717 ts)
15718 (setq extra (match-string 1 ts)))
15720 (setq with-hm t))
15721 (setq time0 (org-parse-time-string ts))
15722 (when (and updown
15723 (eq org-ts-what 'minute)
15724 (not current-prefix-arg))
15725 ;; This looks like s-up and s-down. Change by one rounding step.
15726 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15727 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15728 (setcar (cdr time0) (+ (nth 1 time0)
15729 (if (> n 0) (- rem) (- dm rem))))))
15730 (setq time
15731 (encode-time (or (car time0) 0)
15732 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15733 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15734 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15735 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15736 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15737 (nthcdr 6 time0)))
15738 (when (and (member org-ts-what '(hour minute))
15739 extra
15741 (setq extra (org-modify-ts-extra
15742 extra
15743 (if (eq org-ts-what 'hour) 2 5)
15744 n dm)))
15745 (when (integerp org-ts-what)
15746 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15747 (if (eq what 'calendar)
15748 (let ((cal-date (org-get-date-from-calendar)))
15749 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15750 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15751 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15752 (setcar time0 (or (car time0) 0))
15753 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15754 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15755 (setq time (apply 'encode-time time0))))
15756 ;; Insert the new time-stamp, and ensure point stays in the same
15757 ;; category as before (i.e. not after the last position in that
15758 ;; category).
15759 (let ((pos (point)))
15760 ;; Stay before inserted string. `save-excursion' is of no use.
15761 (setq org-last-changed-timestamp
15762 (org-insert-time-stamp time with-hm inactive nil nil extra))
15763 (goto-char pos))
15764 (save-match-data
15765 (looking-at org-ts-regexp3)
15766 (goto-char (cond
15767 ;; `day' category ends before `hour' if any, or at
15768 ;; the end of the day name.
15769 ((eq origin-cat 'day)
15770 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15771 ((eq origin-cat 'hour) (min (match-end 7) origin))
15772 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15773 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15774 ;; `year' and `month' have both fixed size: point
15775 ;; couldn't have moved into another part.
15776 (t origin))))
15777 ;; Update clock if on a CLOCK line.
15778 (org-clock-update-time-maybe)
15779 ;; Try to recenter the calendar window, if any.
15780 (if (and org-calendar-follow-timestamp-change
15781 (get-buffer-window "*Calendar*" t)
15782 (memq org-ts-what '(day month year)))
15783 (org-recenter-calendar (time-to-days time))))))
15785 (defun org-modify-ts-extra (s pos n dm)
15786 "Change the different parts of the lead-time and repeat fields in timestamp."
15787 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15788 ng h m new rem)
15789 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15790 (cond
15791 ((or (org-pos-in-match-range pos 2)
15792 (org-pos-in-match-range pos 3))
15793 (setq m (string-to-number (match-string 3 s))
15794 h (string-to-number (match-string 2 s)))
15795 (if (org-pos-in-match-range pos 2)
15796 (setq h (+ h n))
15797 (setq n (* dm (org-no-warnings (signum n))))
15798 (when (not (= 0 (setq rem (% m dm))))
15799 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15800 (setq m (+ m n)))
15801 (if (< m 0) (setq m (+ m 60) h (1- h)))
15802 (if (> m 59) (setq m (- m 60) h (1+ h)))
15803 (setq h (min 24 (max 0 h)))
15804 (setq ng 1 new (format "-%02d:%02d" h m)))
15805 ((org-pos-in-match-range pos 6)
15806 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15807 ((org-pos-in-match-range pos 5)
15808 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15810 ((org-pos-in-match-range pos 9)
15811 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15812 ((org-pos-in-match-range pos 8)
15813 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15815 (when ng
15816 (setq s (concat
15817 (substring s 0 (match-beginning ng))
15818 new
15819 (substring s (match-end ng))))))
15820 s))
15822 (defun org-recenter-calendar (date)
15823 "If the calendar is visible, recenter it to DATE."
15824 (let* ((win (selected-window))
15825 (cwin (get-buffer-window "*Calendar*" t))
15826 (calendar-move-hook nil))
15827 (when cwin
15828 (select-window cwin)
15829 (calendar-goto-date (if (listp date) date
15830 (calendar-gregorian-from-absolute date)))
15831 (select-window win))))
15833 (defun org-goto-calendar (&optional arg)
15834 "Go to the Emacs calendar at the current date.
15835 If there is a time stamp in the current line, go to that date.
15836 A prefix ARG can be used to force the current date."
15837 (interactive "P")
15838 (let ((tsr org-ts-regexp) diff
15839 (calendar-move-hook nil)
15840 (calendar-view-holidays-initially-flag nil)
15841 (calendar-view-diary-initially-flag nil))
15842 (if (or (org-at-timestamp-p)
15843 (save-excursion
15844 (beginning-of-line 1)
15845 (looking-at (concat ".*" tsr))))
15846 (let ((d1 (time-to-days (current-time)))
15847 (d2 (time-to-days
15848 (org-time-string-to-time (match-string 1)))))
15849 (setq diff (- d2 d1))))
15850 (calendar)
15851 (calendar-goto-today)
15852 (if (and diff (not arg)) (calendar-forward-day diff))))
15854 (defun org-get-date-from-calendar ()
15855 "Return a list (month day year) of date at point in calendar."
15856 (with-current-buffer "*Calendar*"
15857 (save-match-data
15858 (calendar-cursor-to-date))))
15860 (defun org-date-from-calendar ()
15861 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15862 If there is already a time stamp at the cursor position, update it."
15863 (interactive)
15864 (if (org-at-timestamp-p t)
15865 (org-timestamp-change 0 'calendar)
15866 (let ((cal-date (org-get-date-from-calendar)))
15867 (org-insert-time-stamp
15868 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15870 (defcustom org-effort-durations
15871 `(("h" . 60)
15872 ("d" . ,(* 60 8))
15873 ("w" . ,(* 60 8 5))
15874 ("m" . ,(* 60 8 5 4))
15875 ("y" . ,(* 60 8 5 40)))
15876 "Conversion factor to minutes for an effort modifier.
15878 Each entry has the form (MODIFIER . MINUTES).
15880 In an effort string, a number followed by MODIFIER is multiplied
15881 by the specified number of MINUTES to obtain an effort in
15882 minutes.
15886 :group 'org-agenda
15887 :type '(alist :key-type (string :tag "Modifier")
15888 :value-type (number :tag "Minutes")))
15890 ;;;; Files
15892 (defun org-save-all-org-buffers ()
15893 "Save all Org-mode buffers without user confirmation."
15894 (interactive)
15895 (message "Saving all Org-mode buffers...")
15896 (save-some-buffers t 'org-mode-p)
15897 (when (featurep 'org-id) (org-id-locations-save))
15898 (message "Saving all Org-mode buffers... done"))
15900 (defun org-revert-all-org-buffers ()
15901 "Revert all Org-mode buffers.
15902 Prompt for confirmation when there are unsaved changes.
15903 Be sure you know what you are doing before letting this function
15904 overwrite your changes.
15906 This function is useful in a setup where one tracks org files
15907 with a version control system, to revert on one machine after pulling
15908 changes from another. I believe the procedure must be like this:
15910 1. M-x org-save-all-org-buffers
15911 2. Pull changes from the other machine, resolve conflicts
15912 3. M-x org-revert-all-org-buffers"
15913 (interactive)
15914 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15915 (error "Abort"))
15916 (save-excursion
15917 (save-window-excursion
15918 (mapc
15919 (lambda (b)
15920 (when (and (with-current-buffer b (org-mode-p))
15921 (with-current-buffer b buffer-file-name))
15922 (org-pop-to-buffer-same-window b)
15923 (revert-buffer t 'no-confirm)))
15924 (buffer-list))
15925 (when (and (featurep 'org-id) org-id-track-globally)
15926 (org-id-locations-load)))))
15928 ;;;; Agenda files
15930 ;;;###autoload
15931 (defun org-switchb (&optional arg)
15932 "Switch between Org buffers.
15933 With a prefix argument, restrict available to files.
15934 With two prefix arguments, restrict available buffers to agenda files.
15936 Defaults to `iswitchb' for buffer name completion.
15937 Set `org-completion-use-ido' to make it use ido instead."
15938 (interactive "P")
15939 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15940 ((equal arg '(16)) (org-buffer-list 'agenda))
15941 (t (org-buffer-list))))
15942 (org-completion-use-iswitchb org-completion-use-iswitchb)
15943 (org-completion-use-ido org-completion-use-ido))
15944 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15945 (setq org-completion-use-iswitchb t))
15946 (org-pop-to-buffer-same-window
15947 (org-icompleting-read "Org buffer: "
15948 (mapcar 'list (mapcar 'buffer-name blist))
15949 nil t))))
15951 ;;; Define some older names previously used for this functionality
15952 ;;;###autoload
15953 (defalias 'org-ido-switchb 'org-switchb)
15954 ;;;###autoload
15955 (defalias 'org-iswitchb 'org-switchb)
15957 (defun org-buffer-list (&optional predicate exclude-tmp)
15958 "Return a list of Org buffers.
15959 PREDICATE can be `export', `files' or `agenda'.
15961 export restrict the list to Export buffers.
15962 files restrict the list to buffers visiting Org files.
15963 agenda restrict the list to buffers visiting agenda files.
15965 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15966 (let* ((bfn nil)
15967 (agenda-files (and (eq predicate 'agenda)
15968 (mapcar 'file-truename (org-agenda-files t))))
15969 (filter
15970 (cond
15971 ((eq predicate 'files)
15972 (lambda (b) (with-current-buffer b (org-mode-p))))
15973 ((eq predicate 'export)
15974 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15975 ((eq predicate 'agenda)
15976 (lambda (b)
15977 (with-current-buffer b
15978 (and (org-mode-p)
15979 (setq bfn (buffer-file-name b))
15980 (member (file-truename bfn) agenda-files)))))
15981 (t (lambda (b) (with-current-buffer b
15982 (or (org-mode-p)
15983 (string-match "\*Org .*Export"
15984 (buffer-name b)))))))))
15985 (delq nil
15986 (mapcar
15987 (lambda(b)
15988 (if (and (funcall filter b)
15989 (or (not exclude-tmp)
15990 (not (string-match "tmp" (buffer-name b)))))
15991 b
15992 nil))
15993 (buffer-list)))))
15995 (defun org-agenda-files (&optional unrestricted archives)
15996 "Get the list of agenda files.
15997 Optional UNRESTRICTED means return the full list even if a restriction
15998 is currently in place.
15999 When ARCHIVES is t, include all archive files that are really being
16000 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16001 `org-agenda-archives-mode' is t."
16002 (let ((files
16003 (cond
16004 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16005 ((stringp org-agenda-files) (org-read-agenda-file-list))
16006 ((listp org-agenda-files) org-agenda-files)
16007 (t (error "Invalid value of `org-agenda-files'")))))
16008 (setq files (apply 'append
16009 (mapcar (lambda (f)
16010 (if (file-directory-p f)
16011 (directory-files
16012 f t org-agenda-file-regexp)
16013 (list f)))
16014 files)))
16015 (when org-agenda-skip-unavailable-files
16016 (setq files (delq nil
16017 (mapcar (function
16018 (lambda (file)
16019 (and (file-readable-p file) file)))
16020 files))))
16021 (when (or (eq archives t)
16022 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16023 (setq files (org-add-archive-files files)))
16024 files))
16026 (defun org-agenda-file-p (&optional file)
16027 "Return non-nil, if FILE is an agenda file.
16028 If FILE is omitted, use the file associated with the current
16029 buffer."
16030 (member (or file (buffer-file-name))
16031 (org-agenda-files t)))
16033 (defun org-edit-agenda-file-list ()
16034 "Edit the list of agenda files.
16035 Depending on setup, this either uses customize to edit the variable
16036 `org-agenda-files', or it visits the file that is holding the list. In the
16037 latter case, the buffer is set up in a way that saving it automatically kills
16038 the buffer and restores the previous window configuration."
16039 (interactive)
16040 (if (stringp org-agenda-files)
16041 (let ((cw (current-window-configuration)))
16042 (find-file org-agenda-files)
16043 (org-set-local 'org-window-configuration cw)
16044 (org-add-hook 'after-save-hook
16045 (lambda ()
16046 (set-window-configuration
16047 (prog1 org-window-configuration
16048 (kill-buffer (current-buffer))))
16049 (org-install-agenda-files-menu)
16050 (message "New agenda file list installed"))
16051 nil 'local)
16052 (message "%s" (substitute-command-keys
16054 (customize-variable 'org-agenda-files)))
16056 (defun org-store-new-agenda-file-list (list)
16057 "Set new value for the agenda file list and save it correctly."
16058 (if (stringp org-agenda-files)
16059 (let ((fe (org-read-agenda-file-list t)) b u)
16060 (while (setq b (find-buffer-visiting org-agenda-files))
16061 (kill-buffer b))
16062 (with-temp-file org-agenda-files
16063 (insert
16064 (mapconcat
16065 (lambda (f) ;; Keep un-expanded entries.
16066 (if (setq u (assoc f fe))
16067 (cdr u)
16068 f))
16071 (let ((org-mode-hook nil) (org-inhibit-startup t)
16072 (org-insert-mode-line-in-empty-file nil))
16073 (setq org-agenda-files list)
16074 (customize-save-variable 'org-agenda-files org-agenda-files))))
16076 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16077 "Read the list of agenda files from a file.
16078 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16079 filenames, used by `org-store-new-agenda-file-list' to write back
16080 un-expanded file names."
16081 (when (file-directory-p org-agenda-files)
16082 (error "`org-agenda-files' cannot be a single directory"))
16083 (when (stringp org-agenda-files)
16084 (with-temp-buffer
16085 (insert-file-contents org-agenda-files)
16086 (mapcar
16087 (lambda (f)
16088 (let ((e (expand-file-name (substitute-in-file-name f)
16089 org-directory)))
16090 (if pair-with-expansion
16091 (cons e f)
16092 e)))
16095 ;;;###autoload
16096 (defun org-cycle-agenda-files ()
16097 "Cycle through the files in `org-agenda-files'.
16098 If the current buffer visits an agenda file, find the next one in the list.
16099 If the current buffer does not, find the first agenda file."
16100 (interactive)
16101 (let* ((fs (org-agenda-files t))
16102 (files (append fs (list (car fs))))
16103 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16104 file)
16105 (unless files (error "No agenda files"))
16106 (catch 'exit
16107 (while (setq file (pop files))
16108 (if (equal (file-truename file) tcf)
16109 (when (car files)
16110 (find-file (car files))
16111 (throw 'exit t))))
16112 (find-file (car fs)))
16113 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16115 (defun org-agenda-file-to-front (&optional to-end)
16116 "Move/add the current file to the top of the agenda file list.
16117 If the file is not present in the list, it is added to the front. If it is
16118 present, it is moved there. With optional argument TO-END, add/move to the
16119 end of the list."
16120 (interactive "P")
16121 (let ((org-agenda-skip-unavailable-files nil)
16122 (file-alist (mapcar (lambda (x)
16123 (cons (file-truename x) x))
16124 (org-agenda-files t)))
16125 (ctf (file-truename buffer-file-name))
16126 x had)
16127 (setq x (assoc ctf file-alist) had x)
16129 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16130 (if to-end
16131 (setq file-alist (append (delq x file-alist) (list x)))
16132 (setq file-alist (cons x (delq x file-alist))))
16133 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16134 (org-install-agenda-files-menu)
16135 (message "File %s to %s of agenda file list"
16136 (if had "moved" "added") (if to-end "end" "front"))))
16138 (defun org-remove-file (&optional file)
16139 "Remove current file from the list of files in variable `org-agenda-files'.
16140 These are the files which are being checked for agenda entries.
16141 Optional argument FILE means use this file instead of the current."
16142 (interactive)
16143 (let* ((org-agenda-skip-unavailable-files nil)
16144 (file (or file buffer-file-name))
16145 (true-file (file-truename file))
16146 (afile (abbreviate-file-name file))
16147 (files (delq nil (mapcar
16148 (lambda (x)
16149 (if (equal true-file
16150 (file-truename x))
16151 nil x))
16152 (org-agenda-files t)))))
16153 (if (not (= (length files) (length (org-agenda-files t))))
16154 (progn
16155 (org-store-new-agenda-file-list files)
16156 (org-install-agenda-files-menu)
16157 (message "Removed file: %s" afile))
16158 (message "File was not in list: %s (not removed)" afile))))
16160 (defun org-file-menu-entry (file)
16161 (vector file (list 'find-file file) t))
16163 (defun org-check-agenda-file (file)
16164 "Make sure FILE exists. If not, ask user what to do."
16165 (when (not (file-exists-p file))
16166 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16167 (abbreviate-file-name file))
16168 (let ((r (downcase (read-char-exclusive))))
16169 (cond
16170 ((equal r ?r)
16171 (org-remove-file file)
16172 (throw 'nextfile t))
16173 (t (error "Abort"))))))
16175 (defun org-get-agenda-file-buffer (file)
16176 "Get a buffer visiting FILE. If the buffer needs to be created, add
16177 it to the list of buffers which might be released later."
16178 (let ((buf (org-find-base-buffer-visiting file)))
16179 (if buf
16180 buf ; just return it
16181 ;; Make a new buffer and remember it
16182 (setq buf (find-file-noselect file))
16183 (if buf (push buf org-agenda-new-buffers))
16184 buf)))
16186 (defun org-release-buffers (blist)
16187 "Release all buffers in list, asking the user for confirmation when needed.
16188 When a buffer is unmodified, it is just killed. When modified, it is saved
16189 \(if the user agrees) and then killed."
16190 (let (buf file)
16191 (while (setq buf (pop blist))
16192 (setq file (buffer-file-name buf))
16193 (when (and (buffer-modified-p buf)
16194 file
16195 (y-or-n-p (format "Save file %s? " file)))
16196 (with-current-buffer buf (save-buffer)))
16197 (kill-buffer buf))))
16199 (defun org-prepare-agenda-buffers (files)
16200 "Create buffers for all agenda files, protect archived trees and comments."
16201 (interactive)
16202 (let ((pa '(:org-archived t))
16203 (pc '(:org-comment t))
16204 (pall '(:org-archived t :org-comment t))
16205 (inhibit-read-only t)
16206 (rea (concat ":" org-archive-tag ":"))
16207 bmp file re)
16208 (save-excursion
16209 (save-restriction
16210 (while (setq file (pop files))
16211 (catch 'nextfile
16212 (if (bufferp file)
16213 (set-buffer file)
16214 (org-check-agenda-file file)
16215 (set-buffer (org-get-agenda-file-buffer file)))
16216 (widen)
16217 (setq bmp (buffer-modified-p))
16218 (org-refresh-category-properties)
16219 (setq org-todo-keywords-for-agenda
16220 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16221 (setq org-done-keywords-for-agenda
16222 (append org-done-keywords-for-agenda org-done-keywords))
16223 (setq org-todo-keyword-alist-for-agenda
16224 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16225 (setq org-drawers-for-agenda
16226 (append org-drawers-for-agenda org-drawers))
16227 (setq org-tag-alist-for-agenda
16228 (append org-tag-alist-for-agenda org-tag-alist))
16230 (save-excursion
16231 (remove-text-properties (point-min) (point-max) pall)
16232 (when org-agenda-skip-archived-trees
16233 (goto-char (point-min))
16234 (while (re-search-forward rea nil t)
16235 (if (org-on-heading-p t)
16236 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16237 (goto-char (point-min))
16239 (while (re-search-forward re nil t)
16240 (add-text-properties
16241 (match-beginning 0) (org-end-of-subtree t) pc)))
16242 (set-buffer-modified-p bmp)))))
16243 (setq org-todo-keywords-for-agenda
16244 (org-uniquify org-todo-keywords-for-agenda))
16245 (setq org-todo-keyword-alist-for-agenda
16246 (org-uniquify org-todo-keyword-alist-for-agenda)
16247 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16249 ;;;; Embedded LaTeX
16251 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16252 "Keymap for the minor `org-cdlatex-mode'.")
16254 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16255 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16256 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16257 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16258 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16260 (defvar org-cdlatex-texmathp-advice-is-done nil
16261 "Flag remembering if we have applied the advice to texmathp already.")
16263 (define-minor-mode org-cdlatex-mode
16264 "Toggle the minor `org-cdlatex-mode'.
16265 This mode supports entering LaTeX environment and math in LaTeX fragments
16266 in Org-mode.
16268 nil " OCDL" nil
16269 (when org-cdlatex-mode (require 'cdlatex))
16270 (unless org-cdlatex-texmathp-advice-is-done
16271 (setq org-cdlatex-texmathp-advice-is-done t)
16272 (defadvice texmathp (around org-math-always-on activate)
16273 "Always return t in org-mode buffers.
16274 This is because we want to insert math symbols without dollars even outside
16275 the LaTeX math segments. If Orgmode thinks that point is actually inside
16276 an embedded LaTeX fragment, let texmathp do its job.
16278 (interactive)
16279 (let (p)
16280 (cond
16281 ((not (org-mode-p)) ad-do-it)
16282 ((eq this-command 'cdlatex-math-symbol)
16283 (setq ad-return-value t
16284 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16285 (t
16286 (let ((p (org-inside-LaTeX-fragment-p)))
16287 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16288 (setq ad-return-value t
16289 texmathp-why '("Org-mode embedded math" . 0))
16290 (if p ad-do-it)))))))))
16292 (defun turn-on-org-cdlatex ()
16293 "Unconditionally turn on `org-cdlatex-mode'."
16294 (org-cdlatex-mode 1))
16296 (defun org-inside-LaTeX-fragment-p ()
16297 "Test if point is inside a LaTeX fragment.
16299 sequence appearing also before point.
16300 Even though the matchers for math are configurable, this function assumes
16302 delimiters are skipped when they have been removed by customization.
16303 The return value is nil, or a cons cell with the delimiter and the
16304 position of this delimiter.
16306 This function does a reasonably good job, but can locally be fooled by
16307 for example currency specifications. For example it will assume being in
16309 fragments that are properly closed, but during editing, we have to live
16310 with the uncertainty caused by missing closing delimiters. This function
16311 looks only before point, not after."
16312 (catch 'exit
16313 (let ((pos (point))
16314 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16315 (lim (progn
16317 (point)))
16318 dd-on str (start 0) m re)
16319 (goto-char pos)
16320 (when dodollar
16322 re (nth 1 (assoc "$" org-latex-regexps)))
16323 (while (string-match re str start)
16324 (cond
16325 ((= (match-end 0) (length str))
16326 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16327 ((= (match-end 0) (- (length str) 5))
16328 (throw 'exit nil))
16329 (t (setq start (match-end 0))))))
16330 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16331 (goto-char pos)
16332 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16333 (and (match-beginning 2) (throw 'exit nil))
16334 ;; count $$
16336 (setq dd-on (not dd-on)))
16337 (goto-char pos)
16338 (if dd-on (cons "$$" m))))))
16340 (defun org-inside-latex-macro-p ()
16341 "Is point inside a LaTeX macro or its arguments?"
16342 (save-match-data
16343 (org-in-regexp
16346 (defun org-try-cdlatex-tab ()
16347 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16348 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16349 - inside a LaTeX fragment, or
16350 - after the first word in a line, where an abbreviation expansion could
16351 insert a LaTeX environment."
16352 (when org-cdlatex-mode
16353 (cond
16354 ((save-excursion
16355 (skip-chars-backward "a-zA-Z0-9*")
16357 (bolp))
16358 (cdlatex-tab) t)
16359 ((org-inside-LaTeX-fragment-p)
16360 (cdlatex-tab) t)
16361 (t nil))))
16363 (defun org-cdlatex-underscore-caret (&optional arg)
16364 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16365 Revert to the normal definition outside of these fragments."
16366 (interactive "P")
16367 (if (org-inside-LaTeX-fragment-p)
16368 (call-interactively 'cdlatex-sub-superscript)
16369 (let (org-cdlatex-mode)
16370 (call-interactively (key-binding (vector last-input-event))))))
16372 (defun org-cdlatex-math-modify (&optional arg)
16373 "Execute `cdlatex-math-modify' in LaTeX fragments.
16374 Revert to the normal definition outside of these fragments."
16375 (interactive "P")
16376 (if (org-inside-LaTeX-fragment-p)
16377 (call-interactively 'cdlatex-math-modify)
16378 (let (org-cdlatex-mode)
16379 (call-interactively (key-binding (vector last-input-event))))))
16381 (defvar org-latex-fragment-image-overlays nil
16382 "List of overlays carrying the images of latex fragments.")
16383 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16385 (defun org-remove-latex-fragment-image-overlays ()
16386 "Remove all overlays with LaTeX fragment images in current buffer."
16387 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16388 (setq org-latex-fragment-image-overlays nil))
16390 (defun org-preview-latex-fragment (&optional subtree)
16391 "Preview the LaTeX fragment at point, or all locally or globally.
16392 If the cursor is in a LaTeX fragment, create the image and overlay
16393 it over the source code. If there is no fragment at point, display
16394 all fragments in the current text, from one headline to the next. With
16395 prefix SUBTREE, display all fragments in the current subtree. With a
16397 the cursor is before the first headline,
16398 display all fragments in the buffer.
16400 (interactive "P")
16401 (org-remove-latex-fragment-image-overlays)
16402 (save-excursion
16403 (save-restriction
16404 (let (beg end at msg)
16405 (cond
16406 ((or (equal subtree '(16))
16407 (not (save-excursion
16408 (re-search-backward org-outline-regexp-bol nil t))))
16409 (setq beg (point-min) end (point-max)
16410 msg "Creating images for buffer...%s"))
16411 ((equal subtree '(4))
16412 (org-back-to-heading)
16413 (setq beg (point) end (org-end-of-subtree t)
16414 msg "Creating images for subtree...%s"))
16415 (t
16416 (if (setq at (org-inside-LaTeX-fragment-p))
16417 (goto-char (max (point-min) (- (cdr at) 2)))
16418 (org-back-to-heading))
16419 (setq beg (point) end (progn (outline-next-heading) (point))
16420 msg (if at "Creating image...%s"
16421 "Creating images for entry...%s"))))
16422 (message msg "")
16423 (narrow-to-region beg end)
16424 (goto-char beg)
16425 (org-format-latex
16426 (concat "ltxpng/" (file-name-sans-extension
16427 (file-name-nondirectory
16428 buffer-file-name)))
16429 default-directory 'overlays msg at 'forbuffer 'dvipng)
16430 (message msg "done. Use `C-c C-c' to remove images.")))))
16432 (defvar org-latex-regexps
16434 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16437 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16441 "Regular expressions for matching embedded LaTeX.")
16443 (defvar org-export-have-math nil) ;; dynamic scoping
16444 (defun org-format-latex (prefix &optional dir overlays msg at
16445 forbuffer processing-type)
16446 "Replace LaTeX fragments with links to an image, and produce images.
16447 Some of the options can be changed using the variable
16448 `org-format-latex-options'."
16449 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16450 (let* ((prefixnodir (file-name-nondirectory prefix))
16451 (absprefix (expand-file-name prefix dir))
16452 (todir (file-name-directory absprefix))
16453 (opt org-format-latex-options)
16454 (matchers (plist-get opt :matchers))
16455 (re-list org-latex-regexps)
16456 (org-format-latex-header-extra
16457 (plist-get (org-infile-export-plist) :latex-header-extra))
16458 (cnt 0) txt hash link beg end re e checkdir
16459 executables-checked string
16460 m n block linkfile movefile ov)
16461 ;; Check the different regular expressions
16462 (while (setq e (pop re-list))
16463 (setq m (car e) re (nth 1 e) n (nth 2 e)
16465 (when (member m matchers)
16466 (goto-char (point-min))
16467 (while (re-search-forward re nil t)
16468 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16469 (not (get-text-property (match-beginning n)
16470 'org-protected))
16471 (or (not overlays)
16472 (not (eq (get-char-property (match-beginning n)
16473 'org-overlay-type)
16474 'org-latex-overlay))))
16475 (setq org-export-have-math t)
16476 (cond
16477 ((eq processing-type 'verbatim)
16478 ;; Leave the text verbatim, just protect it
16479 (add-text-properties (match-beginning n) (match-end n)
16480 '(org-protected t)))
16481 ((eq processing-type 'mathjax)
16482 ;; Prepare for MathJax processing
16483 (setq string (match-string n))
16484 (if (member m '("$" "$1"))
16485 (save-excursion
16486 (delete-region (match-beginning n) (match-end n))
16487 (goto-char (match-beginning n))
16490 '(org-protected t))))
16491 (add-text-properties (match-beginning n) (match-end n)
16492 '(org-protected t))))
16493 ((or (eq processing-type 'dvipng) t)
16494 ;; Process to an image
16495 (setq txt (match-string n)
16496 beg (match-beginning n) end (match-end n)
16497 cnt (1+ cnt))
16498 (let (print-length print-level) ; make sure full list is printed
16499 (setq hash (sha1 (prin1-to-string
16500 (list org-format-latex-header
16501 org-format-latex-header-extra
16502 org-export-latex-default-packages-alist
16503 org-export-latex-packages-alist
16504 org-format-latex-options
16505 forbuffer txt)))
16506 linkfile (format "%s_%s.png" prefix hash)
16507 movefile (format "%s_%s.png" absprefix hash)))
16508 (setq link (concat block "[[file:" linkfile "]]" block))
16509 (if msg (message msg cnt))
16510 (goto-char beg)
16511 (unless checkdir ; make sure the directory exists
16512 (setq checkdir t)
16513 (or (file-directory-p todir) (make-directory todir t)))
16515 (unless executables-checked
16516 (org-check-external-command
16517 "latex" "needed to convert LaTeX fragments to images")
16518 (org-check-external-command
16519 "dvipng" "needed to convert LaTeX fragments to images")
16520 (setq executables-checked t))
16522 (unless (file-exists-p movefile)
16523 (org-create-formula-image
16524 txt movefile opt forbuffer))
16525 (if overlays
16526 (progn
16527 (mapc (lambda (o)
16528 (if (eq (overlay-get o 'org-overlay-type)
16529 'org-latex-overlay)
16530 (delete-overlay o)))
16531 (overlays-in beg end))
16532 (setq ov (make-overlay beg end))
16533 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16534 (if (featurep 'xemacs)
16535 (progn
16536 (overlay-put ov 'invisible t)
16537 (overlay-put
16538 ov 'end-glyph
16539 (make-glyph (vector 'png :file movefile))))
16540 (overlay-put
16541 ov 'display
16542 (list 'image :type 'png :file movefile :ascent 'center)))
16543 (push ov org-latex-fragment-image-overlays)
16544 (goto-char end))
16545 (delete-region beg end)
16546 (insert (org-add-props link
16547 (list 'org-latex-src
16548 (replace-regexp-in-string
16551 ;; This function borrows from Ganesh Swami's latex2png.el
16552 (defun org-create-formula-image (string tofile options buffer)
16553 "This calls dvipng."
16554 (require 'org-latex)
16555 (let* ((tmpdir (if (featurep 'xemacs)
16556 (temp-directory)
16557 temporary-file-directory))
16558 (texfilebase (make-temp-name
16559 (expand-file-name "orgtex" tmpdir)))
16560 (texfile (concat texfilebase ".tex"))
16561 (dvifile (concat texfilebase ".dvi"))
16562 (pngfile (concat texfilebase ".png"))
16563 (fnh (if (featurep 'xemacs)
16564 (font-height (get-face-font 'default))
16565 (face-attribute 'default :height nil)))
16566 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16567 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16568 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16569 "Black"))
16570 (bg (or (plist-get options (if buffer :background :html-background))
16571 "Transparent")))
16572 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16573 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16574 (with-temp-file texfile
16575 (insert (org-splice-latex-header
16576 org-format-latex-header
16577 org-export-latex-default-packages-alist
16578 org-export-latex-packages-alist t
16579 org-format-latex-header-extra))
16581 (require 'org-latex)
16582 (org-export-latex-fix-inputenc))
16583 (let ((dir default-directory))
16584 (condition-case nil
16585 (progn
16586 (cd tmpdir)
16587 (call-process "latex" nil nil nil texfile))
16588 (error nil))
16589 (cd dir))
16590 (if (not (file-exists-p dvifile))
16591 (progn (message "Failed to create dvi file from %s" texfile) nil)
16592 (condition-case nil
16593 (call-process "dvipng" nil nil nil
16594 "-fg" fg "-bg" bg
16595 "-D" dpi
16596 ;;"-x" scale "-y" scale
16597 "-T" "tight"
16598 "-o" pngfile
16599 dvifile)
16600 (error nil))
16601 (if (not (file-exists-p pngfile))
16602 (if org-format-latex-signal-error
16603 (error "Failed to create png file from %s" texfile)
16604 (message "Failed to create png file from %s" texfile)
16605 nil)
16606 ;; Use the requested file name and clean up
16607 (copy-file pngfile tofile 'replace)
16608 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16609 (delete-file (concat texfilebase e)))
16610 pngfile))))
16612 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16613 "Fill a LaTeX header template TPL.
16614 In the template, the following place holders will be recognized:
16617 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16619 [NO-PACKAGES] do not include PKG
16620 [EXTRA] the string EXTRA
16621 [NO-EXTRA] do not include EXTRA
16623 For backward compatibility, if both the positive and the negative place
16625 assumed to be present at the end of the template.
16626 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16627 EXTRA is a string.
16628 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16629 (let (rpl (end ""))
16631 (setq rpl (if (or (match-end 1) (not def-pkg))
16632 "" (org-latex-packages-to-string def-pkg snippets-p t))
16633 tpl (replace-match rpl t t tpl))
16634 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16637 (setq rpl (if (or (match-end 1) (not pkg))
16638 "" (org-latex-packages-to-string pkg snippets-p t))
16639 tpl (replace-match rpl t t tpl))
16640 (if pkg (setq end
16642 (org-latex-packages-to-string pkg snippets-p)))))
16645 (setq rpl (if (or (match-end 1) (not extra))
16647 tpl (replace-match rpl t t tpl))
16653 tpl)))
16655 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16657 (setq pkg (mapconcat (lambda(p)
16658 (cond
16659 ((stringp p) p)
16660 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16661 (format "%% Package %s omitted" (cadr p)))
16662 ((equal "" (car p))
16664 (t
16666 (car p) (cadr p)))))
16667 pkg
16671 (defun org-dvipng-color (attr)
16672 "Return an rgb color specification for dvipng."
16673 (apply 'format "rgb %s %s %s"
16674 (mapcar 'org-normalize-color
16675 (color-values (face-attribute 'default attr nil)))))
16677 (defun org-normalize-color (value)
16678 "Return string to be used as color value for an RGB component."
16679 (format "%g" (/ value 65535.0)))
16681 ;; Image display
16684 (defvar org-inline-image-overlays nil)
16685 (make-variable-buffer-local 'org-inline-image-overlays)
16687 (defun org-toggle-inline-images (&optional include-linked)
16688 "Toggle the display of inline images.
16689 INCLUDE-LINKED is passed to `org-display-inline-images'."
16690 (interactive "P")
16691 (if org-inline-image-overlays
16692 (progn
16693 (org-remove-inline-images)
16694 (message "Inline image display turned off"))
16695 (org-display-inline-images include-linked)
16696 (if org-inline-image-overlays
16697 (message "%d images displayed inline"
16698 (length org-inline-image-overlays))
16699 (message "No images to display inline"))))
16701 (defun org-display-inline-images (&optional include-linked refresh beg end)
16702 "Display inline images.
16703 Normally only links without a description part are inlined, because this
16704 is how it will work for export. When INCLUDE-LINKED is set, also links
16705 with a description part will be inlined. This can be nice for a quick
16706 look at those images, but it does not reflect what exported files will look
16707 like.
16708 When REFRESH is set, refresh existing images between BEG and END.
16709 This will create new image displays only if necessary.
16710 BEG and END default to the buffer boundaries."
16711 (interactive "P")
16712 (unless refresh
16713 (org-remove-inline-images)
16714 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16715 (save-excursion
16716 (save-restriction
16717 (widen)
16718 (setq beg (or beg (point-min)) end (or end (point-max)))
16719 (goto-char (point-min))
16721 (substring (org-image-file-name-regexp) 0 -2)
16723 old file ov img)
16724 (while (re-search-forward re end t)
16725 (setq old (get-char-property-and-overlay (match-beginning 1)
16726 'org-image-overlay))
16727 (setq file (expand-file-name
16728 (concat (or (match-string 3) "") (match-string 4))))
16729 (when (file-exists-p file)
16730 (if (and (car-safe old) refresh)
16731 (image-refresh (overlay-get (cdr old) 'display))
16732 (setq img (save-match-data (create-image file)))
16733 (when img
16734 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16735 (overlay-put ov 'display img)
16736 (overlay-put ov 'face 'default)
16737 (overlay-put ov 'org-image-overlay t)
16738 (overlay-put ov 'modification-hooks
16739 (list 'org-display-inline-modification-hook))
16740 (push ov org-inline-image-overlays)))))))))
16742 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16743 "Remove inline-display overlay if a corresponding region is modified."
16744 (let ((inhibit-modification-hooks t))
16745 (when (and ov after)
16746 (delete ov org-inline-image-overlays)
16747 (delete-overlay ov))))
16749 (defun org-remove-inline-images ()
16750 "Remove inline display of images."
16751 (interactive)
16752 (mapc 'delete-overlay org-inline-image-overlays)
16753 (setq org-inline-image-overlays nil))
16755 ;;;; Key bindings
16757 ;; Make `C-c C-x' a prefix key
16758 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16760 ;; TAB key with modifiers
16761 (org-defkey org-mode-map "\C-i" 'org-cycle)
16762 (org-defkey org-mode-map [(tab)] 'org-cycle)
16763 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16764 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16766 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16767 ;; The following line is necessary under Suse GNU/Linux
16768 (unless (featurep 'xemacs)
16769 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16770 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16771 (define-key org-mode-map [backtab] 'org-shifttab)
16773 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16774 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16775 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16777 ;; Cursor keys with modifiers
16778 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16779 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16780 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16781 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16783 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16784 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16785 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16786 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16788 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16789 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16790 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16791 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16793 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16794 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16795 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16796 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16798 ;; Babel keys
16799 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16800 (mapc (lambda (pair)
16801 (define-key org-babel-map (car pair) (cdr pair)))
16802 org-babel-key-bindings)
16804 ;;; Extra keys for tty access.
16805 ;; We only set them when really needed because otherwise the
16806 ;; menus don't show the simple keys
16808 (when (or org-use-extra-keys
16809 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16810 (not window-system))
16811 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16812 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16813 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16814 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16815 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16816 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16817 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16818 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16819 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16820 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16821 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16822 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16823 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16824 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16825 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16826 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16827 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16828 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16829 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16830 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16831 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16832 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16833 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16834 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16835 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16836 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16837 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16838 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16840 ;; All the other keys
16842 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16843 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16844 (if (boundp 'narrow-map)
16845 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16846 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16847 (if (boundp 'narrow-map)
16848 (org-defkey narrow-map "b" 'org-narrow-to-block)
16849 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16850 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16851 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16852 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16853 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16854 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16855 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16856 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16857 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16858 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16859 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16860 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16861 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16862 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16863 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16864 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16865 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16867 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16868 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16869 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16870 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16871 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16872 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16873 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16874 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16875 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16876 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16877 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16878 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16879 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16880 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16881 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16882 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16883 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16884 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16885 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16886 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16888 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16889 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16890 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16891 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16892 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16893 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16894 (org-defkey org-mode-map "\C-c^" 'org-sort)
16895 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16896 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16897 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16898 (org-defkey org-mode-map "\C-m" 'org-return)
16899 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16900 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16901 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16902 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16903 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16904 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16905 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16906 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16907 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16908 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16909 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16910 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16911 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16912 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16913 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16914 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16915 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16916 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16917 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16918 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16919 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16920 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16922 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16923 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16924 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16925 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16927 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16928 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16929 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16930 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16931 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16932 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16933 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16934 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16935 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16936 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16938 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16939 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16940 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16941 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16942 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16943 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16944 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16946 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16947 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16948 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16949 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16950 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16952 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16954 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16956 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16957 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16959 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16962 (when (featurep 'xemacs)
16963 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16966 (defconst org-speed-commands-default
16967 '(
16968 ("Outline Navigation")
16969 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16970 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16971 ("f" . (org-speed-move-safe 'org-forward-same-level))
16972 ("b" . (org-speed-move-safe 'org-backward-same-level))
16973 ("u" . (org-speed-move-safe 'outline-up-heading))
16974 ("j" . org-goto)
16975 ("g" . (org-refile t))
16976 ("Outline Visibility")
16977 ("c" . org-cycle)
16978 ("C" . org-shifttab)
16979 (" " . org-display-outline-path)
16980 ("Outline Structure Editing")
16981 ("U" . org-shiftmetaup)
16982 ("D" . org-shiftmetadown)
16983 ("r" . org-metaright)
16984 ("l" . org-metaleft)
16985 ("R" . org-shiftmetaright)
16986 ("L" . org-shiftmetaleft)
16987 ("i" . (progn (forward-char 1) (call-interactively
16988 'org-insert-heading-respect-content)))
16989 ("^" . org-sort)
16990 ("w" . org-refile)
16991 ("a" . org-archive-subtree-default-with-confirmation)
16992 ("." . org-mark-subtree)
16993 ("Clock Commands")
16994 ("I" . org-clock-in)
16995 ("O" . org-clock-out)
16996 ("Meta Data Editing")
16997 ("t" . org-todo)
16998 ("0" . (org-priority ?\ ))
16999 ("1" . (org-priority ?A))
17000 ("2" . (org-priority ?B))
17001 ("3" . (org-priority ?C))
17002 (";" . org-set-tags-command)
17003 ("e" . org-set-effort)
17004 ("Agenda Views etc")
17005 ("v" . org-agenda)
17006 ("/" . org-sparse-tree)
17007 ("Misc")
17008 ("o" . org-open-at-point)
17009 ("?" . org-speed-command-help)
17010 ("<" . (org-agenda-set-restriction-lock 'subtree))
17011 (">" . (org-agenda-remove-restriction-lock))
17012 )
17013 "The default speed commands.")
17015 (defun org-print-speed-command (e)
17016 (if (> (length (car e)) 1)
17017 (progn
17019 (princ (car e))
17021 (princ (make-string (length (car e)) ?-))
17023 (princ (car e))
17024 (princ " ")
17025 (if (symbolp (cdr e))
17026 (princ (symbol-name (cdr e)))
17027 (prin1 (cdr e)))
17030 (defun org-speed-command-help ()
17031 "Show the available speed commands."
17032 (interactive)
17033 (if (not org-use-speed-commands)
17034 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17035 (with-output-to-temp-buffer "*Help*"
17037 (mapc 'org-print-speed-command org-speed-commands-user)
17040 (mapc 'org-print-speed-command org-speed-commands-default))
17041 (with-current-buffer "*Help*"
17042 (setq truncate-lines t))))
17044 (defun org-speed-move-safe (cmd)
17045 "Execute CMD, but make sure that the cursor always ends up in a headline.
17046 If not, return to the original position and throw an error."
17047 (interactive)
17048 (let ((pos (point)))
17049 (call-interactively cmd)
17050 (unless (and (bolp) (org-on-heading-p))
17051 (goto-char pos)
17052 (error "Boundary reached while executing %s" cmd))))
17054 (defvar org-self-insert-command-undo-counter 0)
17056 (defvar org-table-auto-blank-field) ; defined in org-table.el
17057 (defvar org-speed-command nil)
17059 (defun org-speed-command-default-hook (keys)
17060 "Hook for activating single-letter speed commands.
17061 `org-speed-commands-default' specifies a minimal command set. Use
17062 `org-speed-commands-user' for further customization."
17063 (when (or (and (bolp) (looking-at org-outline-regexp))
17064 (and (functionp org-use-speed-commands)
17065 (funcall org-use-speed-commands)))
17066 (cdr (assoc keys (append org-speed-commands-user
17067 org-speed-commands-default)))))
17069 (defun org-babel-speed-command-hook (keys)
17070 "Hook for activating single-letter code block commands."
17071 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17072 (cdr (assoc keys org-babel-key-bindings))))
17074 (defcustom org-speed-command-hook
17075 '(org-speed-command-default-hook org-babel-speed-command-hook)
17076 "Hook for activating speed commands at strategic locations.
17077 Hook functions are called in sequence until a valid handler is
17078 found.
17080 Each hook takes a single argument, a user-pressed command key
17081 which is also a `self-insert-command' from the global map.
17083 Within the hook, examine the cursor position and the command key
17084 and return nil or a valid handler as appropriate. Handler could
17085 be one of an interactive command, a function, or a form.
17087 Set `org-use-speed-commands' to non-nil value to enable this
17088 hook. The default setting is `org-speed-command-default-hook'."
17089 :group 'org-structure
17090 :type 'hook)
17092 (defun org-self-insert-command (N)
17093 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17094 If the cursor is in a table looking at whitespace, the whitespace is
17095 overwritten, and the table is not marked as requiring realignment."
17096 (interactive "p")
17097 (cond
17098 ((and org-use-speed-commands
17099 (setq org-speed-command
17100 (run-hook-with-args-until-success
17101 'org-speed-command-hook (this-command-keys))))
17102 (cond
17103 ((commandp org-speed-command)
17104 (setq this-command org-speed-command)
17105 (call-interactively org-speed-command))
17106 ((functionp org-speed-command)
17107 (funcall org-speed-command))
17108 ((and org-speed-command (listp org-speed-command))
17109 (eval org-speed-command))
17110 (t (let (org-use-speed-commands)
17111 (call-interactively 'org-self-insert-command)))))
17112 ((and
17113 (org-table-p)
17114 (progn
17115 ;; check if we blank the field, and if that triggers align
17116 (and (featurep 'org-table) org-table-auto-blank-field
17117 (member last-command
17118 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17120 ;; got extra space, this field does not determine column width
17121 (let (org-table-may-need-update) (org-table-blank-field))
17122 ;; no extra space, this field may determine column width
17123 (org-table-blank-field)))
17124 t)
17125 (eq N 1)
17127 (let (org-table-may-need-update)
17128 (goto-char (1- (match-end 0)))
17129 (delete-char -1)
17130 (goto-char (match-beginning 0))
17131 (self-insert-command N)))
17132 (t
17133 (setq org-table-may-need-update t)
17134 (self-insert-command N)
17135 (org-fix-tags-on-the-fly)
17136 (if org-self-insert-cluster-for-undo
17137 (if (not (eq last-command 'org-self-insert-command))
17138 (setq org-self-insert-command-undo-counter 1)
17139 (if (>= org-self-insert-command-undo-counter 20)
17140 (setq org-self-insert-command-undo-counter 1)
17141 (and (> org-self-insert-command-undo-counter 0)
17142 buffer-undo-list (listp buffer-undo-list)
17143 (not (cadr buffer-undo-list)) ; remove nil entry
17144 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17145 (setq org-self-insert-command-undo-counter
17146 (1+ org-self-insert-command-undo-counter))))))))
17148 (defun org-fix-tags-on-the-fly ()
17149 (when (and (equal (char-after (point-at-bol)) ?*)
17150 (org-on-heading-p))
17151 (org-align-tags-here org-tags-column)))
17153 (defun org-delete-backward-char (N)
17154 "Like `delete-backward-char', insert whitespace at field end in tables.
17155 When deleting backwards, in tables this function will insert whitespace in
17157 still be marked for re-alignment if the field did fill the entire column,
17158 because, in this case the deletion might narrow the column."
17159 (interactive "p")
17160 (if (and (org-table-p)
17161 (eq N 1)
17162 (string-match "|" (buffer-substring (point-at-bol) (point)))
17163 (looking-at ".*?|"))
17164 (let ((pos (point))
17166 (c org-table-may-need-update))
17167 (backward-delete-char N)
17168 (if (not overwrite-mode)
17169 (progn
17170 (skip-chars-forward "^|")
17171 (insert " ")
17172 (goto-char (1- pos))))
17173 ;; noalign: if there were two spaces at the end, this field
17174 ;; does not determine the width of the column.
17175 (if noalign (setq org-table-may-need-update c)))
17176 (backward-delete-char N)
17177 (org-fix-tags-on-the-fly)))
17179 (defun org-delete-char (N)
17180 "Like `delete-char', but insert whitespace at field end in tables.
17181 When deleting characters, in tables this function will insert whitespace in
17183 still be marked for re-alignment if the field did fill the entire column,
17184 because, in this case the deletion might narrow the column."
17185 (interactive "p")
17186 (if (and (org-table-p)
17187 (not (bolp))
17188 (not (= (char-after) ?|))
17189 (eq N 1))
17190 (if (looking-at ".*?|")
17191 (let ((pos (point))
17193 (c org-table-may-need-update))
17194 (replace-match (concat
17195 (substring (match-string 0) 1 -1)
17196 " |"))
17197 (goto-char pos)
17198 ;; noalign: if there were two spaces at the end, this field
17199 ;; does not determine the width of the column.
17200 (if noalign (setq org-table-may-need-update c)))
17201 (delete-char N))
17202 (delete-char N)
17203 (org-fix-tags-on-the-fly)))
17205 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17206 (put 'org-self-insert-command 'delete-selection t)
17207 (put 'orgtbl-self-insert-command 'delete-selection t)
17208 (put 'org-delete-char 'delete-selection 'supersede)
17209 (put 'org-delete-backward-char 'delete-selection 'supersede)
17210 (put 'org-yank 'delete-selection 'yank)
17212 ;; Make `flyspell-mode' delay after some commands
17213 (put 'org-self-insert-command 'flyspell-delayed t)
17214 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17215 (put 'org-delete-char 'flyspell-delayed t)
17216 (put 'org-delete-backward-char 'flyspell-delayed t)
17218 ;; Make pabbrev-mode expand after org-mode commands
17219 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17220 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17222 ;; How to do this: Measure non-white length of current string
17223 ;; If equal to column width, we should realign.
17225 (defun org-remap (map &rest commands)
17226 "In MAP, remap the functions given in COMMANDS.
17227 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17228 (let (new old)
17229 (while commands
17230 (setq old (pop commands) new (pop commands))
17231 (if (fboundp 'command-remapping)
17232 (org-defkey map (vector 'remap old) new)
17233 (substitute-key-definition old new map global-map)))))
17235 (when (eq org-enable-table-editor 'optimized)
17236 ;; If the user wants maximum table support, we need to hijack
17237 ;; some standard editing functions
17238 (org-remap org-mode-map
17239 'self-insert-command 'org-self-insert-command
17240 'delete-char 'org-delete-char
17241 'delete-backward-char 'org-delete-backward-char)
17242 (org-defkey org-mode-map "|" 'org-force-self-insert))
17244 (defvar org-ctrl-c-ctrl-c-hook nil
17245 "Hook for functions attaching themselves to `C-c C-c'.
17247 This can be used to add additional functionality to the C-c C-c
17248 key which executes context-dependent commands. This hook is run
17249 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17250 run after the last test.
17252 Each function will be called with no arguments. The function
17253 must check if the context is appropriate for it to act. If yes,
17254 it should do its thing and then return a non-nil value. If the
17255 context is wrong, just do nothing and return nil.")
17257 (defvar org-ctrl-c-ctrl-c-final-hook nil
17258 "Hook for functions attaching themselves to `C-c C-c'.
17260 This can be used to add additional functionality to the C-c C-c
17261 key which executes context-dependent commands. This hook is run
17262 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17263 before the first test.
17265 Each function will be called with no arguments. The function
17266 must check if the context is appropriate for it to act. If yes,
17267 it should do its thing and then return a non-nil value. If the
17268 context is wrong, just do nothing and return nil.")
17270 (defvar org-tab-first-hook nil
17271 "Hook for functions to attach themselves to TAB.
17272 See `org-ctrl-c-ctrl-c-hook' for more information.
17273 This hook runs as the first action when TAB is pressed, even before
17274 `org-cycle' messes around with the `outline-regexp' to cater for
17275 inline tasks and plain list item folding.
17276 If any function in this hook returns t, any other actions that
17277 would have been caused by TAB (such as table field motion or visibility
17278 cycling) will not occur.")
17280 (defvar org-tab-after-check-for-table-hook nil
17281 "Hook for functions to attach themselves to TAB.
17282 See `org-ctrl-c-ctrl-c-hook' for more information.
17283 This hook runs after it has been established that the cursor is not in a
17284 table, but before checking if the cursor is in a headline or if global cycling
17285 should be done.
17286 If any function in this hook returns t, not other actions like visibility
17287 cycling will be done.")
17289 (defvar org-tab-after-check-for-cycling-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 it has been established that not table field motion and
17293 not visibility should be done because of current context. This is probably
17294 the place where a package like yasnippets can hook in.")
17296 (defvar org-tab-before-tab-emulation-hook nil
17297 "Hook for functions to attach themselves to TAB.
17298 See `org-ctrl-c-ctrl-c-hook' for more information.
17299 This hook runs after every other options for TAB have been exhausted, but
17302 (defvar org-metaleft-hook nil
17303 "Hook for functions attaching themselves to `M-left'.
17304 See `org-ctrl-c-ctrl-c-hook' for more information.")
17305 (defvar org-metaright-hook nil
17306 "Hook for functions attaching themselves to `M-right'.
17307 See `org-ctrl-c-ctrl-c-hook' for more information.")
17308 (defvar org-metaup-hook nil
17309 "Hook for functions attaching themselves to `M-up'.
17310 See `org-ctrl-c-ctrl-c-hook' for more information.")
17311 (defvar org-metadown-hook nil
17312 "Hook for functions attaching themselves to `M-down'.
17313 See `org-ctrl-c-ctrl-c-hook' for more information.")
17314 (defvar org-shiftmetaleft-hook nil
17315 "Hook for functions attaching themselves to `M-S-left'.
17316 See `org-ctrl-c-ctrl-c-hook' for more information.")
17317 (defvar org-shiftmetaright-hook nil
17318 "Hook for functions attaching themselves to `M-S-right'.
17319 See `org-ctrl-c-ctrl-c-hook' for more information.")
17320 (defvar org-shiftmetaup-hook nil
17321 "Hook for functions attaching themselves to `M-S-up'.
17322 See `org-ctrl-c-ctrl-c-hook' for more information.")
17323 (defvar org-shiftmetadown-hook nil
17324 "Hook for functions attaching themselves to `M-S-down'.
17325 See `org-ctrl-c-ctrl-c-hook' for more information.")
17326 (defvar org-metareturn-hook nil
17327 "Hook for functions attaching themselves to `M-RET'.
17328 See `org-ctrl-c-ctrl-c-hook' for more information.")
17329 (defvar org-shiftup-hook nil
17330 "Hook for functions attaching themselves to `S-up'.
17331 See `org-ctrl-c-ctrl-c-hook' for more information.")
17332 (defvar org-shiftup-final-hook nil
17333 "Hook for functions attaching themselves to `S-up'.
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-shiftdown-hook nil
17337 "Hook for functions attaching themselves to `S-down'.
17338 See `org-ctrl-c-ctrl-c-hook' for more information.")
17339 (defvar org-shiftdown-final-hook nil
17340 "Hook for functions attaching themselves to `S-down'.
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-shiftleft-hook nil
17344 "Hook for functions attaching themselves to `S-left'.
17345 See `org-ctrl-c-ctrl-c-hook' for more information.")
17346 (defvar org-shiftleft-final-hook nil
17347 "Hook for functions attaching themselves to `S-left'.
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.")
17350 (defvar org-shiftright-hook nil
17351 "Hook for functions attaching themselves to `S-right'.
17352 See `org-ctrl-c-ctrl-c-hook' for more information.")
17353 (defvar org-shiftright-final-hook nil
17354 "Hook for functions attaching themselves to `S-right'.
17355 This one runs after all other options except shift-select have been excluded.
17356 See `org-ctrl-c-ctrl-c-hook' for more information.")
17358 (defun org-modifier-cursor-error ()
17359 "Throw an error, a modified cursor command was applied in wrong context."
17360 (error "This command is active in special context like tables, headlines or items"))
17362 (defun org-shiftselect-error ()
17363 "Throw an error because Shift-Cursor command was applied in wrong context."
17364 (if (and (boundp 'shift-select-mode) shift-select-mode)
17365 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17366 (error "This command works only in special context like headlines or timestamps")))
17368 (defun org-call-for-shift-select (cmd)
17369 (let ((this-command-keys-shift-translated t))
17370 (call-interactively cmd)))
17372 (defun org-shifttab (&optional arg)
17373 "Global visibility cycling or move to previous table field.
17374 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17375 on context.
17376 See the individual commands for more information."
17377 (interactive "P")
17378 (cond
17379 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17380 ((integerp arg)
17381 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17382 (message "Content view to level: %d" arg)
17383 (org-content (prefix-numeric-value arg2))
17384 (setq org-cycle-global-status 'overview)))
17385 (t (call-interactively 'org-global-cycle))))
17387 (defun org-shiftmetaleft ()
17388 "Promote subtree or delete table column.
17389 Calls `org-promote-subtree', `org-outdent-item',
17390 or `org-table-delete-column', depending on context.
17391 See the individual commands for more information."
17392 (interactive)
17393 (cond
17394 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17395 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17396 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17397 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17398 (t (org-modifier-cursor-error))))
17400 (defun org-shiftmetaright ()
17401 "Demote subtree or insert table column.
17402 Calls `org-demote-subtree', `org-indent-item',
17403 or `org-table-insert-column', depending on context.
17404 See the individual commands for more information."
17405 (interactive)
17406 (cond
17407 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17408 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17409 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17410 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17411 (t (org-modifier-cursor-error))))
17413 (defun org-shiftmetaup (&optional arg)
17414 "Move subtree up or kill table row.
17415 Calls `org-move-subtree-up' or `org-table-kill-row' or
17416 `org-move-item-up' depending on context. See the individual commands
17417 for more information."
17418 (interactive "P")
17419 (cond
17420 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17421 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17422 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17423 ((org-at-item-p) (call-interactively 'org-move-item-up))
17424 (t (org-modifier-cursor-error))))
17426 (defun org-shiftmetadown (&optional arg)
17427 "Move subtree down or insert table row.
17428 Calls `org-move-subtree-down' or `org-table-insert-row' or
17429 `org-move-item-down', depending on context. See the individual
17430 commands for more information."
17431 (interactive "P")
17432 (cond
17433 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17434 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17435 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17436 ((org-at-item-p) (call-interactively 'org-move-item-down))
17437 (t (org-modifier-cursor-error))))
17439 (defsubst org-hidden-tree-error ()
17440 (error
17441 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17443 (defun org-metaleft (&optional arg)
17444 "Promote heading or move table column to left.
17445 Calls `org-do-promote' or `org-table-move-column', depending on context.
17446 With no specific context, calls the Emacs default `backward-word'.
17447 See the individual commands for more information."
17448 (interactive "P")
17449 (cond
17450 ((run-hook-with-args-until-success 'org-metaleft-hook))
17451 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17452 ((org-with-limited-levels
17453 (or (org-on-heading-p)
17454 (and (org-region-active-p)
17455 (save-excursion
17456 (goto-char (region-beginning))
17457 (org-on-heading-p)))))
17458 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17459 (call-interactively 'org-do-promote))
17460 ;; At an inline task.
17461 ((org-on-heading-p)
17462 (call-interactively 'org-inlinetask-promote))
17463 ((or (org-at-item-p)
17464 (and (org-region-active-p)
17465 (save-excursion
17466 (goto-char (region-beginning))
17467 (org-at-item-p))))
17468 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17469 (call-interactively 'org-outdent-item))
17470 (t (call-interactively 'backward-word))))
17472 (defun org-metaright (&optional arg)
17473 "Demote subtree or move table column to right.
17474 Calls `org-do-demote' or `org-table-move-column', depending on context.
17475 With no specific context, calls the Emacs default `forward-word'.
17476 See the individual commands for more information."
17477 (interactive "P")
17478 (cond
17479 ((run-hook-with-args-until-success 'org-metaright-hook))
17480 ((org-at-table-p) (call-interactively 'org-table-move-column))
17481 ((org-with-limited-levels
17482 (or (org-on-heading-p)
17483 (and (org-region-active-p)
17484 (save-excursion
17485 (goto-char (region-beginning))
17486 (org-on-heading-p)))))
17487 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17488 (call-interactively 'org-do-demote))
17489 ;; At an inline task.
17490 ((org-on-heading-p)
17491 (call-interactively 'org-inlinetask-demote))
17492 ((or (org-at-item-p)
17493 (and (org-region-active-p)
17494 (save-excursion
17495 (goto-char (region-beginning))
17496 (org-at-item-p))))
17497 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17498 (call-interactively 'org-indent-item))
17499 (t (call-interactively 'forward-word))))
17501 (defun org-check-for-hidden (what)
17502 "Check if there are hidden headlines/items in the current visual line.
17503 WHAT can be either `headlines' or `items'. If the current line is
17504 an outline or item heading and it has a folded subtree below it,
17505 this function returns t, nil otherwise."
17506 (let ((re (cond
17507 ((eq what 'headlines) org-outline-regexp-bol)
17508 ((eq what 'items) (org-item-beginning-re))
17509 (t (error "This should not happen"))))
17510 beg end)
17511 (save-excursion
17512 (catch 'exit
17513 (unless (org-region-active-p)
17514 (setq beg (point-at-bol))
17515 (beginning-of-line 2)
17516 (while (and (not (eobp)) ;; this is like `next-line'
17517 (get-char-property (1- (point)) 'invisible))
17518 (beginning-of-line 2))
17519 (setq end (point))
17520 (goto-char beg)
17521 (goto-char (point-at-eol))
17522 (setq end (max end (point)))
17523 (while (re-search-forward re end t)
17524 (if (get-char-property (match-beginning 0) 'invisible)
17525 (throw 'exit t))))
17526 nil))))
17528 (defun org-metaup (&optional arg)
17529 "Move subtree up or move table row up.
17530 Calls `org-move-subtree-up' or `org-table-move-row' or
17531 `org-move-item-up', depending on context. See the individual commands
17532 for more information."
17533 (interactive "P")
17534 (cond
17535 ((run-hook-with-args-until-success 'org-metaup-hook))
17536 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17537 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17538 ((org-at-item-p) (call-interactively 'org-move-item-up))
17539 (t (transpose-lines 1) (beginning-of-line -1))))
17541 (defun org-metadown (&optional arg)
17542 "Move subtree down or move table row down.
17543 Calls `org-move-subtree-down' or `org-table-move-row' or
17544 `org-move-item-down', depending on context. See the individual
17545 commands for more information."
17546 (interactive "P")
17547 (cond
17548 ((run-hook-with-args-until-success 'org-metadown-hook))
17549 ((org-at-table-p) (call-interactively 'org-table-move-row))
17550 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17551 ((org-at-item-p) (call-interactively 'org-move-item-down))
17552 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17554 (defun org-shiftup (&optional arg)
17555 "Increase item in timestamp or increase priority of current headline.
17556 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17557 depending on context. See the individual commands for more information."
17558 (interactive "P")
17559 (cond
17560 ((run-hook-with-args-until-success 'org-shiftup-hook))
17561 ((and org-support-shift-select (org-region-active-p))
17562 (org-call-for-shift-select 'previous-line))
17563 ((org-at-timestamp-p t)
17564 (call-interactively (if org-edit-timestamp-down-means-later
17565 'org-timestamp-down 'org-timestamp-up)))
17566 ((and (not (eq org-support-shift-select 'always))
17567 org-enable-priority-commands
17568 (org-on-heading-p))
17569 (call-interactively 'org-priority-up))
17570 ((and (not org-support-shift-select) (org-at-item-p))
17571 (call-interactively 'org-previous-item))
17572 ((org-clocktable-try-shift 'up arg))
17573 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17574 (org-support-shift-select
17575 (org-call-for-shift-select 'previous-line))
17576 (t (org-shiftselect-error))))
17578 (defun org-shiftdown (&optional arg)
17579 "Decrease item in timestamp or decrease priority of current headline.
17580 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17581 depending on context. See the individual commands for more information."
17582 (interactive "P")
17583 (cond
17584 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17585 ((and org-support-shift-select (org-region-active-p))
17586 (org-call-for-shift-select 'next-line))
17587 ((org-at-timestamp-p t)
17588 (call-interactively (if org-edit-timestamp-down-means-later
17589 'org-timestamp-up 'org-timestamp-down)))
17590 ((and (not (eq org-support-shift-select 'always))
17591 org-enable-priority-commands
17592 (org-on-heading-p))
17593 (call-interactively 'org-priority-down))
17594 ((and (not org-support-shift-select) (org-at-item-p))
17595 (call-interactively 'org-next-item))
17596 ((org-clocktable-try-shift 'down arg))
17597 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17598 (org-support-shift-select
17599 (org-call-for-shift-select 'next-line))
17600 (t (org-shiftselect-error))))
17602 (defun org-shiftright (&optional arg)
17603 "Cycle the thing at point or in the current line, depending on context.
17604 Depending on context, this does one of the following:
17606 - switch a timestamp at point one day into the future
17607 - on a headline, switch to the next TODO keyword.
17608 - on an item, switch entire list to the next bullet type
17609 - on a property line, switch to the next allowed value
17610 - on a clocktable definition line, move time block into the future"
17611 (interactive "P")
17612 (cond
17613 ((run-hook-with-args-until-success 'org-shiftright-hook))
17614 ((and org-support-shift-select (org-region-active-p))
17615 (org-call-for-shift-select 'forward-char))
17616 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17617 ((and (not (eq org-support-shift-select 'always))
17618 (org-on-heading-p))
17619 (let ((org-inhibit-logging
17620 (not org-treat-S-cursor-todo-selection-as-state-change))
17621 (org-inhibit-blocking
17622 (not org-treat-S-cursor-todo-selection-as-state-change)))
17623 (org-call-with-arg 'org-todo 'right)))
17624 ((or (and org-support-shift-select
17625 (not (eq org-support-shift-select 'always))
17626 (org-at-item-bullet-p))
17627 (and (not org-support-shift-select) (org-at-item-p)))
17628 (org-call-with-arg 'org-cycle-list-bullet nil))
17629 ((and (not (eq org-support-shift-select 'always))
17630 (org-at-property-p))
17631 (call-interactively 'org-property-next-allowed-value))
17632 ((org-clocktable-try-shift 'right arg))
17633 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17634 (org-support-shift-select
17635 (org-call-for-shift-select 'forward-char))
17636 (t (org-shiftselect-error))))
17638 (defun org-shiftleft (&optional arg)
17639 "Cycle the thing at point or in the current line, depending on context.
17640 Depending on context, this does one of the following:
17642 - switch a timestamp at point one day into the past
17643 - on a headline, switch to the previous TODO keyword.
17644 - on an item, switch entire list to the previous bullet type
17645 - on a property line, switch to the previous allowed value
17646 - on a clocktable definition line, move time block into the past"
17647 (interactive "P")
17648 (cond
17649 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17650 ((and org-support-shift-select (org-region-active-p))
17651 (org-call-for-shift-select 'backward-char))
17652 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17653 ((and (not (eq org-support-shift-select 'always))
17654 (org-on-heading-p))
17655 (let ((org-inhibit-logging
17656 (not org-treat-S-cursor-todo-selection-as-state-change))
17657 (org-inhibit-blocking
17658 (not org-treat-S-cursor-todo-selection-as-state-change)))
17659 (org-call-with-arg 'org-todo 'left)))
17660 ((or (and org-support-shift-select
17661 (not (eq org-support-shift-select 'always))
17662 (org-at-item-bullet-p))
17663 (and (not org-support-shift-select) (org-at-item-p)))
17664 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17665 ((and (not (eq org-support-shift-select 'always))
17666 (org-at-property-p))
17667 (call-interactively 'org-property-previous-allowed-value))
17668 ((org-clocktable-try-shift 'left arg))
17669 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17670 (org-support-shift-select
17671 (org-call-for-shift-select 'backward-char))
17672 (t (org-shiftselect-error))))
17674 (defun org-shiftcontrolright ()
17675 "Switch to next TODO set."
17676 (interactive)
17677 (cond
17678 ((and org-support-shift-select (org-region-active-p))
17679 (org-call-for-shift-select 'forward-word))
17680 ((and (not (eq org-support-shift-select 'always))
17681 (org-on-heading-p))
17682 (org-call-with-arg 'org-todo 'nextset))
17683 (org-support-shift-select
17684 (org-call-for-shift-select 'forward-word))
17685 (t (org-shiftselect-error))))
17687 (defun org-shiftcontrolleft ()
17688 "Switch to previous TODO set."
17689 (interactive)
17690 (cond
17691 ((and org-support-shift-select (org-region-active-p))
17692 (org-call-for-shift-select 'backward-word))
17693 ((and (not (eq org-support-shift-select 'always))
17694 (org-on-heading-p))
17695 (org-call-with-arg 'org-todo 'previousset))
17696 (org-support-shift-select
17697 (org-call-for-shift-select 'backward-word))
17698 (t (org-shiftselect-error))))
17700 (defun org-shiftcontrolup ()
17701 "Change timestamps synchronously up in CLOCK log lines."
17702 (interactive)
17703 (cond ((and (not org-support-shift-select)
17704 (org-at-clock-log-p)
17705 (org-at-timestamp-p t))
17706 (org-clock-timestamps-up))
17707 (t (org-shiftselect-error))))
17709 (defun org-shiftcontroldown ()
17710 "Change timestamps synchronously down in CLOCK log lines."
17711 (interactive)
17712 (cond ((and (not org-support-shift-select)
17713 (org-at-clock-log-p)
17714 (org-at-timestamp-p t))
17715 (org-clock-timestamps-down))
17716 (t (org-shiftselect-error))))
17718 (defun org-ctrl-c-ret ()
17719 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17720 (interactive)
17721 (cond
17722 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17723 (t (call-interactively 'org-insert-heading))))
17725 (defun org-find-visible ()
17726 (let ((s (point)))
17727 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17728 (get-char-property s 'invisible)))
17729 s))
17730 (defun org-find-invisible ()
17731 (let ((s (point)))
17732 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17733 (not (get-char-property s 'invisible))))
17734 s))
17736 (defun org-copy-visible (beg end)
17737 "Copy the visible parts of the region."
17738 (interactive "r")
17739 (let (snippets s)
17740 (save-excursion
17741 (save-restriction
17742 (narrow-to-region beg end)
17743 (setq s (goto-char (point-min)))
17744 (while (not (= (point) (point-max)))
17745 (goto-char (org-find-invisible))
17746 (push (buffer-substring s (point)) snippets)
17747 (setq s (goto-char (org-find-visible))))))
17748 (kill-new (apply 'concat (nreverse snippets)))))
17750 (defun org-copy-special ()
17751 "Copy region in table or copy current subtree.
17752 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17753 See the individual commands for more information."
17754 (interactive)
17755 (call-interactively
17756 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17758 (defun org-cut-special ()
17759 "Cut region in table or cut current subtree.
17760 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17761 See the individual commands for more information."
17762 (interactive)
17763 (call-interactively
17764 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17766 (defun org-paste-special (arg)
17767 "Paste rectangular region into table, or past subtree relative to level.
17768 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17769 See the individual commands for more information."
17770 (interactive "P")
17771 (if (org-at-table-p)
17772 (org-table-paste-rectangle)
17773 (org-paste-subtree arg)))
17775 (defun org-edit-special (&optional arg)
17776 "Call a special editor for the stuff at point.
17777 When at a table, call the formula editor with `org-table-edit-formulas'.
17778 When at the first line of an src example, call `org-edit-src-code'.
17779 When in an #+include line, visit the include file. Otherwise call
17780 `ffap' to visit the file at point."
17781 (interactive)
17782 ;; possibly prep session before editing source
17783 (when arg
17784 (let* ((info (org-babel-get-src-block-info))
17785 (lang (nth 0 info))
17786 (params (nth 2 info))
17787 (session (cdr (assoc :session params))))
17788 (when (and info session) ;; we are in a source-code block with a session
17789 (funcall
17790 (intern (concat "org-babel-prep-session:" lang)) session params))))
17791 (cond ;; proceed with `org-edit-special'
17792 ((save-excursion
17793 (beginning-of-line 1)
17794 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17795 (find-file (org-trim (match-string 1))))
17796 ((org-edit-src-code))
17797 ((org-edit-fixed-width-region))
17798 ((org-at-table.el-p)
17799 (org-edit-src-code))
17800 ((or (org-at-table-p)
17801 (save-excursion
17802 (beginning-of-line 1)
17804 (call-interactively 'org-table-edit-formulas))
17805 (t (call-interactively 'ffap))))
17807 (defun org-ctrl-c-ctrl-c (&optional arg)
17808 "Set tags in headline, or update according to changed information at point.
17810 This command does many different things, depending on context:
17812 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17813 this is what we do.
17815 - If the cursor is on a statistics cookie, update it.
17817 - If the cursor is in a headline, prompt for tags and insert them
17818 into the current line, aligned to `org-tags-column'. When called
17819 with prefix arg, realign all tags in the current buffer.
17821 - If the cursor is in one of the special #+KEYWORD lines, this
17822 triggers scanning the buffer for these lines and updating the
17823 information.
17825 - If the cursor is inside a table, realign the table. This command
17826 works even if the automatic table editor has been turned off.
17828 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17829 the entire table.
17831 - If the cursor is at a footnote reference or definition, jump to
17832 the corresponding definition or references, respectively.
17834 - If the cursor is a the beginning of a dynamic block, update it.
17836 - If the current buffer is a capture buffer, close note and file it.
17838 - If the cursor is on a <<<target>>>, update radio targets and
17839 corresponding links in this buffer.
17841 - If the cursor is on a numbered item in a plain list, renumber the
17842 ordered list.
17844 - If the cursor is on a checkbox, toggle it.
17846 - If the cursor is on a code block, evaluate it. The variable
17847 `org-confirm-babel-evaluate' can be used to control prompting
17848 before code block evaluation, by default every code block
17849 evaluation requires confirmation. Code block evaluation can be
17850 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17851 (interactive "P")
17852 (let ((org-enable-table-editor t))
17853 (cond
17854 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17855 org-occur-highlights
17856 org-latex-fragment-image-overlays)
17857 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17858 (org-remove-occur-highlights)
17859 (org-remove-latex-fragment-image-overlays)
17860 (message "Temporary highlights/overlays removed from current buffer"))
17861 ((and (local-variable-p 'org-finish-function (current-buffer))
17862 (fboundp org-finish-function))
17863 (funcall org-finish-function))
17864 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17865 ((or (looking-at org-property-start-re)
17866 (org-at-property-p))
17867 (call-interactively 'org-property-action))
17868 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17870 (or (org-on-heading-p) (org-at-item-p)))
17871 (call-interactively 'org-update-statistics-cookies))
17872 ((org-on-heading-p) (call-interactively 'org-set-tags))
17873 ((org-at-table.el-p)
17874 (message "Use C-c ' to edit table.el tables"))
17875 ((org-at-table-p)
17876 (org-table-maybe-eval-formula)
17877 (if arg
17878 (call-interactively 'org-table-recalculate)
17879 (org-table-maybe-recalculate-line))
17880 (call-interactively 'org-table-align)
17881 (orgtbl-send-table 'maybe))
17882 ((or (org-footnote-at-reference-p)
17883 (org-footnote-at-definition-p))
17884 (call-interactively 'org-footnote-action))
17885 ((org-at-item-checkbox-p)
17886 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17887 ;; list only if at top item.
17888 (let* ((cbox (match-string 1))
17889 (struct (org-list-struct))
17890 (old-struct (copy-tree struct))
17891 (parents (org-list-parents-alist struct))
17892 (prevs (org-list-prevs-alist struct))
17893 (orderedp (org-entry-get nil "ORDERED"))
17894 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17895 block-item)
17896 ;; Use a light version of `org-toggle-checkbox' to avoid
17897 ;; computing list structure twice.
17898 (org-list-set-checkbox (point-at-bol) struct
17899 (cond
17900 ((equal arg '(16)) "[-]")
17901 ((equal arg '(4)) nil)
17902 ((equal "[X]" cbox) "[ ]")
17903 (t "[X]")))
17904 (org-list-struct-fix-ind struct parents)
17905 (org-list-struct-fix-bul struct prevs)
17906 (setq block-item
17907 (org-list-struct-fix-box struct parents prevs orderedp))
17908 (when block-item
17909 (message
17910 "Checkboxes were removed due to unchecked box at line %d"
17911 (org-current-line block-item)))
17912 (org-list-struct-apply-struct struct old-struct)
17913 (org-update-checkbox-count-maybe)
17914 (when firstp (org-list-send-list 'maybe))))
17915 ((org-at-item-p)
17916 ;; Cursor at an item: repair list. Do checkbox related actions
17917 ;; only if function was called with an argument. Send list only
17918 ;; if at top item.
17919 (let* ((struct (org-list-struct))
17920 (old-struct (copy-tree struct))
17921 (parents (org-list-parents-alist struct))
17922 (prevs (org-list-prevs-alist struct))
17923 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17924 (org-list-struct-fix-ind struct parents)
17925 (org-list-struct-fix-bul struct prevs)
17926 (when arg
17927 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17928 (org-list-struct-fix-box struct parents prevs))
17929 (org-list-struct-apply-struct struct old-struct)
17930 (when arg (org-update-checkbox-count-maybe))
17931 (when firstp (org-list-send-list 'maybe))))
17932 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17933 ;; Dynamic block
17934 (beginning-of-line 1)
17935 (save-excursion (org-update-dblock)))
17936 ((save-excursion
17937 (beginning-of-line 1)
17939 (cond
17940 ((equal (match-string 1) "TBLFM")
17941 ;; Recalculate the table before this line
17942 (save-excursion
17943 (beginning-of-line 1)
17945 (if (org-at-table-p)
17946 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17947 (t
17948 (let ((org-inhibit-startup-visibility-stuff t)
17949 (org-startup-align-all-tables nil))
17950 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17951 (message "Local setup has been refreshed"))))
17952 ((org-clock-update-time-maybe))
17953 (t
17954 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17955 (error "C-c C-c can do nothing useful at this location"))))))
17957 (defun org-mode-restart ()
17958 "Restart Org-mode, to scan again for special lines.
17959 Also updates the keyword regular expressions."
17960 (interactive)
17961 (org-mode)
17962 (message "Org-mode restarted"))
17964 (defun org-kill-note-or-show-branches ()
17965 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17966 (interactive)
17967 (if (not org-finish-function)
17968 (progn
17969 (hide-subtree)
17970 (call-interactively 'show-branches))
17971 (let ((org-note-abort t))
17972 (funcall org-finish-function))))
17974 (defun org-return (&optional indent)
17975 "Goto next table row or insert a newline.
17976 Calls `org-table-next-row' or `newline', depending on context.
17977 See the individual commands for more information."
17978 (interactive)
17979 (cond
17980 ((bobp) (if indent (newline-and-indent) (newline)))
17981 ((org-at-table-p)
17982 (org-table-justify-field-maybe)
17983 (call-interactively 'org-table-next-row))
17984 ;; when `newline-and-indent' is called within a list, make sure
17985 ;; text moved stays inside the item.
17986 ((and (org-in-item-p) indent)
17987 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17988 (progn
17989 (save-match-data (newline))
17990 (org-indent-line-to (length (match-string 0))))
17991 (let ((ind (org-get-indentation)))
17992 (newline)
17993 (if (org-looking-back org-list-end-re)
17994 (org-indent-line-function)
17995 (org-indent-line-to ind)))))
17996 ((and org-return-follows-link
17997 (eq (get-text-property (point) 'face) 'org-link))
17998 (call-interactively 'org-open-at-point))
17999 ((and (org-at-heading-p)
18000 (looking-at
18002 (org-show-entry)
18003 (end-of-line 1)
18004 (newline))
18005 (t (if indent (newline-and-indent) (newline)))))
18007 (defun org-return-indent ()
18008 "Goto next table row or insert a newline and indent.
18009 Calls `org-table-next-row' or `newline-and-indent', depending on
18010 context. See the individual commands for more information."
18011 (interactive)
18012 (org-return t))
18014 (defun org-ctrl-c-star ()
18015 "Compute table, or change heading status of lines.
18016 Calls `org-table-recalculate' or `org-toggle-heading',
18017 depending on context."
18018 (interactive)
18019 (cond
18020 ((org-at-table-p)
18021 (call-interactively 'org-table-recalculate))
18022 (t
18023 ;; Convert all lines in region to list items
18024 (call-interactively 'org-toggle-heading))))
18026 (defun org-ctrl-c-minus ()
18027 "Insert separator line in table or modify bullet status of line.
18028 Also turns a plain line or a region of lines into list items.
18029 Calls `org-table-insert-hline', `org-toggle-item', or
18030 `org-cycle-list-bullet', depending on context."
18031 (interactive)
18032 (cond
18033 ((org-at-table-p)
18034 (call-interactively 'org-table-insert-hline))
18035 ((org-region-active-p)
18036 (call-interactively 'org-toggle-item))
18037 ((org-in-item-p)
18038 (call-interactively 'org-cycle-list-bullet))
18039 (t
18040 (call-interactively 'org-toggle-item))))
18042 (defun org-toggle-item (arg)
18043 "Convert headings or normal lines to items, items to normal lines.
18044 If there is no active region, only the current line is considered.
18046 If the first non blank line in the region is an headline, convert
18047 all headlines to items, shifting text accordingly.
18049 If it is an item, convert all items to normal lines.
18051 If it is normal text, change region into an item. With a prefix
18052 argument ARG, change each line in region into an item."
18053 (interactive "P")
18054 (let ((shift-text
18055 (function
18056 ;; Shift text in current section to IND, from point to END.
18057 ;; The function leaves point to END line.
18058 (lambda (ind end)
18059 (let ((min-i 1000) (end (copy-marker end)))
18060 ;; First determine the minimum indentation (MIN-I) of
18061 ;; the text.
18062 (save-excursion
18063 (catch 'exit
18064 (while (< (point) end)
18065 (let ((i (org-get-indentation)))
18066 (cond
18067 ;; Skip blank lines and inline tasks.
18069 ((looking-at org-outline-regexp-bol))
18070 ;; We can't find less than 0 indentation.
18071 ((zerop i) (throw 'exit (setq min-i 0)))
18072 ((< i min-i) (setq min-i i))))
18073 (forward-line))))
18074 ;; Then indent each line so that a line indented to
18075 ;; MIN-I becomes indented to IND. Ignore blank lines
18076 ;; and inline tasks in the process.
18077 (let ((delta (- ind min-i)))
18078 (while (< (point) end)
18080 (looking-at org-outline-regexp-bol))
18081 (org-indent-line-to (+ (org-get-indentation) delta)))
18082 (forward-line)))))))
18083 (skip-blanks
18084 (function
18085 ;; Return beginning of first non-blank line, starting from
18086 ;; line at POS.
18087 (lambda (pos)
18088 (save-excursion
18089 (goto-char pos)
18091 (point-at-bol)))))
18092 beg end)
18093 ;; Determine boundaries of changes.
18094 (if (org-region-active-p)
18095 (setq beg (funcall skip-blanks (region-beginning))
18096 end (copy-marker (region-end)))
18097 (setq beg (funcall skip-blanks (point-at-bol))
18098 end (copy-marker (point-at-eol))))
18099 ;; Depending on the starting line, choose an action on the text
18100 ;; between BEG and END.
18101 (org-with-limited-levels
18102 (save-excursion
18103 (goto-char beg)
18104 (cond
18105 ;; Case 1. Start at an item: de-itemize. Note that it only
18106 ;; happens when a region is active: `org-ctrl-c-minus'
18107 ;; would call `org-cycle-list-bullet' otherwise.
18108 ((org-at-item-p)
18109 (while (< (point) end)
18110 (when (org-at-item-p)
18112 (delete-region (point) (match-end 0)))
18113 (forward-line)))
18114 ;; Case 2. Start at an heading: convert to items.
18115 ((org-on-heading-p)
18116 (let* ((bul (org-list-bullet-string "-"))
18117 (bul-len (length bul))
18118 ;; Indentation of the first heading. It should be
18119 ;; relative to the indentation of its parent, if any.
18120 (start-ind (save-excursion
18121 (cond
18122 ((not org-adapt-indentation) 0)
18123 ((not (outline-previous-heading)) 0)
18124 (t (length (match-string 0))))))
18125 ;; Level of first heading. Further headings will be
18126 ;; compared to it to determine hierarchy in the list.
18127 (ref-level (org-reduced-level (org-outline-level))))
18128 (while (< (point) end)
18129 (let* ((level (org-reduced-level (org-outline-level)))
18130 (delta (max 0 (- level ref-level))))
18131 ;; If current headline is less indented than the first
18132 ;; one, set it as reference, in order to preserve
18133 ;; subtrees.
18134 (when (< level ref-level) (setq ref-level level))
18135 (replace-match bul t t)
18136 (org-indent-line-to (+ start-ind (* delta bul-len)))
18137 ;; Ensure all text down to END (or SECTION-END) belongs
18138 ;; to the newly created item.
18139 (let ((section-end (save-excursion
18140 (or (outline-next-heading) (point)))))
18141 (forward-line)
18142 (funcall shift-text
18143 (+ start-ind (* (1+ delta) bul-len))
18144 (min end section-end)))))))
18145 ;; Case 3. Normal line with ARG: turn each non-item line into
18146 ;; an item.
18147 (arg
18148 (while (< (point) end)
18149 (unless (or (org-on-heading-p) (org-at-item-p))
18151 (replace-match
18153 (forward-line)))
18154 ;; Case 4. Normal line without ARG: make the first line of
18155 ;; region an item, and shift indentation of others
18156 ;; lines to set them as item's body.
18157 (t (let* ((bul (org-list-bullet-string "-"))
18158 (bul-len (length bul))
18159 (ref-ind (org-get-indentation)))
18161 (insert bul)
18162 (forward-line)
18163 (while (< (point) end)
18164 ;; Ensure that lines less indented than first one
18165 ;; still get included in item body.
18166 (funcall shift-text
18167 (+ ref-ind bul-len)
18168 (min end (save-excursion (or (outline-next-heading)
18169 (point)))))
18170 (forward-line)))))))))
18172 (defun org-toggle-heading (&optional nstars)
18173 "Convert headings to normal text, or items or text to headings.
18174 If there is no active region, only the current line is considered.
18176 If the first non blank line is an headline, remove the stars from
18177 all headlines in the region.
18179 If it is a plain list item, turn all plain list items into headings.
18181 If it is a normal line, turn each and every normal line (i.e. not
18182 an heading or an item) in the region into a heading.
18184 When converting a line into a heading, the number of stars is chosen
18185 such that the lines become children of the current entry. However,
18186 when a prefix argument is given, its value determines the number of
18187 stars to add."
18188 (interactive "P")
18189 (let ((skip-blanks
18190 (function
18191 ;; Return beginning of first non-blank line, starting from
18192 ;; line at POS.
18193 (lambda (pos)
18194 (save-excursion
18195 (goto-char pos)
18197 (point-at-bol)))))
18198 beg end)
18199 ;; Determine boundaries of changes. If region ends at a bol, do
18200 ;; not consider the last line to be in the region.
18201 (if (org-region-active-p)
18202 (setq beg (funcall skip-blanks (region-beginning))
18203 end (copy-marker (save-excursion
18204 (goto-char (region-end))
18205 (if (bolp) (point) (point-at-eol)))))
18206 (setq beg (funcall skip-blanks (point-at-bol))
18207 end (copy-marker (point-at-eol))))
18208 ;; Ensure inline tasks don't count as headings.
18209 (org-with-limited-levels
18210 (save-excursion
18211 (goto-char beg)
18212 (cond
18213 ;; Case 1. Started at an heading: de-star headings.
18214 ((org-on-heading-p)
18215 (while (< (point) end)
18216 (when (org-on-heading-p t)
18217 (looking-at org-outline-regexp) (replace-match ""))
18218 (forward-line)))
18219 ;; Case 2. Started at an item: change items into headlines.
18220 ;; One star will be added by `org-list-to-subtree'.
18221 ((org-at-item-p)
18222 (let* ((stars (make-string
18223 (if nstars
18224 ;; subtract the star that will be added again by
18225 ;; `org-list-to-subtree'
18226 (1- (prefix-numeric-value current-prefix-arg))
18227 (or (org-current-level) 0))
18228 ?*))
18229 (add-stars
18230 (cond (nstars "") ; stars from prefix only
18231 ((equal stars "") "") ; before first heading
18232 (org-odd-levels-only "*") ; inside heading, odd
18233 (t "")))) ; inside heading, oddeven
18234 (while (< (point) end)
18235 (when (org-at-item-p)
18236 ;; Pay attention to cases when region ends before list.
18237 (let* ((struct (org-list-struct))
18238 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18239 (save-restriction
18240 (narrow-to-region (point) list-end)
18241 (insert
18242 (org-list-to-subtree
18243 (org-list-parse-list t)
18244 '(:istart (concat stars add-stars (funcall get-stars depth))
18245 :icount (concat stars add-stars (funcall get-stars depth))))))))
18246 (forward-line))))
18247 ;; Case 3. Started at normal text: make every line an heading,
18248 ;; skipping headlines and items.
18249 (t (let* ((stars (make-string
18250 (if nstars
18251 (prefix-numeric-value current-prefix-arg)
18252 (or (org-current-level) 0))
18253 ?*))
18254 (add-stars
18255 (cond (nstars "") ; stars from prefix only
18256 ((equal stars "") "*") ; before first heading
18257 (org-odd-levels-only "**") ; inside heading, odd
18258 (t "*"))) ; inside heading, oddeven
18259 (rpl (concat stars add-stars " ")))
18260 (while (< (point) end)
18261 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18263 (replace-match (concat rpl (match-string 2))))
18264 (forward-line)))))))))
18266 (defun org-meta-return (&optional arg)
18267 "Insert a new heading or wrap a region in a table.
18268 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18269 See the individual commands for more information."
18270 (interactive "P")
18271 (cond
18272 ((run-hook-with-args-until-success 'org-metareturn-hook))
18273 ((org-at-table-p)
18274 (call-interactively 'org-table-wrap-region))
18275 (t (call-interactively 'org-insert-heading))))
18277 ;;; Menu entries
18279 ;; Define the Org-mode menus
18280 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18281 '("Tbl"
18282 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18283 ["Next Field" org-cycle (org-at-table-p)]
18284 ["Previous Field" org-shifttab (org-at-table-p)]
18285 ["Next Row" org-return (org-at-table-p)]
18286 "--"
18287 ["Blank Field" org-table-blank-field (org-at-table-p)]
18288 ["Edit Field" org-table-edit-field (org-at-table-p)]
18289 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18290 "--"
18291 ("Column"
18292 ["Move Column Left" org-metaleft (org-at-table-p)]
18293 ["Move Column Right" org-metaright (org-at-table-p)]
18294 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18295 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18296 ("Row"
18297 ["Move Row Up" org-metaup (org-at-table-p)]
18298 ["Move Row Down" org-metadown (org-at-table-p)]
18299 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18300 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18301 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18302 "--"
18303 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18304 ("Rectangle"
18305 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18306 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18307 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18308 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18309 "--"
18310 ("Calculate"
18311 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18312 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18313 ["Edit Formulas" org-edit-special (org-at-table-p)]
18314 "--"
18315 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18316 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18317 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18318 "--"
18319 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18320 "--"
18321 ["Sum Column/Rectangle" org-table-sum
18322 (or (org-at-table-p) (org-region-active-p))]
18323 ["Which Column?" org-table-current-column (org-at-table-p)])
18324 ["Debug Formulas"
18325 org-table-toggle-formula-debugger
18326 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18327 ["Show Col/Row Numbers"
18328 org-table-toggle-coordinate-overlays
18329 :style toggle
18330 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18331 "--"
18332 ["Create" org-table-create (and (not (org-at-table-p))
18333 org-enable-table-editor)]
18334 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18335 ["Import from File" org-table-import (not (org-at-table-p))]
18336 ["Export to File" org-table-export (org-at-table-p)]
18337 "--"
18338 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18340 (easy-menu-define org-org-menu org-mode-map "Org menu"
18341 '("Org"
18342 ("Show/Hide"
18343 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18344 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18345 ["Sparse Tree..." org-sparse-tree t]
18346 ["Reveal Context" org-reveal t]
18347 ["Show All" show-all t]
18348 "--"
18349 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18350 "--"
18351 ["New Heading" org-insert-heading t]
18352 ("Navigate Headings"
18353 ["Up" outline-up-heading t]
18354 ["Next" outline-next-visible-heading t]
18355 ["Previous" outline-previous-visible-heading t]
18356 ["Next Same Level" outline-forward-same-level t]
18357 ["Previous Same Level" outline-backward-same-level t]
18358 "--"
18359 ["Jump" org-goto t])
18360 ("Edit Structure"
18361 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18362 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18363 "--"
18364 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18365 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18366 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18367 "--"
18368 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18369 "--"
18370 ["Copy visible text" org-copy-visible t]
18371 "--"
18372 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18373 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18374 ["Demote Heading" org-metaright (not (org-at-table-p))]
18375 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18376 "--"
18377 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18378 "--"
18379 ["Convert to odd levels" org-convert-to-odd-levels t]
18380 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18381 ("Editing"
18382 ["Emphasis..." org-emphasize t]
18383 ["Edit Source Example" org-edit-special t]
18384 "--"
18385 ["Footnote new/jump" org-footnote-action t]
18386 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18387 ("Archive"
18388 ["Archive (default method)" org-archive-subtree-default t]
18389 "--"
18390 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18391 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18392 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18393 )
18394 "--"
18395 ("Hyperlinks"
18396 ["Store Link (Global)" org-store-link t]
18397 ["Find existing link to here" org-occur-link-in-agenda-files t]
18398 ["Insert Link" org-insert-link t]
18399 ["Follow Link" org-open-at-point t]
18400 "--"
18401 ["Next link" org-next-link t]
18402 ["Previous link" org-previous-link t]
18403 "--"
18404 ["Descriptive Links"
18405 org-toggle-link-display
18406 :style radio
18407 :selected org-link-display-descriptive
18408 ]
18409 ["Literal Links"
18410 org-toggle-link-display
18411 :style radio
18412 :selected (not org-link-display-descriptive)])
18413 "--"
18414 ("TODO Lists"
18415 ["TODO/DONE/-" org-todo t]
18416 ("Select keyword"
18417 ["Next keyword" org-shiftright (org-on-heading-p)]
18418 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18419 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18420 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18421 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18422 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18423 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18424 "--"
18425 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18426 :selected org-enforce-todo-dependencies :style toggle :active t]
18427 "Settings for tree at point"
18428 ["Do Children sequentially" org-toggle-ordered-property :style radio
18429 :selected (org-entry-get nil "ORDERED")
18430 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18431 ["Do Children parallel" org-toggle-ordered-property :style radio
18432 :selected (not (org-entry-get nil "ORDERED"))
18433 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18434 "--"
18435 ["Set Priority" org-priority t]
18436 ["Priority Up" org-shiftup t]
18437 ["Priority Down" org-shiftdown t]
18438 "--"
18439 ["Get news from all feeds" org-feed-update-all t]
18440 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18441 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18442 ("TAGS and Properties"
18443 ["Set Tags" org-set-tags-command t]
18444 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18445 "--"
18446 ["Set property" org-set-property t]
18447 ["Column view of properties" org-columns t]
18448 ["Insert Column View DBlock" org-insert-columns-dblock t])
18449 ("Dates and Scheduling"
18450 ["Timestamp" org-time-stamp t]
18451 ["Timestamp (inactive)" org-time-stamp-inactive t]
18452 ("Change Date"
18453 ["1 Day Later" org-shiftright t]
18454 ["1 Day Earlier" org-shiftleft t]
18455 ["1 ... Later" org-shiftup t]
18456 ["1 ... Earlier" org-shiftdown t])
18457 ["Compute Time Range" org-evaluate-time-range t]
18458 ["Schedule Item" org-schedule t]
18459 ["Deadline" org-deadline t]
18460 "--"
18461 ["Custom time format" org-toggle-time-stamp-overlays
18462 :style radio :selected org-display-custom-times]
18463 "--"
18464 ["Goto Calendar" org-goto-calendar t]
18465 ["Date from Calendar" org-date-from-calendar t]
18466 "--"
18467 ["Start/Restart Timer" org-timer-start t]
18468 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18469 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18470 ["Insert Timer String" org-timer t]
18471 ["Insert Timer Item" org-timer-item t])
18472 ("Logging work"
18473 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18474 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18475 ["Clock out" org-clock-out t]
18476 ["Clock cancel" org-clock-cancel t]
18477 "--"
18478 ["Mark as default task" org-clock-mark-default-task t]
18479 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18480 ["Goto running clock" org-clock-goto t]
18481 "--"
18482 ["Display times" org-clock-display t]
18483 ["Create clock table" org-clock-report t]
18484 "--"
18485 ["Record DONE time"
18486 (progn (setq org-log-done (not org-log-done))
18487 (message "Switching to %s will %s record a timestamp"
18488 (car org-done-keywords)
18489 (if org-log-done "automatically" "not")))
18490 :style toggle :selected org-log-done])
18491 "--"
18492 ["Agenda Command..." org-agenda t]
18493 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18494 ("File List for Agenda")
18495 ("Special views current file"
18496 ["TODO Tree" org-show-todo-tree t]
18497 ["Check Deadlines" org-check-deadlines t]
18498 ["Timeline" org-timeline t]
18499 ["Tags/Property tree" org-match-sparse-tree t])
18500 "--"
18501 ["Export/Publish..." org-export t]
18502 ("LaTeX"
18503 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18504 :selected org-cdlatex-mode]
18505 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18506 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18507 ["Modify math symbol" org-cdlatex-math-modify
18508 (org-inside-LaTeX-fragment-p)]
18509 ["Insert citation" org-reftex-citation t]
18510 "--"
18511 ["Template for BEAMER" org-insert-beamer-options-template t])
18512 "--"
18513 ("MobileOrg"
18514 ["Push Files and Views" org-mobile-push t]
18515 ["Get Captured and Flagged" org-mobile-pull t]
18516 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18517 "--"
18518 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18519 "--"
18520 ("Documentation"
18521 ["Show Version" org-version t]
18522 ["Info Documentation" org-info t])
18523 ("Customize"
18524 ["Browse Org Group" org-customize t]
18525 "--"
18526 ["Expand This Menu" org-create-customize-menu
18527 (fboundp 'customize-menu-create)])
18528 ["Send bug report" org-submit-bug-report t]
18529 "--"
18530 ("Refresh/Reload"
18531 ["Refresh setup current buffer" org-mode-restart t]
18532 ["Reload Org (after update)" org-reload t]
18533 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18534 ))
18536 (defun org-info (&optional node)
18537 "Read documentation for Org-mode in the info system.
18538 With optional NODE, go directly to that node."
18539 (interactive)
18540 (info (format "(org)%s" (or node ""))))
18542 ;;;###autoload
18543 (defun org-submit-bug-report ()
18544 "Submit a bug report on Org-mode via mail.
18546 Don't hesitate to report any problems or inaccurate documentation.
18548 If you don't have setup sending mail from (X)Emacs, please copy the
18549 output buffer into your mail program, as it gives us important
18550 information about your Org-mode version and configuration."
18551 (interactive)
18552 (require 'reporter)
18553 (org-load-modules-maybe)
18554 (org-require-autoloaded-modules)
18555 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18556 (reporter-submit-bug-report
18557 "emacs-orgmode@gnu.org"
18558 (org-version)
18559 (let (list)
18560 (save-window-excursion
18561 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18562 (delete-other-windows)
18563 (erase-buffer)
18564 (insert "You are about to submit a bug report to the Org-mode mailing list.
18566 We would like to add your full Org-mode and Outline configuration to the
18567 bug report. This greatly simplifies the work of the maintainer and
18568 other experts on the mailing list.
18570 HOWEVER, some variables you have customized may contain private
18571 information. The names of customers, colleagues, or friends, might
18572 appear in the form of file names, tags, todo states, or search strings.
18573 If you answer yes to the prompt, you might want to check and remove
18574 such private information before sending the email.")
18575 (add-text-properties (point-min) (point-max) '(face org-warning))
18576 (when (yes-or-no-p "Include your Org-mode configuration ")
18577 (mapatoms
18578 (lambda (v)
18579 (and (boundp v)
18581 (or (and (symbol-value v)
18583 (and
18584 (get v 'custom-type) (get v 'standard-value)
18585 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18586 (push v list)))))
18587 (kill-buffer (get-buffer "*Warn about privacy*"))
18588 list))
18589 nil nil
18590 "Remember to cover the basics, that is, what you expected to happen and
18591 what in fact did happen. You don't know how to make a good report? See
18593 http://orgmode.org/manual/Feedback.html#Feedback
18595 Your bug report will be posted to the Org-mode mailing list.
18596 ------------------------------------------------------------------------")
18597 (save-excursion
18602 (defun org-install-agenda-files-menu ()
18603 (let ((bl (buffer-list)))
18604 (save-excursion
18605 (while bl
18606 (set-buffer (pop bl))
18607 (if (org-mode-p) (setq bl nil)))
18608 (when (org-mode-p)
18609 (easy-menu-change
18610 '("Org") "File List for Agenda"
18611 (append
18612 (list
18613 ["Edit File List" (org-edit-agenda-file-list) t]
18614 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18615 ["Remove Current File from List" org-remove-file t]
18616 ["Cycle through agenda files" org-cycle-agenda-files t]
18617 ["Occur in all agenda files" org-occur-in-agenda-files t]
18618 "--")
18619 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18621 ;;;; Documentation
18623 ;;;###autoload
18624 (defun org-require-autoloaded-modules ()
18625 (interactive)
18626 (mapc 'require
18627 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18628 org-docbook org-exp org-html org-icalendar
18629 org-id org-latex
18630 org-publish org-remember org-table
18631 org-timer org-xoxo)))
18633 ;;;###autoload
18634 (defun org-reload (&optional uncompiled)
18635 "Reload all org lisp files.
18636 With prefix arg UNCOMPILED, load the uncompiled versions."
18637 (interactive "P")
18638 (require 'find-func)
18640 (dir-org (file-name-directory (org-find-library-name "org")))
18641 (dir-org-contrib (ignore-errors
18642 (file-name-directory
18643 (org-find-library-name "org-contribdir"))))
18644 (babel-files
18645 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18646 (append (list nil "comint" "eval" "exp" "keys"
18647 "lob" "ref" "table" "tangle")
18648 (delq nil
18649 (mapcar
18650 (lambda (lang)
18651 (when (cdr lang) (symbol-name (car lang))))
18652 org-babel-load-languages)))))
18653 (files
18654 (append (directory-files dir-org t file-re)
18655 babel-files
18656 (and dir-org-contrib
18657 (directory-files dir-org-contrib t file-re))))
18658 (remove-re (concat (if (featurep 'xemacs)
18659 "org-colview" "org-colview-xemacs")
18661 (setq files (mapcar 'file-name-sans-extension files))
18662 (setq files (mapcar
18663 (lambda (x) (if (string-match remove-re x) nil x))
18664 files))
18665 (setq files (delq nil files))
18666 (mapc
18667 (lambda (f)
18668 (when (featurep (intern (file-name-nondirectory f)))
18669 (if (and (not uncompiled)
18670 (file-exists-p (concat f ".elc")))
18671 (load (concat f ".elc") nil nil t)
18672 (load (concat f ".el") nil nil t))))
18673 files))
18674 (org-version))
18676 ;;;###autoload
18677 (defun org-customize ()
18678 "Call the customize function with org as argument."
18679 (interactive)
18680 (org-load-modules-maybe)
18681 (org-require-autoloaded-modules)
18682 (customize-browse 'org))
18684 (defun org-create-customize-menu ()
18685 "Create a full customization menu for Org-mode, insert it into the menu."
18686 (interactive)
18687 (org-load-modules-maybe)
18688 (org-require-autoloaded-modules)
18689 (if (fboundp 'customize-menu-create)
18690 (progn
18691 (easy-menu-change
18692 '("Org") "Customize"
18693 `(["Browse Org group" org-customize t]
18694 "--"
18695 ,(customize-menu-create 'org)
18696 ["Set" Custom-set t]
18697 ["Save" Custom-save t]
18698 ["Reset to Current" Custom-reset-current t]
18699 ["Reset to Saved" Custom-reset-saved t]
18700 ["Reset to Standard Settings" Custom-reset-standard t]))
18702 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18704 ;;;; Miscellaneous stuff
18706 ;;; Generally useful functions
18708 (defun org-get-at-bol (property)
18709 "Get text property PROPERTY at beginning of line."
18710 (get-text-property (point-at-bol) property))
18712 (defun org-find-text-property-in-string (prop s)
18713 "Return the first non-nil value of property PROP in string S."
18714 (or (get-text-property 0 prop s)
18715 (get-text-property (or (next-single-property-change 0 prop s) 0)
18716 prop s)))
18718 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18719 "Display the given MESSAGE as a warning."
18720 (if (fboundp 'display-warning)
18721 (display-warning 'org message
18722 (if (featurep 'xemacs) 'warning :warning))
18723 (let ((buf (get-buffer-create "*Org warnings*")))
18724 (with-current-buffer buf
18725 (goto-char (point-max))
18726 (insert "Warning (Org): " message)
18727 (unless (bolp)
18728 (newline)))
18729 (display-buffer buf)
18730 (sit-for 0))))
18732 (defun org-eval (form)
18733 "Eval FORM and return result."
18734 (condition-case error
18735 (eval form)
18736 (error (format "%%![Error: %s]" error))))
18738 (defun org-in-commented-line ()
18739 "Is point in a line starting with `#'?"
18740 (equal (char-after (point-at-bol)) ?#))
18742 (defun org-in-indented-comment-line ()
18743 "Is point in a line starting with `#' after some white space?"
18744 (save-excursion
18745 (save-match-data
18746 (goto-char (point-at-bol))
18749 (defun org-in-verbatim-emphasis ()
18750 (save-match-data
18751 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18753 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18754 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18755 (if (and marker (marker-buffer marker)
18756 (buffer-live-p (marker-buffer marker)))
18757 (progn
18758 (org-pop-to-buffer-same-window (marker-buffer marker))
18759 (if (or (> marker (point-max)) (< marker (point-min)))
18760 (widen))
18761 (goto-char marker)
18762 (org-show-context 'org-goto))
18763 (if bookmark
18764 (bookmark-jump bookmark)
18765 (error "Cannot find location"))))
18767 (defun org-quote-csv-field (s)
18768 "Quote field for inclusion in CSV material."
18771 s))
18773 (defun org-force-self-insert (N)
18774 "Needed to enforce self-insert under remapping."
18775 (interactive "p")
18776 (self-insert-command N))
18778 (defun org-string-width (s)
18779 "Compute width of string, ignoring invisible characters.
18780 This ignores character with invisibility property `org-link', and also
18781 characters with property `org-cwidth', because these will become invisible
18782 upon the next fontification round."
18783 (let (b l)
18784 (when (or (eq t buffer-invisibility-spec)
18785 (assq 'org-link buffer-invisibility-spec))
18786 (while (setq b (text-property-any 0 (length s)
18787 'invisible 'org-link s))
18788 (setq s (concat (substring s 0 b)
18789 (substring s (or (next-single-property-change
18790 b 'invisible s) (length s)))))))
18791 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18792 (setq s (concat (substring s 0 b)
18793 (substring s (or (next-single-property-change
18794 b 'org-cwidth s) (length s))))))
18795 (setq l (string-width s) b -1)
18796 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18797 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18798 l))
18800 (defun org-shorten-string (s maxlength)
18801 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18802 If the string is shorter or has length MAXLENGTH, just return the
18803 original string. If it is longer, the functions finds a space in the
18804 string, breaks this string off at that locations and adds three dots
18805 as ellipsis. Including the ellipsis, the string will not be longer
18806 than MAXLENGTH. If finding a good breaking point in the string does
18807 not work, the string is just chopped off in the middle of a word
18808 if necessary."
18809 (if (<= (length s) maxlength)
18810 s
18811 (let* ((n (max (- maxlength 4) 1))
18813 (if (string-match re s)
18814 (concat (match-string 1 s) "...")
18815 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18817 (defun org-get-indentation (&optional line)
18818 "Get the indentation of the current line, interpreting tabs.
18819 When LINE is given, assume it represents a line and compute its indentation."
18820 (if line
18821 (if (string-match "^ *" (org-remove-tabs line))
18822 (match-end 0))
18823 (save-excursion
18824 (beginning-of-line 1)
18826 (current-column))))
18828 (defun org-get-string-indentation (s)
18829 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18830 (let ((n -1) (i 0) (w tab-width) c)
18831 (catch 'exit
18832 (while (< (setq n (1+ n)) (length s))
18833 (setq c (aref s n))
18834 (cond ((= c ?\ ) (setq i (1+ i)))
18836 (t (throw 'exit t)))))
18837 i))
18839 (defun org-remove-tabs (s &optional width)
18840 "Replace tabulators in S with spaces.
18841 Assumes that s is a single line, starting in column 0."
18842 (setq width (or width tab-width))
18844 (setq s (replace-match
18845 (make-string
18846 (- (* width (/ (+ (match-beginning 0) width) width))
18847 (match-beginning 0)) ?\ )
18848 t t s)))
18849 s)
18851 (defun org-fix-indentation (line ind)
18852 "Fix indentation in LINE.
18853 IND is a cons cell with target and minimum indentation.
18854 If the current indentation in LINE is smaller than the minimum,
18855 leave it alone. If it is larger than ind, set it to the target."
18856 (let* ((l (org-remove-tabs line))
18857 (i (org-get-indentation l))
18858 (i1 (car ind)) (i2 (cdr ind)))
18859 (if (>= i i2) (setq l (substring line i2)))
18860 (if (> i1 0)
18861 (concat (make-string i1 ?\ ) l)
18862 l)))
18864 (defun org-remove-indentation (code &optional n)
18865 "Remove the maximum common indentation from the lines in CODE.
18866 N may optionally be the number of spaces to remove."
18867 (with-temp-buffer
18868 (insert code)
18869 (org-do-remove-indentation n)
18870 (buffer-string)))
18872 (defun org-do-remove-indentation (&optional n)
18873 "Remove the maximum common indentation from the buffer."
18874 (untabify (point-min) (point-max))
18875 (let ((min 10000) re)
18876 (if n
18877 (setq min n)
18878 (goto-char (point-min))
18880 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18881 (unless (or (= min 0) (= min 10000))
18883 (goto-char (point-min))
18884 (while (re-search-forward re nil t)
18885 (replace-match "")
18886 (end-of-line 1))
18887 min)))
18889 (defun org-fill-template (template alist)
18890 "Find each %key of ALIST in TEMPLATE and replace it."
18891 (let ((case-fold-search nil)
18892 entry key value)
18893 (setq alist (sort (copy-sequence alist)
18894 (lambda (a b) (< (length (car a)) (length (car b))))))
18895 (while (setq entry (pop alist))
18896 (setq template
18897 (replace-regexp-in-string
18898 (concat "%" (regexp-quote (car entry)))
18899 (cdr entry) template t t)))
18900 template))
18902 (defun org-base-buffer (buffer)
18903 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18904 (if (not buffer)
18905 buffer
18906 (or (buffer-base-buffer buffer)
18907 buffer)))
18909 (defun org-trim (s)
18910 "Remove whitespace at beginning and end of string."
18913 s)
18915 (defun org-wrap (string &optional width lines)
18916 "Wrap string to either a number of lines, or a width in characters.
18917 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18918 that costs. If there is a word longer than WIDTH, the text is actually
18919 wrapped to the length of that word.
18920 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18921 many lines, whatever width that takes.
18922 The return value is a list of lines, without newlines at the end."
18924 (maxword (apply 'max (mapcar 'org-string-width words)))
18925 w ll)
18926 (cond (width
18927 (org-do-wrap words (max maxword width)))
18928 (lines
18929 (setq w maxword)
18930 (setq ll (org-do-wrap words maxword))
18931 (if (<= (length ll) lines)
18932 ll
18933 (setq ll words)
18934 (while (> (length ll) lines)
18935 (setq w (1+ w))
18936 (setq ll (org-do-wrap words w)))
18937 ll))
18938 (t (error "Cannot wrap this")))))
18940 (defun org-do-wrap (words width)
18941 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18942 (let (lines line)
18943 (while words
18944 (setq line (pop words))
18945 (while (and words (< (+ (length line) (length (car words))) width))
18946 (setq line (concat line " " (pop words))))
18947 (setq lines (push line lines)))
18948 (nreverse lines)))
18950 (defun org-split-string (string &optional separators)
18951 "Splits STRING into substrings at SEPARATORS.
18952 No empty strings are returned if there are matches at the beginning
18953 and end of string."
18955 (start 0)
18956 notfirst
18957 (list nil))
18958 (while (and (string-match rexp string
18959 (if (and notfirst
18960 (= start (match-beginning 0))
18961 (< start (length string)))
18962 (1+ start) start))
18963 (< (match-beginning 0) (length string)))
18964 (setq notfirst t)
18965 (or (eq (match-beginning 0) 0)
18966 (and (eq (match-beginning 0) (match-end 0))
18967 (eq (match-beginning 0) start))
18968 (setq list
18969 (cons (substring string start (match-beginning 0))
18970 list)))
18971 (setq start (match-end 0)))
18972 (or (eq start (length string))
18973 (setq list
18974 (cons (substring string start)
18975 list)))
18976 (nreverse list)))
18978 (defun org-quote-vert (s)
18980 (while (string-match "|" s)
18982 s)
18984 (defun org-uuidgen-p (s)
18985 "Is S an ID created by UUIDGEN?"
18986 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18988 (defun org-context ()
18989 "Return a list of contexts of the current cursor position.
18990 If several contexts apply, all are returned.
18991 Each context entry is a list with a symbol naming the context, and
18992 two positions indicating start and end of the context. Possible
18993 contexts are:
18995 :headline anywhere in a headline
18996 :headline-stars on the leading stars in a headline
18997 :todo-keyword on a TODO keyword (including DONE) in a headline
18998 :tags on the TAGS in a headline
18999 :priority on the priority cookie in a headline
19000 :item on the first line of a plain list item
19001 :item-bullet on the bullet/number of a plain list item
19002 :checkbox on the checkbox in a plain list item
19003 :table in an org-mode table
19004 :table-special on a special filed in a table
19005 :table-table in a table.el table
19006 :link on a hyperlink
19007 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19008 :target on a <<target>>
19009 :radio-target on a <<<radio-target>>>
19010 :latex-fragment on a LaTeX fragment
19011 :latex-preview on a LaTeX fragment with overlayed preview image
19013 This function expects the position to be visible because it uses font-lock
19014 faces as a help to recognize the following contexts: :table-special, :link,
19015 and :keyword."
19016 (let* ((f (get-text-property (point) 'face))
19017 (faces (if (listp f) f (list f)))
19018 (p (point)) clist o)
19019 ;; First the large context
19020 (cond
19021 ((org-on-heading-p t)
19022 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19023 (when (progn
19024 (beginning-of-line 1)
19025 (looking-at org-todo-line-tags-regexp))
19026 (push (org-point-in-group p 1 :headline-stars) clist)
19027 (push (org-point-in-group p 2 :todo-keyword) clist)
19028 (push (org-point-in-group p 4 :tags) clist))
19029 (goto-char p)
19032 (push (org-point-in-group p 0 :priority) clist)))
19034 ((org-at-item-p)
19035 (push (org-point-in-group p 2 :item-bullet) clist)
19036 (push (list :item (point-at-bol)
19037 (save-excursion (org-end-of-item) (point)))
19038 clist)
19039 (and (org-at-item-checkbox-p)
19040 (push (org-point-in-group p 0 :checkbox) clist)))
19042 ((org-at-table-p)
19043 (push (list :table (org-table-begin) (org-table-end)) clist)
19044 (if (memq 'org-formula faces)
19045 (push (list :table-special
19046 (previous-single-property-change p 'face)
19047 (next-single-property-change p 'face)) clist)))
19048 ((org-at-table-p 'any)
19049 (push (list :table-table) clist)))
19050 (goto-char p)
19052 ;; Now the small context
19053 (cond
19054 ((org-at-timestamp-p)
19055 (push (org-point-in-group p 0 :timestamp) clist))
19056 ((memq 'org-link faces)
19057 (push (list :link
19058 (previous-single-property-change p 'face)
19059 (next-single-property-change p 'face)) clist))
19060 ((memq 'org-special-keyword faces)
19061 (push (list :keyword
19062 (previous-single-property-change p 'face)
19063 (next-single-property-change p 'face)) clist))
19064 ((org-on-target-p)
19065 (push (org-point-in-group p 0 :target) clist)
19066 (goto-char (1- (match-beginning 0)))
19067 (if (looking-at org-radio-target-regexp)
19068 (push (org-point-in-group p 0 :radio-target) clist))
19069 (goto-char p))
19070 ((setq o (car (delq nil
19071 (mapcar
19072 (lambda (x)
19073 (if (memq x org-latex-fragment-image-overlays) x))
19074 (overlays-at (point))))))
19075 (push (list :latex-fragment
19076 (overlay-start o) (overlay-end o)) clist)
19077 (push (list :latex-preview
19078 (overlay-start o) (overlay-end o)) clist))
19079 ((org-inside-LaTeX-fragment-p)
19080 ;; FIXME: positions wrong.
19081 (push (list :latex-fragment (point) (point)) clist)))
19083 (setq clist (nreverse (delq nil clist)))
19084 clist))
19086 ;; FIXME: Compare with at-regexp-p Do we need both?
19087 (defun org-in-regexp (re &optional nlines visually)
19088 "Check if point is inside a match of regexp.
19089 Normally only the current line is checked, but you can include NLINES extra
19090 lines both before and after point into the search.
19091 If VISUALLY is set, require that the cursor is not after the match but
19092 really on, so that the block visually is on the match."
19093 (catch 'exit
19094 (let ((pos (point))
19095 (eol (point-at-eol (+ 1 (or nlines 0))))
19096 (inc (if visually 1 0)))
19097 (save-excursion
19098 (beginning-of-line (- 1 (or nlines 0)))
19099 (while (re-search-forward re eol t)
19100 (if (and (<= (match-beginning 0) pos)
19101 (>= (+ inc (match-end 0)) pos))
19102 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19104 (defun org-at-regexp-p (regexp)
19105 "Is point inside a match of REGEXP in the current line?"
19106 (catch 'exit
19107 (save-excursion
19108 (let ((pos (point)) (end (point-at-eol)))
19109 (beginning-of-line 1)
19110 (while (re-search-forward regexp end t)
19111 (if (and (<= (match-beginning 0) pos)
19112 (>= (match-end 0) pos))
19113 (throw 'exit t)))
19114 nil))))
19116 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19117 "Non-nil when point is between matches of START-RE and END-RE.
19119 Also return a non-nil value when point is on one of the matches.
19121 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19122 buffer positions. Default values are the positions of headlines
19123 surrounding the point.
19125 The functions returns a cons cell whose car (resp. cdr) is the
19126 position before START-RE (resp. after END-RE)."
19127 (save-match-data
19128 (let ((pos (point))
19129 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19130 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19131 beg end)
19132 (save-excursion
19133 ;; Point is on a block when on START-RE or if START-RE can be
19134 ;; found before it...
19135 (and (or (org-at-regexp-p start-re)
19136 (re-search-backward start-re limit-up t))
19137 (setq beg (match-beginning 0))
19138 ;; ... and END-RE after it...
19139 (goto-char (match-end 0))
19140 (re-search-forward end-re limit-down t)
19141 (> (setq end (match-end 0)) pos)
19142 ;; ... without another START-RE in-between.
19143 (goto-char (match-beginning 0))
19144 (not (re-search-backward start-re (1+ beg) t))
19145 ;; Return value.
19146 (cons beg end))))))
19148 (defun org-in-block-p (names)
19149 "Is point inside any block whose name belongs to NAMES?
19151 NAMES is a list of strings containing names of blocks."
19152 (save-match-data
19153 (catch 'exit
19154 (let ((case-fold-search t)
19155 (lim-up (save-excursion (outline-previous-heading)))
19156 (lim-down (save-excursion (outline-next-heading))))
19157 (mapc (lambda (name)
19158 (let ((n (regexp-quote name)))
19159 (when (org-between-regexps-p
19162 lim-up lim-down)
19163 (throw 'exit t))))
19164 names))
19165 nil)))
19167 (defun org-occur-in-agenda-files (regexp &optional nlines)
19168 "Call `multi-occur' with buffers for all agenda files."
19170 (let* ((files (org-agenda-files))
19171 (tnames (mapcar 'file-truename files))
19172 (extra org-agenda-text-search-extra-files)
19173 f)
19174 (when (eq (car extra) 'agenda-archives)
19175 (setq extra (cdr extra))
19176 (setq files (org-add-archive-files files)))
19177 (while (setq f (pop extra))
19178 (unless (member (file-truename f) tnames)
19179 (add-to-list 'files f 'append)
19180 (add-to-list 'tnames (file-truename f) 'append)))
19181 (multi-occur
19182 (mapcar (lambda (x)
19183 (with-current-buffer
19184 (or (get-file-buffer x) (find-file-noselect x))
19185 (widen)
19186 (current-buffer)))
19187 files)
19188 regexp)))
19190 (if (boundp 'occur-mode-find-occurrence-hook)
19191 ;; Emacs 23
19192 (add-hook 'occur-mode-find-occurrence-hook
19193 (lambda ()
19194 (when (org-mode-p)
19195 (org-reveal))))
19196 ;; Emacs 22
19197 (defadvice occur-mode-goto-occurrence
19198 (after org-occur-reveal activate)
19199 (and (org-mode-p) (org-reveal)))
19200 (defadvice occur-mode-goto-occurrence-other-window
19201 (after org-occur-reveal activate)
19202 (and (org-mode-p) (org-reveal)))
19203 (defadvice occur-mode-display-occurrence
19204 (after org-occur-reveal activate)
19205 (when (org-mode-p)
19206 (let ((pos (occur-mode-find-occurrence)))
19207 (with-current-buffer (marker-buffer pos)
19208 (save-excursion
19209 (goto-char pos)
19210 (org-reveal)))))))
19212 (defun org-occur-link-in-agenda-files ()
19213 "Create a link and search for it in the agendas.
19214 The link is not stored in `org-stored-links', it is just created
19215 for the search purpose."
19216 (interactive)
19217 (let ((link (condition-case nil
19218 (org-store-link nil)
19219 (error "Unable to create a link to here"))))
19220 (org-occur-in-agenda-files (regexp-quote link))))
19222 (defun org-uniquify (list)
19223 "Remove duplicate elements from LIST."
19224 (let (res)
19225 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19226 res))
19228 (defun org-delete-all (elts list)
19229 "Remove all elements in ELTS from LIST."
19230 (while elts
19231 (setq list (delete (pop elts) list)))
19232 list)
19234 (defun org-count (cl-item cl-seq)
19235 "Count the number of occurrences of ITEM in SEQ.
19236 Taken from `count' in cl-seq.el with all keyword arguments removed."
19237 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19238 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19239 (while (< cl-start cl-end)
19240 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19241 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19242 (setq cl-start (1+ cl-start)))
19243 cl-count))
19245 (defun org-remove-if (predicate seq)
19246 "Remove everything from SEQ that fulfills PREDICATE."
19247 (let (res e)
19248 (while seq
19249 (setq e (pop seq))
19250 (if (not (funcall predicate e)) (push e res)))
19251 (nreverse res)))
19253 (defun org-remove-if-not (predicate seq)
19254 "Remove everything from SEQ that does not fulfill PREDICATE."
19255 (let (res e)
19256 (while seq
19257 (setq e (pop seq))
19258 (if (funcall predicate e) (push e res)))
19259 (nreverse res)))
19261 (defun org-back-over-empty-lines ()
19262 "Move backwards over whitespace, to the beginning of the first empty line.
19263 Returns the number of empty lines passed."
19264 (let ((pos (point)))
19265 (if (cdr (assoc 'heading org-blank-before-new-entry))
19267 (unless (eobp)
19268 (forward-line -1)))
19269 (beginning-of-line 2)
19270 (goto-char (min (point) pos))
19271 (count-lines (point) pos)))
19273 (defun org-skip-whitespace ()
19276 (defun org-point-in-group (point group &optional context)
19277 "Check if POINT is in match-group GROUP.
19278 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19279 match. If the match group does not exist or point is not inside it,
19280 return nil."
19281 (and (match-beginning group)
19282 (>= point (match-beginning group))
19283 (<= point (match-end group))
19284 (if context
19285 (list context (match-beginning group) (match-end group))
19286 t)))
19288 (defun org-switch-to-buffer-other-window (&rest args)
19289 "Switch to buffer in a second window on the current frame.
19290 In particular, do not allow pop-up frames.
19291 Returns the newly created buffer."
19292 (let (pop-up-frames special-display-buffer-names special-display-regexps
19293 special-display-function)
19294 (apply 'switch-to-buffer-other-window args)))
19296 (defun org-combine-plists (&rest plists)
19297 "Create a single property list from all plists in PLISTS.
19298 The process starts by copying the first list, and then setting properties
19299 from the other lists. Settings in the last list are the most significant
19300 ones and overrule settings in the other lists."
19301 (let ((rtn (copy-sequence (pop plists)))
19302 p v ls)
19303 (while plists
19304 (setq ls (pop plists))
19305 (while ls
19306 (setq p (pop ls) v (pop ls))
19307 (setq rtn (plist-put rtn p v))))
19308 rtn))
19310 (defun org-move-line-down (arg)
19311 "Move the current line down. With prefix argument, move it past ARG lines."
19312 (interactive "p")
19313 (let ((col (current-column))
19314 beg end pos)
19315 (beginning-of-line 1) (setq beg (point))
19316 (beginning-of-line 2) (setq end (point))
19317 (beginning-of-line (+ 1 arg))
19318 (setq pos (move-marker (make-marker) (point)))
19319 (insert (delete-and-extract-region beg end))
19320 (goto-char pos)
19321 (org-move-to-column col)))
19323 (defun org-move-line-up (arg)
19324 "Move the current line up. With prefix argument, move it past ARG lines."
19325 (interactive "p")
19326 (let ((col (current-column))
19327 beg end pos)
19328 (beginning-of-line 1) (setq beg (point))
19329 (beginning-of-line 2) (setq end (point))
19330 (beginning-of-line (- arg))
19331 (setq pos (move-marker (make-marker) (point)))
19332 (insert (delete-and-extract-region beg end))
19333 (goto-char pos)
19334 (org-move-to-column col)))
19336 (defun org-replace-escapes (string table)
19337 "Replace %-escapes in STRING with values in TABLE.
19339 The sequences in STRING may contain normal field width and padding information,
19341 so values can contain further %-escapes if they are define later in TABLE."
19342 (let ((tbl (copy-alist table))
19343 (case-fold-search nil)
19344 (pchg 0)
19345 e re rpl)
19346 (while (setq e (pop tbl))
19347 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19348 (when (and (cdr e) (string-match re (cdr e)))
19349 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19350 (safe "SREF"))
19351 (add-text-properties 0 3 (list 'sref sref) safe)
19352 (setcdr e (replace-match safe t t (cdr e)))))
19353 (while (string-match re string)
19354 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19355 (cdr e)))
19356 (setq string (replace-match rpl t t string))))
19357 (while (setq pchg (next-property-change pchg string))
19358 (let ((sref (get-text-property pchg 'sref string)))
19359 (when (and sref (string-match "SREF" string pchg))
19360 (setq string (replace-match sref t t string)))))
19361 string))
19363 (defun org-sublist (list start end)
19364 "Return a section of LIST, from START to END.
19365 Counting starts at 1."
19366 (let (rtn (c start))
19367 (setq list (nthcdr (1- start) list))
19368 (while (and list (<= c end))
19369 (push (pop list) rtn)
19370 (setq c (1+ c)))
19371 (nreverse rtn)))
19373 (defun org-find-base-buffer-visiting (file)
19374 "Like `find-buffer-visiting' but always return the base buffer and
19375 not an indirect buffer."
19376 (let ((buf (or (get-file-buffer file)
19377 (find-buffer-visiting file))))
19378 (if buf
19379 (or (buffer-base-buffer buf) buf)
19380 nil)))
19382 (defun org-image-file-name-regexp (&optional extensions)
19383 "Return regexp matching the file names of images.
19384 If EXTENSIONS is given, only match these."
19385 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19386 (image-file-name-regexp)
19387 (let ((image-file-name-extensions
19388 (or extensions
19389 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19390 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19392 (regexp-opt (nconc (mapcar 'upcase
19393 image-file-name-extensions)
19394 image-file-name-extensions)
19395 t)
19398 (defun org-file-image-p (file &optional extensions)
19399 "Return non-nil if FILE is an image."
19400 (save-match-data
19401 (string-match (org-image-file-name-regexp extensions) file)))
19403 (defun org-get-cursor-date ()
19404 "Return the date at cursor in as a time.
19405 This works in the calendar and in the agenda, anywhere else it just
19406 returns the current time."
19407 (let (date day defd)
19408 (cond
19409 ((eq major-mode 'calendar-mode)
19410 (setq date (calendar-cursor-to-date)
19411 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19412 ((eq major-mode 'org-agenda-mode)
19413 (setq day (get-text-property (point) 'day))
19414 (if day
19415 (setq date (calendar-gregorian-from-absolute day)
19416 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19417 (nth 2 date))))))
19418 (or defd (current-time))))
19420 (defvar org-agenda-action-marker (make-marker)
19421 "Marker pointing to the entry for the next agenda action.")
19423 (defun org-mark-entry-for-agenda-action ()
19424 "Mark the current entry as target of an agenda action.
19425 Agenda actions are actions executed from the agenda with the key `k',
19426 which make use of the date at the cursor."
19427 (interactive)
19428 (move-marker org-agenda-action-marker
19429 (save-excursion (org-back-to-heading t) (point))
19430 (current-buffer))
19431 (message
19432 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19434 (defun org-mark-subtree ()
19435 "Mark the current subtree.
19436 This puts point at the start of the current subtree, and mark at the end.
19438 If point is in an inline task, mark that task instead."
19439 (interactive)
19440 (let ((inline-task-p
19441 (and (featurep 'org-inlinetask)
19442 (org-inlinetask-in-task-p)))
19443 (beg))
19444 ;; Get beginning of subtree
19445 (cond
19446 (inline-task-p (org-inlinetask-goto-beginning))
19447 ((org-at-heading-p) (beginning-of-line))
19448 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19449 (setq beg (point))
19450 ;; Get end of it
19451 (if inline-task-p
19452 (org-inlinetask-goto-end)
19453 (org-end-of-subtree))
19454 ;; Mark zone
19455 (push-mark (point) nil t)
19456 (goto-char beg)))
19458 ;;; Paragraph filling stuff.
19459 ;; We want this to be just right, so use the full arsenal.
19461 (defun org-indent-line-function ()
19462 "Indent line depending on context."
19463 (interactive)
19464 (let* ((pos (point))
19465 (itemp (org-at-item-p))
19466 (case-fold-search t)
19468 (inline-task-p (and (featurep 'org-inlinetask)
19469 (org-inlinetask-in-task-p)))
19470 (inline-re (and inline-task-p
19471 (org-inlinetask-outline-regexp)))
19472 column)
19473 (beginning-of-line 1)
19474 (cond
19475 ;; Comments
19476 ((looking-at "# ") (setq column 0))
19477 ;; Headings
19478 ((looking-at org-outline-regexp) (setq column 0))
19479 ;; Included files
19481 ;; Footnote definition
19482 ((looking-at org-footnote-definition-re) (setq column 0))
19483 ;; Literal examples
19485 (setq column (org-get-indentation))) ; do nothing
19486 ;; Lists
19487 ((ignore-errors (goto-char (org-in-item-p)))
19488 (setq column (if itemp
19489 (org-get-indentation)
19490 (org-list-item-body-column (point))))
19491 (goto-char pos))
19492 ;; Drawers
19494 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19495 (save-excursion
19496 (goto-char (1- (match-beginning 1)))
19497 (setq column (current-column))))
19498 ;; Special blocks
19500 (save-excursion
19501 (re-search-backward
19503 (setq column (org-get-indentation (match-string 0))))
19506 (save-excursion
19508 (setq column
19509 (cond ((equal (downcase (match-string 1)) "src")
19510 ;; src blocks: let `org-edit-src-exit' handle them
19511 (org-get-indentation))
19512 ((equal (downcase (match-string 1)) "example")
19513 (max (org-get-indentation)
19514 (org-get-indentation (match-string 0))))
19515 (t
19516 (org-get-indentation (match-string 0))))))
19517 ;; This line has nothing special, look at the previous relevant
19518 ;; line to compute indentation
19519 (t
19520 (beginning-of-line 0)
19521 (while (and (not (bobp))
19522 (not (looking-at org-drawer-regexp))
19523 ;; When point started in an inline task, do not move
19524 ;; above task starting line.
19525 (not (and inline-task-p (looking-at inline-re)))
19526 ;; Skip drawers, blocks, empty lines, verbatim,
19527 ;; comments, tables, footnotes definitions, lists,
19528 ;; inline tasks.
19530 (re-search-backward org-drawer-regexp nil t))
19534 (looking-at org-footnote-definition-re)
19535 (and (ignore-errors (goto-char (org-in-item-p)))
19536 (goto-char
19537 (org-list-get-top-point (org-list-struct))))
19538 (and (not inline-task-p)
19539 (featurep 'org-inlinetask)
19540 (org-inlinetask-in-task-p)
19541 (or (org-inlinetask-goto-beginning) t))))
19542 (beginning-of-line 0))
19543 (cond
19544 ;; There was an heading above.
19546 (if (not org-adapt-indentation)
19547 (setq column 0)
19548 (goto-char (match-end 0))
19549 (setq column (current-column))))
19550 ;; A drawer had started and is unfinished
19551 ((looking-at org-drawer-regexp)
19552 (goto-char (1- (match-beginning 1)))
19553 (setq column (current-column)))
19554 ;; Else, nothing noticeable found: get indentation and go on.
19555 (t (setq column (org-get-indentation))))))
19556 ;; Now apply indentation and move cursor accordingly
19557 (goto-char pos)
19558 (if (<= (current-column) (current-indentation))
19559 (org-indent-line-to column)
19560 (save-excursion (org-indent-line-to column)))
19561 ;; Special polishing for properties, see `org-property-format'
19562 (setq column (current-column))
19563 (beginning-of-line 1)
19564 (if (looking-at
19566 (replace-match (concat (match-string 1)
19567 (format org-property-format
19568 (match-string 2) (match-string 3)))
19569 t t))
19570 (org-move-to-column column)))
19572 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19573 "Variable to store copy of `adaptive-fill-regexp'.
19574 Since `adaptive-fill-regexp' is set to never match, we need to
19575 store a backup of its value before entering `org-mode' so that
19576 the functionality can be provided as a fall-back.")
19578 (defun org-set-autofill-regexps ()
19579 (interactive)
19580 ;; In the paragraph separator we include headlines, because filling
19581 ;; text in a line directly attached to a headline would otherwise
19582 ;; fill the headline as well.
19585 ;; The paragraph starter includes hand-formatted lists.
19586 (org-set-local
19587 'paragraph-start
19588 (concat
19597 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19598 ;; But only if the user has not turned off tables or fixed-width regions
19599 (org-set-local
19600 'auto-fill-inhibit-regexp
19601 (concat org-outline-regexp
19604 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19605 (concat
19607 (if org-enable-table-editor "|" "")
19608 (if org-enable-fixed-width-editor ":" "")
19609 "]"))))
19610 ;; We use our own fill-paragraph function, to make sure that tables
19611 ;; and fixed-width regions are not wrapped. That function will pass
19612 ;; through to `fill-paragraph' when appropriate.
19613 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19614 ;; Prevent auto-fill from inserting unwanted new items.
19615 (org-set-local 'fill-nobreak-predicate
19616 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19617 fill-nobreak-predicate
19618 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19619 ;; Adaptive filling: To get full control, first make sure that
19620 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19621 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19622 (org-set-local 'org-adaptive-fill-regexp-backup
19623 adaptive-fill-regexp))
19625 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19626 (org-set-local 'adaptive-fill-function
19627 'org-adaptive-fill-function)
19628 (org-set-local
19629 'align-mode-rules-list
19630 '((org-in-buffer-settings
19632 (modes . '(org-mode))))))
19634 (defun org-fill-item-nobreak-p ()
19635 "Non-nil when a line break at point would insert a new item."
19636 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19638 (defun org-fill-paragraph (&optional justify)
19639 "Re-align a table, pass through to fill-paragraph if no table."
19640 (let ((table-p (org-at-table-p))
19641 (table.el-p (org-at-table.el-p))
19642 (itemp (org-in-item-p)))
19643 (cond ((and (equal (char-after (point-at-bol)) ?*)
19644 (save-excursion (goto-char (point-at-bol))
19645 (looking-at org-outline-regexp)))
19646 t) ; skip headlines
19647 (table.el-p t) ; skip table.el tables
19648 (table-p (org-table-align) t) ; align Org tables
19649 (itemp ; align text in items
19650 (let* ((struct (save-excursion (goto-char itemp)
19651 (org-list-struct)))
19652 (parents (org-list-parents-alist struct))
19653 (children (org-list-get-children itemp struct parents))
19654 beg end prev next prefix)
19655 ;; Determine in which part of item point is: before
19656 ;; first child, after last child, between two
19657 ;; sub-lists, or simply in item if there's no child.
19658 (cond
19659 ((not children)
19660 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19661 beg itemp
19662 end (org-list-get-item-end itemp struct)))
19663 ((< (point) (setq next (car children)))
19664 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19665 beg itemp
19666 end next))
19667 ((> (point) (setq prev (car (last children))))
19668 (setq beg (org-list-get-item-end prev struct)
19669 end (org-list-get-item-end itemp struct)
19670 prefix (save-excursion
19671 (goto-char beg)
19673 (make-string (current-column) ?\ ))))
19674 (t (catch 'exit
19675 (while (setq next (pop children))
19676 (if (> (point) next)
19677 (setq prev next)
19678 (setq beg (org-list-get-item-end prev struct)
19679 end next
19680 prefix (save-excursion
19681 (goto-char beg)
19683 (make-string (current-column) ?\ )))
19684 (throw 'exit nil))))))
19685 ;; Use `fill-paragraph' with buffer narrowed to item
19686 ;; without any child, and with our computed PREFIX.
19687 (flet ((fill-context-prefix (from to &optional flr) prefix))
19688 (save-restriction
19689 (narrow-to-region beg end)
19690 (save-excursion (fill-paragraph justify)))) t))
19691 ;; Special case where point is not in a list but is on
19692 ;; a paragraph adjacent to a list: make sure this paragraph
19693 ;; doesn't get merged with the end of the list by narrowing
19694 ;; buffer first.
19695 ((save-excursion (forward-paragraph -1)
19696 (setq itemp (org-in-item-p)))
19697 (let ((struct (save-excursion (goto-char itemp)
19698 (org-list-struct))))
19699 (save-restriction
19700 (narrow-to-region (org-list-get-bottom-point struct)
19701 (save-excursion (forward-paragraph 1)
19702 (point)))
19703 (fill-paragraph justify) t)))
19704 ;; Else simply call `fill-paragraph'.
19705 (t nil))))
19707 ;; For reference, this is the default value of adaptive-fill-regexp
19710 (defun org-adaptive-fill-function ()
19711 "Return a fill prefix for org-mode files."
19712 (let (itemp)
19713 (save-excursion
19714 (cond
19715 ;; Comment line
19717 (match-string-no-properties 0))
19718 ;; Plain list item
19719 ((org-at-item-p)
19720 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19721 ;; Point is in a list after `backward-paragraph': original
19722 ;; point wasn't in the list, or filling would have been taken
19723 ;; care of by `org-auto-fill-function', but the list and the
19724 ;; real paragraph are not separated by a blank line. Thus, move
19725 ;; point after the list to go back to real paragraph and
19726 ;; determine fill-prefix.
19727 ((setq itemp (org-in-item-p))
19728 (goto-char itemp)
19729 (let* ((struct (org-list-struct))
19730 (bottom (org-list-get-bottom-point struct)))
19731 (goto-char bottom)
19732 (make-string (org-get-indentation) ?\ )))
19733 ;; Other text
19734 ((looking-at org-adaptive-fill-regexp-backup)
19735 (match-string-no-properties 0))))))
19737 (defun org-auto-fill-function ()
19738 "Auto-fill function."
19739 (let (itemp prefix)
19740 ;; When in a list, compute an appropriate fill-prefix and make
19741 ;; sure it will be used by `do-auto-fill'.
19742 (if (setq itemp (org-in-item-p))
19743 (progn
19744 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19745 (flet ((fill-context-prefix (from to &optional flr) prefix))
19746 (do-auto-fill)))
19747 ;; Else just use `do-auto-fill'.
19748 (do-auto-fill))))
19750 ;;; Other stuff.
19752 (defun org-toggle-fixed-width-section (arg)
19753 "Toggle the fixed-width export.
19754 If there is no active region, the QUOTE keyword at the current headline is
19755 inserted or removed. When present, it causes the text between this headline
19756 and the next to be exported as fixed-width text, and unmodified.
19757 If there is an active region, this command adds or removes a colon as the
19758 first character of this line. If the first character of a line is a colon,
19759 this line is also exported in fixed-width font."
19760 (interactive "P")
19761 (let* ((cc 0)
19762 (regionp (org-region-active-p))
19763 (beg (if regionp (region-beginning) (point)))
19764 (end (if regionp (region-end)))
19765 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19766 (case-fold-search nil)
19768 off)
19769 (if regionp
19770 (save-excursion
19771 (goto-char beg)
19772 (setq cc (current-column))
19773 (beginning-of-line 1)
19774 (setq off (looking-at re))
19775 (while (> nlines 0)
19776 (setq nlines (1- nlines))
19777 (beginning-of-line 1)
19778 (cond
19779 (arg
19780 (org-move-to-column cc t)
19782 (forward-line -1))
19783 ((and off (looking-at re))
19784 (replace-match "" t t nil 1))
19785 ((not off) (org-move-to-column cc t) (insert ": ")))
19786 (forward-line 1)))
19787 (save-excursion
19788 (org-back-to-heading)
19789 (if (looking-at (concat org-outline-regexp
19791 (replace-match "" t t nil 1)
19792 (if (looking-at org-outline-regexp)
19793 (progn
19794 (goto-char (match-end 0))
19795 (insert org-quote-string " "))))))))
19797 (defun org-reftex-citation ()
19798 "Use reftex-citation to insert a citation into the buffer.
19799 This looks for a line like
19801 #+BIBLIOGRAPHY: foo plain option:-d
19803 and derives from it that foo.bib is the bibliography file relevant
19804 for this document. It then installs the necessary environment for RefTeX
19805 to work in this buffer and calls `reftex-citation' to insert a citation
19806 into the buffer.
19808 Export of such citations to both LaTeX and HTML is handled by the contributed
19809 package org-exp-bibtex by Taru Karttunen."
19810 (interactive)
19811 (let ((reftex-docstruct-symbol 'rds)
19813 rds bib)
19814 (save-excursion
19815 (save-restriction
19816 (widen)
19817 (let ((case-fold-search t)
19819 (if (not (save-excursion
19820 (or (re-search-forward re nil t)
19821 (re-search-backward re nil t))))
19822 (error "No bibliography defined in file")
19823 (setq bib (concat (match-string 1) ".bib")
19824 rds (list (list 'bib bib)))))))
19825 (call-interactively 'reftex-citation)))
19827 ;;;; Functions extending outline functionality
19829 (defun org-beginning-of-line (&optional arg)
19830 "Go to the beginning of the current line. If that is invisible, continue
19831 to a visible line beginning. This makes the function of C-a more intuitive.
19832 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19833 first attempt, and only move to after the tags when the cursor is already
19834 beyond the end of the headline."
19835 (interactive "P")
19836 (let ((pos (point))
19837 (special (if (consp org-special-ctrl-a/e)
19838 (car org-special-ctrl-a/e)
19839 org-special-ctrl-a/e))
19840 refpos)
19841 (if (org-bound-and-true-p line-move-visual)
19842 (beginning-of-visual-line 1)
19843 (beginning-of-line 1))
19844 (if (and arg (fboundp 'move-beginning-of-line))
19845 (call-interactively 'move-beginning-of-line)
19846 (if (bobp)
19847 nil
19848 (backward-char 1)
19849 (if (org-truely-invisible-p)
19850 (while (and (not (bobp)) (org-truely-invisible-p))
19851 (backward-char 1)
19852 (beginning-of-line 1))
19853 (forward-char 1))))
19854 (when special
19855 (cond
19856 ((and (looking-at org-complex-heading-regexp)
19857 (= (char-after (match-end 1)) ?\ ))
19858 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19859 (point-at-eol)))
19860 (goto-char
19861 (if (eq special t)
19862 (cond ((> pos refpos) refpos)
19863 ((= pos (point)) refpos)
19864 (t (point)))
19865 (cond ((> pos (point)) (point))
19866 ((not (eq last-command this-command)) (point))
19867 (t refpos)))))
19868 ((org-at-item-p)
19869 (goto-char
19870 (if (eq special t)
19871 (cond ((> pos (match-end 0)) (match-end 0))
19872 ((= pos (point)) (match-end 0))
19873 (t (point)))
19874 (cond ((> pos (point)) (point))
19875 ((not (eq last-command this-command)) (point))
19876 (t (match-end 0))))))))
19877 (org-no-warnings
19878 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19880 (defun org-end-of-line (&optional arg)
19881 "Go to the end of the line.
19882 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19883 first attempt, and only move to after the tags when the cursor is already
19884 beyond the end of the headline."
19885 (interactive "P")
19886 (let ((special (if (consp org-special-ctrl-a/e)
19887 (cdr org-special-ctrl-a/e)
19888 org-special-ctrl-a/e)))
19889 (if (or (not special)
19890 (not (org-on-heading-p))
19891 arg)
19892 (call-interactively
19893 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19894 ((fboundp 'move-end-of-line) 'move-end-of-line)
19895 (t 'end-of-line)))
19896 (let ((pos (point)))
19897 (beginning-of-line 1)
19899 (if (eq special t)
19900 (if (or (< pos (match-beginning 1))
19901 (= pos (match-end 0)))
19902 (goto-char (match-beginning 1))
19903 (goto-char (match-end 0)))
19904 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19905 (goto-char (match-end 0))
19906 (goto-char (match-beginning 1))))
19907 (call-interactively (if (fboundp 'move-end-of-line)
19908 'move-end-of-line
19909 'end-of-line)))))
19910 (org-no-warnings
19911 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19913 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19914 (define-key org-mode-map "\C-e" 'org-end-of-line)
19916 (defun org-backward-sentence (&optional arg)
19917 "Go to beginning of sentence, or beginning of table field.
19918 This will call `backward-sentence' or `org-table-beginning-of-field',
19919 depending on context."
19920 (interactive "P")
19921 (cond
19922 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19923 (t (call-interactively 'backward-sentence))))
19925 (defun org-forward-sentence (&optional arg)
19926 "Go to end of sentence, or end of table field.
19927 This will call `forward-sentence' or `org-table-end-of-field',
19928 depending on context."
19929 (interactive "P")
19930 (cond
19931 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19932 (t (call-interactively 'forward-sentence))))
19934 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19935 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19937 (defun org-kill-line (&optional arg)
19938 "Kill line, to tags or end of line."
19939 (interactive "P")
19940 (cond
19941 ((or (not org-special-ctrl-k)
19942 (bolp)
19943 (not (org-on-heading-p)))
19944 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19945 org-ctrl-k-protect-subtree)
19946 (if (or (eq org-ctrl-k-protect-subtree 'error)
19947 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19948 (error "C-k aborted - would kill hidden subtree")))
19949 (call-interactively 'kill-line))
19951 (kill-region (point) (match-beginning 1))
19952 (org-set-tags nil t))
19953 (t (kill-region (point) (point-at-eol)))))
19955 (define-key org-mode-map "\C-k" 'org-kill-line)
19957 (defun org-yank (&optional arg)
19958 "Yank. If the kill is a subtree, treat it specially.
19959 This command will look at the current kill and check if is a single
19960 subtree, or a series of subtrees[1]. If it passes the test, and if the
19961 cursor is at the beginning of a line or after the stars of a currently
19962 empty headline, then the yank is handled specially. How exactly depends
19963 on the value of the following variables, both set by default.
19965 org-yank-folded-subtrees
19966 When set, the subtree(s) will be folded after insertion, but only
19967 if doing so would now swallow text after the yanked text.
19969 org-yank-adjusted-subtrees
19970 When set, the subtree will be promoted or demoted in order to
19971 fit into the local outline tree structure, which means that the level
19972 will be adjusted so that it becomes the smaller one of the two
19973 *visible* surrounding headings.
19975 Any prefix to this command will cause `yank' to be called directly with
19977 will just
19978 plainly yank the text as it is.
19980 \[1] The test checks if the first non-white line is a heading
19981 and if there are no other headings with fewer stars."
19982 (interactive "P")
19983 (org-yank-generic 'yank arg))
19985 (defun org-yank-generic (command arg)
19986 "Perform some yank-like command.
19988 This function implements the behavior described in the `org-yank'
19989 documentation. However, it has been generalized to work for any
19990 interactive command with similar behavior."
19992 ;; pretend to be command COMMAND
19993 (setq this-command command)
19995 (if arg
19996 (call-interactively command)
19998 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19999 (and (org-kill-is-subtree-p)
20000 (or (bolp)
20002 (string-match
20004 (buffer-substring (point-at-bol) (point)))))))
20005 swallowp)
20006 (cond
20007 ((and subtreep org-yank-folded-subtrees)
20008 (let ((beg (point))
20009 end)
20010 (if (and subtreep org-yank-adjusted-subtrees)
20011 (org-paste-subtree nil nil 'for-yank)
20012 (call-interactively command))
20014 (setq end (point))
20015 (goto-char beg)
20016 (when (and (bolp) subtreep
20017 (not (setq swallowp
20018 (org-yank-folding-would-swallow-text beg end))))
20019 (org-with-limited-levels
20020 (or (looking-at org-outline-regexp)
20021 (re-search-forward org-outline-regexp-bol end t))
20022 (while (and (< (point) end) (looking-at org-outline-regexp))
20023 (hide-subtree)
20024 (org-cycle-show-empty-lines 'folded)
20025 (condition-case nil
20026 (outline-forward-same-level 1)
20027 (error (goto-char end))))))
20028 (when swallowp
20029 (message
20030 "Inserted text not folded because that would swallow text"))
20032 (goto-char end)
20034 (beginning-of-line 1)
20035 (push-mark beg 'nomsg)))
20036 ((and subtreep org-yank-adjusted-subtrees)
20037 (let ((beg (point-at-bol)))
20038 (org-paste-subtree nil nil 'for-yank)
20039 (push-mark beg 'nomsg)))
20040 (t
20041 (call-interactively command))))))
20043 (defun org-yank-folding-would-swallow-text (beg end)
20044 "Would hide-subtree at BEG swallow any text after END?"
20045 (let (level)
20046 (org-with-limited-levels
20047 (save-excursion
20048 (goto-char beg)
20049 (when (or (looking-at org-outline-regexp)
20050 (re-search-forward org-outline-regexp-bol end t))
20051 (setq level (org-outline-level)))
20052 (goto-char end)
20054 (if (or (eobp)
20055 (and (bolp) (looking-at org-outline-regexp)
20056 (<= (org-outline-level) level)))
20057 nil ; Nothing would be swallowed
20058 t))))) ; something would swallow
20060 (define-key org-mode-map "\C-y" 'org-yank)
20062 (defun org-truely-invisible-p ()
20063 "Check if point is at a character currently not visible.
20064 This version does not only check the character property, but also
20065 `visible-mode'."
20066 ;; Early versions of noutline don't have `outline-invisible-p'.
20067 (if (org-bound-and-true-p visible-mode)
20068 nil
20069 (outline-invisible-p)))
20071 (defun org-invisible-p2 ()
20072 "Check if point is at a character currently not visible."
20073 (save-excursion
20074 (if (and (eolp) (not (bobp))) (backward-char 1))
20075 ;; Early versions of noutline don't have `outline-invisible-p'.
20076 (outline-invisible-p)))
20078 (defun org-back-to-heading (&optional invisible-ok)
20079 "Call `outline-back-to-heading', but provide a better error message."
20080 (condition-case nil
20081 (outline-back-to-heading invisible-ok)
20082 (error (error "Before first headline at position %d in buffer %s"
20083 (point) (current-buffer)))))
20085 (defun org-beginning-of-defun ()
20086 "Go to the beginning of the subtree, i.e. back to the heading."
20087 (org-back-to-heading))
20088 (defun org-end-of-defun ()
20089 "Go to the end of the subtree."
20090 (org-end-of-subtree nil t))
20092 (defun org-before-first-heading-p ()
20093 "Before first heading?"
20094 (save-excursion
20095 (end-of-line)
20096 (null (re-search-backward org-outline-regexp-bol nil t))))
20098 (defun org-on-heading-p (&optional ignored)
20099 (outline-on-heading-p t))
20100 (defun org-at-heading-p (&optional ignored)
20101 (outline-on-heading-p t))
20103 (defun org-point-at-end-of-empty-headline ()
20104 "If point is at the end of an empty headline, return t, else nil.
20105 If the heading only contains a TODO keyword, it is still still considered
20106 empty."
20108 (save-excursion
20109 (beginning-of-line 1)
20110 (let ((case-fold-search nil))
20113 (defun org-at-heading-or-item-p ()
20114 (or (org-on-heading-p) (org-at-item-p)))
20116 (defun org-on-target-p ()
20117 (or (org-in-regexp org-radio-target-regexp)
20118 (org-in-regexp org-target-regexp)))
20120 (defun org-up-heading-all (arg)
20121 "Move to the heading line of which the present line is a subheading.
20122 This function considers both visible and invisible heading lines.
20123 With argument, move up ARG levels."
20124 (if (fboundp 'outline-up-heading-all)
20125 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20126 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20128 (defun org-up-heading-safe ()
20129 "Move to the heading line of which the present line is a subheading.
20130 This version will not throw an error. It will return the level of the
20131 headline found, or nil if no higher level is found.
20133 Also, this function will be a lot faster than `outline-up-heading',
20134 because it relies on stars being the outline starters. This can really
20135 make a significant difference in outlines with very many siblings."
20136 (let (start-level re)
20137 (org-back-to-heading t)
20138 (setq start-level (funcall outline-level))
20139 (if (equal start-level 1)
20140 nil
20142 (if (re-search-backward re nil t)
20143 (funcall outline-level)))))
20145 (defun org-first-sibling-p ()
20146 "Is this heading the first child of its parents?"
20147 (interactive)
20148 (let ((re org-outline-regexp-bol)
20149 level l)
20150 (unless (org-at-heading-p t)
20151 (error "Not at a heading"))
20152 (setq level (funcall outline-level))
20153 (save-excursion
20154 (if (not (re-search-backward re nil t))
20155 t
20156 (setq l (funcall outline-level))
20157 (< l level)))))
20159 (defun org-goto-sibling (&optional previous)
20160 "Goto the next sibling, even if it is invisible.
20161 When PREVIOUS is set, go to the previous sibling instead. Returns t
20162 when a sibling was found. When none is found, return nil and don't
20163 move point."
20164 (let ((fun (if previous 're-search-backward 're-search-forward))
20165 (pos (point))
20166 (re org-outline-regexp-bol)
20167 level l)
20168 (when (condition-case nil (org-back-to-heading t) (error nil))
20169 (setq level (funcall outline-level))
20170 (catch 'exit
20171 (or previous (forward-char 1))
20172 (while (funcall fun re nil t)
20173 (setq l (funcall outline-level))
20174 (when (< l level) (goto-char pos) (throw 'exit nil))
20175 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20176 (goto-char pos)
20177 nil))))
20179 (defun org-show-siblings ()
20180 "Show all siblings of the current headline."
20181 (save-excursion
20182 (while (org-goto-sibling) (org-flag-heading nil)))
20183 (save-excursion
20184 (while (org-goto-sibling 'previous)
20185 (org-flag-heading nil))))
20187 (defun org-goto-first-child ()
20188 "Goto the first child, even if it is invisible.
20189 Return t when a child was found. Otherwise don't move point and
20190 return nil."
20191 (let (level (pos (point)) (re org-outline-regexp-bol))
20192 (when (condition-case nil (org-back-to-heading t) (error nil))
20193 (setq level (outline-level))
20194 (forward-char 1)
20195 (if (and (re-search-forward re nil t) (> (outline-level) level))
20196 (progn (goto-char (match-beginning 0)) t)
20197 (goto-char pos) nil))))
20199 (defun org-show-hidden-entry ()
20200 "Show an entry where even the heading is hidden."
20201 (save-excursion
20202 (org-show-entry)))
20204 (defun org-flag-heading (flag &optional entry)
20205 "Flag the current heading. FLAG non-nil means make invisible.
20206 When ENTRY is non-nil, show the entire entry."
20207 (save-excursion
20208 (org-back-to-heading t)
20209 ;; Check if we should show the entire entry
20210 (if entry
20211 (progn
20212 (org-show-entry)
20213 (save-excursion
20214 (and (outline-next-heading)
20215 (org-flag-heading nil))))
20216 (outline-flag-region (max (point-min) (1- (point)))
20217 (save-excursion (outline-end-of-heading) (point))
20218 flag))))
20220 (defun org-get-next-sibling ()
20221 "Move to next heading of the same level, and return point.
20222 If there is no such heading, return nil.
20223 This is like outline-next-sibling, but invisible headings are ok."
20224 (let ((level (funcall outline-level)))
20225 (outline-next-heading)
20226 (while (and (not (eobp)) (> (funcall outline-level) level))
20227 (outline-next-heading))
20228 (if (or (eobp) (< (funcall outline-level) level))
20229 nil
20230 (point))))
20232 (defun org-get-last-sibling ()
20233 "Move to previous heading of the same level, and return point.
20234 If there is no such heading, return nil."
20235 (let ((opoint (point))
20236 (level (funcall outline-level)))
20237 (outline-previous-heading)
20238 (when (and (/= (point) opoint) (outline-on-heading-p t))
20239 (while (and (> (funcall outline-level) level)
20240 (not (bobp)))
20241 (outline-previous-heading))
20242 (if (< (funcall outline-level) level)
20243 nil
20244 (point)))))
20246 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20247 ;; This contains an exact copy of the original function, but it uses
20248 ;; `org-back-to-heading', to make it work also in invisible
20249 ;; trees. And is uses an invisible-OK argument.
20250 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20251 ;; Furthermore, when used inside Org, finding the end of a large subtree
20252 ;; with many children and grandchildren etc, this can be much faster
20253 ;; than the outline version.
20254 (org-back-to-heading invisible-OK)
20255 (let ((first t)
20256 (level (funcall outline-level)))
20257 (if (and (org-mode-p) (< level 1000))
20258 ;; A true heading (not a plain list item), in Org-mode
20259 ;; This means we can easily find the end by looking
20260 ;; only for the right number of stars. Using a regexp to do
20261 ;; this is so much faster than using a Lisp loop.
20263 (forward-char 1)
20264 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20265 ;; something else, do it the slow way
20266 (while (and (not (eobp))
20267 (or first (> (funcall outline-level) level)))
20268 (setq first nil)
20269 (outline-next-heading)))
20270 (unless to-heading
20272 (progn
20273 ;; Go to end of line before heading
20274 (forward-char -1)
20276 ;; leave blank line before heading
20277 (forward-char -1))))))
20278 (point))
20280 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20281 "Use Org version in org-mode, for dramatic speed-up."
20282 (if (org-mode-p)
20283 (progn
20284 (org-end-of-subtree nil t)
20285 (unless (eobp) (backward-char 1)))
20286 ad-do-it))
20288 (defun org-end-of-meta-data-and-drawers ()
20289 "Jump to the first text after meta data and drawers in the current entry.
20290 This will move over empty lines, lines with planning time stamps,
20291 clocking lines, and drawers."
20292 (org-back-to-heading t)
20293 (let ((end (save-excursion (outline-next-heading) (point)))
20296 (forward-line 1)
20297 (while (re-search-forward re end t)
20298 (if (not (match-end 1))
20299 ;; empty or planning line
20300 (forward-line 1)
20301 ;; a drawer, find the end
20303 (forward-line 1)))
20305 (point)))
20307 (defun org-forward-same-level (arg &optional invisible-ok)
20308 "Move forward to the arg'th subheading at same level as this one.
20309 Stop at the first and last subheadings of a superior heading.
20310 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20311 it wil also look at invisible ones."
20312 (interactive "p")
20313 (org-back-to-heading invisible-ok)
20314 (org-on-heading-p)
20315 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20317 l)
20318 (forward-char 1)
20319 (while (> arg 0)
20320 (while (and (re-search-forward re nil 'move)
20321 (setq l (- (match-end 0) (match-beginning 0) 1))
20322 (= l level)
20323 (not invisible-ok)
20324 (progn (backward-char 1) (outline-invisible-p)))
20325 (if (< l level) (setq arg 1)))
20326 (setq arg (1- arg)))
20327 (beginning-of-line 1)))
20329 (defun org-backward-same-level (arg &optional invisible-ok)
20330 "Move backward to the arg'th subheading at same level as this one.
20331 Stop at the first and last subheadings of a superior heading."
20332 (interactive "p")
20333 (org-back-to-heading)
20334 (org-on-heading-p)
20335 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20337 l)
20338 (while (> arg 0)
20339 (while (and (re-search-backward re nil 'move)
20340 (setq l (- (match-end 0) (match-beginning 0) 1))
20341 (= l level)
20342 (not invisible-ok)
20343 (outline-invisible-p))
20344 (if (< l level) (setq arg 1)))
20345 (setq arg (1- arg)))))
20347 (defun org-show-subtree ()
20348 "Show everything after this heading at deeper levels."
20349 (outline-flag-region
20350 (point)
20351 (save-excursion
20352 (org-end-of-subtree t t))
20353 nil))
20355 (defun org-show-entry ()
20356 "Show the body directly following this heading.
20357 Show the heading too, if it is currently invisible."
20358 (interactive)
20359 (save-excursion
20360 (condition-case nil
20361 (progn
20362 (org-back-to-heading t)
20363 (outline-flag-region
20364 (max (point-min) (1- (point)))
20365 (save-excursion
20366 (if (re-search-forward
20368 (match-beginning 1)
20369 (point-max)))
20370 nil)
20371 (org-cycle-hide-drawers 'children))
20372 (error nil))))
20374 (defun org-make-options-regexp (kwds &optional extra)
20375 "Make a regular expression for keyword lines."
20376 (concat
20377 "^"
20384 ;; Make isearch reveal the necessary context
20385 (defun org-isearch-end ()
20386 "Reveal context after isearch exits."
20387 (when isearch-success ; only if search was successful
20388 (if (featurep 'xemacs)
20389 ;; Under XEmacs, the hook is run in the correct place,
20390 ;; we directly show the context.
20391 (org-show-context 'isearch)
20392 ;; In Emacs the hook runs *before* restoring the overlays.
20393 ;; So we have to use a one-time post-command-hook to do this.
20394 ;; (Emacs 22 has a special variable, see function `org-mode')
20395 (unless (and (boundp 'isearch-mode-end-hook-quit)
20396 isearch-mode-end-hook-quit)
20397 ;; Only when the isearch was not quitted.
20398 (org-add-hook 'post-command-hook 'org-isearch-post-command
20399 'append 'local)))))
20401 (defun org-isearch-post-command ()
20402 "Remove self from hook, and show context."
20403 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20404 (org-show-context 'isearch))
20407 ;;;; Integration with and fixes for other packages
20409 ;;; Imenu support
20411 (defvar org-imenu-markers nil
20412 "All markers currently used by Imenu.")
20413 (make-variable-buffer-local 'org-imenu-markers)
20415 (defun org-imenu-new-marker (&optional pos)
20416 "Return a new marker for use by Imenu, and remember the marker."
20417 (let ((m (make-marker)))
20418 (move-marker m (or pos (point)))
20419 (push m org-imenu-markers)
20420 m))
20422 (defun org-imenu-get-tree ()
20423 "Produce the index for Imenu."
20424 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20425 (setq org-imenu-markers nil)
20426 (let* ((n org-imenu-depth)
20427 (re (concat "^" (org-get-limited-outline-regexp)))
20428 (subs (make-vector (1+ n) nil))
20429 (last-level 0)
20430 m level head)
20431 (save-excursion
20432 (save-restriction
20433 (widen)
20434 (goto-char (point-max))
20435 (while (re-search-backward re nil t)
20436 (setq level (org-reduced-level (funcall outline-level)))
20437 (when (<= level n)
20438 (looking-at org-complex-heading-regexp)
20439 (setq head (org-link-display-format
20440 (org-match-string-no-properties 4))
20441 m (org-imenu-new-marker))
20442 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20443 (if (>= level last-level)
20444 (push (cons head m) (aref subs level))
20445 (push (cons head (aref subs (1+ level))) (aref subs level))
20446 (loop for i from (1+ level) to n do (aset subs i nil)))
20447 (setq last-level level)))))
20448 (aref subs 1)))
20450 (eval-after-load "imenu"
20451 '(progn
20452 (add-hook 'imenu-after-jump-hook
20453 (lambda ()
20454 (if (org-mode-p)
20455 (org-show-context 'org-goto))))))
20457 (defun org-link-display-format (link)
20458 "Replace a link with either the description, or the link target
20459 if no description is present"
20460 (save-match-data
20461 (if (string-match org-bracket-link-analytic-regexp link)
20462 (replace-match (if (match-end 5)
20463 (match-string 5 link)
20464 (concat (match-string 1 link)
20465 (match-string 3 link)))
20466 nil t link)
20467 link)))
20469 (defun org-toggle-link-display ()
20470 "Toggle the literal or descriptive display of links."
20471 (interactive)
20472 (if org-link-display-descriptive
20473 (progn (org-remove-from-invisibility-spec '(org-link))
20474 (org-restart-font-lock)
20475 (setq org-link-display-descriptive nil))
20476 (progn (add-to-invisibility-spec '(org-link))
20477 (org-restart-font-lock)
20478 (setq org-link-display-descriptive t))))
20480 ;; Speedbar support
20482 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20483 "Overlay marking the agenda restriction line in speedbar.")
20484 (overlay-put org-speedbar-restriction-lock-overlay
20485 'face 'org-agenda-restriction-lock)
20486 (overlay-put org-speedbar-restriction-lock-overlay
20487 'help-echo "Agendas are currently limited to this item.")
20488 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20490 (defun org-speedbar-set-agenda-restriction ()
20491 "Restrict future agenda commands to the location at point in speedbar.
20493 (interactive)
20494 (require 'org-agenda)
20495 (let (p m tp np dir txt)
20496 (cond
20497 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20498 'org-imenu t))
20499 (setq m (get-text-property p 'org-imenu-marker))
20500 (with-current-buffer (marker-buffer m)
20501 (goto-char m)
20502 (org-agenda-set-restriction-lock 'subtree)))
20503 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20504 'speedbar-function 'speedbar-find-file))
20505 (setq tp (previous-single-property-change
20506 (1+ p) 'speedbar-function)
20507 np (next-single-property-change
20508 tp 'speedbar-function)
20509 dir (speedbar-line-directory)
20510 txt (buffer-substring-no-properties (or tp (point-min))
20511 (or np (point-max))))
20512 (with-current-buffer (find-file-noselect
20513 (let ((default-directory dir))
20514 (expand-file-name txt)))
20515 (unless (org-mode-p)
20516 (error "Cannot restrict to non-Org-mode file"))
20517 (org-agenda-set-restriction-lock 'file)))
20518 (t (error "Don't know how to restrict Org-mode's agenda")))
20519 (move-overlay org-speedbar-restriction-lock-overlay
20520 (point-at-bol) (point-at-eol))
20521 (setq current-prefix-arg nil)
20522 (org-agenda-maybe-redo)))
20524 (eval-after-load "speedbar"
20525 '(progn
20526 (speedbar-add-supported-extension ".org")
20527 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20528 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20529 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20530 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20531 (add-hook 'speedbar-visiting-tag-hook
20532 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20534 ;;; Fixes and Hacks for problems with other packages
20536 ;; Make flyspell not check words in links, to not mess up our keymap
20537 (defun org-mode-flyspell-verify ()
20538 "Don't let flyspell put overlays at active buttons, or on
20539 {todo,all-time,additional-option-like}-keywords."
20540 (let ((pos (max (1- (point)) (point-min)))
20541 (word (thing-at-point 'word)))
20542 (and (not (get-text-property pos 'keymap))
20543 (not (get-text-property pos 'org-no-flyspell))
20544 (not (member word org-todo-keywords-1))
20545 (not (member word org-all-time-keywords))
20546 (not (member word org-additional-option-like-keywords)))))
20548 (defun org-remove-flyspell-overlays-in (beg end)
20549 "Remove flyspell overlays in region."
20550 (and (org-bound-and-true-p flyspell-mode)
20551 (fboundp 'flyspell-delete-region-overlays)
20552 (flyspell-delete-region-overlays beg end))
20553 (add-text-properties beg end '(org-no-flyspell t)))
20555 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20556 (eval-after-load "bookmark"
20557 '(if (boundp 'bookmark-after-jump-hook)
20558 ;; We can use the hook
20559 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20560 ;; Hook not available, use advice
20561 (defadvice bookmark-jump (after org-make-visible activate)
20562 "Make the position visible."
20563 (org-bookmark-jump-unhide))))
20565 ;; Make sure saveplace shows the location if it was hidden
20566 (eval-after-load "saveplace"
20567 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20568 "Make the position visible."
20569 (org-bookmark-jump-unhide)))
20571 ;; Make sure ecb shows the location if it was hidden
20572 (eval-after-load "ecb"
20573 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20574 "Make hierarchy visible when jumping into location from ECB tree buffer."
20575 (if (org-mode-p)
20576 (org-show-context))))
20578 (defun org-bookmark-jump-unhide ()
20579 "Unhide the current position, to show the bookmark location."
20580 (and (org-mode-p)
20581 (or (outline-invisible-p)
20582 (save-excursion (goto-char (max (point-min) (1- (point))))
20583 (outline-invisible-p)))
20584 (org-show-context 'bookmark-jump)))
20586 ;; Make session.el ignore our circular variable
20587 (eval-after-load "session"
20588 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20590 ;;;; Experimental code
20592 (defun org-closed-in-range ()
20593 "Sparse tree of items closed in a certain time range.
20594 Still experimental, may disappear in the future."
20595 (interactive)
20596 ;; Get the time interval from the user.
20597 (let* ((time1 (org-float-time
20598 (org-read-date nil 'to-time nil "Starting date: ")))
20599 (time2 (org-float-time
20600 (org-read-date nil 'to-time nil "End date:")))
20601 ;; callback function
20602 (callback (lambda ()
20603 (let ((time
20604 (org-float-time
20605 (apply 'encode-time
20606 (org-parse-time-string
20607 (match-string 1))))))
20608 ;; check if time in interval
20609 (and (>= time time1) (<= time time2))))))
20610 ;; make tree, check each match with the callback
20613 ;;;; Finish up
20615 (provide 'org)
20617 (run-hooks 'org-load-hook)
20619 ;;; org.el ends here