| blob | 4a11fc0354fdaf399c9be2b18cb2c153f26c81e1 |
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
193 ;;;; Customization variables
195 "Remove ID property of clones of a subtree.
196 When non-nil, clones of a subtree don't inherit the ID property.
197 Otherwise they inherit the ID property with a new unique
198 identifier."
202 ;;; Version
208 "Show the org-mode version in the echo area.
209 With prefix arg HERE, insert it at point."
235 ;;; Compatibility constants
237 ;;; The custom variables
240 "Outline-based notes management and organizer."
246 "Mode hook for Org-mode, run after the mode was turned on."
251 "Hook that is run after org.el has been loaded."
256 "Hook that is run after an Org log buffer is created."
265 "Load all extensions listed in `org-modules'."
270 org-modules)
274 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
283 (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)
284 "Modules that should always be loaded together with org.el.
285 If a description starts with <C>, the file is not part of Emacs
286 and loading it will require that you have downloaded and properly installed
287 the org-mode distribution.
289 You can also use this system to load external packages (i.e. neither Org
290 core modules, nor modules from the CONTRIB directory). Just add symbols
291 to the end of the list. If the package is called org-xyz.el, then you need
292 to add the symbol `xyz', and the package must have a call to
294 (provide 'org-xyz)"
297 :type
328 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
337 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
346 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
363 "Non-nil means make shift-cursor commands select text when possible.
365 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
366 start selecting a region, or enlarge regions started in this way.
367 In Org-mode, in special contexts, these same keys are used for
368 other purposes, important enough to compete with shift selection.
369 Org tries to balance these needs by supporting `shift-select-mode'
370 outside these special contexts, under control of this variable.
372 The default of this variable is nil, to avoid confusing behavior. Shifted
373 cursor keys will then execute Org commands in the following contexts:
374 - on a headline, changing TODO state (left/right) and priority (up/down)
375 - on a time stamp, changing the time
376 - in a plain list item, changing the bullet type
377 - in a property definition line, switching between allowed values
378 - in the BEGIN line of a clock table (changing the time block).
379 Outside these contexts, the commands will throw an error.
381 When this variable is t and the cursor is not in a special
382 context, Org-mode will support shift-selection for making and
383 enlarging regions. To make this more effective, the bullet
384 cycling will no longer happen anywhere in an item line, but only
385 if the cursor is exactly on the bullet.
387 If you set this variable to the symbol `always', then the keys
388 will not be special in headlines, property lines, and item lines,
389 to make shift selection work there as well. If this is what you
390 want, you can use the following alternative commands: `C-c C-t'
391 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
392 can be used to switch TODO sets, `C-c -' to cycle item bullet
393 types, and properties can be edited by hand or in column view.
395 However, when the cursor is on a timestamp, shift-cursor commands
396 will still edit the time stamp - this is just too good to give up.
398 XEmacs user should have this variable set to nil, because
399 `shift-select-mode' is in Emacs 23 or later only."
407 "Options concerning startup of Org-mode."
412 "Non-nil means entering Org-mode will switch to OVERVIEW.
413 This can also be configured on a per-file basis by adding one of
414 the following lines anywhere in the buffer:
416 #+STARTUP: fold (or `overview', this is equivalent)
417 #+STARTUP: nofold (or `showall', this is equivalent)
418 #+STARTUP: content
419 #+STARTUP: showeverything"
428 "Non-nil means entering Org-mode will set `truncate-lines'.
429 This is useful since some lines containing links can be very long and
430 uninteresting. Also tables look terrible when wrapped."
435 "Non-nil means turn on `org-indent-mode' on startup.
436 This can also be configured on a per-file basis by adding one of
437 the following lines anywhere in the buffer:
439 #+STARTUP: indent
440 #+STARTUP: noindent"
448 When this option is turned on, you can use TeX-like syntax for sub- and
450 considered as a single item - so grouping with {} is normally not
451 needed. For example, the following things will be parsed as single
452 sub- or superscripts.
454 10^24 or 10^tau several digits will be considered 1 item.
455 10^-12 or 10^-tau a leading sign with digits or a word
456 x^2-y^3 will be read as x^2 - y^3, because items are
457 terminated by almost any nonword/nondigit char.
458 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
460 Still, ambiguity is possible - so when in doubt use {} to enclose the
461 sub/superscript. If you set this variable to the symbol `{}',
462 the braces are *required* in order to trigger interpretations as
464 frequently in plain text.
466 Not all export backends support this, but HTML does.
481 "Non-nil means turn on `org-beamer-mode' on startup.
482 This can also be configured on a per-file basis by adding one of
483 the following lines anywhere in the buffer:
485 #+STARTUP: beamer"
490 "Non-nil means align all tables when visiting a file.
491 This is useful when the column width in tables is forced with <N> cookies
492 in table fields. Such tables will look correct only after the first re-align.
493 This can also be configured on a per-file basis by adding one of
494 the following lines anywhere in the buffer:
495 #+STARTUP: align
496 #+STARTUP: noalign"
501 "Non-nil means show inline images when loading a new Org file.
502 This can also be configured on a per-file basis by adding one of
503 the following lines anywhere in the buffer:
504 #+STARTUP: inlineimages
505 #+STARTUP: noinlineimages"
510 "Non-nil means insert the first line setting Org-mode in empty files.
511 When the function `org-mode' is called interactively in an empty file, this
512 normally means that the file name does not automatically trigger Org-mode.
513 To ensure that the file will always be in Org-mode in the future, a
514 line enforcing Org-mode will be inserted into the buffer, if this option
515 has been set."
520 "Non-nil means use alternative key bindings for some keys.
521 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
522 These keys are also used by other packages like shift-selection-mode'
523 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
524 If you want to use Org-mode together with one of these other modes,
525 or more generally if you would like to move some Org-mode commands to
526 other keys, set this variable and configure the keys with the variable
527 `org-disputed-keys'.
529 This option is only relevant at load-time of Org-mode, and must be set
530 *before* org.el is loaded. Changing it requires a restart of Emacs to
531 become effective."
536 "Non-nil means use extra key sequence definitions for certain commands.
537 This happens automatically if you run XEmacs or if `window-system'
538 is nil. This variable lets you do the same manually. You must
539 set it before loading org.
541 Example: on Carbon Emacs 22 running graphically, with an external
542 keyboard on a Powerbook, the default way of setting M-left might
543 not work for either Alt or ESC. Setting this variable will make
544 it work for ESC."
558 "Keys for which Org-mode and other modes compete.
559 This is an alist, cars are the default keys, second element specifies
560 the alternative to use when `org-replace-disputed-keys' is t.
562 Keys can be specified in any syntax supported by `define-key'.
563 The value of this option takes effect only at Org-mode's startup,
564 therefore you'll have to restart Emacs to apply it after changing."
569 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
570 Or return the original if not disputed.
571 Also apply the translations defined in `org-xemacs-key-equivalents'."
576 org-disputed-keys)))
580 key)
590 "Define a key, possibly translated, as returned by `org-key'."
594 "The ellipsis to use in the Org-mode outline.
595 When nil, just use the standard three dots. When a string, use that instead,
596 When a face, use the standard 3 dots, but with the specified face.
597 The change affects only Org-mode (which will then use its own display table).
598 Changing this requires executing `M-x org-mode' in a buffer to become
599 effective."
609 "Keywords in Org-mode."
614 "String to mark deadline entries.
615 A deadline is this string, followed by a time stamp. Should be a word,
616 terminated by a colon. You can insert a schedule keyword and
618 Changes become only effective after restarting Emacs."
623 "String to mark scheduled TODO entries.
624 A schedule is this string, followed by a time stamp. Should be a word,
625 terminated by a colon. You can insert a schedule keyword and
627 Changes become only effective after restarting Emacs."
632 "String used as the prefix for timestamps logging closing a TODO entry."
637 "String used as prefix for timestamps clocking work hours on an item."
642 "Entries starting with this keyword will never be exported.
643 An entry can be toggled between COMMENT and normal with
645 Changes become only effective after restarting Emacs."
650 "Entries starting with this keyword will be exported in fixed-width font.
651 Quoting applies only to the text in the entry following the headline, and does
652 not extend beyond the next headline, even if that is lower level.
653 An entry can be toggled between QUOTE and normal with
660 "Regular expression for specifying repeated events.
664 "Options concerning the general structure of Org-mode files."
669 "Options about how to make context of a location visible."
693 "Non-nil means show full hierarchy when revealing a location.
694 Org-mode often shows locations in an org-mode file which might have
695 been invisible before. When this is set, the hierarchy of headings
696 above the exposed location is shown.
697 Turning this off for example for sparse trees makes them very compact.
698 Instead of t, this can also be an alist specifying this option for different
699 contexts. Valid contexts are
700 agenda when exposing an entry from the agenda
701 org-goto when using the command `org-goto' on key C-c C-j
702 occur-tree when using the command `org-occur' on key C-c /
703 tags-tree when constructing a sparse tree based on tags matches
704 link-search when exposing search matches associated with a link
705 mark-goto when exposing the jump goal of a mark
706 bookmark-jump when exposing a bookmark location
707 isearch when exiting from an incremental search
708 default default for all contexts not set explicitly"
713 "Non-nil means show following heading when revealing a location.
714 Org-mode often shows locations in an org-mode file which might have
715 been invisible before. When this is set, the heading following the
716 match is shown.
717 Turning this off for example for sparse trees makes them very compact,
718 but makes it harder to edit the location of the match. In such a case,
720 Instead of t, this can also be an alist specifying this option for different
721 contexts. See `org-show-hierarchy-above' for valid contexts."
726 "Non-nil means show all sibling heading when revealing a location.
727 Org-mode often shows locations in an org-mode file which might have
728 been invisible before. When this is set, the sibling of the current entry
729 heading are all made visible. If `org-show-hierarchy-above' is t,
730 the same happens on each level of the hierarchy above the current entry.
732 By default this is on for the isearch context, off for all other contexts.
733 Turning this off for example for sparse trees makes them very compact,
734 but makes it harder to edit the location of the match. In such a case,
736 Instead of t, this can also be an alist specifying this option for different
737 contexts. See `org-show-hierarchy-above' for valid contexts."
742 "Non-nil means show the entry below a headline when revealing a location.
743 Org-mode often shows locations in an org-mode file which might have
744 been invisible before. When this is set, the text below the headline that is
745 exposed is also shown.
747 By default this is off for all contexts.
748 Instead of t, this can also be an alist specifying this option for different
749 contexts. See `org-show-hierarchy-above' for valid contexts."
754 "How should indirect tree buffers be displayed?
755 This applies to indirect buffers created with the commands
757 Valid values are:
758 current-window Display in the current window
759 other-window Just display in another window.
760 dedicated-frame Create one new frame, and re-use it each time.
761 new-frame Make a new frame each time. Note that in this case
762 previously-made indirect buffers are kept, and you need to
763 kill these buffers yourself."
773 "Non-nil means activate single letter commands at beginning of a headline.
774 This may also be a function to test for appropriate locations where speed
775 commands should be active."
783 "Alist of additional speed commands.
784 This list will be checked before `org-speed-commands-default'
785 when the variable `org-use-speed-commands' is non-nil
786 and when the cursor is at the beginning of a headline.
787 The car if each entry is a string with a single letter, which must
788 be assigned to `self-insert-command' in the global map.
789 The cdr is either a command to be called interactively, a function
790 to be called, or a form to be evaluated.
791 An entry that is just a list with a single string will be interpreted
792 as a descriptive headline that will be added when listing the speed
793 commands in the Help buffer using the `?' speed command."
805 "Options concerning visibility cycling in Org-mode."
810 "Non-nil means skip CHILDREN state in entries that don't have any."
815 "Maximum level which should still be subject to visibility cycling.
816 Levels higher than this will, for cycling, be treated as text, not a headline.
817 When `org-odd-levels-only' is set, a value of N in this variable actually
818 means 2N-1 stars as the limiting headline.
819 When nil, cycle all levels.
820 Note that the limiting level of cycling is also influenced by
821 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
822 `org-inlinetask-min-level' is, cycling will be limited to levels one less
823 than its value."
830 "Names of drawers. Drawers are not opened by cycling on the headline above.
831 Drawers only open with a TAB on the drawer line itself. A drawer looks like
832 this:
833 :DRAWERNAME:
834 .....
835 :END:
837 the property API.
839 Drawers can be defined on the per-file basis with a line like:
841 #+DRAWERS: HIDDEN STATE PROPERTIES"
847 "Non-nil means entering Org-mode will fold all blocks.
848 This can also be set in on a per-file basis with
850 #+STARTUP: hideblocks
851 #+STARTUP: showblocks"
857 "Cycle globally if cursor is at beginning of buffer and not at a headline.
858 This makes it possible to do global cycling without having to use S-TAB or
860 of the buffer
861 must not be a headline - it may be empty or some other text. When used in
862 this way, `org-cycle-hook' is disables temporarily, to make sure the
863 cursor stays at the beginning of the buffer.
864 When this option is nil, don't do anything special at the beginning
865 of the buffer."
870 "Non-nil means cycle entry level or item indentation in new empty entries.
872 When the cursor is at the end of an empty headline, i.e with only stars
873 and maybe a TODO keyword, TAB will then switch the entry to become a child,
874 and then all possible ancestor states, before returning to the original state.
875 This makes data entry extremely fast: M-RET to create a new headline,
876 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
878 When the cursor is at the end of an empty plain list item, one TAB will
879 make it a subitem, two or more tabs will back up to make this an item
880 higher up in the item hierarchy."
885 "Where should `org-cycle' emulate TAB.
886 nil Never
887 white Only in completely white lines
888 whitestart Only at the beginning of lines, before the first non-white char
889 t Everywhere except in headlines
890 exc-hl-bol Everywhere except at the start of a headline
891 If TAB is used in a place where it does not emulate TAB, the current subtree
892 visibility is cycled."
899 ))
902 "Number of empty lines needed to keep an empty line between collapsed trees.
903 If you leave an empty line between the end of a subtree and the following
904 headline, this empty line is hidden when the subtree is folded.
905 Org-mode will leave (exactly) one empty line visible if the number of
906 empty lines is equal or larger to the number given in this variable.
907 So the default 2 means at least 2 empty lines after the end of a subtree
908 are needed to produce free space between a collapsed subtree and the
909 following headline.
911 If the number is negative, and the number of empty lines is at least -N,
912 all empty lines are shown.
914 Special case: when 0, never leave empty lines in collapsed view."
920 "Hook that is run before visibility cycling is happening.
921 The function(s) in this hook must accept a single argument which indicates
922 the new state that will be set right after running this hook. The
923 argument is a symbol. Before a global state change, it can have the values
924 `overview', `content', or `all'. Before a local state change, it can have
925 the values `folded', `children', or `subtree'."
930 org-cycle-hide-drawers
931 org-cycle-show-empty-lines
932 org-optimize-window-after-visibility-change)
933 "Hook that is run after `org-cycle' has changed the buffer visibility.
934 The function(s) in this hook must accept a single argument which indicates
935 the new state that was set by the most recent `org-cycle' command. The
936 argument is a symbol. After a global state change, it can have the values
937 `overview', `content', or `all'. After a local state change, it can have
938 the values `folded', `children', or `subtree'."
943 "Options concerning structure editing in Org-mode."
948 "Non-nil means skip even levels and only use odd levels for the outline.
949 This has the effect that two stars are being added/taken away in
950 promotion/demotion commands. It also influences how levels are
951 handled by the exporters.
952 Changing it requires restart of `font-lock-mode' to become effective
953 for fontification also in regions already fontified.
954 You may also set this on a per-file basis by adding one of the following
955 lines to the buffer:
957 #+STARTUP: odd
958 #+STARTUP: oddeven"
964 "Non-nil means adapt indentation to outline node level.
966 When this variable is set, Org assumes that you write outlines by
967 indenting text in each node to align with the headline (after the stars).
968 The following issues are influenced by this variable:
970 - When this is set and the *entire* text in an entry is indented, the
971 indentation is increased by one space in a demotion command, and
972 decreased by one in a promotion command. If any line in the entry
973 body starts with text at column 0, indentation is not changed at all.
975 - Property drawers and planning information is inserted indented when
976 this variable s set. When nil, they will not be indented.
978 - TAB indents a line relative to context. The lines below a headline
979 will be indented when this variable is set.
981 Note that this is all about true indentation, by adding and removing
982 space characters. See also `org-indent.el' which does level-dependent
983 indentation in a virtual way, i.e. at display time in Emacs."
988 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
990 When t, `C-a' will bring back the cursor to the beginning of the
991 headline text, i.e. after the stars and after a possible TODO keyword.
992 In an item, this will be the position after the bullet.
993 When the cursor is already at that position, another `C-a' will bring
994 it to the beginning of the line.
996 `C-e' will jump to the end of the headline, ignoring the presence of tags
997 in the headline. A second `C-e' will then jump to the true end of the
998 line, after any tags. This also means that, when this variable is
999 non-nil, `C-e' also will never jump beyond the end of the heading of a
1000 folded section, i.e. not after the ellipses.
1002 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1003 going to the true line boundary first. Only a directly following, identical
1004 keypress will bring the cursor to the special positions.
1006 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1007 set separately."
1026 "Non-nil means `C-k' will behave specially in headlines.
1027 When nil, `C-k' will call the default `kill-line' command.
1028 When t, the following will happen while the cursor is in the headline:
1030 - When the cursor is at the beginning of a headline, kill the entire
1031 line and possible the folded subtree below the line.
1032 - When in the middle of the headline text, kill the headline up to the tags.
1033 - When after the headline text, kill the tags."
1038 "Non-nil means, do not delete a hidden subtree with C-k.
1039 When set to the symbol `error', simply throw an error when C-k is
1040 used to kill (part-of) a headline that has hidden text behind it.
1041 Any other non-nil value will result in a query to the user, if it is
1042 OK to kill that hidden subtree. When nil, kill without remorse."
1050 "Non-nil means when yanking subtrees, fold them.
1051 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1052 it starts with a heading and all other headings in it are either children
1053 or siblings, then fold all the subtrees. However, do this only if no
1054 text after the yank would be swallowed into a folded tree by this action."
1059 "Non-nil means when yanking subtrees, adjust the level.
1060 With this setting, `org-paste-subtree' is used to insert the subtree, see
1061 this function for details."
1066 "Non-nil means M-RET will split the line at the cursor position.
1067 When nil, it will go to the end of the line before making a
1068 new line.
1069 You may also set this option in a different way for different
1070 contexts. Valid contexts are:
1072 headline when creating a new headline
1073 item when creating a new item
1074 table in a table field
1075 default the value to be used for all contexts not explicitly
1076 customized"
1093 "Non-nil means insert new headings after the current subtree.
1094 When nil, the new heading is created directly after the current line.
1097 for the duration of the command."
1103 "Should `org-insert-heading' leave a blank line before new heading/item?
1104 The value is an alist, with `heading' and `plain-list-item' as CAR,
1105 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1106 which case Org will look at the surrounding headings/items and try to
1107 make an intelligent decision whether to insert a blank line or not.
1109 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1110 set, the setting here is ignored and no empty line is inserted, to avoid
1111 breaking the list structure."
1124 "Hook being run after inserting a new heading."
1130 This currently only means they are never auto-wrapped.
1131 When nil, such lines will be treated like ordinary lines.
1132 See also the QUOTE keyword."
1137 "Non-nil means typing characters in `org-goto' starts incremental search."
1142 "Options concerning sparse trees in Org-mode."
1147 "Non-nil means highlight all matches that define a sparse tree.
1148 The highlights will automatically disappear the next time the buffer is
1149 changed by an edit command."
1154 "Non-nil means any change to the buffer will remove temporary highlights.
1155 Such highlights are created by `org-occur' and `org-clock-display'.
1156 When nil, `C-c C-c needs to be used to get rid of the highlights.
1157 The highlights created by `org-preview-latex-fragment' always need
1158 `C-c C-c' to be removed."
1165 "Hook that is run after `org-occur' has constructed a sparse tree.
1166 This can be used to recenter the window to show as much of the structure
1167 as possible."
1172 "Options concerning imenu and speedbar in Org-mode."
1177 "The maximum level for Imenu access to Org-mode headlines.
1178 This also applied for speedbar access."
1183 "Options concerning tables in Org-mode."
1189 When nil, such lines will be treated like ordinary lines.
1191 When equal to the symbol `optimized', the table editor will be optimized to
1192 do the following:
1193 - Automatic overwrite mode in front of whitespace in table fields.
1194 This makes the structure of the table stay in tact as long as the edited
1195 field does not exceed the column width.
1196 - Minimize the number of realigns. Normally, the table is aligned each time
1197 TAB or RET are pressed to move to another field. With optimization this
1198 happens only if changes to a field might have changed the column width.
1199 Optimization requires replacing the functions `self-insert-command',
1200 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1201 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1202 very good at guessing when a re-align will be necessary, but you can always
1205 If you would like to use the optimized version in Org-mode, but the
1206 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1208 This variable can be used to turn on and off the table editor during a session,
1209 but in order to toggle optimization, a restart is required.
1211 See also the variable `org-table-auto-blank-field'."
1219 "Non-nil means cluster self-insert commands for undo when possible.
1220 If this is set, then, like in the Emacs command loop, 20 consecutive
1221 characters will be undone together.
1222 This is configurable, because there is some impact on typing performance."
1227 "Non-nil means TAB will automatically notice a table.el table.
1228 When it sees such a table, it moves point into it and - if necessary -
1229 calls `table-recognize-table'."
1234 "Options concerning links in Org-mode."
1239 "Buffer-local version of `org-link-abbrev-alist', which see.
1244 "Alist of link abbreviations.
1245 The car of each element is a string, to be replaced at the start of a link.
1247 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1249 [[linkkey:tag][description]]
1251 The 'linkkey' must be a word word, starting with a letter, followed
1252 by letters, numbers, '-' or '_'.
1254 If REPLACE is a string, the tag will simply be appended to create the link.
1257 be inserted at that point (see the function `url-hexify-string').
1259 REPLACE may also be a function that will be called with the tag as the
1260 only argument to create the link, which should be returned as a string.
1262 See the manual for examples."
1272 "Non-nil means Org will display descriptive links.
1273 E.g. [[http://orgmode.org][Org website]] will be displayed as
1275 description. When set to `nil', Org will display the full links
1276 literally.
1278 You can interactively set the value of this variable by calling
1279 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1284 "How the path name in file links should be stored.
1285 Valid values are:
1287 relative Relative to the current directory, i.e. the directory of the file
1288 into which the link is being inserted.
1289 absolute Absolute path, if possible with ~ for home directory.
1290 noabbrev Absolute path, no abbreviation of home directory.
1291 adaptive Use relative path for files in the current directory and sub-
1292 directories of it. For other files, use an absolute path."
1301 "Types of links that should be activated in Org-mode files.
1302 This is a list of symbols, each leading to the activation of a certain link
1303 type. In principle, it does not hurt to turn on most link types - there may
1304 be a small gain when turning off unused link types. The types are:
1306 bracket The recommended [[link][description]] or [[link]] links with hiding.
1307 angle Links in angular brackets that may contain whitespace like
1308 <bbdb:Carsten Dominik>.
1309 plain Plain links in normal text, no whitespace, like http://google.com.
1310 radio Text that is matched by a radio target, see manual for details.
1311 tag Tag settings in a headline (link to tag search).
1312 date Time stamps (link to calendar).
1313 footnote Footnote labels.
1315 Changing this variable requires a restart of Emacs to become effective."
1327 "Function to use to generate link descriptions from links.
1328 If nil the link location will be used. This function must take
1329 two parameters; the first is the link and the second the
1330 description `org-insert-link' has generated, and should return the
1331 description to use."
1336 "Options concerning storing links in Org-mode."
1341 "Format of the description part of a link to an email or usenet message.
1342 The following %-escapes will be replaced by corresponding information:
1350 %s subject
1351 %d date
1352 %m message-id.
1354 You may use normal field width specification between the % and the letter.
1355 This is for example useful to limit the length of the subject.
1369 It should match if the message is from the user him/herself."
1374 "Non-nil means storing a link to an Org file will use entry IDs.
1376 Note that before this variable is even considered, org-id must be loaded,
1377 so please customize `org-modules' and turn it on.
1379 The variable can have the following values:
1381 t Create an ID if needed to make a link to the current entry.
1383 create-if-interactive
1384 If `org-store-link' is called directly (interactively, as a user
1385 command), do create an ID to support the link. But when doing the
1386 job for remember, only use the ID if it already exists. The
1387 purpose of this setting is to avoid proliferation of unwanted
1388 IDs, just because you happen to be in an Org file when you
1389 call `org-remember' that automatically and preemptively
1390 creates a link. If you do want to get an ID link in a remember
1391 template to an entry not having an ID, create it first by
1392 explicitly creating a link to it, using `C-c C-l' first.
1394 create-if-interactive-and-no-custom-id
1395 Like create-if-interactive, but do not create an ID if there is
1396 a CUSTOM_ID property defined in the entry. This is the default.
1398 use-existing
1399 Use existing ID, do not create one.
1401 nil Never use an ID to make a link, instead link using a text search for
1402 the headline text."
1407 create-if-interactive)
1409 create-if-interactive-and-no-custom-id)
1414 "Non-nil means file links from `org-store-link' contain context.
1415 A search string will be added to the file name with :: as separator and
1416 used to find the context when the link is activated by the command
1417 `org-open-at-point'. When this option is t, the entire active region
1418 will be placed in the search string of the file link. If set to a
1419 positive integer, only the first n lines of context will be stored.
1422 negates this setting for the duration of the command."
1427 "Non-nil means keep link in list for entire session.
1429 The command `org-store-link' adds a link pointing to the current
1430 location to an internal list. These links accumulate during a session.
1431 The command `org-insert-link' can be used to insert links into any
1432 Org-mode file (offering completion for all stored links). When this
1434 will be removed from the list, to make completing the unused links
1435 more efficient."
1440 "Options concerning following links in Org-mode."
1445 "Function to translate links with different syntax to Org syntax.
1446 This can be used to translate links created for example by the Planner
1447 or emacs-wiki packages to Org syntax.
1448 The function must accept two parameters, a TYPE containing the link
1450 which is everything after the link protocol. It should return a cons
1451 with possibly modified values of type and path.
1452 Org contains a function for this, so if you set this variable to
1453 `org-translate-link-from-planner', you should be able follow many
1454 links created by planner."
1459 "Hook that is run after a link has been followed."
1464 "Non-nil means on links TAB will follow the link.
1465 Needs to be set before org.el is loaded.
1466 This really should not be used, it does not make sense, and the
1467 implementation is bad."
1472 "Non-nil means on links RET will follow the link."
1478 "Non-nil means mouse-1 on a link will follow the link.
1479 A longer mouse click will still set point. Does not work on XEmacs.
1480 Needs to be set before org.el is loaded."
1485 "Number of different positions to be recorded in the ring.
1486 Changing this requires a restart of Emacs to work correctly."
1491 "Non-nil means internal links in Org files must exactly match a headline.
1492 When nil, the link search tries to match a phrase with all words
1493 in the search text."
1499 query-to-create)))
1506 "Setup the frame configuration for following links.
1507 When following a link with Emacs, it may often be useful to display
1508 this link in another window or frame. This variable can be used to
1509 set this up for the different types of links.
1510 For VM, use any of
1511 `vm-visit-folder'
1512 `vm-visit-folder-other-window'
1513 `vm-visit-folder-other-frame'
1514 For Gnus, use any of
1515 `gnus'
1516 `gnus-other-frame'
1517 `org-gnus-no-new-news'
1518 For FILE, use any of
1519 `find-file'
1520 `find-file-other-window'
1521 `find-file-other-frame'
1522 For Wanderlust use any of
1523 `wl'
1524 `wl-other-frame'
1525 For the calendar, use the variable `calendar-setup'.
1526 For BBDB, it is currently only possible to display the matches in
1527 another window."
1551 "Non-nil means use indirect buffer to display infile links.
1552 Activating internal links (from one location in a file to another location
1553 in the same file) normally just jumps to the location. When the link is
1555 is displayed in
1556 another window. When this option is set, the other window actually displays
1557 an indirect buffer clone of the current buffer, to avoid any visibility
1558 changes to the current buffer."
1563 "Non-nil means `org-open-file' will open non-existing files.
1564 When nil, an error will be generated.
1565 This variable applies only to external applications because they
1566 might choke on non-existing files. If the link is to a file that
1567 will be opened in Emacs, the variable is ignored."
1572 "Non-nil means a link to a directory really means to index.org.
1573 When nil, following a directory link will run dired or open a finder/explorer
1574 window on that directory."
1579 "Function and arguments to call for following mailto links.
1580 This is a list with the first element being a Lisp function, and the
1581 remaining elements being arguments to the function. In string arguments,
1582 %a will be replaced by the address, and %s will be replaced by the subject
1583 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1592 "Non-nil means ask for confirmation before executing shell links.
1593 Shell links can be dangerous: just think about a link
1595 [[shell:rm -rf ~/*][Google Search]]
1598 but really it would remove your entire home directory.
1599 Therefore we advise against setting this variable to nil.
1600 Just change it to `y-or-n-p' if you want to confirm with a
1608 'safe-local-variable
1612 "A regexp to skip confirmation for shell links."
1617 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1618 Elisp links can be dangerous: just think about a link
1623 but really it would remove your entire home directory.
1624 Therefore we advise against setting this variable to nil.
1625 Just change it to `y-or-n-p' if you want to confirm with a
1633 'safe-local-variable
1637 "A regexp to skip confirmation for Elisp links."
1645 "Default file applications on a UNIX or GNU/Linux system.
1656 "Default file applications on a MacOS X system.
1658 for some files for which the OS does not have a good default.
1666 'mswindows-shell-execute
1671 'mswindows-shell-execute
1674 "Default file applications on a Windows NT system.
1679 '(
1684 )
1685 "External applications for opening `file:path' items in a document.
1686 Org-mode uses system defaults for different file types, but
1687 you can use this variable to set the application for a given file
1688 extension. The entries in this list are cons cells where the car identifies
1689 files and the cdr the corresponding command. Possible values for the
1690 file identifier are
1692 ways, depending on its contents:
1694 - Alphanumeric characters only:
1695 Match links with this file extension.
1697 to open PDFs with evince.
1699 - Regular expression: Match links where the
1700 filename matches the regexp. If you want to
1701 use groups here, use shy groups.
1705 to open *.html and *.xhtml with firefox.
1707 - Regular expression which contains (non-shy) groups:
1709 anything after that, matches the regexp.
1710 In a custom command string, %1, %2, etc. are replaced with
1711 the parts of the link that were matched by the groups.
1712 For backwards compatibility, if a command string is given
1713 that does not use any of the group matches, this case is
1714 handled identically to the second one (i.e. match against
1715 file name only).
1716 In a custom lisp form, you can access the group matches with
1717 (match-string n link).
1720 to open [[file:document.pdf::5]] with evince at page 5.
1722 `directory' Matches a directory
1723 `remote' Matches a remote file, accessible through tramp or efs.
1724 Remote files most likely should be visited through Emacs
1725 because external applications cannot handle such paths.
1726 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1727 so all files Emacs knows how to handle. Using this with
1728 command `emacs' will open most files in Emacs. Beware that this
1729 will also open html files inside Emacs, unless you add
1731 t Default for files not matched by any of the other options.
1732 `system' The system command to open files, like `open' on Windows
1733 and Mac OS X, and mailcap under GNU/Linux. This is the command
1734 that will be selected if you call `C-c C-o' with a double
1737 Possible values for the command are:
1738 `emacs' The file will be visited by the current Emacs process.
1739 `default' Use the default application for this file type, which is the
1740 association for t in the list, most likely in the system-specific
1741 part.
1742 This can be used to overrule an unwanted setting in the
1743 system-specific variable.
1745 This command is specified by the entry whose car is `system'.
1746 Most likely, the system-specific version of this variable
1747 does define this command, but you can overrule/replace it
1748 here.
1749 string A command to be executed by a shell; %s will be replaced
1750 by the path to the file.
1751 sexp A Lisp form which will be evaluated. The file path will
1752 be available in the Lisp variable `file'.
1753 For more examples, see the system specific constants
1754 `org-file-apps-defaults-macosx'
1755 `org-file-apps-defaults-windowsnt'
1756 `org-file-apps-defaults-gnu'."
1766 auto-mode))
1777 "Options concerning refiling entries in Org-mode."
1782 "Directory with org files.
1783 This is just a default location to look for Org files. There is no need
1784 at all to put your files into this directory. It is only used in the
1785 following situations:
1787 1. When a remember template specifies a target file that is not an
1788 absolute path. The path will then be interpreted relative to
1789 `org-directory'
1790 2. When a remember note is filed away in an interactive way (when exiting the
1791 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1792 with `org-directory' as the default path."
1798 "Default target for storing notes.
1799 Used as a fall back file for org-remember.el and org-capture.el, for
1800 templates that do not specify a target file."
1805 file))
1808 "The default interface to be used for `org-goto'.
1809 Allowed values are:
1810 outline The interface shows an outline of the relevant file
1811 and the correct heading is found by moving through
1812 the outline or by searching with incremental search.
1813 outline-path-completion Headlines in the current buffer are offered via
1814 completion. This is the interface also used by
1815 the refile command."
1822 "Maximum target level when running `org-goto' with refile interface."
1827 "Non-nil means store new notes at the beginning of a file or entry.
1828 When nil, new notes will be filed to the end of a file or entry.
1829 This can also be a list with cons cells of regular expressions that
1830 are matched against file names, and values."
1840 "Information to record when a task is refiled.
1842 Possible values are:
1844 nil Don't add anything
1845 time Add a time stamp to the task
1846 note Prompt for a note and add it with template `org-log-note-headings'
1848 This option can also be set with on a per-file-basis with
1850 #+STARTUP: nologrefile
1851 #+STARTUP: logrefile
1852 #+STARTUP: lognoterefile
1854 You can have local logging settings for a subtree by setting the LOGGING
1855 property to one or more of these keywords.
1857 When bulk-refiling from the agenda, the value `note' is forbidden and
1858 will temporarily be changed to `time'."
1868 This is a list of cons cells. Each cell contains:
1869 - a specification of the files to be considered, either a list of files,
1870 or a symbol whose function or variable value will be used to retrieve
1871 a file name or a list of file names. If you use `org-agenda-files' for
1872 that, all agenda files will be scanned for targets. Nil means consider
1873 headings in the current buffer.
1874 - A specification of how to find candidate refile targets. This may be
1875 any of:
1877 This tag has to be present in all target headlines, inheritance will
1878 not be considered.
1880 todo keyword.
1882 headlines that are refiling targets.
1883 - a cons cell (:level . N). Any headline of level N is considered a target.
1884 Note that, when `org-odd-levels-only' is set, level corresponds to
1885 order in hierarchy, not to the number of stars.
1886 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1887 Note that, when `org-odd-levels-only' is set, level corresponds to
1888 order in hierarchy, not to the number of stars.
1890 Each element of this list generates a set of possible targets.
1891 The union of these sets is presented (with completion) to
1892 the user by `org-refile'.
1894 You can set the variable `org-refile-target-verify-function' to a function
1895 to verify each headline found by the simple criteria above.
1897 When this variable is nil, all top-level headlines in the current buffer
1898 are used, equivalent to the value `((nil . (:level . 1))'."
1914 "Function to verify if the headline at point should be a refile target.
1915 The function will be called without arguments, with point at the
1916 beginning of the headline. It should return t and leave point
1917 where it is if the headline is a valid target for refiling.
1919 If the target should not be selected, the function must return nil.
1920 In addition to this, it may move point to a place from where the search
1921 should be continued. For example, the function may decide that the entire
1922 subtree of the current entry should be excluded and move point to the end
1923 of the subtree."
1928 "Non-nil means cache refile targets to speed up the process.
1929 The cache for a particular file will be updated automatically when
1930 the buffer has been killed, or when any of the marker used for flagging
1931 refile targets no longer points at a live buffer.
1932 If you have added new entries to a buffer that might themselves be targets,
1933 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1934 find that easier, `C-u C-u C-u C-c C-w'."
1939 "Non-nil means provide refile targets as paths.
1940 So a level 3 headline will be available as level1/level2/level3.
1942 When the value is `file', also include the file name (without directory)
1943 into the path. In this case, you can also stop the completion after
1944 the file name, to get entries inserted as top level in the file.
1946 When `full-file-path', include the full file path."
1955 "Non-nil means complete the outline path in hierarchical steps.
1956 When Org-mode uses the refile interface to select an outline path
1957 \(see variable `org-refile-use-outline-path'), the completion of
1958 the path can be done is a single go, or if can be done in steps down
1959 the headline hierarchy. Going in steps is probably the best if you
1960 do not use a special completion package like `ido' or `icicles'.
1961 However, when using these packages, going in one step can be very
1962 fast, while still showing the whole path to the entry."
1967 "Non-nil means allow to create new nodes as refile targets.
1969 of an existing node. When the value of this variable is `confirm',
1970 new node creation must be confirmed by the user (recommended)
1971 When nil, the completion must match an existing entry.
1973 Note that, if the new heading is not seen by the criteria
1974 listed in `org-refile-targets', multiple instances of the same
1975 heading would be created by trying again to file under the new
1976 heading."
1984 "Non-nil means also refile active region within a subtree.
1986 By default `org-refile' doesn't allow refiling regions if they
1987 don't contain a set of subtrees, but it might be convenient to
1988 do so sometimes: in that case, the first line of the region is
1989 converted to a headline before refiling."
1994 "Options concerning TODO items in Org-mode."
1999 "Options concerning Progress logging in Org-mode."
2006 "The available interpretation symbols for customizing `org-todo-keywords'.
2010 "List of TODO entry keyword sequences and their interpretation.
2013 Each sequence starts with a symbol, either `sequence' or `type',
2014 indicating if the keywords should be interpreted as a sequence of
2015 action steps, or as different types of TODO items. The first
2016 keywords are states requiring action - these states will select a headline
2017 for inclusion into the global TODO list Org-mode produces. If one of
2020 the last keyword is treated as the only DONE state of the sequence.
2023 additional state where no keyword is present. For details about this
2024 cycling, see the manual.
2026 TODO keywords and interpretation can also be set on a per-file basis with
2027 the special #+SEQ_TODO and #+TYP_TODO lines.
2029 Each keyword can optionally specify a character for fast state selection
2030 \(in combination with the variable `org-use-fast-todo-selection')
2031 and specifiers for state change logging, using the same syntax
2034 indicates to record a time stamp each time this state is selected.
2036 Each keyword may also specify if a timestamp or a note should be
2037 recorded when entering or leaving the state, by adding additional
2038 characters in the parenthesis after the keyword. This looks like this:
2040 record only the time of the state change. With X and Y being either
2042 Y when leaving the state if and only if the *target* state does not
2043 define X. You may omit any of the fast-selection key or X or /Y,
2044 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2046 For backward compatibility, this variable may also be just a list
2047 of keywords - in this case the interpretation (sequence or type) will be
2048 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2058 ;;Quick and dirty way to see
2059 ;;`org-todo-interpretations'. This takes the
2060 ;;place of item arguments
2061 :convert-widget
2068 org-todo-interpretation-widgets))
2069 widget))
2100 "Controls how TODO keywords are interpreted.
2101 This variable is in principle obsolete and is only used for
2102 backward compatibility, if the interpretation of todo keywords is
2103 not given already in `org-todo-keywords'. See that variable for
2104 more information."
2111 "Non-nil means use the fast todo selection scheme with C-c C-t.
2112 This variable describes if and under what circumstances the cycling
2113 mechanism for TODO keywords will be replaced by a single-key, direct
2114 selection scheme.
2116 When nil, fast selection is never used.
2118 When the symbol `prefix', it will be used when `org-todo' is called with
2119 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2120 in an agenda buffer.
2122 When t, fast selection is used by default. In this case, the prefix
2123 argument forces cycling instead.
2125 In all cases, the special interface is only used if access keys have actually
2126 been assigned by the user, i.e. if keywords in the configuration are followed
2127 by a letter in parenthesis, like TODO(t)."
2135 "Non-nil means update todo statistics after insert and toggle.
2136 ALL-HEADLINES means update todo statistics by including headlines
2137 with no TODO keyword as well, counting them as not done.
2138 A list of TODO keywords means the same, but skip keywords that are
2139 not in this list.
2141 When this is set, todo statistics is updated in the parent of the
2142 current entry each time a todo state is changed."
2152 "Non-nil means TODO statistics covers just direct children.
2153 When nil, all entries in the subtree are considered.
2154 This has only an effect if `org-provide-todo-statistics' is set.
2155 To set this to nil for only a single subtree, use a COOKIE_DATA
2161 "Hook which is run after the state of a TODO item was changed.
2162 The new state (a string with a TODO keyword, or nil) is available in the
2163 Lisp variable `state'."
2168 "Hook for functions that are allowed to block a state change.
2170 Each function gets as its single argument a property list, see
2171 `org-trigger-hook' for more information about this list.
2173 If any of the functions in this hook returns nil, the state change
2177 "Hook for functions that are triggered by a state change.
2179 Each function gets as its single argument a property list with at least
2180 the following elements:
2182 (:type type-of-change :position pos-at-entry-start
2183 :from old-state :to new-state)
2185 Depending on the type, more properties may be present.
2187 This mechanism is currently implemented for:
2189 TODO state changes
2190 ------------------
2191 :type todo-state-change
2192 :from previous state (keyword as a string), or nil, or a symbol
2193 'todo' or 'done', to indicate the general type of state.
2197 "Non-nil means undone TODO entries will block switching the parent to DONE.
2198 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2199 be blocked if any prior sibling is not yet done.
2200 Finally, if the parent is blocked because of ordered siblings of its own,
2201 the child will also be blocked.
2202 This variable needs to be set before org.el is loaded, and you need to
2203 restart Emacs after a change to make the change effective. The only way
2204 to change is while Emacs is running is through the customize interface."
2216 "Non-nil means unchecked boxes will block switching the parent to DONE.
2217 When this is nil, checkboxes have no influence on switching TODO states.
2218 When non-nil, you first need to check off all check boxes before the TODO
2219 entry can be switched to DONE.
2220 This variable needs to be set before org.el is loaded, and you need to
2221 restart Emacs after a change to make the change effective. The only way
2222 to change is while Emacs is running is through the customize interface."
2234 "Non-nil means inserting a TODO heading is treated as state change.
2236 logging will apply if appropriate. When nil, the new TODO item will
2237 be inserted directly, and no logging will take place."
2242 "Non-nil means switching TODO states with S-cursor counts as state change.
2243 This is the default behavior. However, setting this to nil allows a
2244 convenient way to select a TODO state and bypass any logging associated
2245 with that."
2250 "Tag changes that should be triggered by TODO state changes.
2251 This is a list. Each entry is
2253 (state-change (tag . flag) .......)
2255 State-change can be a string with a state, and empty string to indicate the
2256 state that has no TODO keyword, or it can be one of the symbols `todo'
2257 or `done', meaning any not-done or done state, respectively."
2271 "Information to record when a task moves to the DONE state.
2273 Possible values are:
2275 nil Don't add anything, just change the keyword
2276 time Add a time stamp to the task
2277 note Prompt for a note and add it with template `org-log-note-headings'
2279 This option can also be set with on a per-file-basis with
2281 #+STARTUP: nologdone
2282 #+STARTUP: logdone
2283 #+STARTUP: lognotedone
2285 You can have local logging settings for a subtree by setting the LOGGING
2286 property to one or more of these keywords."
2294 ;; Normalize old uses of org-log-done.
2301 "Information to record when the scheduling date of a tasks is modified.
2303 Possible values are:
2305 nil Don't add anything, just change the date
2306 time Add a time stamp to the task
2307 note Prompt for a note and add it with template `org-log-note-headings'
2309 This option can also be set with on a per-file-basis with
2311 #+STARTUP: nologreschedule
2312 #+STARTUP: logreschedule
2313 #+STARTUP: lognotereschedule"
2322 "Information to record when the deadline date of a tasks is modified.
2324 Possible values are:
2326 nil Don't add anything, just change the date
2327 time Add a time stamp to the task
2328 note Prompt for a note and add it with template `org-log-note-headings'
2330 This option can also be set with on a per-file-basis with
2332 #+STARTUP: nologredeadline
2333 #+STARTUP: logredeadline
2334 #+STARTUP: lognoteredeadline
2336 You can have local logging settings for a subtree by setting the LOGGING
2337 property to one or more of these keywords."
2346 "Non-nil means record a note when clocking out of an item.
2347 This can also be configured on a per-file basis by adding one of
2348 the following lines anywhere in the buffer:
2350 #+STARTUP: lognoteclock-out
2351 #+STARTUP: nolognoteclock-out"
2357 "Non-nil means the CLOSED time stamp will contain date and time.
2358 When nil, only the date will be recorded."
2372 "Headings for notes added to entries.
2373 The value is an alist, with the car being a symbol indicating the note
2374 context, and the cdr is the heading to be used. The heading may also be the
2375 empty string.
2376 %t in the heading will be replaced by a time stamp.
2377 %T will be an active time stamp instead the default inactive one
2378 %s will be replaced by the new TODO state, in double quotes.
2379 %S will be replaced by the old TODO state, in double quotes.
2380 %u will be replaced by the user name.
2381 %U will be replaced by the full user name.
2383 In fact, it is not a good idea to change the `state' entry, because
2384 agenda log mode depends on the format of these entries."
2390 "Heading when changing todo state (todo sequence only)"
2404 "Non-nil means insert state change notes and time stamps into a drawer.
2405 When nil, state changes notes will be inserted after the headline and
2406 any scheduling and clock lines, but not inside a drawer.
2408 The value of this variable should be the name of the drawer to use.
2409 LOGBOOK is proposed as the default drawer for this purpose, you can
2410 also set this to a string to define the drawer of your choice.
2414 If this variable is set, `org-log-state-notes-insert-after-drawers'
2415 will be ignored.
2417 You can set the property LOG_INTO_DRAWER to overrule this setting for
2418 a subtree."
2430 "Return the value of `org-log-into-drawer', but let properties overrule.
2431 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2432 used instead of the default value."
2440 "Non-nil means insert state change notes after any drawers in entry.
2441 Only the drawers that *immediately* follow the headline and the
2442 deadline/scheduled line are skipped.
2443 When nil, insert notes right after the heading and perhaps the line
2444 with deadline/scheduling if present.
2446 This variable will have no effect if `org-log-into-drawer' is
2447 set."
2453 "Non-nil means the latest state note will be directly after heading.
2454 When nil, the state change notes will be ordered according to time."
2460 "The TODO state to which a repeater should return the repeating task.
2461 By default this is the first task in a TODO sequence, or the previous state
2462 in a TODO_TYP set. But you can specify another task here.
2463 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2469 "Non-nil means record moving through the DONE state when triggering repeat.
2470 An auto-repeating task is immediately switched back to TODO when
2473 record a closing note, there will be no record of the task moving
2474 through DONE. This variable forces taking a note anyway.
2476 nil Don't force a record
2477 time Record a time stamp
2478 note Record a note
2480 This option can also be set with on a per-file-basis with
2482 #+STARTUP: logrepeat
2483 #+STARTUP: lognoterepeat
2484 #+STARTUP: nologrepeat
2486 You can have local logging settings for a subtree by setting the LOGGING
2487 property to one or more of these keywords."
2497 "Priorities in Org-mode."
2502 "Non-nil means priority commands are active.
2503 When nil, these commands will be disabled, so that you never accidentally
2504 set a priority."
2509 "The highest priority of TODO items. A character like ?A, ?B etc.
2510 Must have a smaller ASCII number than `org-lowest-priority'."
2515 "The lowest priority of TODO items. A character like ?A, ?B etc.
2516 Must have a larger ASCII number than `org-highest-priority'."
2521 "The default priority of TODO items.
2522 This is the priority an item gets if no explicit priority is given.
2523 When starting to cycle on an empty priority the first step in the cycle
2524 depends on `org-priority-start-cycle-with-default'. The resulting first
2525 step priority must not exceed the range from `org-highest-priority' to
2526 `org-lowest-priority' which means that `org-default-priority' has to be
2527 in this range exclusive or inclusive the range boundaries. Else the
2528 first step refuses to set the default and the second will fall back
2529 to (depending on the command used) the highest or lowest priority."
2534 "Non-nil means start with default priority when starting to cycle.
2535 When this is nil, the first step in the cycle will be (depending on the
2536 command used) one higher or lower than the default priority.
2537 See also `org-default-priority'."
2542 "Function to extract the priority from a string.
2543 The string is normally the headline. If this is nil Org computes the
2544 priority from the priority cookie like [#A] in the headline. It returns
2545 an integer, increasing by 1000 for each priority level.
2546 The user can set a different function here, which should take a string
2547 as an argument and return the numeric priority."
2552 "Options concerning time stamps and deadlines in Org-mode."
2557 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2558 When nil, these labeled time stamps are forces into the second line of an
2559 entry, just after the headline. When scheduling from the global TODO list,
2560 the time stamp will always be forced into the second line."
2565 "Formats for `format-time-string' which are used for time stamps.
2569 "Number of minutes to round time stamps to.
2570 These are two values, the first applies when first creating a time stamp.
2571 The second applies when changing it with the commands `S-up' and `S-down'.
2572 When changing the time stamp, this means that it will change in steps
2573 of N minutes, as given by the second value.
2575 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2576 numbers should be factors of 60, so for example 5, 10, 15.
2578 When this is larger than 1, you can still force an exact time stamp by using
2579 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2580 and by using a prefix arg to `S-up/down' to specify the exact number
2581 of minutes to shift."
2591 ;; Normalize old customizations of this variable.
2595 org-time-stamp-rounding-minutes)))
2598 "Non-nil means overlay custom formats over all time stamps.
2599 The formats are defined through the variable `org-time-stamp-custom-formats'.
2600 To turn this on on a per-file basis, insert anywhere in the file:
2601 #+STARTUP: customtime"
2609 "Custom formats for time stamps. See `format-time-string' for the syntax.
2610 These are overlayed over the default ISO format if the variable
2611 `org-display-custom-times' is set. Time like %H:%M should be at the
2612 end of the second format. The custom formats are also honored by export
2613 commands, if custom time display is turned on at the time of export."
2618 "Get the right format for a time string."
2623 f)))
2626 "The format string used when creating CLOCKSUM lines.
2627 This is also used when org-mode generates a time duration."
2633 org-mode generates a time duration."
2638 "The format string used when creating CLOCKSUM lines, or when
2639 org-mode generates a time duration."
2644 "No. of days before expiration during which a deadline becomes active.
2645 This variable governs the display in sparse trees and in the agenda.
2646 When 0 or negative, it means use this number (the absolute value of it)
2647 even if a deadline has a different individual lead time specified.
2649 Custom commands can set this variable in the options section."
2655 "Non-nil means assume future for incomplete date input from user.
2656 This affects the following situations:
2657 1. The user gives a month but not a year.
2660 2. The user gives a day, but no month.
2663 it will be considered as *this* month.
2665 If you set this variable to the symbol `time', then also the following
2666 will work:
2668 3. If the user gives a time, but no day. If the time is before now,
2669 to will be interpreted as tomorrow.
2671 Currently none of this works for ISO week specifications.
2673 When this option is nil, the current day, month and year will always be
2674 used as defaults.
2676 See also `org-agenda-jump-prefer-future'."
2684 "Should the agenda jump command prefer the future for incomplete dates?
2685 The default is to do the same as configured in `org-read-date-prefer-future'.
2686 But you can also set a deviating value here.
2687 This may t or nil, or the symbol `org-read-date-prefer-future'."
2692 org-read-date-prefer-future)
2697 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2699 Depending on the system Emacs is running on, certain dates cannot
2700 be represented with the type used internally to represent time.
2701 Dates between 1970-1-1 and 2038-1-1 can always be represented
2702 correctly. Some systems allow for earlier dates, some for later,
2703 some for both. One way to find out it to insert any date into an
2704 Org buffer, putting the cursor on the year and hitting S-up and
2705 S-down to test the range.
2707 When this variable is set to t, the date/time prompt will not let
2708 you specify dates outside the 1970-2037 range, so it is certain that
2709 these dates will work in whatever version of Emacs you are
2710 running, and also that you can move a file from one Emacs implementation
2711 to another. WHenever Org is forcing the year for you, it will display
2712 a message and beep.
2714 When this variable is nil, Org will check if the date is
2715 representable in the specific Emacs implementation you are using.
2716 If not, it will force a year, usually the current year, and beep
2717 to remind you. Currently this setting is not recommended because
2718 the likelihood that you will open your Org files in an Emacs that
2719 has limited date range is not negligible.
2721 A workaround for this problem is to use diary sexp dates for time
2722 stamps outside of this range."
2727 "Non-nil means display current interpretation of date prompt live.
2728 This display will be in an overlay, in the minibuffer."
2733 "Non-nil means pop up a calendar when prompting for a date.
2734 In the calendar, the date can be selected with mouse-1. However, the
2735 minibuffer will also be active, and you can simply enter the date as well.
2736 When nil, only the minibuffer will be available."
2744 "Hook to be used to set up keys for the date/time interface.
2745 Add key definitions to `minibuffer-local-map', which will be a temporary
2746 copy."
2751 "The hour when your day really ends. Must be an integer.
2752 This has influence for the following applications:
2754 the time given here, the day recognized as TODAY is actually yesterday.
2755 - When a date is read from the user and it is still before the time given
2756 here, the current date and time will be assumed to be yesterday, 23:59.
2757 Also, timestamps inserted in remember templates follow this rule.
2759 IMPORTANT: This is a feature whose implementation is and likely will
2760 remain incomplete. Really, it is only here because past midnight seems to
2761 be the favorite working time of John Wiegley :-)"
2766 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2767 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2769 23:59 of the previous day."
2774 "Non-nil means S-down will increase the time in a time stamp.
2775 When nil, S-up will increase."
2780 "Non-nil means make the calendar window follow timestamp changes.
2781 When a timestamp is modified and the calendar window is visible, it will be
2782 moved to the new date."
2787 "Options concerning tags in Org-mode."
2792 "List of tags allowed in Org-mode files.
2793 When this list is nil, Org-mode will base TAG input on what is already in the
2794 buffer.
2795 The value of this variable is an alist, the car of each entry must be a
2796 keyword as a string, the cdr may be a character that is used to select
2797 that tag through the fast-tag-selection interface.
2798 See the manual for details."
2813 "List of tags that will always appear in all Org-mode files.
2814 This is in addition to any in buffer settings or customizations
2815 of `org-tag-alist'.
2816 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2817 The value of this variable is an alist, the car of each entry must be a
2818 keyword as a string, the cdr may be a character that is used to select
2819 that tag through the fast-tag-selection interface.
2820 See the manual for details.
2821 To disable these tags on a per-file basis, insert anywhere in the file:
2822 #+STARTUP: noptag"
2833 "If non-nil, always offer completion for all tags of all agenda files.
2834 Instead of customizing this variable directly, you might want to
2835 set it locally for capture buffers, because there no list of
2836 tags in that file can be created dynamically (there are none).
2838 (add-hook 'org-capture-mode-hook
2839 (lambda ()
2840 (set (make-local-variable
2841 'org-complete-tags-always-offer-all-agenda-tags)
2842 t)))"
2847 "List of tags that can be inherited by all entries in the file.
2848 The tags will be inherited if the variable `org-use-tag-inheritance'
2849 says they should be.
2853 "Non-nil means use fast tag selection scheme.
2854 This is a special interface to select and deselect tags with single keys.
2855 When nil, fast selection is never used.
2856 When the symbol `auto', fast selection is used if and only if selection
2857 characters for tags have been configured, either through the variable
2858 `org-tag-alist' or through a #+TAGS line in the buffer.
2859 When t, fast selection is always used and selection keys are assigned
2860 automatically if necessary."
2868 "Non-nil means fast tag selection exits after first change.
2869 When nil, you have to press RET to exit it.
2870 During fast tag selection, you can toggle this flag with `C-c'.
2871 This variable can also have the value `expert'. In this case, the window
2872 displaying the tags menu is not even shown, until you press C-c again."
2880 "Non-nil means fast tags selection interface will also offer TODO states.
2884 "The column to which tags should be indented in a headline.
2885 If this number is positive, it specifies the column. If it is negative,
2886 it means that the tags should be flushright to that column. For example,
2887 -80 works well for a normal 80 character screen.
2888 When 0, place tags directly after headline text, with only one space in
2889 between."
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
4828 org-display-table 4
4831 org-ellipsis)))
4836 ;; tag faces set outside customize.... force initialization.
4838 ;; Calc embedded
4844 ;; Activate before-change-function
4848 ;; Check for running clock before killing a buffer
4850 ;; Paragraphs and auto-filling
4854 ;; Beginning/end of defun
4857 ;; Next error for sparse trees
4859 ;; Make sure dependence stuff works reliably, even for users who set it
4860 ;; too late :-(
4872 ;; Comment characters
4876 ;; Align options lines
4878 'align-mode-rules-list
4883 ;; Imenu
4887 ;; Make isearch reveal context
4890 ;; Emacs 21 and XEmacs make use of the hook
4892 ;; Emacs 22 deals with this through a special variable
4896 ;; Turn on org-beamer-mode?
4899 ;; Setup the pcomplete hooks
4912 ;; If empty file that did not turn on org-mode automatically, make it to.
4937 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4947 "Return today date, considering `org-extend-today-until'."
4952 ;;;; Font-Lock stuff, including the activators
4983 "Regular expression used to analyze links.
4984 Here is what the match groups contain after a match:
4985 1: http:
4986 2: http
4987 3: path
4988 4: [desc]
4996 "Number of stacked braces for sub/superscript matching.
4997 This has to be set before loading org.el to be effective."
5002 "Create a regular expression which will match a balanced sexp.
5003 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5004 as single character strings.
5005 The regexp returned will match the entire expression including the
5006 delimiters. It will also define a single group which contains the
5007 match except for the outermost delimiters. The maximum depth of
5008 stacked delimiters is N. Escaping delimiters is not possible."
5037 "Update the link regular expressions.
5038 This should be called after the variable `org-link-types' has changed."
5042 org-link-re-with-space
5048 org-link-re-with-space2
5054 org-link-re-with-space3
5059 org-angle-link-re
5065 org-plain-link-re
5069 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5070 org-bracket-link-regexp
5072 org-bracket-link-analytic-regexp
5080 org-bracket-link-analytic-regexp++
5088 org-any-link-re
5097 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5099 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5100 "Regular expression matching time strings for analysis.
5101 This one does not require the space after the date, so it can be used
5103 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5119 "Regular expression matching a time stamp or time stamp range.
5125 "Run through the buffer and add overlays to emphasised strings."
5134 'face
5147 rtn))
5150 "Insert or change an emphasis, i.e. a font like bold or italic.
5151 If there is an active region, change that region to a new emphasis.
5152 If there is no region, just insert the marker characters and position
5153 the cursor between them.
5154 CHAR should be either the marker character, or the first character of the
5155 HTML tag associated with that emphasis. If CHAR is a space, the means
5156 to remove the emphasis of the selected region.
5157 If char is not given (for example in an interactive call) it
5158 will be prompted for."
5209 "Run through the buffer and add overlays to links."
5218 nil
5224 t)))))
5232 t)))
5235 "When non-nil, fontify code in code blocks."
5246 "Fontify #+ lines and blocks, in the correct ways."
5249 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5250 limit t)
5258 end end1 quoting block-type ovl)
5261 ;; a single line of backend-specific content
5269 ; for backend-specific code
5270 t)
5272 ;; Truly a block
5284 beg end
5292 ;; remove old background overlays
5297 ;; add a background overlay
5311 t))
5324 ;; just any other in-buffer setting, but not indented
5328 t)
5337 t)
5345 "Run through the buffer and add overlays to links."
5353 t)))
5356 "Run through the buffer and add overlays to footnotes."
5363 'keymap org-mouse-map
5364 'help-echo
5366 "Footnote definition"
5368 'font-lock-fontified t
5369 'font-lock-multiline t
5373 "Run through the buffer and add overlays to bracketed links."
5377 ;; FIXME: above we should remove the escapes.
5378 ;; but that requires another match, protecting match data,
5379 ;; a lot of overhead for font-lock.
5386 ;; We need to remove the invisible property here. Table narrowing
5387 ;; may have made some of this invisible.
5405 t)))
5408 "Run through the buffer and add overlays to dates."
5420 t)))
5429 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5433 "Run through the buffer and add overlays to target matches."
5441 'keymap org-mouse-map
5445 t)))))
5448 "Find all radio targets in this file and update the regular expression."
5463 t)))
5470 ;; This should be with the exporter code, but we also use if for font-locking
5480 "Compute regular expression for stuff treated specially by exporters."
5487 org-latex-regexps)))
5515 org-entities)))
5519 org-latex-entities)
5520 nil))
5522 ))
5523 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5526 org-export-html-special-string-regexps)))
5531 ))))
5533 'org-latex-and-specials-regexp
5538 "Run through the buffer and add overlays to links."
5542 limit t))
5556 rtn)))
5559 "Restart `font-lock-mode', to force refontification."
5565 "Return a list of all targets in this file.
5566 With optional argument RADIO, only find radio targets."
5568 rtn)
5573 rtn)))
5576 "Make regular expression matching all strings in TARGETS.
5577 The regular expression finds the targets also if there is a line break
5578 between words."
5587 x)
5588 targets
5600 t)))
5603 "Compute the outline level of the heading at point.
5604 This function assumes that the cursor is at the beginning of a line matched
5605 by `outline-regexp'. Otherwise it returns garbage.
5606 If this is called at a normal headline, the level is the number of stars.
5607 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5614 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5621 "Functions that can manipulate `org-font-lock-extra-keywords'.
5622 This is calles after `org-font-lock-extra-keywords' is defined, but before
5623 it is installed to be used by font lock. This can be useful if something
5634 ;; Call the hook
5636 ;; Headlines
5643 ;; Table lines
5646 ;; Table internals
5651 ;; Drawers
5654 ;; Properties
5658 ;; Links
5668 ;; TODO lines
5671 ;; DONE
5677 nil)
5678 ;; Priorities
5680 ;; Tags
5682 ;; Special keywords
5687 ;; Emphasis
5692 ;; Checkboxes
5693 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5698 ;; Description list items
5701 ;; ARCHIVEd headings
5703 org-outline-regexp-bol
5706 ;; Specials
5710 ;; Code
5712 ;; COMMENT
5717 ;; Blocks and meta lines
5719 )))
5722 ;; Now set the full font-lock-keywords
5729 "Toggle the composition display of entities as UTF8 characters."
5741 "Find an entity to fontify."
5747 limit t)
5759 nil))))
5762 "Fontify string S like in Org-mode."
5774 "Get the right face for match N in font-lock matching of headlines."
5787 "Get the right face for a TODO keyword KWD.
5788 If KWD is a number, get the corresponding match group."
5796 "Create a face list that inherits INHERIT, but sets the foreground color.
5797 When FACE-OR-COLOR is not a string, just return it."
5801 face-or-color)
5802 face-or-color))
5805 "Add the special tag faces."
5814 "Add the special priority faces."
5821 org-priority-faces)))
5826 "Get the right face for a TODO keyword KWD.
5827 If KWD is a number, get the corresponding match group."
5834 "Remove fontification and activation overlays from links."
5839 deactivate-mark buffer-file-name buffer-file-truename)
5843 invisible t intangible t
5844 org-no-flyspell t org-emphasis t))
5854 "Remove specific display properties that have been added by font lock.
5855 The will remove the raise properties that are used to show superscripts
5856 and subscripts."
5866 "Add raise properties to sub/superscripts."
5870 org-match-substring-regexp
5871 org-match-substring-with-braces-regexp)
5872 limit t)
5882 ;; FIXME: Should we go back one character here, for a_b^c
5883 ;; (goto-char (1- pos)) ;????????????????????
5885 t
5887 'display
5903 t)))))
5905 ;;;; Visibility cycling, including org-goto and indirect buffer
5907 ;;; Cycling
5914 ;;;###autoload
5919 "TAB-action and visibility cycling for Org-mode.
5921 This is the command invoked in Org-mode by the TAB key. Its main purpose
5922 is outline visibility cycling, but it also invokes other actions
5923 in special contexts.
5925 - When this function is called with a prefix argument, rotate the entire
5926 buffer through 3 states (global cycling)
5927 1. OVERVIEW: Show only top-level headlines.
5928 2. CONTENTS: Show all headlines of all levels, but no body text.
5929 3. SHOW ALL: Show everything.
5930 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5931 determined by the variable `org-startup-folded', and by any VISIBILITY
5932 properties in the buffer.
5933 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5934 including any drawers.
5936 - When inside a table, re-align the table and move to the next field.
5938 - When point is at the beginning of a headline, rotate the subtree started
5939 by this line through 3 different states (local cycling)
5940 1. FOLDED: Only the main headline is shown.
5941 2. CHILDREN: The main headline and the direct children are shown.
5942 From this state, you can move to one of the children
5943 and zoom in further.
5944 3. SUBTREE: Show the entire subtree, including body text.
5945 If there is no subtree, switch directly from CHILDREN to FOLDED.
5947 - When point is at the beginning of an empty headline and the variable
5948 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5949 of the headline by demoting and promoting it to likely levels. This
5950 speeds up creation document structure by pressing TAB once or several
5951 times right after creating a new headline.
5953 - When there is a numeric prefix, go up to a heading with level ARG, do
5954 a `show-subtree' and return to the previous cursor position. If ARG
5955 is negative, go up that many levels.
5957 - When point is not at the beginning of a headline, execute the global
5958 binding for TAB, which is re-indenting the line. See the option
5959 `org-cycle-emulate-tab' for details.
5961 - Special case: if point is at the beginning of the buffer and there is
5962 no headline in line 1, this function will act as if called with prefix arg
5963 (C-u TAB, same as S-TAB) also when called without prefix arg.
5964 But only if also the variable `org-cycle-global-at-bob' is t."
5974 org-inlinetask-min-level
5979 limit-level)))
5982 outline-regexp
5990 org-cycle-hook))
5994 ;; special case: use global cycling
6008 ;; Table: enter it or move to the next field.
6019 ;; Global cycling: delegate to `org-cycle-internal-global'.
6022 ;; Drawers: delegate to `org-flag-drawer'.
6030 ;; Show-subtree, ARG levels up from here.
6038 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6044 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6051 ;; From there: TAB emulation and template completion.
6075 t
6084 "Do the global cycling action."
6088 ;; We just created the overview - now do table of contents
6089 ;; This can be slow in very large buffers, so indicate action
6099 ;; We just showed the table of contents - now show everything
6107 ;; Default action: go to overview
6115 "Do the local cycling action."
6117 ;; First, determine end of headline (EOH), end of subtree or item
6118 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6142 ;; Determine end invisible part of buffer (EOL)
6144 ;; XEmacs doesn't have `next-single-char-property-change'
6154 ;; Find out what to do next and set `this-command'
6157 ;; Nothing is hidden behind this heading
6169 org-cycle-skip-children-state-if-no-children))))
6170 ;; Entire subtree is hidden in one line: children view
6176 ;; Fold every list in subtree to top-level items.
6198 ;; We just showed the children, or no children are there,
6199 ;; now show everything.
6206 ;; Default action: hide the subtree.
6213 ;;;###autoload
6215 "Cycle the global visibility. For details see `org-cycle'.
6217 With a numeric prefix, show all headlines up to that level."
6233 "Set the visibility required by startup options and properties."
6248 "Switch subtree visibilities according to :VISIBILITY: property."
6255 nil t)
6279 ;; This function uses outline-regexp instead of the more fundamental
6280 ;; org-outline-regexp so that org-cycle-global works outside of Org
6281 ;; buffers, where outline-regexp is needed.
6283 "Switch to overview mode, showing only top-level headlines.
6284 Really, this shows all headlines with level equal or greater than the level
6285 of the first headline in the buffer. This is important, because if the
6286 first headline is not level one, then (hide-sublevels 1) gives confusing
6287 results."
6298 "Show all headlines in the buffer, like a table of contents.
6299 With numerical argument N, show content up to level N."
6302 ;; Visit all headings and show their offspring
6309 t)
6318 "Adjust the window after a change in outline visibility.
6319 This function is the default value of the hook `org-cycle-hook'."
6329 "Remove outline overlays that do not contain non-white stuff."
6339 "Fix visibility issues after moving a subtree."
6340 ;; First, find a reasonable region to look at:
6341 ;; Start two siblings above, end three below
6359 ;; Properly fold already folded siblings
6370 "Show empty lines above all visible headlines.
6371 The region to be covered depends on STATE when called through
6372 `org-cycle-hook'. Lisp program can use t for STATE to get the
6373 entire buffer covered. Note that an empty line is only shown if there
6374 are at least `org-cycle-separator-lines' empty lines before the headline."
6384 beg end b e)
6408 ;; Never hide empty lines at the end of the file.
6418 "Move to the parent and re-show empty lines before visible headlines."
6424 "Return `org-agenda-files' list, plus all open org-mode files.
6425 This is useful for operations that need to scan all of a user's
6426 open and agenda-wise Org files."
6434 files))
6437 "Return the beginning position of the current entry."
6441 "Return the end position of the current entry."
6445 "Re-hide all drawers after a visibility state change."
6471 "Is the end of the current subtree visible?"
6476 "Move cursor to the first headline and recenter the headline.
6477 Optional argument N means put the headline into the Nth line of the window."
6483 ;;; Saving and restoring visibility
6486 "Return a list of the locations of all outline overlays.
6487 These are overlays with the `invisible' property value `outline'.
6488 The return value is a list of cons cells, with start and stop
6489 positions for each overlay.
6490 If USE-MARKERS is set, return the positions as markers."
6508 "Create visibility overlays for all positions in DATA.
6509 DATA should have been made by `org-outline-overlay-data'."
6518 data)))))
6520 ;;; Folding of blocks
6531 "Call FUNCTION at the head of all source blocks in the current buffer.
6532 Optional arguments START and END can be used to limit the range."
6544 "Toggle the visibility of all blocks in the current buffer."
6548 "Fold all blocks in the current buffer."
6554 "Unfold all blocks in the current buffer."
6560 "Toggle visibility of block at point."
6571 "Toggle the visibility of the current block."
6578 ov)
6594 ;; make the block accessible to isearch
6596 ov 'isearch-open-invisible
6607 ;; org-tab-after-check-for-cycling-hook
6609 ;; Remove overlays when changing major mode
6614 ;;; Org-goto
6620 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6636 nil)
6637 (org-defkey map "q" 'org-goto-quit)
6638 (org-defkey map "n" 'outline-next-visible-heading)
6639 (org-defkey map "p" 'outline-previous-visible-heading)
6640 (org-defkey map "f" 'outline-forward-same-level)
6641 (org-defkey map "b" 'outline-backward-same-level)
6642 (org-defkey map "u" 'outline-up-heading))
6643 (org-defkey map "/" 'org-occur)
6644 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6645 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6646 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6647 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6648 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6649 map))
6651 (defconst org-goto-help
6652 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6653 RET=jump to location [Q]uit and return to previous location
6654 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6656 (defvar org-goto-start-pos) ; dynamically scoped parameter
6658 ;; FIXME: Docstring does not mention both interfaces
6659 (defun org-goto (&optional alternative-interface)
6660 "Look up a different location in the current file, keeping current visibility.
6662 When you want look-up or go to a different location in a document, the
6663 fastest way is often to fold the entire buffer and then dive into the tree.
6664 This method has the disadvantage, that the previous location will be folded,
6665 which may not be what you want.
6667 This command works around this by showing a copy of the current buffer
6668 in an indirect buffer, in overview mode. You can dive into the tree in
6669 that copy, use org-occur and incremental search to find a location.
6670 When pressing RET or `Q', the command returns to the original buffer in
6671 which the visibility is still unchanged. After RET is will also jump to
6672 the location selected in the indirect buffer and expose the headline
6673 hierarchy above."
6674 (interactive "P")
6675 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6676 (org-refile-use-outline-path t)
6677 (org-refile-target-verify-function nil)
6678 (interface
6679 (if (not alternative-interface)
6680 org-goto-interface
6681 (if (eq org-goto-interface 'outline)
6682 'outline-path-completion
6683 'outline)))
6684 (org-goto-start-pos (point))
6685 (selected-point
6686 (if (eq interface 'outline)
6687 (car (org-get-location (current-buffer) org-goto-help))
6688 (let ((pa (org-refile-get-location "Goto")))
6689 (org-refile-check-position pa)
6690 (nth 3 pa)))))
6691 (if selected-point
6692 (progn
6693 (org-mark-ring-push org-goto-start-pos)
6694 (goto-char selected-point)
6695 (if (or (outline-invisible-p) (org-invisible-p2))
6696 (org-show-context 'org-goto)))
6697 (message "Quit"))))
6699 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6700 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6701 (defvar org-goto-local-auto-isearch-map) ; defined below
6703 (defun org-get-location (buf help)
6704 "Let the user select a location in the Org-mode buffer BUF.
6705 This function uses a recursive edit. It returns the selected position
6706 or nil."
6707 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6708 (isearch-hide-immediately nil)
6709 (isearch-search-fun-function
6710 (lambda () 'org-goto-local-search-headings))
6711 (org-goto-selected-point org-goto-exit-command)
6712 (pop-up-frames nil)
6713 (special-display-buffer-names nil)
6714 (special-display-regexps nil)
6715 (special-display-function nil))
6716 (save-excursion
6717 (save-window-excursion
6718 (delete-other-windows)
6719 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6720 (org-pop-to-buffer-same-window
6721 (condition-case nil
6722 (make-indirect-buffer (current-buffer) "*org-goto*")
6723 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6724 (with-output-to-temp-buffer "*Help*"
6725 (princ help))
6726 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6727 (setq buffer-read-only nil)
6728 (let ((org-startup-truncated t)
6729 (org-startup-folded nil)
6730 (org-startup-align-all-tables nil))
6731 (org-mode)
6732 (org-overview))
6733 (setq buffer-read-only t)
6734 (if (and (boundp 'org-goto-start-pos)
6735 (integer-or-marker-p org-goto-start-pos))
6736 (let ((org-show-hierarchy-above t)
6737 (org-show-siblings t)
6738 (org-show-following-heading t))
6739 (goto-char org-goto-start-pos)
6740 (and (outline-invisible-p) (org-show-context)))
6741 (goto-char (point-min)))
6742 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6743 (message "Select location and press RET")
6744 (use-local-map org-goto-map)
6745 (recursive-edit)
6746 ))
6747 (kill-buffer "*org-goto*")
6748 (cons org-goto-selected-point org-goto-exit-command)))
6750 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6751 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6752 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6753 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6755 (defun org-goto-local-search-headings (string bound noerror)
6756 "Search and make sure that any matches are in headlines."
6757 (catch 'return
6758 (while (if isearch-forward
6759 (search-forward string bound noerror)
6760 (search-backward string bound noerror))
6761 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6762 (and (member :headline context)
6763 (not (member :tags context))))
6764 (throw 'return (point))))))
6766 (defun org-goto-local-auto-isearch ()
6767 "Start isearch."
6768 (interactive)
6769 (goto-char (point-min))
6770 (let ((keys (this-command-keys)))
6771 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6772 (isearch-mode t)
6773 (isearch-process-search-char (string-to-char keys)))))
6775 (defun org-goto-ret (&optional arg)
6776 "Finish `org-goto' by going to the new location."
6777 (interactive "P")
6778 (setq org-goto-selected-point (point)
6779 org-goto-exit-command 'return)
6780 (throw 'exit nil))
6782 (defun org-goto-left ()
6783 "Finish `org-goto' by going to the new location."
6784 (interactive)
6785 (if (org-on-heading-p)
6786 (progn
6787 (beginning-of-line 1)
6788 (setq org-goto-selected-point (point)
6789 org-goto-exit-command 'left)
6790 (throw 'exit nil))
6791 (error "Not on a heading")))
6793 (defun org-goto-right ()
6794 "Finish `org-goto' by going to the new location."
6795 (interactive)
6796 (if (org-on-heading-p)
6797 (progn
6798 (setq org-goto-selected-point (point)
6799 org-goto-exit-command 'right)
6800 (throw 'exit nil))
6801 (error "Not on a heading")))
6803 (defun org-goto-quit ()
6804 "Finish `org-goto' without cursor motion."
6805 (interactive)
6806 (setq org-goto-selected-point nil)
6807 (setq org-goto-exit-command 'quit)
6808 (throw 'exit nil))
6810 ;;; Indirect buffer display of subtrees
6812 (defvar org-indirect-dedicated-frame nil
6813 "This is the frame being used for indirect tree display.")
6814 (defvar org-last-indirect-buffer nil)
6816 (defun org-tree-to-indirect-buffer (&optional arg)
6817 "Create indirect buffer and narrow it to current subtree.
6818 With numerical prefix ARG, go up to this level and then take that tree.
6819 If ARG is negative, go up that many levels.
6820 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6821 indirect buffer previously made with this command, to avoid proliferation of
6822 indirect buffers. However, when you call the command with a \
6824 when `org-indirect-buffer-display' is `new-frame', the last buffer
6825 is kept so that you can work with several indirect buffers at the same time.
6826 If `org-indirect-buffer-display' is `dedicated-frame', the \
6828 requests that a new frame be made for the new buffer, so that the dedicated
6829 frame is not changed."
6830 (interactive "P")
6831 (let ((cbuf (current-buffer))
6832 (cwin (selected-window))
6833 (pos (point))
6834 beg end level heading ibuf)
6835 (save-excursion
6836 (org-back-to-heading t)
6837 (when (numberp arg)
6838 (setq level (org-outline-level))
6839 (if (< arg 0) (setq arg (+ level arg)))
6840 (while (> (setq level (org-outline-level)) arg)
6841 (outline-up-heading 1 t)))
6842 (setq beg (point)
6843 heading (org-get-heading))
6844 (org-end-of-subtree t t)
6845 (if (org-on-heading-p) (backward-char 1))
6846 (setq end (point)))
6847 (if (and (buffer-live-p org-last-indirect-buffer)
6848 (not (eq org-indirect-buffer-display 'new-frame))
6849 (not arg))
6850 (kill-buffer org-last-indirect-buffer))
6851 (setq ibuf (org-get-indirect-buffer cbuf)
6852 org-last-indirect-buffer ibuf)
6853 (cond
6854 ((or (eq org-indirect-buffer-display 'new-frame)
6855 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6856 (select-frame (make-frame))
6857 (delete-other-windows)
6858 (org-pop-to-buffer-same-window ibuf)
6859 (org-set-frame-title heading))
6860 ((eq org-indirect-buffer-display 'dedicated-frame)
6861 (raise-frame
6862 (select-frame (or (and org-indirect-dedicated-frame
6863 (frame-live-p org-indirect-dedicated-frame)
6864 org-indirect-dedicated-frame)
6865 (setq org-indirect-dedicated-frame (make-frame)))))
6866 (delete-other-windows)
6867 (org-pop-to-buffer-same-window ibuf)
6868 (org-set-frame-title (concat "Indirect: " heading)))
6869 ((eq org-indirect-buffer-display 'current-window)
6870 (org-pop-to-buffer-same-window ibuf))
6871 ((eq org-indirect-buffer-display 'other-window)
6872 (pop-to-buffer ibuf))
6873 (t (error "Invalid value")))
6874 (if (featurep 'xemacs)
6875 (save-excursion (org-mode) (turn-on-font-lock)))
6876 (narrow-to-region beg end)
6877 (show-all)
6878 (goto-char pos)
6879 (run-hook-with-args 'org-cycle-hook 'all)
6880 (and (window-live-p cwin) (select-window cwin))))
6882 (defun org-get-indirect-buffer (&optional buffer)
6883 (setq buffer (or buffer (current-buffer)))
6884 (let ((n 1) (base (buffer-name buffer)) bname)
6885 (while (buffer-live-p
6886 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6887 (setq n (1+ n)))
6888 (condition-case nil
6889 (make-indirect-buffer buffer bname 'clone)
6890 (error (make-indirect-buffer buffer bname)))))
6892 (defun org-set-frame-title (title)
6893 "Set the title of the current frame to the string TITLE."
6894 ;; FIXME: how to name a single frame in XEmacs???
6895 (unless (featurep 'xemacs)
6896 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6898 ;;;; Structure editing
6900 ;;; Inserting headlines
6902 (defun org-previous-line-empty-p ()
6903 (save-excursion
6904 (and (not (bobp))
6905 (or (beginning-of-line 0) t)
6906 (save-match-data
6909 (defun org-insert-heading (&optional force-heading invisible-ok)
6910 "Insert a new heading or item with same depth at point.
6911 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6912 If point is at the beginning of a headline, insert a sibling before the
6913 current headline. If point is not at the beginning, split the line,
6914 create the new headline with the text in the current line after point
6915 \(but see also the variable `org-M-RET-may-split-line').
6917 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6918 This is important for non-interactive uses of the command."
6919 (interactive "P")
6920 (if (or (= (buffer-size) 0)
6921 (and (not (save-excursion
6922 (and (ignore-errors (org-back-to-heading invisible-ok))
6923 (org-on-heading-p))))
6924 (or force-heading (not (org-in-item-p)))))
6925 (progn
6927 (run-hooks 'org-insert-heading-hook))
6928 (when (or force-heading (not (org-insert-item)))
6929 (let* ((empty-line-p nil)
6930 (level nil)
6931 (on-heading (org-on-heading-p))
6932 (head (save-excursion
6933 (condition-case nil
6934 (progn
6935 (org-back-to-heading invisible-ok)
6936 (when (and (not on-heading)
6937 (featurep 'org-inlinetask)
6938 (integerp org-inlinetask-min-level)
6939 (>= (length (match-string 0))
6940 org-inlinetask-min-level))
6941 ;; Find a heading level before the inline task
6942 (while (and (setq level (org-up-heading-safe))
6943 (>= level org-inlinetask-min-level)))
6944 (if (org-on-heading-p)
6945 (org-back-to-heading invisible-ok)
6946 (error "This should not happen")))
6947 (setq empty-line-p (org-previous-line-empty-p))
6948 (match-string 0))
6949 (error "*"))))
6950 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6951 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6952 pos hide-previous previous-pos)
6953 (cond
6954 ((and (org-on-heading-p) (bolp)
6955 (or (bobp)
6956 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6957 ;; insert before the current line
6958 (open-line (if blank 2 1)))
6959 ((and (bolp)
6960 (not org-insert-heading-respect-content)
6961 (or (bobp)
6962 (save-excursion
6963 (backward-char 1) (not (outline-invisible-p)))))
6964 ;; insert right here
6965 nil)
6966 (t
6967 ;; somewhere in the line
6968 (save-excursion
6969 (setq previous-pos (point-at-bol))
6970 (end-of-line)
6971 (setq hide-previous (outline-invisible-p)))
6972 (and org-insert-heading-respect-content (org-show-subtree))
6973 (let ((split
6974 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6975 (save-excursion
6976 (let ((p (point)))
6977 (goto-char (point-at-bol))
6978 (and (looking-at org-complex-heading-regexp)
6979 (> p (match-beginning 4)))))))
6980 tags pos)
6981 (cond
6982 (org-insert-heading-respect-content
6983 (org-end-of-subtree nil t)
6984 (when (featurep 'org-inlinetask)
6985 (while (and (not (eobp))
6987 (>= (length (match-string 1))
6988 org-inlinetask-min-level))
6989 (org-end-of-subtree nil t)))
6990 (or (bolp) (newline))
6991 (or (org-previous-line-empty-p)
6992 (and blank (newline)))
6993 (open-line 1))
6994 ((org-on-heading-p)
6995 (when hide-previous
6996 (show-children)
6997 (org-show-entry))
6999 (setq tags (and (match-end 2) (match-string 2)))
7000 (and (match-end 1)
7001 (delete-region (match-beginning 1) (match-end 1)))
7002 (setq pos (point-at-bol))
7003 (or split (end-of-line 1))
7004 (delete-horizontal-space)
7006 (buffer-substring (point-at-bol) (point)))
7007 (insert " "))
7008 (newline (if blank 2 1))
7009 (when tags
7010 (save-excursion
7011 (goto-char pos)
7012 (end-of-line 1)
7013 (insert " " tags)
7014 (org-set-tags nil 'align))))
7015 (t
7016 (or split (end-of-line 1))
7017 (newline (if blank 2 1)))))))
7018 (insert head) (just-one-space)
7019 (setq pos (point))
7020 (end-of-line 1)
7021 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7022 (when (and org-insert-heading-respect-content hide-previous)
7023 (save-excursion
7024 (goto-char previous-pos)
7025 (hide-subtree)))
7026 (run-hooks 'org-insert-heading-hook)))))
7028 (defun org-get-heading (&optional no-tags no-todo)
7029 "Return the heading of the current entry, without the stars.
7030 When NO-TAGS is non-nil, don't include tags.
7031 When NO-TODO is non-nil, don't include TODO keywords."
7032 (save-excursion
7033 (org-back-to-heading t)
7034 (cond
7035 ((and no-tags no-todo)
7036 (looking-at org-complex-heading-regexp)
7037 (match-string 4))
7038 (no-tags
7040 (match-string 1))
7041 (no-todo
7044 (match-string 2))
7046 (match-string 1)))))
7048 (defun org-heading-components ()
7049 "Return the components of the current heading.
7050 This is a list with the following elements:
7051 - the level as an integer
7052 - the reduced level, different if `org-odd-levels-only' is set.
7053 - the TODO keyword, or nil
7054 - the priority character, like ?A, or nil if no priority is given
7055 - the headline text itself, or the tags string if no headline text
7056 - the tags string, or nil."
7057 (save-excursion
7058 (org-back-to-heading t)
7059 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7060 (list (length (match-string 1))
7061 (org-reduced-level (length (match-string 1)))
7062 (org-match-string-no-properties 2)
7063 (and (match-end 3) (aref (match-string 3) 2))
7064 (org-match-string-no-properties 4)
7065 (org-match-string-no-properties 5)))))
7067 (defun org-get-entry ()
7068 "Get the entry text, after heading, entire subtree."
7069 (save-excursion
7070 (org-back-to-heading t)
7071 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7073 (defun org-insert-heading-after-current ()
7074 "Insert a new heading with same level as current, after current subtree."
7075 (interactive)
7076 (org-back-to-heading)
7077 (org-insert-heading)
7078 (org-move-subtree-down)
7079 (end-of-line 1))
7081 (defun org-insert-heading-respect-content ()
7082 (interactive)
7083 (let ((org-insert-heading-respect-content t))
7084 (org-insert-heading t)))
7086 (defun org-insert-todo-heading-respect-content (&optional force-state)
7087 (interactive "P")
7088 (let ((org-insert-heading-respect-content t))
7089 (org-insert-todo-heading force-state t)))
7091 (defun org-insert-todo-heading (arg &optional force-heading)
7092 "Insert a new heading with the same level and TODO state as current heading.
7093 If the heading has no TODO state, or if the state is DONE, use the first
7094 state (TODO by default). Also with prefix arg, force first state."
7095 (interactive "P")
7096 (when (or force-heading (not (org-insert-item 'checkbox)))
7097 (org-insert-heading force-heading)
7098 (save-excursion
7099 (org-back-to-heading)
7100 (outline-previous-heading)
7101 (looking-at org-todo-line-regexp))
7102 (let*
7103 ((new-mark-x
7104 (if (or arg
7105 (not (match-beginning 2))
7106 (member (match-string 2) org-done-keywords))
7107 (car org-todo-keywords-1)
7108 (match-string 2)))
7109 (new-mark
7110 (or
7111 (run-hook-with-args-until-success
7112 'org-todo-get-default-hook new-mark-x nil)
7113 new-mark-x)))
7114 (beginning-of-line 1)
7115 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7116 (if org-treat-insert-todo-heading-as-state-change
7117 (org-todo new-mark)
7118 (insert new-mark " "))))
7119 (when org-provide-todo-statistics
7120 (org-update-parent-todo-statistics))))
7122 (defun org-insert-subheading (arg)
7123 "Insert a new subheading and demote it.
7124 Works for outline headings and for plain lists alike."
7125 (interactive "P")
7126 (org-insert-heading arg)
7127 (cond
7128 ((org-on-heading-p) (org-do-demote))
7129 ((org-at-item-p) (org-indent-item))))
7131 (defun org-insert-todo-subheading (arg)
7132 "Insert a new subheading with TODO keyword or checkbox and demote it.
7133 Works for outline headings and for plain lists alike."
7134 (interactive "P")
7135 (org-insert-todo-heading arg)
7136 (cond
7137 ((org-on-heading-p) (org-do-demote))
7138 ((org-at-item-p) (org-indent-item))))
7140 ;;; Promotion and Demotion
7142 (defvar org-after-demote-entry-hook nil
7143 "Hook run after an entry has been demoted.
7144 The cursor will be at the beginning of the entry.
7145 When a subtree is being demoted, the hook will be called for each node.")
7147 (defvar org-after-promote-entry-hook nil
7148 "Hook run after an entry has been promoted.
7149 The cursor will be at the beginning of the entry.
7150 When a subtree is being promoted, the hook will be called for each node.")
7152 (defun org-promote-subtree ()
7153 "Promote the entire subtree.
7154 See also `org-promote'."
7155 (interactive)
7156 (save-excursion
7157 (org-with-limited-levels (org-map-tree 'org-promote)))
7158 (org-fix-position-after-promote))
7160 (defun org-demote-subtree ()
7161 "Demote the entire subtree. See `org-demote'.
7162 See also `org-promote'."
7163 (interactive)
7164 (save-excursion
7165 (org-with-limited-levels (org-map-tree 'org-demote)))
7166 (org-fix-position-after-promote))
7169 (defun org-do-promote ()
7170 "Promote the current heading higher up the tree.
7171 If the region is active in `transient-mark-mode', promote all headings
7172 in the region."
7173 (interactive)
7174 (save-excursion
7175 (if (org-region-active-p)
7176 (org-map-region 'org-promote (region-beginning) (region-end))
7177 (org-promote)))
7178 (org-fix-position-after-promote))
7180 (defun org-do-demote ()
7181 "Demote the current heading lower down the tree.
7182 If the region is active in `transient-mark-mode', demote all headings
7183 in the region."
7184 (interactive)
7185 (save-excursion
7186 (if (org-region-active-p)
7187 (org-map-region 'org-demote (region-beginning) (region-end))
7188 (org-demote)))
7189 (org-fix-position-after-promote))
7191 (defun org-fix-position-after-promote ()
7192 "Make sure that after pro/demotion cursor position is right."
7193 (let ((pos (point)))
7194 (when (save-excursion
7195 (beginning-of-line 1)
7196 (looking-at org-todo-line-regexp)
7197 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7198 (cond ((eobp) (insert " "))
7199 ((eolp) (insert " "))
7200 ((equal (char-after) ?\ ) (forward-char 1))))))
7202 (defun org-current-level ()
7203 "Return the level of the current entry, or nil if before the first headline.
7204 The level is the number of stars at the beginning of the headline."
7205 (save-excursion
7206 (org-with-limited-levels
7207 (ignore-errors
7208 (org-back-to-heading t)
7209 (funcall outline-level)))))
7211 (defun org-get-previous-line-level ()
7212 "Return the outline depth of the last headline before the current line.
7213 Returns 0 for the first headline in the buffer, and nil if before the
7214 first headline."
7215 (let ((current-level (org-current-level))
7216 (prev-level (when (> (line-number-at-pos) 1)
7217 (save-excursion
7218 (beginning-of-line 0)
7219 (org-current-level)))))
7220 (cond ((null current-level) nil) ; Before first headline
7221 ((null prev-level) 0) ; At first headline
7222 (prev-level))))
7224 (defun org-reduced-level (l)
7225 "Compute the effective level of a heading.
7226 This takes into account the setting of `org-odd-levels-only'."
7227 (cond
7228 ((zerop l) 0)
7229 (org-odd-levels-only (1+ (floor (/ l 2))))
7230 (t l)))
7232 (defun org-level-increment ()
7233 "Return the number of stars that will be added or removed at a
7234 time to headlines when structure editing, based on the value of
7235 `org-odd-levels-only'."
7236 (if org-odd-levels-only 2 1))
7238 (defun org-get-valid-level (level &optional change)
7239 "Rectify a level change under the influence of `org-odd-levels-only'
7240 LEVEL is a current level, CHANGE is by how much the level should be
7241 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7242 even level numbers will become the next higher odd number."
7243 (if org-odd-levels-only
7244 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7245 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7246 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7247 (max 1 (+ level (or change 0)))))
7249 (if (boundp 'define-obsolete-function-alias)
7250 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7251 (define-obsolete-function-alias 'org-get-legal-level
7252 'org-get-valid-level)
7253 (define-obsolete-function-alias 'org-get-legal-level
7254 'org-get-valid-level "23.1")))
7256 (defun org-promote ()
7257 "Promote the current heading higher up the tree.
7258 If the region is active in `transient-mark-mode', promote all headings
7259 in the region."
7260 (org-back-to-heading t)
7261 (let* ((level (save-match-data (funcall outline-level)))
7262 (after-change-functions (remove 'flyspell-after-change-function
7263 after-change-functions))
7264 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7265 (diff (abs (- level (length up-head) -1))))
7266 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7267 (replace-match up-head nil t)
7268 ;; Fixup tag positioning
7269 (and org-auto-align-tags (org-set-tags nil t))
7270 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7271 (run-hooks 'org-after-promote-entry-hook)))
7273 (defun org-demote ()
7274 "Demote the current heading lower down the tree.
7275 If the region is active in `transient-mark-mode', demote all headings
7276 in the region."
7277 (org-back-to-heading t)
7278 (let* ((level (save-match-data (funcall outline-level)))
7279 (after-change-functions (remove 'flyspell-after-change-function
7280 after-change-functions))
7281 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7282 (diff (abs (- level (length down-head) -1))))
7283 (replace-match down-head nil t)
7284 ;; Fixup tag positioning
7285 (and org-auto-align-tags (org-set-tags nil t))
7286 (if org-adapt-indentation (org-fixup-indentation diff))
7287 (run-hooks 'org-after-demote-entry-hook)))
7289 (defun org-cycle-level ()
7290 "Cycle the level of an empty headline through possible states.
7291 This goes first to child, then to parent, level, then up the hierarchy.
7292 After top level, it switches back to sibling level."
7293 (interactive)
7294 (let ((org-adapt-indentation nil))
7295 (when (org-point-at-end-of-empty-headline)
7296 (setq this-command 'org-cycle-level) ; Only needed for caching
7297 (let ((cur-level (org-current-level))
7298 (prev-level (org-get-previous-line-level)))
7299 (cond
7300 ;; If first headline in file, promote to top-level.
7301 ((= prev-level 0)
7302 (loop repeat (/ (- cur-level 1) (org-level-increment))
7303 do (org-do-promote)))
7304 ;; If same level as prev, demote one.
7305 ((= prev-level cur-level)
7306 (org-do-demote))
7307 ;; If parent is top-level, promote to top level if not already.
7308 ((= prev-level 1)
7309 (loop repeat (/ (- cur-level 1) (org-level-increment))
7310 do (org-do-promote)))
7311 ;; If top-level, return to prev-level.
7312 ((= cur-level 1)
7313 (loop repeat (/ (- prev-level 1) (org-level-increment))
7314 do (org-do-demote)))
7315 ;; If less than prev-level, promote one.
7316 ((< cur-level prev-level)
7317 (org-do-promote))
7318 ;; If deeper than prev-level, promote until higher than
7319 ;; prev-level.
7320 ((> cur-level prev-level)
7321 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7322 do (org-do-promote))))
7323 t))))
7325 (defun org-map-tree (fun)
7326 "Call FUN for every heading underneath the current one."
7327 (org-back-to-heading)
7328 (let ((level (funcall outline-level)))
7329 (save-excursion
7330 (funcall fun)
7331 (while (and (progn
7332 (outline-next-heading)
7333 (> (funcall outline-level) level))
7334 (not (eobp)))
7335 (funcall fun)))))
7337 (defun org-map-region (fun beg end)
7338 "Call FUN for every heading between BEG and END."
7339 (let ((org-ignore-region t))
7340 (save-excursion
7341 (setq end (copy-marker end))
7342 (goto-char beg)
7343 (if (and (re-search-forward org-outline-regexp-bol nil t)
7344 (< (point) end))
7345 (funcall fun))
7346 (while (and (progn
7347 (outline-next-heading)
7348 (< (point) end))
7349 (not (eobp)))
7350 (funcall fun)))))
7352 (defvar org-property-end-re) ; silence byte-compiler
7353 (defun org-fixup-indentation (diff)
7354 "Change the indentation in the current entry by DIFF.
7355 However, if any line in the current entry has no indentation, or if it
7356 would end up with no indentation after the change, nothing at all is done."
7357 (save-excursion
7358 (let ((end (save-excursion (outline-next-heading)
7359 (point-marker)))
7360 (prohibit (if (> diff 0)
7363 col)
7364 (unless (save-excursion (end-of-line 1)
7365 (re-search-forward prohibit end t))
7366 (while (and (< (point) end)
7368 (goto-char (match-end 0))
7369 (setq col (current-column))
7370 (if (< diff 0) (replace-match ""))
7371 (org-indent-to-column (+ diff col))))
7372 (move-marker end nil))))
7374 (defun org-convert-to-odd-levels ()
7375 "Convert an org-mode file with all levels allowed to one with odd levels.
7376 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7377 level 5 etc."
7378 (interactive)
7379 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7380 (let ((outline-level 'org-outline-level)
7381 (org-odd-levels-only nil) n)
7382 (save-excursion
7383 (goto-char (point-min))
7385 (setq n (- (length (match-string 0)) 2))
7386 (while (>= (setq n (1- n)) 0)
7387 (org-demote))
7388 (end-of-line 1))))))
7390 (defun org-convert-to-oddeven-levels ()
7391 "Convert an org-mode file with only odd levels to one with odd/even levels.
7392 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7393 file contains a section with an even level, conversion would
7394 destroy the structure of the file. An error is signaled in this
7395 case."
7396 (interactive)
7397 (goto-char (point-min))
7398 ;; First check if there are no even levels
7400 (org-show-context t)
7401 (error "Not all levels are odd in this file. Conversion not possible"))
7402 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7403 (let ((outline-regexp org-outline-regexp)
7404 (outline-level 'org-outline-level)
7405 (org-odd-levels-only nil) n)
7406 (save-excursion
7407 (goto-char (point-min))
7409 (setq n (/ (1- (length (match-string 0))) 2))
7410 (while (>= (setq n (1- n)) 0)
7411 (org-promote))
7412 (end-of-line 1))))))
7414 (defun org-tr-level (n)
7415 "Make N odd if required."
7416 (if org-odd-levels-only (1+ (/ n 2)) n))
7418 ;;; Vertical tree motion, cutting and pasting of subtrees
7420 (defun org-move-subtree-up (&optional arg)
7421 "Move the current subtree up past ARG headlines of the same level."
7422 (interactive "p")
7423 (org-move-subtree-down (- (prefix-numeric-value arg))))
7425 (defun org-move-subtree-down (&optional arg)
7426 "Move the current subtree down past ARG headlines of the same level."
7427 (interactive "p")
7428 (setq arg (prefix-numeric-value arg))
7429 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7430 'org-get-last-sibling))
7431 (ins-point (make-marker))
7432 (cnt (abs arg))
7433 (col (current-column))
7434 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7435 ;; Select the tree
7436 (org-back-to-heading)
7437 (setq beg0 (point))
7438 (save-excursion
7439 (setq ne-beg (org-back-over-empty-lines))
7440 (setq beg (point)))
7441 (save-match-data
7442 (save-excursion (outline-end-of-heading)
7443 (setq folded (outline-invisible-p)))
7444 (outline-end-of-subtree))
7445 (outline-next-heading)
7446 (setq ne-end (org-back-over-empty-lines))
7447 (setq end (point))
7448 (goto-char beg0)
7449 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7450 ;; include less whitespace
7451 (save-excursion
7452 (goto-char beg)
7453 (forward-line (- ne-beg ne-end))
7454 (setq beg (point))))
7455 ;; Find insertion point, with error handling
7456 (while (> cnt 0)
7457 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7458 (progn (goto-char beg0)
7459 (error "Cannot move past superior level or buffer limit")))
7460 (setq cnt (1- cnt)))
7461 (if (> arg 0)
7462 ;; Moving forward - still need to move over subtree
7463 (progn (org-end-of-subtree t t)
7464 (save-excursion
7465 (org-back-over-empty-lines)
7466 (or (bolp) (newline)))))
7467 (setq ne-ins (org-back-over-empty-lines))
7468 (move-marker ins-point (point))
7469 (setq txt (buffer-substring beg end))
7470 (org-save-markers-in-region beg end)
7471 (delete-region beg end)
7472 (org-remove-empty-overlays-at beg)
7473 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7474 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7476 (let ((bbb (point)))
7477 (insert-before-markers txt)
7478 (org-reinstall-markers-in-region bbb)
7479 (move-marker ins-point bbb))
7481 (setq ins-end (point))
7482 (goto-char ins-point)
7483 (org-skip-whitespace)
7484 (when (and (< arg 0)
7485 (org-first-sibling-p)
7486 (> ne-ins ne-beg))
7487 ;; Move whitespace back to beginning
7488 (save-excursion
7489 (goto-char ins-end)
7490 (let ((kill-whole-line t))
7491 (kill-line (- ne-ins ne-beg)) (point)))
7493 (move-marker ins-point nil)
7494 (if folded
7495 (hide-subtree)
7496 (org-show-entry)
7497 (show-children)
7498 (org-cycle-hide-drawers 'children))
7499 (org-clean-visibility-after-subtree-move)
7500 ;; move back to the initial column we were at
7501 (move-to-column col)))
7503 (defvar org-subtree-clip ""
7504 "Clipboard for cut and paste of subtrees.
7505 This is actually only a copy of the kill, because we use the normal kill
7506 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7508 (defvar org-subtree-clip-folded nil
7509 "Was the last copied subtree folded?
7510 This is used to fold the tree back after pasting.")
7512 (defun org-cut-subtree (&optional n)
7513 "Cut the current subtree into the clipboard.
7514 With prefix arg N, cut this many sequential subtrees.
7515 This is a short-hand for marking the subtree and then cutting it."
7516 (interactive "p")
7517 (org-copy-subtree n 'cut))
7519 (defun org-copy-subtree (&optional n cut force-store-markers)
7520 "Cut the current subtree into the clipboard.
7521 With prefix arg N, cut this many sequential subtrees.
7522 This is a short-hand for marking the subtree and then copying it.
7523 If CUT is non-nil, actually cut the subtree.
7524 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7525 of some markers in the region, even if CUT is non-nil. This is
7526 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7527 (interactive "p")
7528 (let (beg end folded (beg0 (point)))
7529 (if (org-called-interactively-p 'any)
7530 (org-back-to-heading nil) ; take what looks like a subtree
7531 (org-back-to-heading t)) ; take what is really there
7532 (org-back-over-empty-lines)
7533 (setq beg (point))
7535 (save-match-data
7536 (save-excursion (outline-end-of-heading)
7537 (setq folded (outline-invisible-p)))
7538 (condition-case nil
7539 (org-forward-same-level (1- n) t)
7540 (error nil))
7541 (org-end-of-subtree t t))
7542 (org-back-over-empty-lines)
7543 (setq end (point))
7544 (goto-char beg0)
7545 (when (> end beg)
7546 (setq org-subtree-clip-folded folded)
7547 (when (or cut force-store-markers)
7548 (org-save-markers-in-region beg end))
7549 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7550 (setq org-subtree-clip (current-kill 0))
7551 (message "%s: Subtree(s) with %d characters"
7552 (if cut "Cut" "Copied")
7553 (length org-subtree-clip)))))
7555 (defun org-paste-subtree (&optional level tree for-yank)
7556 "Paste the clipboard as a subtree, with modification of headline level.
7557 The entire subtree is promoted or demoted in order to match a new headline
7558 level.
7560 If the cursor is at the beginning of a headline, the same level as
7561 that headline is used to paste the tree
7563 If not, the new level is derived from the *visible* headings
7564 before and after the insertion point, and taken to be the inferior headline
7565 level of the two. So if the previous visible heading is level 3 and the
7566 next is level 4 (or vice versa), level 4 will be used for insertion.
7567 This makes sure that the subtree remains an independent subtree and does
7568 not swallow low level entries.
7570 You can also force a different level, either by using a numeric prefix
7571 argument, or by inserting the heading marker by hand. For example, if the
7574 If optional TREE is given, use this text instead of the kill ring.
7576 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7577 move back over whitespace before inserting, and move point to the end of
7578 the inserted text when done."
7579 (interactive "P")
7580 (setq tree (or tree (and kill-ring (current-kill 0))))
7581 (unless (org-kill-is-subtree-p tree)
7582 (error "%s"
7583 (substitute-command-keys
7585 (org-with-limited-levels
7586 (let* ((visp (not (outline-invisible-p)))
7587 (txt tree)
7589 (old-level (if (string-match org-outline-regexp-bol txt)
7590 (- (match-end 0) (match-beginning 0) 1)
7591 -1))
7592 (force-level (cond (level (prefix-numeric-value level))
7594 (string-match
7596 (point-at-bol) (point))))
7597 (- (match-end 1) (match-beginning 1)))
7598 ((and (bolp)
7599 (looking-at org-outline-regexp))
7600 (- (match-end 0) (point) 1))
7601 (t nil)))
7602 (previous-level (save-excursion
7603 (condition-case nil
7604 (progn
7605 (outline-previous-visible-heading 1)
7606 (if (looking-at ^re_)
7607 (- (match-end 0) (match-beginning 0) 1)
7608 1))
7609 (error 1))))
7610 (next-level (save-excursion
7611 (condition-case nil
7612 (progn
7613 (or (looking-at org-outline-regexp)
7614 (outline-next-visible-heading 1))
7615 (if (looking-at ^re_)
7616 (- (match-end 0) (match-beginning 0) 1)
7617 1))
7618 (error 1))))
7619 (new-level (or force-level (max previous-level next-level)))
7620 (shift (if (or (= old-level -1)
7621 (= new-level -1)
7622 (= old-level new-level))
7623 0
7624 (- new-level old-level)))
7625 (delta (if (> shift 0) -1 1))
7626 (func (if (> shift 0) 'org-demote 'org-promote))
7627 (org-odd-levels-only nil)
7628 beg end newend)
7629 ;; Remove the forced level indicator
7630 (if force-level
7631 (delete-region (point-at-bol) (point)))
7632 ;; Paste
7633 (beginning-of-line (if (bolp) 1 2))
7634 (unless for-yank (org-back-over-empty-lines))
7635 (setq beg (point))
7636 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7637 (insert-before-markers txt)
7639 (setq newend (point))
7640 (org-reinstall-markers-in-region beg)
7641 (setq end (point))
7642 (goto-char beg)
7644 (setq beg (point))
7645 (if (and (outline-invisible-p) visp)
7646 (save-excursion (outline-show-heading)))
7647 ;; Shift if necessary
7648 (unless (= shift 0)
7649 (save-restriction
7650 (narrow-to-region beg end)
7651 (while (not (= shift 0))
7652 (org-map-region func (point-min) (point-max))
7653 (setq shift (+ delta shift)))
7654 (goto-char (point-min))
7655 (setq newend (point-max))))
7656 (when (or (org-called-interactively-p 'interactive) for-yank)
7657 (message "Clipboard pasted as level %d subtree" new-level))
7658 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7659 kill-ring
7660 (eq org-subtree-clip (current-kill 0))
7661 org-subtree-clip-folded)
7662 ;; The tree was folded before it was killed/copied
7663 (hide-subtree))
7664 (and for-yank (goto-char newend)))))
7666 (defun org-kill-is-subtree-p (&optional txt)
7667 "Check if the current kill is an outline subtree, or a set of trees.
7668 Returns nil if kill does not start with a headline, or if the first
7669 headline level is not the largest headline level in the tree.
7670 So this will actually accept several entries of equal levels as well,
7671 which is OK for `org-paste-subtree'.
7672 If optional TXT is given, check this string instead of the current kill."
7673 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7674 (re (org-get-limited-outline-regexp))
7675 (^re (concat "^" re))
7676 (start-level (and kill
7677 (string-match
7679 kill)
7680 (- (match-end 2) (match-beginning 2) 1)))
7681 (start (1+ (or (match-beginning 2) -1))))
7682 (if (not start-level)
7683 (progn
7684 nil) ;; does not even start with a heading
7685 (catch 'exit
7686 (while (setq start (string-match ^re kill (1+ start)))
7687 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7688 (throw 'exit nil)))
7689 t))))
7691 (defvar org-markers-to-move nil
7692 "Markers that should be moved with a cut-and-paste operation.
7693 Those markers are stored together with their positions relative to
7694 the start of the region.")
7696 (defun org-save-markers-in-region (beg end)
7697 "Check markers in region.
7698 If these markers are between BEG and END, record their position relative
7699 to BEG, so that after moving the block of text, we can put the markers back
7700 into place.
7701 This function gets called just before an entry or tree gets cut from the
7702 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7703 called immediately, to move the markers with the entries."
7704 (setq org-markers-to-move nil)
7705 (when (featurep 'org-clock)
7706 (org-clock-save-markers-for-cut-and-paste beg end))
7707 (when (featurep 'org-agenda)
7708 (org-agenda-save-markers-for-cut-and-paste beg end)))
7710 (defun org-check-and-save-marker (marker beg end)
7711 "Check if MARKER is between BEG and END.
7712 If yes, remember the marker and the distance to BEG."
7713 (when (and (marker-buffer marker)
7714 (equal (marker-buffer marker) (current-buffer)))
7715 (if (and (>= marker beg) (< marker end))
7716 (push (cons marker (- marker beg)) org-markers-to-move))))
7718 (defun org-reinstall-markers-in-region (beg)
7719 "Move all remembered markers to their position relative to BEG."
7720 (mapc (lambda (x)
7721 (move-marker (car x) (+ beg (cdr x))))
7722 org-markers-to-move)
7723 (setq org-markers-to-move nil))
7725 (defun org-narrow-to-subtree ()
7726 "Narrow buffer to the current subtree."
7727 (interactive)
7728 (save-excursion
7729 (save-match-data
7730 (org-with-limited-levels
7731 (narrow-to-region
7732 (progn (org-back-to-heading t) (point))
7733 (progn (org-end-of-subtree t t)
7734 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7735 (point)))))))
7737 (defun org-narrow-to-block ()
7738 "Narrow buffer to the current block."
7739 (interactive)
7740 (let* ((case-fold-search t)
7743 (if blockp
7744 (narrow-to-region (car blockp) (cdr blockp))
7745 (error "Not in a block"))))
7747 (eval-when-compile
7748 (defvar org-property-drawer-re))
7750 (defvar org-property-start-re) ;; defined below
7751 (defun org-clone-subtree-with-time-shift (n &optional shift)
7752 "Clone the task (subtree) at point N times.
7753 The clones will be inserted as siblings.
7755 In interactive use, the user will be prompted for the number of
7756 clones to be produced, and for a time SHIFT, which may be a
7757 repeater as used in time stamps, for example `+3d'.
7759 When a valid repeater is given and the entry contains any time
7760 stamps, the clones will become a sequence in time, with time
7761 stamps in the subtree shifted for each clone produced. If SHIFT
7762 is nil or the empty string, time stamps will be left alone. The
7763 ID property of the original subtree is removed.
7765 If the original subtree did contain time stamps with a repeater,
7766 the following will happen:
7767 - the repeater will be removed in each clone
7768 - an additional clone will be produced, with the current, unshifted
7769 date(s) in the entry.
7770 - the original entry will be placed *after* all the clones, with
7771 repeater intact.
7772 - the start days in the repeater in the original entry will be shifted
7773 to past the last clone.
7774 I this way you can spell out a number of instances of a repeating task,
7775 and still retain the repeater to cover future instances of the task."
7776 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7777 (let (beg end template task idprop
7778 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7779 (if (not (and (integerp n) (> n 0)))
7780 (error "Invalid number of replications %s" n))
7783 shift)))
7784 (error "Invalid shift specification %s" shift))
7785 (when doshift
7786 (setq shift-n (string-to-number (match-string 1 shift))
7787 shift-what (cdr (assoc (match-string 2 shift)
7788 '(("d" . day) ("w" . week)
7789 ("m" . month) ("y" . year))))))
7790 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7791 (setq nmin 1 nmax n)
7792 (org-back-to-heading t)
7793 (setq beg (point))
7794 (setq idprop (org-entry-get nil "ID"))
7795 (org-end-of-subtree t t)
7797 (setq end (point))
7798 (setq template (buffer-substring beg end))
7799 ;; Remove clocks and empty drawers
7800 (with-temp-buffer
7801 (insert template)
7802 (goto-char (point-min))
7803 (while (re-search-forward
7805 (replace-match "")
7806 (kill-whole-line))
7807 (goto-char (point-min))
7808 (while (re-search-forward
7810 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7811 (setq template (buffer-substring (point-min) (point-max))))
7812 (when (and doshift
7814 (delete-region beg end)
7815 (setq end beg)
7816 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7817 (goto-char end)
7818 (loop for n from nmin to nmax do
7819 ;; prepare clone
7820 (with-temp-buffer
7821 (insert template)
7822 (org-mode)
7823 (goto-char (point-min))
7824 (and idprop (if org-clone-delete-id
7825 (org-entry-delete nil "ID")
7826 (org-id-get-create t)))
7827 (while (re-search-forward org-property-start-re nil t)
7828 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7829 (goto-char (point-min))
7830 (when doshift
7831 (while (re-search-forward org-ts-regexp-both nil t)
7832 (org-timestamp-change (* n shift-n) shift-what))
7833 (unless (= n n-no-remove)
7834 (goto-char (point-min))
7835 (while (re-search-forward org-ts-regexp nil t)
7836 (save-excursion
7837 (goto-char (match-beginning 0))
7839 (delete-region (match-beginning 1) (match-end 1)))))))
7840 (setq task (buffer-string)))
7841 (insert task))
7842 (goto-char beg)))
7844 ;;; Outline Sorting
7846 (defun org-sort (with-case)
7847 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7848 Optional argument WITH-CASE means sort case-sensitively.
7849 With a double prefix argument, also remove duplicate entries."
7850 (interactive "P")
7851 (cond
7852 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7853 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7854 (t
7855 (org-call-with-arg 'org-sort-entries with-case))))
7857 (defun org-sort-remove-invisible (s)
7858 (remove-text-properties 0 (length s) org-rm-props s)
7859 (while (string-match org-bracket-link-regexp s)
7860 (setq s (replace-match (if (match-end 2)
7861 (match-string 3 s)
7862 (match-string 1 s)) t t s)))
7863 s)
7865 (defvar org-priority-regexp) ; defined later in the file
7867 (defvar org-after-sorting-entries-or-items-hook nil
7868 "Hook that is run after a bunch of entries or items have been sorted.
7869 When children are sorted, the cursor is in the parent line when this
7870 hook gets called. When a region or a plain list is sorted, the cursor
7871 will be in the first entry of the sorted region/list.")
7873 (defun org-sort-entries
7874 (&optional with-case sorting-type getkey-func compare-func property)
7875 "Sort entries on a certain level of an outline tree.
7876 If there is an active region, the entries in the region are sorted.
7877 Else, if the cursor is before the first entry, sort the top-level items.
7878 Else, the children of the entry at point are sorted.
7880 Sorting can be alphabetically, numerically, by date/time as given by
7881 a time stamp, by a property or by priority.
7883 The command prompts for the sorting type unless it has been given to the
7884 function through the SORTING-TYPE argument, which needs to be a character,
7885 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7886 precise meaning of each character:
7888 n Numerically, by converting the beginning of the entry/item to a number.
7889 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7890 t By date/time, either the first active time stamp in the entry, or, if
7891 none exist, by the first inactive one.
7892 s By the scheduled date/time.
7893 d By deadline date/time.
7894 c By creation time, which is assumed to be the first inactive time stamp
7895 at the beginning of a line.
7896 p By priority according to the cookie.
7897 r By the value of a property.
7899 Capital letters will reverse the sort order.
7901 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7902 called with point at the beginning of the record. It must return either
7903 a string or a number that should serve as the sorting key for that record.
7905 Comparing entries ignores case by default. However, with an optional argument
7906 WITH-CASE, the sorting considers case as well."
7907 (interactive "P")
7908 (let ((case-func (if with-case 'identity 'downcase))
7909 start beg end stars re re2
7910 txt what tmp)
7911 ;; Find beginning and end of region to sort
7912 (cond
7913 ((org-region-active-p)
7914 ;; we will sort the region
7915 (setq end (region-end)
7916 what "region")
7917 (goto-char (region-beginning))
7918 (if (not (org-on-heading-p)) (outline-next-heading))
7919 (setq start (point)))
7920 ((or (org-on-heading-p)
7921 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7922 ;; we will sort the children of the current headline
7923 (org-back-to-heading)
7924 (setq start (point)
7925 end (progn (org-end-of-subtree t t)
7927 (org-back-over-empty-lines)
7928 (point))
7929 what "children")
7930 (goto-char start)
7931 (show-subtree)
7932 (outline-next-heading))
7933 (t
7934 ;; we will sort the top-level entries in this file
7935 (goto-char (point-min))
7936 (or (org-on-heading-p) (outline-next-heading))
7937 (setq start (point))
7938 (goto-char (point-max))
7939 (beginning-of-line 1)
7941 ;; File ends in a non-white line
7942 (end-of-line 1)
7944 (setq end (point-max))
7945 (setq what "top-level")
7946 (goto-char start)
7947 (show-all)))
7949 (setq beg (point))
7950 (if (>= beg end) (error "Nothing to sort"))
7953 (setq stars (match-string 1)
7954 re (concat "^" (regexp-quote stars) " +")
7956 txt (buffer-substring beg end))
7958 (if (and (not (equal stars "*")) (string-match re2 txt))
7959 (error "Region to sort contains a level above the first entry"))
7961 (unless sorting-type
7962 (message
7963 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7965 A/N/T/S/D/C/P/O/F means reversed:"
7966 what)
7967 (setq sorting-type (read-char-exclusive))
7969 (and (= (downcase sorting-type) ?f)
7970 (setq getkey-func
7971 (org-icompleting-read "Sort using function: "
7972 obarray 'fboundp t nil nil))
7973 (setq getkey-func (intern getkey-func)))
7975 (and (= (downcase sorting-type) ?r)
7976 (setq property
7977 (org-icompleting-read "Property: "
7978 (mapcar 'list (org-buffer-property-keys t))
7979 nil t))))
7981 (message "Sorting entries...")
7983 (save-restriction
7984 (narrow-to-region start end)
7985 (let ((dcst (downcase sorting-type))
7986 (case-fold-search nil)
7987 (now (current-time)))
7988 (sort-subr
7989 (/= dcst sorting-type)
7990 ;; This function moves to the beginning character of the "record" to
7991 ;; be sorted.
7992 (lambda nil
7993 (if (re-search-forward re nil t)
7994 (goto-char (match-beginning 0))
7995 (goto-char (point-max))))
7996 ;; This function moves to the last character of the "record" being
7997 ;; sorted.
7998 (lambda nil
7999 (save-match-data
8000 (condition-case nil
8001 (outline-forward-same-level 1)
8002 (error
8003 (goto-char (point-max))))))
8004 ;; This function returns the value that gets sorted against.
8005 (lambda nil
8006 (cond
8007 ((= dcst ?n)
8008 (if (looking-at org-complex-heading-regexp)
8009 (string-to-number (match-string 4))
8010 nil))
8011 ((= dcst ?a)
8012 (if (looking-at org-complex-heading-regexp)
8013 (funcall case-func (match-string 4))
8014 nil))
8015 ((= dcst ?t)
8016 (let ((end (save-excursion (outline-next-heading) (point))))
8017 (if (or (re-search-forward org-ts-regexp end t)
8018 (re-search-forward org-ts-regexp-both end t))
8019 (org-time-string-to-seconds (match-string 0))
8020 (org-float-time now))))
8021 ((= dcst ?c)
8022 (let ((end (save-excursion (outline-next-heading) (point))))
8023 (if (re-search-forward
8025 end t)
8026 (org-time-string-to-seconds (match-string 0))
8027 (org-float-time now))))
8028 ((= dcst ?s)
8029 (let ((end (save-excursion (outline-next-heading) (point))))
8030 (if (re-search-forward org-scheduled-time-regexp end t)
8031 (org-time-string-to-seconds (match-string 1))
8032 (org-float-time now))))
8033 ((= dcst ?d)
8034 (let ((end (save-excursion (outline-next-heading) (point))))
8035 (if (re-search-forward org-deadline-time-regexp end t)
8036 (org-time-string-to-seconds (match-string 1))
8037 (org-float-time now))))
8038 ((= dcst ?p)
8039 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8040 (string-to-char (match-string 2))
8041 org-default-priority))
8042 ((= dcst ?r)
8043 (or (org-entry-get nil property) ""))
8044 ((= dcst ?o)
8045 (if (looking-at org-complex-heading-regexp)
8046 (- 9999 (length (member (match-string 2)
8047 org-todo-keywords-1)))))
8048 ((= dcst ?f)
8049 (if getkey-func
8050 (progn
8051 (setq tmp (funcall getkey-func))
8052 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8053 tmp)
8054 (error "Invalid key function `%s'" getkey-func)))
8055 (t (error "Invalid sorting type `%c'" sorting-type))))
8056 nil
8057 (cond
8058 ((= dcst ?a) 'string<)
8059 ((= dcst ?f) compare-func)
8060 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8061 (t nil)))))
8062 (run-hooks 'org-after-sorting-entries-or-items-hook)
8063 (message "Sorting entries...done")))
8065 (defun org-do-sort (table what &optional with-case sorting-type)
8066 "Sort TABLE of WHAT according to SORTING-TYPE.
8067 The user will be prompted for the SORTING-TYPE if the call to this
8068 function does not specify it. WHAT is only for the prompt, to indicate
8069 what is being sorted. The sorting key will be extracted from
8070 the car of the elements of the table.
8071 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8072 (unless sorting-type
8073 (message
8074 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8075 what)
8076 (setq sorting-type (read-char-exclusive)))
8077 (let ((dcst (downcase sorting-type))
8078 extractfun comparefun)
8079 ;; Define the appropriate functions
8080 (cond
8081 ((= dcst ?n)
8082 (setq extractfun 'string-to-number
8083 comparefun (if (= dcst sorting-type) '< '>)))
8084 ((= dcst ?a)
8085 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8086 (lambda(x) (downcase (org-sort-remove-invisible x))))
8087 comparefun (if (= dcst sorting-type)
8088 'string<
8089 (lambda (a b) (and (not (string< a b))
8090 (not (string= a b)))))))
8091 ((= dcst ?t)
8092 (setq extractfun
8093 (lambda (x)
8094 (if (or (string-match org-ts-regexp x)
8095 (string-match org-ts-regexp-both x))
8096 (org-float-time
8097 (org-time-string-to-time (match-string 0 x)))
8098 0))
8099 comparefun (if (= dcst sorting-type) '< '>)))
8100 (t (error "Invalid sorting type `%c'" sorting-type)))
8102 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8103 table)
8104 (lambda (a b) (funcall comparefun (car a) (car b))))))
8107 ;;; The orgstruct minor mode
8109 ;; Define a minor mode which can be used in other modes in order to
8110 ;; integrate the org-mode structure editing commands.
8112 ;; This is really a hack, because the org-mode structure commands use
8113 ;; keys which normally belong to the major mode. Here is how it
8114 ;; works: The minor mode defines all the keys necessary to operate the
8115 ;; structure commands, but wraps the commands into a function which
8116 ;; tests if the cursor is currently at a headline or a plain list
8117 ;; item. If that is the case, the structure command is used,
8118 ;; temporarily setting many Org-mode variables like regular
8119 ;; expressions for filling etc. However, when any of those keys is
8120 ;; used at a different location, function uses `key-binding' to look
8121 ;; up if the key has an associated command in another currently active
8122 ;; keymap (minor modes, major mode, global), and executes that
8123 ;; command. There might be problems if any of the keys is otherwise
8124 ;; used as a prefix key.
8126 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8127 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8128 ;; addresses this by checking explicitly for both bindings.
8130 (defvar orgstruct-mode-map (make-sparse-keymap)
8131 "Keymap for the minor `orgstruct-mode'.")
8133 (defvar org-local-vars nil
8134 "List of local variables, for use by `orgstruct-mode'.")
8136 ;;;###autoload
8137 (define-minor-mode orgstruct-mode
8138 "Toggle the minor mode `orgstruct-mode'.
8139 This mode is for using Org-mode structure commands in other
8140 modes. The following keys behave as if Org-mode were active, if
8141 the cursor is on a headline, or on a plain list item (both as
8142 defined by Org-mode).
8144 M-up Move entry/item up
8145 M-down Move entry/item down
8146 M-left Promote
8147 M-right Demote
8148 M-S-up Move entry/item up
8149 M-S-down Move entry/item down
8150 M-S-left Promote subtree
8151 M-S-right Demote subtree
8152 M-q Fill paragraph and items like in Org-mode
8153 C-c ^ Sort entries
8154 C-c - Cycle list bullet
8155 TAB Cycle item visibility
8156 M-RET Insert new heading/item
8157 S-M-RET Insert new TODO heading / Checkbox item
8158 C-c C-c Set tags / toggle checkbox"
8159 nil " OrgStruct" nil
8160 (org-load-modules-maybe)
8161 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8163 ;;;###autoload
8164 (defun turn-on-orgstruct ()
8165 "Unconditionally turn on `orgstruct-mode'."
8166 (orgstruct-mode 1))
8168 (defun orgstruct++-mode (&optional arg)
8169 "Toggle `orgstruct-mode', the enhanced version of it.
8170 In addition to setting orgstruct-mode, this also exports all indentation
8171 and autofilling variables from org-mode into the buffer. It will also
8172 recognize item context in multiline items.
8173 Note that turning off orgstruct-mode will *not* remove the
8174 indentation/paragraph settings. This can only be done by refreshing the
8176 (interactive "P")
8177 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8178 (if (< arg 1)
8179 (orgstruct-mode -1)
8180 (orgstruct-mode 1)
8181 (let (var val)
8182 (mapc
8183 (lambda (x)
8184 (when (string-match
8186 (symbol-name (car x)))
8187 (setq var (car x) val (nth 1 x))
8188 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8189 org-local-vars)
8190 (org-set-local 'orgstruct-is-++ t))))
8192 (defvar orgstruct-is-++ nil
8193 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8194 (make-variable-buffer-local 'orgstruct-is-++)
8196 ;;;###autoload
8197 (defun turn-on-orgstruct++ ()
8198 "Unconditionally turn on `orgstruct++-mode'."
8199 (orgstruct++-mode 1))
8201 (defun orgstruct-error ()
8202 "Error when there is no default binding for a structure key."
8203 (interactive)
8204 (error "This key has no function outside structure elements"))
8206 (defun orgstruct-setup ()
8207 "Setup orgstruct keymaps."
8208 (let ((nfunc 0)
8209 (bindings
8210 (list
8211 '([(meta up)] org-metaup)
8212 '([(meta down)] org-metadown)
8213 '([(meta left)] org-metaleft)
8214 '([(meta right)] org-metaright)
8215 '([(meta shift up)] org-shiftmetaup)
8216 '([(meta shift down)] org-shiftmetadown)
8217 '([(meta shift left)] org-shiftmetaleft)
8218 '([(meta shift right)] org-shiftmetaright)
8219 '([?\e (up)] org-metaup)
8220 '([?\e (down)] org-metadown)
8221 '([?\e (left)] org-metaleft)
8222 '([?\e (right)] org-metaright)
8223 '([?\e (shift up)] org-shiftmetaup)
8224 '([?\e (shift down)] org-shiftmetadown)
8225 '([?\e (shift left)] org-shiftmetaleft)
8226 '([?\e (shift right)] org-shiftmetaright)
8227 '([(shift up)] org-shiftup)
8228 '([(shift down)] org-shiftdown)
8229 '([(shift left)] org-shiftleft)
8230 '([(shift right)] org-shiftright)
8231 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8232 '("\M-q" fill-paragraph)
8233 '("\C-c^" org-sort)
8234 '("\C-c-" org-cycle-list-bullet)))
8235 elt key fun cmd)
8236 (while (setq elt (pop bindings))
8237 (setq nfunc (1+ nfunc))
8238 (setq key (org-key (car elt))
8239 fun (nth 1 elt)
8240 cmd (orgstruct-make-binding fun nfunc key))
8241 (org-defkey orgstruct-mode-map key cmd))
8243 ;; Special treatment needed for TAB and RET
8244 (org-defkey orgstruct-mode-map [(tab)]
8245 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8246 (org-defkey orgstruct-mode-map "\C-i"
8247 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8249 (org-defkey orgstruct-mode-map "\M-\C-m"
8250 (orgstruct-make-binding 'org-insert-heading 105
8251 "\M-\C-m" [(meta return)]))
8252 (org-defkey orgstruct-mode-map [(meta return)]
8253 (orgstruct-make-binding 'org-insert-heading 106
8254 [(meta return)] "\M-\C-m"))
8256 (org-defkey orgstruct-mode-map [(shift meta return)]
8257 (orgstruct-make-binding 'org-insert-todo-heading 107
8258 [(meta return)] "\M-\C-m"))
8260 (org-defkey orgstruct-mode-map "\e\C-m"
8261 (orgstruct-make-binding 'org-insert-heading 108
8262 "\e\C-m" [?\e (return)]))
8263 (org-defkey orgstruct-mode-map [?\e (return)]
8264 (orgstruct-make-binding 'org-insert-heading 109
8265 [?\e (return)] "\e\C-m"))
8266 (org-defkey orgstruct-mode-map [?\e (shift return)]
8267 (orgstruct-make-binding 'org-insert-todo-heading 110
8268 [?\e (return)] "\e\C-m"))
8270 (unless org-local-vars
8271 (setq org-local-vars (org-get-local-variables)))
8273 t))
8275 (defun orgstruct-make-binding (fun n &rest keys)
8276 "Create a function for binding in the structure minor mode.
8277 FUN is the command to call inside a table. N is used to create a unique
8278 command name. KEYS are keys that should be checked in for a command
8279 to execute outside of tables."
8280 (eval
8281 (list 'defun
8282 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8283 '(arg)
8285 "Outside of structure, run the binding of `"
8286 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8287 "'.")
8288 '(interactive "p")
8289 (list 'if
8290 `(org-context-p 'headline 'item
8291 (and orgstruct-is-++
8292 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8293 'item-body))
8294 (list 'org-run-like-in-org-mode (list 'quote fun))
8295 (list 'let '(orgstruct-mode)
8296 (list 'call-interactively
8297 (append '(or)
8298 (mapcar (lambda (k)
8299 (list 'key-binding k))
8300 keys)
8301 '('orgstruct-error))))))))
8303 (defun org-context-p (&rest contexts)
8304 "Check if local context is any of CONTEXTS.
8305 Possible values in the list of contexts are `table', `headline', and `item'."
8306 (let ((pos (point)))
8307 (goto-char (point-at-bol))
8308 (prog1 (or (and (memq 'table contexts)
8310 (and (memq 'headline contexts)
8311 (looking-at org-outline-regexp))
8312 (and (memq 'item contexts)
8314 (and (memq 'item-body contexts)
8315 (org-in-item-p)))
8316 (goto-char pos))))
8318 (defun org-get-local-variables ()
8319 "Return a list of all local variables in an org-mode buffer."
8320 (let (varlist)
8321 (with-current-buffer (get-buffer-create "*Org tmp*")
8322 (erase-buffer)
8323 (org-mode)
8324 (setq varlist (buffer-local-variables)))
8325 (kill-buffer "*Org tmp*")
8326 (delq nil
8327 (mapcar
8328 (lambda (x)
8329 (setq x
8330 (if (symbolp x)
8331 (list x)
8332 (list (car x) (list 'quote (cdr x)))))
8333 (if (string-match
8334 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8335 (symbol-name (car x)))
8336 x nil))
8337 varlist))))
8339 (defun org-clone-local-variables (from-buffer &optional regexp)
8340 "Clone local variables from FROM-BUFFER.
8341 Optional argument REGEXP selects variables to clone."
8342 (mapc
8343 (lambda (pair)
8344 (and (symbolp (car pair))
8345 (or (null regexp)
8346 (string-match regexp (symbol-name (car pair))))
8347 (set (make-local-variable (car pair))
8348 (cdr pair))))
8349 (buffer-local-variables from-buffer)))
8351 ;;;###autoload
8352 (defun org-run-like-in-org-mode (cmd)
8353 "Run a command, pretending that the current buffer is in Org-mode.
8354 This will temporarily bind local variables that are typically bound in
8355 Org-mode to the values they have in Org-mode, and then interactively
8356 call CMD."
8357 (org-load-modules-maybe)
8358 (unless org-local-vars
8359 (setq org-local-vars (org-get-local-variables)))
8360 (eval (list 'let org-local-vars
8361 (list 'call-interactively (list 'quote cmd)))))
8363 ;;;; Archiving
8365 (defun org-get-category (&optional pos force-refresh)
8366 "Get the category applying to position POS."
8367 (if force-refresh (org-refresh-category-properties))
8368 (let ((pos (or pos (point))))
8369 (or (get-text-property pos 'org-category)
8370 (progn (org-refresh-category-properties)
8371 (get-text-property pos 'org-category)))))
8373 (defun org-refresh-category-properties ()
8374 "Refresh category text properties in the buffer."
8375 (let ((def-cat (cond
8376 ((null org-category)
8377 (if buffer-file-name
8378 (file-name-sans-extension
8379 (file-name-nondirectory buffer-file-name))
8380 "???"))
8381 ((symbolp org-category) (symbol-name org-category))
8382 (t org-category)))
8383 beg end cat pos optionp)
8384 (org-unmodified
8385 (save-excursion
8386 (save-restriction
8387 (widen)
8388 (goto-char (point-min))
8389 (put-text-property (point) (point-max) 'org-category def-cat)
8390 (while (re-search-forward
8392 (setq pos (match-end 0)
8393 optionp (equal (char-after (match-beginning 0)) ?#)
8394 cat (org-trim (match-string 2)))
8395 (if optionp
8396 (setq beg (point-at-bol) end (point-max))
8397 (org-back-to-heading t)
8398 (setq beg (point) end (org-end-of-subtree t t)))
8399 (put-text-property beg end 'org-category cat)
8400 (put-text-property beg end 'org-category-position beg)
8401 (goto-char pos)))))))
8404 ;;;; Link Stuff
8406 ;;; Link abbreviations
8408 (defun org-link-expand-abbrev (link)
8409 "Apply replacements as defined in `org-link-abbrev-alist."
8411 (let* ((key (match-string 1 link))
8412 (as (or (assoc key org-link-abbrev-alist-local)
8413 (assoc key org-link-abbrev-alist)))
8414 (tag (and (match-end 2) (match-string 3 link)))
8415 rpl)
8416 (if (not as)
8417 link
8418 (setq rpl (cdr as))
8419 (cond
8420 ((symbolp rpl) (funcall rpl tag))
8421 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8422 ((string-match "%h" rpl)
8423 (replace-match (url-hexify-string (or tag "")) t t rpl))
8424 (t (concat rpl tag)))))
8425 link))
8427 ;;; Storing and inserting links
8429 (defvar org-insert-link-history nil
8430 "Minibuffer history for links inserted with `org-insert-link'.")
8432 (defvar org-stored-links nil
8433 "Contains the links stored with `org-store-link'.")
8435 (defvar org-store-link-plist nil
8436 "Plist with info about the most recently link created with `org-store-link'.")
8438 (defvar org-link-protocols nil
8439 "Link protocols added to Org-mode using `org-add-link-type'.")
8441 (defvar org-store-link-functions nil
8442 "List of functions that are called to create and store a link.
8443 Each function will be called in turn until one returns a non-nil
8444 value. Each function should check if it is responsible for creating
8445 this link (for example by looking at the major mode).
8446 If not, it must exit and return nil.
8447 If yes, it should return a non-nil value after a calling
8448 `org-store-link-props' with a list of properties and values.
8449 Special properties are:
8453 This is obligatory as well.
8454 :description Optional default description for the second pair
8455 of brackets in an Org-mode link. The user can still change
8456 this when inserting this link into an Org-mode buffer.
8458 In addition to these, any additional properties can be specified
8459 and then used in remember templates.")
8461 (defun org-add-link-type (type &optional follow export)
8462 "Add TYPE to the list of `org-link-types'.
8463 Re-compute all regular expressions depending on `org-link-types'
8465 FOLLOW and EXPORT are two functions.
8467 FOLLOW should take the link path as the single argument and do whatever
8468 is necessary to follow the link, for example find a file or display
8469 a mail message.
8471 EXPORT should format the link path for export to one of the export formats.
8472 It should be a function accepting three arguments:
8475 desc the description of the link, if any, or a description added by
8476 org-export-normalize-links if there is none
8477 format the export format, a symbol like `html' or `latex' or `ascii'..
8479 The function may use the FORMAT information to return different values
8480 depending on the format. The return value will be put literally into
8481 the exported file. If the return value is nil, this means Org should
8482 do what it normally does with links which do not have EXPORT defined.
8484 Org-mode has a built-in default for exporting links. If you are happy with
8485 this default, there is no need to define an export function for the link
8486 type. For a simple example of an export function, see `org-bbdb.el'."
8487 (add-to-list 'org-link-types type t)
8488 (org-make-link-regexps)
8489 (if (assoc type org-link-protocols)
8490 (setcdr (assoc type org-link-protocols) (list follow export))
8491 (push (list type follow export) org-link-protocols)))
8493 (defvar org-agenda-buffer-name)
8495 ;;;###autoload
8496 (defun org-store-link (arg)
8498 This link is added to `org-stored-links' and can later be inserted
8501 For some link types, a prefix arg is interpreted:
8502 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8503 For file links, arg negates `org-context-in-file-links'."
8504 (interactive "P")
8505 (org-load-modules-maybe)
8506 (setq org-store-link-plist nil) ; reset
8507 (org-with-limited-levels
8508 (let (link cpltxt desc description search txt custom-id agenda-link)
8509 (cond
8511 ((run-hook-with-args-until-success 'org-store-link-functions)
8512 (setq link (plist-get org-store-link-plist :link)
8513 desc (or (plist-get org-store-link-plist :description) link)))
8515 ((equal (buffer-name) "*Org Edit Src Example*")
8516 (let (label gc)
8517 (while (or (not label)
8518 (save-excursion
8519 (save-restriction
8520 (widen)
8521 (goto-char (point-min))
8522 (re-search-forward
8523 (regexp-quote (format org-coderef-label-format label))
8524 nil t))))
8525 (when label (message "Label exists already") (sit-for 2))
8526 (setq label (read-string "Code line label: " label)))
8527 (end-of-line 1)
8528 (setq link (format org-coderef-label-format label))
8529 (setq gc (- 79 (length link)))
8530 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8531 (insert link)
8532 (setq link (concat "(" label ")") desc nil)))
8534 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8535 ;; We are in the agenda, link to referenced location
8536 (let ((m (or (get-text-property (point) 'org-hd-marker)
8537 (get-text-property (point) 'org-marker))))
8538 (when m
8539 (org-with-point-at m
8540 (setq agenda-link
8541 (if (org-called-interactively-p 'any)
8542 (call-interactively 'org-store-link)
8543 (org-store-link nil)))))))
8545 ((eq major-mode 'calendar-mode)
8546 (let ((cd (calendar-cursor-to-date)))
8547 (setq link
8548 (format-time-string
8549 (car org-time-stamp-formats)
8550 (apply 'encode-time
8551 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8552 nil nil nil))))
8553 (org-store-link-props :type "calendar" :date cd)))
8555 ((eq major-mode 'w3-mode)
8556 (setq cpltxt (if (and (buffer-name)
8557 (not (string-match "Untitled" (buffer-name))))
8558 (buffer-name)
8559 (url-view-url t))
8560 link (org-make-link (url-view-url t)))
8561 (org-store-link-props :type "w3" :url (url-view-url t)))
8563 ((eq major-mode 'w3m-mode)
8564 (setq cpltxt (or w3m-current-title w3m-current-url)
8565 link (org-make-link w3m-current-url))
8566 (org-store-link-props :type "w3m" :url (url-view-url t)))
8568 ((setq search (run-hook-with-args-until-success
8569 'org-create-file-search-functions))
8570 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8571 "::" search))
8572 (setq cpltxt (or description link)))
8574 ((eq major-mode 'image-mode)
8575 (setq cpltxt (concat "file:"
8576 (abbreviate-file-name buffer-file-name))
8577 link (org-make-link cpltxt))
8578 (org-store-link-props :type "image" :file buffer-file-name))
8580 ((eq major-mode 'dired-mode)
8581 ;; link to the file in the current line
8582 (let ((file (dired-get-filename nil t)))
8583 (setq file (if file
8584 (abbreviate-file-name
8585 (expand-file-name (dired-get-filename nil t)))
8586 ;; otherwise, no file so use current directory.
8587 default-directory))
8588 (setq cpltxt (concat "file:" file)
8589 link (org-make-link cpltxt))))
8591 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8592 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8593 (cond
8595 (setq cpltxt
8596 (concat "file:"
8597 (abbreviate-file-name
8598 (buffer-file-name (buffer-base-buffer)))
8599 "::" (match-string 1))
8600 link (org-make-link cpltxt)))
8601 ((and (featurep 'org-id)
8602 (or (eq org-link-to-org-use-id t)
8603 (and (eq org-link-to-org-use-id 'create-if-interactive)
8604 (org-called-interactively-p 'any))
8605 (and (eq org-link-to-org-use-id
8606 'create-if-interactive-and-no-custom-id)
8607 (org-called-interactively-p 'any)
8608 (not custom-id))
8609 (and org-link-to-org-use-id
8610 (org-entry-get nil "ID"))))
8611 ;; We can make a link using the ID.
8612 (setq link (condition-case nil
8613 (prog1 (org-id-store-link)
8614 (setq desc (plist-get org-store-link-plist
8615 :description)))
8616 (error
8617 ;; probably before first headline, link to file only
8618 (concat "file:"
8619 (abbreviate-file-name
8620 (buffer-file-name (buffer-base-buffer))))))))
8621 (t
8622 ;; Just link to current headline
8623 (setq cpltxt (concat "file:"
8624 (abbreviate-file-name
8625 (buffer-file-name (buffer-base-buffer)))))
8626 ;; Add a context search string
8627 (when (org-xor org-context-in-file-links arg)
8628 (setq txt (cond
8629 ((org-on-heading-p) nil)
8630 ((org-region-active-p)
8631 (buffer-substring (region-beginning) (region-end)))
8632 (t nil)))
8634 (setq cpltxt
8635 (concat cpltxt "::"
8636 (condition-case nil
8637 (org-make-org-heading-search-string txt)
8638 (error "")))
8639 desc (or (nth 4 (ignore-errors
8640 (org-heading-components))) "NONE"))))
8642 (setq cpltxt (substring cpltxt 0 -2)))
8643 (setq link (org-make-link cpltxt)))))
8645 ((buffer-file-name (buffer-base-buffer))
8646 ;; Just link to this file here.
8647 (setq cpltxt (concat "file:"
8648 (abbreviate-file-name
8649 (buffer-file-name (buffer-base-buffer)))))
8650 ;; Add a context string
8651 (when (org-xor org-context-in-file-links arg)
8652 (setq txt (if (org-region-active-p)
8653 (buffer-substring (region-beginning) (region-end))
8654 (buffer-substring (point-at-bol) (point-at-eol))))
8655 ;; Only use search option if there is some text.
8657 (setq cpltxt
8658 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8659 desc "NONE")))
8660 (setq link (org-make-link cpltxt)))
8662 ((org-called-interactively-p 'interactive)
8663 (error "Cannot link to a buffer which is not visiting a file"))
8665 (t (setq link nil)))
8667 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8668 (setq link (or link cpltxt)
8669 desc (or desc cpltxt))
8670 (if (equal desc "NONE") (setq desc nil))
8672 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8673 (progn
8674 (setq org-stored-links
8675 (cons (list link desc) org-stored-links))
8676 (message "Stored: %s" (or desc link))
8677 (when custom-id
8678 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8679 "::#" custom-id))
8680 (setq org-stored-links
8681 (cons (list link desc) org-stored-links))))
8682 (or agenda-link (and link (org-make-link-string link desc)))))))
8684 (defun org-store-link-props (&rest plist)
8685 "Store link properties, extract names and addresses."
8686 (let (x adr)
8687 (when (setq x (plist-get plist :from))
8688 (setq adr (mail-extract-address-components x))
8689 (setq plist (plist-put plist :fromname (car adr)))
8690 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8691 (when (setq x (plist-get plist :to))
8692 (setq adr (mail-extract-address-components x))
8693 (setq plist (plist-put plist :toname (car adr)))
8694 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8695 (let ((from (plist-get plist :from))
8696 (to (plist-get plist :to)))
8697 (when (and from to org-from-is-user-regexp)
8698 (setq plist
8699 (plist-put plist :fromto
8700 (if (string-match org-from-is-user-regexp from)
8701 (concat "to %t")
8702 (concat "from %f"))))))
8703 (setq org-store-link-plist plist))
8705 (defun org-add-link-props (&rest plist)
8706 "Add these properties to the link property list."
8707 (let (key value)
8708 (while plist
8709 (setq key (pop plist) value (pop plist))
8710 (setq org-store-link-plist
8711 (plist-put org-store-link-plist key value)))))
8713 (defun org-email-link-description (&optional fmt)
8714 "Return the description part of an email link.
8715 This takes information from `org-store-link-plist' and formats it
8716 according to FMT (default from `org-email-link-description-format')."
8717 (setq fmt (or fmt org-email-link-description-format))
8718 (let* ((p org-store-link-plist)
8719 (to (plist-get p :toaddress))
8720 (from (plist-get p :fromaddress))
8721 (table
8722 (list
8723 (cons "%c" (plist-get p :fromto))
8724 (cons "%F" (plist-get p :from))
8725 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8726 (cons "%T" (plist-get p :to))
8727 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8728 (cons "%s" (plist-get p :subject))
8729 (cons "%d" (plist-get p :date))
8730 (cons "%m" (plist-get p :message-id)))))
8731 (when (string-match "%c" fmt)
8732 ;; Check if the user wrote this message
8733 (if (and org-from-is-user-regexp from to
8734 (save-match-data (string-match org-from-is-user-regexp from)))
8735 (setq fmt (replace-match "to %t" t t fmt))
8736 (setq fmt (replace-match "from %f" t t fmt))))
8737 (org-replace-escapes fmt table)))
8739 (defun org-make-org-heading-search-string (&optional string heading)
8740 "Make search string for STRING or current headline."
8741 (interactive)
8742 (let ((s (or string (org-get-heading)))
8743 (lines org-context-in-file-links))
8744 (unless (and string (not heading))
8745 ;; We are using a headline, clean up garbage in there.
8746 (if (string-match org-todo-regexp s)
8747 (setq s (replace-match "" t t s)))
8749 (setq s (replace-match "" t t s)))
8750 (setq s (org-trim s))
8753 (setq s (replace-match "" t t s)))
8754 (while (string-match org-ts-regexp s)
8755 (setq s (replace-match "" t t s))))
8756 (or string (setq s (concat "*" s))) ; Add * for headlines
8757 (when (and string (integerp lines) (> lines 0))
8759 (when (< lines (length slines))
8760 (setq s (mapconcat
8761 'identity
8762 (reverse (nthcdr (- (length slines) lines)
8766 (defun org-make-link (&rest strings)
8767 "Concatenate STRINGS."
8768 (apply 'concat strings))
8770 (defun org-make-link-string (link &optional description)
8771 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8773 (error "Empty link"))
8774 (when (and description
8775 (stringp description)
8777 (setq description nil))
8778 (when (stringp description)
8779 ;; Remove brackets from the description, they are fatal.
8781 (setq description (replace-match "{" t t description)))
8783 (setq description (replace-match "}" t t description))))
8784 (when (equal link description)
8785 ;; No description needed, it is identical
8786 (setq description nil))
8787 (when (and (not description)
8788 (not (string-match (org-image-file-name-regexp) link))
8789 (not (equal link (org-link-escape link))))
8790 (setq description (org-extract-attributes link)))
8791 (setq link
8792 (cond ((string-match (org-image-file-name-regexp) link) link)
8793 ((string-match org-link-types-re link)
8794 (concat (match-string 1 link)
8795 (org-link-escape (substring link (match-end 1)))))
8796 (t (org-link-escape link))))
8797 (concat "[[" link "]"
8798 (if description (concat "[" description "]") "")
8799 "]"))
8801 (defconst org-link-escape-chars
8802 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8803 "List of characters that should be escaped in link.
8804 This is the list that is used for internal purposes.")
8806 (defvar org-url-encoding-use-url-hexify nil)
8808 (defconst org-link-escape-chars-browser
8809 '(?\ )
8810 "List of escapes for characters that are problematic in links.
8811 This is the list that is used before handing over to the browser.")
8813 (defun org-link-escape (text &optional table merge)
8814 "Return percent escaped representation of TEXT.
8815 TEXT is a string with the text to escape.
8816 Optional argument TABLE is a list with characters that should be
8817 escaped. When nil, `org-link-escape-chars' is used.
8818 If optional argument MERGE is set, merge TABLE into
8819 `org-link-escape-chars'."
8820 (if (and org-url-encoding-use-url-hexify (not table))
8821 (url-hexify-string text)
8822 (cond
8823 ((and table merge)
8824 (mapc (lambda (defchr)
8825 (unless (member defchr table)
8826 (setq table (cons defchr table)))) org-link-escape-chars))
8827 ((null table)
8828 (setq table org-link-escape-chars)))
8829 (mapconcat
8830 (lambda (char)
8831 (if (or (member char table)
8832 (< char 32) (= char 37) (> char 126))
8833 (mapconcat (lambda (sequence-element)
8834 (format "%%%.2X" sequence-element))
8835 (or (encode-coding-char char 'utf-8)
8836 (error "Unable to percent escape character: %s"
8837 (char-to-string char))) "")
8838 (char-to-string char))) text "")))
8840 (defun org-link-unescape (str)
8841 "Unhex hexified unicode strings as returned from the JavaScript function
8842 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8843 (unless (and (null str) (string= "" str))
8844 (let ((pos 0) (case-fold-search t) unhexed)
8846 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8847 (setq str (replace-match unhexed t t str))
8848 (setq pos (+ pos (length unhexed))))))
8849 str)
8851 (defun org-link-unescape-compound (hex)
8852 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8853 Note: this function also decodes single byte encodings like
8855 (save-match-data
8856 (let* ((bytes (cdr (split-string hex "%")))
8857 (ret "")
8858 (eat 0)
8859 (sum 0))
8860 (while bytes
8861 (let* ((val (string-to-number (pop bytes) 16))
8862 (shift-xor
8863 (if (= 0 eat)
8864 (cond
8865 ((>= val 252) (cons 6 252))
8866 ((>= val 248) (cons 5 248))
8867 ((>= val 240) (cons 4 240))
8868 ((>= val 224) (cons 3 224))
8869 ((>= val 192) (cons 2 192))
8870 (t (cons 0 0)))
8871 (cons 6 128))))
8872 (if (>= val 192) (setq eat (car shift-xor)))
8873 (setq val (logxor val (cdr shift-xor)))
8874 (setq sum (+ (lsh sum (car shift-xor)) val))
8875 (if (> eat 0) (setq eat (- eat 1)))
8876 (cond
8877 ((= 0 eat) ;multi byte
8878 (setq ret (concat ret (org-char-to-string sum)))
8879 (setq sum 0))
8880 ((not bytes) ; single byte(s)
8881 (setq ret (org-link-unescape-single-byte-sequence hex))))
8882 )) ;; end (while bytes
8883 ret )))
8885 (defun org-link-unescape-single-byte-sequence (hex)
8886 "Unhexify hex-encoded single byte character sequences."
8887 (mapconcat (lambda (byte)
8888 (char-to-string (string-to-number byte 16)))
8889 (cdr (split-string hex "%")) ""))
8891 (defun org-xor (a b)
8892 "Exclusive or."
8893 (if a (not b) b))
8895 (defun org-fixup-message-id-for-http (s)
8896 "Replace special characters in a message id, so it can be used in an http query."
8897 (when (string-match "%" s)
8898 (setq s (mapconcat (lambda (c)
8899 (if (eq c ?%)
8900 "%25"
8901 (char-to-string c)))
8902 s "")))
8903 (while (string-match "<" s)
8904 (setq s (replace-match "%3C" t t s)))
8905 (while (string-match ">" s)
8906 (setq s (replace-match "%3E" t t s)))
8907 (while (string-match "@" s)
8908 (setq s (replace-match "%40" t t s)))
8909 s)
8911 ;;;###autoload
8912 (defun org-insert-link-global ()
8913 "Insert a link like Org-mode does.
8914 This command can be called in any mode to insert a link in Org-mode syntax."
8915 (interactive)
8916 (org-load-modules-maybe)
8917 (org-run-like-in-org-mode 'org-insert-link))
8919 (defun org-insert-link (&optional complete-file link-location)
8920 "Insert a link. At the prompt, enter the link.
8922 Completion can be used to insert any of the link protocol prefixes like
8923 http or ftp in use.
8925 The history can be used to select a link previously stored with
8926 `org-store-link'. When the empty string is entered (i.e. if you just
8927 press RET at the prompt), the link defaults to the most recently
8928 stored link. As SPC triggers completion in the minibuffer, you need to
8929 use M-SPC or C-q SPC to force the insertion of a space character.
8931 You will also be prompted for a description, and if one is given, it will
8932 be displayed in the buffer instead of the link.
8934 If there is already a link at point, this command will allow you to edit link
8935 and description parts.
8938 be selected using completion. The path to the file will be relative to the
8939 current directory if the file is in the current directory or a subdirectory.
8940 Otherwise, the link will be the absolute path as completed in the minibuffer
8941 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8942 option `org-link-file-path-type'.
8945 the current directory or below.
8948 `org-keep-stored-link-after-insertion'.
8950 If `org-make-link-description-function' is non-nil, this function will be
8951 called with the link target, and the result will be the default
8952 link description.
8954 If the LINK-LOCATION parameter is non-nil, this value will be
8955 used as the link location instead of reading one interactively."
8956 (interactive "P")
8957 (let* ((wcf (current-window-configuration))
8958 (region (if (org-region-active-p)
8959 (buffer-substring (region-beginning) (region-end))))
8960 (remove (and region (list (region-beginning) (region-end))))
8961 (desc region)
8962 tmphist ; byte-compile incorrectly complains about this
8963 (link link-location)
8964 entry file all-prefixes)
8965 (cond
8966 (link-location) ; specified by arg, just use it.
8967 ((org-in-regexp org-bracket-link-regexp 1)
8968 ;; We do have a link at point, and we are going to edit it.
8969 (setq remove (list (match-beginning 0) (match-end 0)))
8970 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8971 (setq link (read-string "Link: "
8972 (org-link-unescape
8973 (org-match-string-no-properties 1)))))
8974 ((or (org-in-regexp org-angle-link-re)
8975 (org-in-regexp org-plain-link-re))
8976 ;; Convert to bracket link
8977 (setq remove (list (match-beginning 0) (match-end 0))
8978 link (read-string "Link: "
8979 (org-remove-angle-brackets (match-string 0)))))
8980 ((member complete-file '((4) (16)))
8981 ;; Completing read for file names.
8982 (setq link (org-file-complete-link complete-file)))
8983 (t
8984 ;; Read link, with completion for stored links.
8985 (with-output-to-temp-buffer "*Org Links*"
8986 (princ "Insert a link.
8988 (when org-stored-links
8990 (princ (mapconcat
8991 (lambda (x)
8992 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8994 (let ((cw (selected-window)))
8995 (select-window (get-buffer-window "*Org Links*" 'visible))
8996 (with-current-buffer "*Org Links*" (setq truncate-lines t))
8997 (unless (pos-visible-in-window-p (point-max))
8998 (org-fit-window-to-buffer))
8999 (and (window-live-p cw) (select-window cw)))
9000 ;; Fake a link history, containing the stored links.
9001 (setq tmphist (append (mapcar 'car org-stored-links)
9002 org-insert-link-history))
9003 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9004 (mapcar 'car org-link-abbrev-alist)
9005 org-link-types))
9006 (unwind-protect
9007 (progn
9008 (setq link
9009 (let ((org-completion-use-ido nil)
9010 (org-completion-use-iswitchb nil))
9011 (org-completing-read
9012 "Link: "
9013 (append
9014 (mapcar (lambda (x) (list (concat x ":")))
9015 all-prefixes)
9016 (mapcar 'car org-stored-links))
9017 nil nil nil
9018 'tmphist
9019 (car (car org-stored-links)))))
9021 (error "No link selected"))
9022 (if (or (member link all-prefixes)
9023 (and (equal ":" (substring link -1))
9024 (member (substring link 0 -1) all-prefixes)
9025 (setq link (substring link 0 -1))))
9026 (setq link (org-link-try-special-completion link))))
9027 (set-window-configuration wcf)
9028 (kill-buffer "*Org Links*"))
9029 (setq entry (assoc link org-stored-links))
9030 (or entry (push link org-insert-link-history))
9031 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9032 (not org-keep-stored-link-after-insertion))
9033 (setq org-stored-links (delq (assoc link org-stored-links)
9034 org-stored-links)))
9035 (setq desc (or desc (nth 1 entry)))))
9037 (if (string-match org-plain-link-re link)
9038 ;; URL-like link, normalize the use of angular brackets.
9039 (setq link (org-make-link (org-remove-angle-brackets link))))
9041 ;; Check if we are linking to the current file with a search option
9042 ;; If yes, simplify the link by using only the search option.
9043 (when (and buffer-file-name
9045 (let* ((path (match-string 1 link))
9046 (case-fold-search nil)
9047 (search (match-string 2 link)))
9048 (save-match-data
9049 (if (equal (file-truename buffer-file-name) (file-truename path))
9050 ;; We are linking to this same file, with a search option
9051 (setq link search)))))
9053 ;; Check if we can/should use a relative path. If yes, simplify the link
9055 (let* ((type (match-string 1 link))
9056 (path (match-string 2 link))
9057 (origpath path)
9058 (case-fold-search nil))
9059 (cond
9060 ((or (eq org-link-file-path-type 'absolute)
9061 (equal complete-file '(16)))
9062 (setq path (abbreviate-file-name (expand-file-name path))))
9063 ((eq org-link-file-path-type 'noabbrev)
9064 (setq path (expand-file-name path)))
9065 ((eq org-link-file-path-type 'relative)
9066 (setq path (file-relative-name path)))
9067 (t
9068 (save-match-data
9069 (if (string-match (concat "^" (regexp-quote
9070 (expand-file-name
9071 (file-name-as-directory
9072 default-directory))))
9073 (expand-file-name path))
9074 ;; We are linking a file with relative path name.
9075 (setq path (substring (expand-file-name path)
9076 (match-end 0)))
9077 (setq path (abbreviate-file-name (expand-file-name path)))))))
9078 (setq link (concat type path))
9079 (if (equal desc origpath)
9080 (setq desc path))))
9082 (if org-make-link-description-function
9083 (setq desc (funcall org-make-link-description-function link desc)))
9085 (setq desc (read-string "Description: " desc))
9087 (if remove (apply 'delete-region remove))
9088 (insert (org-make-link-string link desc))))
9090 (defun org-link-try-special-completion (type)
9091 "If there is completion support for link type TYPE, offer it."
9092 (let ((fun (intern (concat "org-" type "-complete-link"))))
9093 (if (functionp fun)
9094 (funcall fun)
9095 (read-string "Link (no completion support): " (concat type ":")))))
9097 (defun org-file-complete-link (&optional arg)
9098 "Create a file link using completion."
9099 (let (file link)
9100 (setq file (read-file-name "File: "))
9101 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9102 (pwd1 (file-name-as-directory (abbreviate-file-name
9103 (expand-file-name ".")))))
9104 (cond
9105 ((equal arg '(16))
9106 (setq link (org-make-link
9107 "file:"
9108 (abbreviate-file-name (expand-file-name file)))))
9110 (setq link (org-make-link "file:" (match-string 1 file))))
9112 (expand-file-name file))
9113 (setq link (org-make-link
9114 "file:" (match-string 1 (expand-file-name file)))))
9115 (t (setq link (org-make-link "file:" file)))))
9116 link))
9118 (defun org-completing-read (&rest args)
9119 "Completing-read with SPACE being a normal character."
9120 (let ((minibuffer-local-completion-map
9121 (copy-keymap minibuffer-local-completion-map)))
9122 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9123 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9124 (apply 'org-icompleting-read args)))
9126 (defun org-completing-read-no-i (&rest args)
9127 (let (org-completion-use-ido org-completion-use-iswitchb)
9128 (apply 'org-completing-read args)))
9130 (defun org-iswitchb-completing-read (prompt choices &rest args)
9131 "Use iswitch as a completing-read replacement to choose from choices.
9132 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9133 from."
9134 (let* ((iswitchb-use-virtual-buffers nil)
9135 (iswitchb-make-buflist-hook
9136 (lambda ()
9137 (setq iswitchb-temp-buflist choices))))
9138 (iswitchb-read-buffer prompt)))
9140 (defun org-icompleting-read (&rest args)
9141 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9142 (org-without-partial-completion
9143 (if (and org-completion-use-ido
9144 (fboundp 'ido-completing-read)
9145 (boundp 'ido-mode) ido-mode
9146 (listp (second args)))
9147 (let ((ido-enter-matching-directory nil))
9148 (apply 'ido-completing-read (concat (car args))
9149 (if (consp (car (nth 1 args)))
9150 (mapcar 'car (nth 1 args))
9151 (nth 1 args))
9152 (cddr args)))
9153 (if (and org-completion-use-iswitchb
9154 (boundp 'iswitchb-mode) iswitchb-mode
9155 (listp (second args)))
9156 (apply 'org-iswitchb-completing-read (concat (car args))
9157 (if (consp (car (nth 1 args)))
9158 (mapcar 'car (nth 1 args))
9159 (nth 1 args))
9160 (cddr args))
9161 (apply 'completing-read args)))))
9163 (defun org-extract-attributes (s)
9164 "Extract the attributes cookie from a string and set as text property."
9165 (let (a attr (start 0) key value)
9166 (save-match-data
9168 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9170 (setq key (match-string 1 a) value (match-string 2 a)
9171 start (match-end 0)
9172 attr (plist-put attr (intern key) value))))
9173 (org-add-props s nil 'org-attr attr))
9174 s))
9176 (defun org-extract-attributes-from-string (tag)
9177 (let (key value attr)
9179 (setq key (match-string 1 tag) value (match-string 2 tag)
9180 tag (replace-match "" t t tag)
9181 attr (plist-put attr (intern key) value)))
9182 (cons tag attr)))
9184 (defun org-attributes-to-string (plist)
9185 "Format a property list into an HTML attribute list."
9186 (let ((s "") key value)
9187 (while plist
9188 (setq key (pop plist) value (pop plist))
9189 (and value
9191 s))
9193 ;;; Opening/following a link
9195 (defvar org-link-search-failed nil)
9197 (defvar org-open-link-functions nil
9198 "Hook for functions finding a plain text link.
9199 These functions must take a single argument, the link content.
9200 They will be called for links that look like [[link text][description]]
9204 These functions will be called *before* Org attempts to resolve the
9205 link by doing text searches in the current buffer - so if you want a
9207 handle this as a special case.
9209 When the function does handle the link, it must return a non-nil value.
9210 If it decides that it is not responsible for this link, it must return
9211 nil to indicate that that Org-mode can continue with other options
9212 like exact and fuzzy text search.")
9214 (defun org-next-link ()
9215 "Move forward to the next link.
9216 If the link is in hidden text, expose it."
9217 (interactive)
9218 (when (and org-link-search-failed (eq this-command last-command))
9219 (goto-char (point-min))
9220 (message "Link search wrapped back to beginning of buffer"))
9221 (setq org-link-search-failed nil)
9222 (let* ((pos (point))
9223 (ct (org-context))
9224 (a (assoc :link ct)))
9225 (if a (goto-char (nth 2 a)))
9226 (if (re-search-forward org-any-link-re nil t)
9227 (progn
9228 (goto-char (match-beginning 0))
9229 (if (outline-invisible-p) (org-show-context)))
9230 (goto-char pos)
9231 (setq org-link-search-failed t)
9232 (error "No further link found"))))
9234 (defun org-previous-link ()
9235 "Move backward to the previous link.
9236 If the link is in hidden text, expose it."
9237 (interactive)
9238 (when (and org-link-search-failed (eq this-command last-command))
9239 (goto-char (point-max))
9240 (message "Link search wrapped back to end of buffer"))
9241 (setq org-link-search-failed nil)
9242 (let* ((pos (point))
9243 (ct (org-context))
9244 (a (assoc :link ct)))
9245 (if a (goto-char (nth 1 a)))
9246 (if (re-search-backward org-any-link-re nil t)
9247 (progn
9248 (goto-char (match-beginning 0))
9249 (if (outline-invisible-p) (org-show-context)))
9250 (goto-char pos)
9251 (setq org-link-search-failed t)
9252 (error "No further link found"))))
9254 (defun org-translate-link (s)
9255 "Translate a link string if a translation function has been defined."
9256 (if (and org-link-translation-function
9257 (fboundp org-link-translation-function)
9259 (progn
9260 (setq s (funcall org-link-translation-function
9261 (match-string 1) (match-string 2)))
9262 (concat (car s) ":" (cdr s)))
9263 s))
9265 (defun org-translate-link-from-planner (type path)
9266 "Translate a link from Emacs Planner syntax so that Org can follow it.
9267 This is still an experimental function, your mileage may vary."
9268 (cond
9269 ((member type '("http" "https" "news" "ftp"))
9270 ;; standard Internet links are the same.
9271 nil)
9272 ((and (equal type "irc") (string-match "^//" path))
9273 ;; Planner has two / at the beginning of an irc link, we have 1.
9274 ;; We should have zero, actually....
9275 (setq path (substring path 1)))
9276 ((and (equal type "lisp") (string-match "^/" path))
9277 ;; Planner has a slash, we do not.
9278 (setq type "elisp" path (substring path 1)))
9280 ;; A typical message link. Planner has the id after the final slash,
9281 ;; we separate it with a hash mark
9282 (setq path (concat (match-string 1 path) "#"
9283 (org-remove-angle-brackets (match-string 2 path)))))
9284 )
9285 (cons type path))
9287 (defun org-find-file-at-mouse (ev)
9288 "Open file link or URL at mouse."
9289 (interactive "e")
9290 (mouse-set-point ev)
9291 (org-open-at-point 'in-emacs))
9293 (defun org-open-at-mouse (ev)
9294 "Open file link or URL at mouse.
9295 See the docstring of `org-open-file' for details."
9296 (interactive "e")
9297 (mouse-set-point ev)
9298 (if (eq major-mode 'org-agenda-mode)
9299 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9300 (org-open-at-point))
9302 (defvar org-window-config-before-follow-link nil
9303 "The window configuration before following a link.
9304 This is saved in case the need arises to restore it.")
9306 (defvar org-open-link-marker (make-marker)
9307 "Marker pointing to the location where `org-open-at-point; was called.")
9309 ;;;###autoload
9310 (defun org-open-at-point-global ()
9311 "Follow a link like Org-mode does.
9312 This command can be called in any mode to follow a link that has
9313 Org-mode syntax."
9314 (interactive)
9315 (org-run-like-in-org-mode 'org-open-at-point))
9317 ;;;###autoload
9318 (defun org-open-link-from-string (s &optional arg reference-buffer)
9319 "Open a link in the string S, as if it was in Org-mode."
9321 (let ((reference-buffer (or reference-buffer (current-buffer))))
9322 (with-temp-buffer
9323 (let ((org-inhibit-startup t))
9324 (org-mode)
9325 (insert s)
9326 (goto-char (point-min))
9327 (when reference-buffer
9328 (setq org-link-abbrev-alist-local
9329 (with-current-buffer reference-buffer
9330 org-link-abbrev-alist-local)))
9331 (org-open-at-point arg reference-buffer)))))
9333 (defvar org-open-at-point-functions nil
9334 "Hook that is run when following a link at point.
9336 Functions in this hook must return t if they identify and follow
9337 a link at point. If they don't find anything interesting at point,
9338 they must return nil.")
9340 (defun org-open-at-point (&optional arg reference-buffer)
9341 "Open link at or after point.
9342 If there is no link at point, this function will search forward up to
9343 the end of the current line.
9344 Normally, files will be opened by an appropriate application. If the
9345 optional prefix argument ARG is non-nil, Emacs will visit the file.
9346 With a double prefix argument, try to open outside of Emacs, in the
9347 application the system uses for this file type."
9348 (interactive "P")
9349 ;; if in a code block, then open the block's results
9350 (unless (call-interactively #'org-babel-open-src-block-result)
9351 (org-load-modules-maybe)
9352 (move-marker org-open-link-marker (point))
9353 (setq org-window-config-before-follow-link (current-window-configuration))
9354 (org-remove-occur-highlights nil nil t)
9355 (cond
9356 ((and (org-on-heading-p)
9357 (not (org-in-regexp
9362 (not (get-text-property (point) 'org-linked-text)))
9363 (or (org-offer-links-in-entry arg)
9364 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9365 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9366 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9367 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9368 (not (org-in-regexp org-bracket-link-regexp)))
9369 (org-footnote-action))
9370 (t
9371 (let (type path link line search (pos (point)))
9372 (catch 'match
9373 (save-excursion
9375 (when (org-in-regexp org-bracket-link-regexp 1)
9376 (setq link (org-extract-attributes
9377 (org-link-unescape (org-match-string-no-properties 1))))
9379 (setq link (replace-match " " t t link)))
9380 (setq link (org-link-expand-abbrev link))
9381 (cond
9382 ((or (file-name-absolute-p link)
9384 (setq type "file" path link))
9385 ((string-match org-link-re-with-space3 link)
9386 (setq type (match-string 1 link) path (match-string 2 link)))
9387 (t (setq type "thisfile" path link)))
9388 (throw 'match t)))
9390 (when (get-text-property (point) 'org-linked-text)
9391 (setq type "thisfile"
9392 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9393 (1+ (point)) (point))
9394 path (buffer-substring
9395 (or (previous-single-property-change pos 'org-linked-text)
9396 (point-min))
9397 (or (next-single-property-change pos 'org-linked-text)
9398 (point-max))))
9399 (throw 'match t))
9401 (save-excursion
9402 (when (or (org-in-regexp org-angle-link-re)
9403 (org-in-regexp org-plain-link-re))
9404 (setq type (match-string 1)
9405 path (org-link-unescape (match-string 2)))
9406 (throw 'match t)))
9407 (save-excursion
9409 (setq type "tags"
9410 path (match-string 1))
9411 (while (string-match ":" path)
9412 (setq path (replace-match "+" t t path)))
9413 (throw 'match t)))
9415 (setq type "tree-match"
9416 path (match-string 1))
9417 (throw 'match t)))
9418 (unless path
9419 (error "No link found"))
9421 ;; switch back to reference buffer
9422 ;; needed when if called in a temporary buffer through
9423 ;; org-open-link-from-string
9424 (with-current-buffer (or reference-buffer (current-buffer))
9426 ;; Remove any trailing spaces in path
9428 (setq path (replace-match "" t t path)))
9429 (if (and org-link-translation-function
9430 (fboundp org-link-translation-function))
9431 ;; Check if we need to translate the link
9432 (let ((tmp (funcall org-link-translation-function type path)))
9433 (setq type (car tmp) path (cdr tmp))))
9435 (cond
9437 ((assoc type org-link-protocols)
9438 (funcall (nth 1 (assoc type org-link-protocols)) path))
9440 ((equal type "mailto")
9441 (let ((cmd (car org-link-mailto-program))
9442 (args (cdr org-link-mailto-program)) args1
9443 (address path) (subject "") a)
9445 (setq address (match-string 1 path)
9446 subject (org-link-escape (match-string 2 path))))
9447 (while args
9448 (cond
9449 ((not (stringp (car args))) (push (pop args) args1))
9450 (t (setq a (pop args))
9451 (if (string-match "%a" a)
9452 (setq a (replace-match address t t a)))
9453 (if (string-match "%s" a)
9454 (setq a (replace-match subject t t a)))
9455 (push a args1))))
9456 (apply cmd (nreverse args1))))
9458 ((member type '("http" "https" "ftp" "news"))
9459 (browse-url (concat type ":" (org-link-escape
9460 path org-link-escape-chars-browser))))
9462 ((string= type "doi")
9463 (browse-url (concat "http://dx.doi.org/"
9464 (org-link-escape
9465 path org-link-escape-chars-browser))))
9467 ((member type '("message"))
9468 (browse-url (concat type ":" path)))
9470 ((string= type "tags")
9471 (org-tags-view arg path))
9473 ((string= type "tree-match")
9476 ((string= type "file")
9478 (setq line (string-to-number (match-string 1 path))
9479 path (substring path 0 (match-beginning 0)))
9481 (setq search (match-string 1 path)
9482 path (substring path 0 (match-beginning 0)))))
9483 (if (string-match "[*?{]" (file-name-nondirectory path))
9484 (dired path)
9485 (org-open-file path arg line search)))
9487 ((string= type "shell")
9488 (let ((cmd path))
9489 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9490 (string-match org-confirm-shell-link-not-regexp cmd))
9491 (not org-confirm-shell-link-function)
9492 (funcall org-confirm-shell-link-function
9494 (org-add-props cmd nil
9495 'face 'org-warning))))
9496 (progn
9497 (message "Executing %s" cmd)
9498 (shell-command cmd))
9499 (error "Abort"))))
9501 ((string= type "elisp")
9502 (let ((cmd path))
9503 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9504 (string-match org-confirm-elisp-link-not-regexp cmd))
9505 (not org-confirm-elisp-link-function)
9506 (funcall org-confirm-elisp-link-function
9508 (org-add-props cmd nil
9509 'face 'org-warning))))
9510 (message "%s => %s" cmd
9511 (if (equal (string-to-char cmd) ?\()
9512 (eval (read cmd))
9513 (call-interactively (read cmd))))
9514 (error "Abort"))))
9516 ((and (string= type "thisfile")
9517 (run-hook-with-args-until-success
9518 'org-open-link-functions path)))
9520 ((string= type "thisfile")
9521 (if arg
9522 (switch-to-buffer-other-window
9523 (org-get-buffer-for-internal-link (current-buffer)))
9524 (org-mark-ring-push))
9525 (let ((cmd `(org-link-search
9526 ,path
9527 ,(cond ((equal arg '(4)) ''occur)
9528 ((equal arg '(16)) ''org-occur)
9529 (t nil))
9530 ,pos)))
9531 (condition-case nil (let ((org-link-search-inhibit-query t))
9532 (eval cmd))
9533 (error (progn (widen) (eval cmd))))))
9535 (t
9536 (browse-url-at-point)))))))
9537 (move-marker org-open-link-marker nil)
9538 (run-hook-with-args 'org-follow-link-hook)))
9540 (defun org-offer-links-in-entry (&optional nth zero)
9541 "Offer links in the current entry and follow the selected link.
9542 If there is only one link, follow it immediately as well.
9543 If NTH is an integer, immediately pick the NTH link found.
9544 If ZERO is a string, check also this string for a link, and if
9545 there is one, offer it as link number zero."
9549 (cnt ?0)
9550 (in-emacs (if (integerp nth) nil nth))
9551 have-zero end links link c)
9552 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9553 (push (match-string 0 zero) links)
9554 (setq cnt (1- cnt) have-zero t))
9555 (save-excursion
9556 (org-back-to-heading t)
9557 (setq end (save-excursion (outline-next-heading) (point)))
9558 (while (re-search-forward re end t)
9559 (push (match-string 0) links))
9560 (setq links (org-uniquify (reverse links))))
9562 (cond
9563 ((null links)
9564 (message "No links"))
9565 ((equal (length links) 1)
9566 (setq link (list (car links))))
9567 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9568 (setq link (nth (if have-zero nth (1- nth)) links)))
9569 (t ; we have to select a link
9570 (save-excursion
9571 (save-window-excursion
9572 (delete-other-windows)
9573 (with-output-to-temp-buffer "*Select Link*"
9574 (mapc (lambda (l)
9575 (if (not (string-match org-bracket-link-regexp l))
9577 (org-remove-angle-brackets l)))
9578 (if (match-end 3)
9580 (match-string 3 l) (match-string 1 l)))
9582 (match-string 1 l))))))
9583 links))
9584 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9585 (message "Select link to open, RET to open all:")
9586 (setq c (read-char-exclusive))
9587 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9588 (when (equal c ?q) (error "Abort"))
9589 (if (equal c ?\C-m)
9590 (setq link links)
9591 (setq nth (- c ?0))
9592 (if have-zero (setq nth (1+ nth)))
9593 (unless (and (integerp nth) (>= (length links) nth))
9594 (error "Invalid link selection"))
9595 (setq link (list (nth (1- nth) links))))))
9596 (if link
9597 (let ((buf (current-buffer)))
9598 (dolist (l link)
9599 (org-open-link-from-string l in-emacs buf))
9600 t)
9601 nil)))
9603 ;; Add special file links that specify the way of opening
9605 (org-add-link-type "file+sys" 'org-open-file-with-system)
9606 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9607 (defun org-open-file-with-system (path)
9608 "Open file at PATH using the system way of opening it."
9609 (org-open-file path 'system))
9610 (defun org-open-file-with-emacs (path)
9611 "Open file at PATH in Emacs."
9612 (org-open-file path 'emacs))
9613 (defun org-remove-file-link-modifiers ()
9614 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9615 (goto-char (point-min))
9617 (org-if-unprotected
9618 (replace-match "file:" t t))))
9619 (eval-after-load "org-exp"
9620 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9621 'org-remove-file-link-modifiers))
9623 ;;;; Time estimates
9625 (defun org-get-effort (&optional pom)
9626 "Get the effort estimate for the current entry."
9627 (org-entry-get pom org-effort-property))
9629 ;;; File search
9631 (defvar org-create-file-search-functions nil
9632 "List of functions to construct the right search string for a file link.
9633 These functions are called in turn with point at the location to
9634 which the link should point.
9636 A function in the hook should first test if it would like to
9637 handle this file type, for example by checking the `major-mode'
9638 or the file extension. If it decides not to handle this file, it
9639 should just return nil to give other functions a chance. If it
9640 does handle the file, it must return the search string to be used
9641 when following the link. The search string will be part of the
9642 file link, given after a double colon, and `org-open-at-point'
9643 will automatically search for it. If special measures must be
9644 taken to make the search successful, another function should be
9645 added to the companion hook `org-execute-file-search-functions',
9646 which see.
9648 A function in this hook may also use `setq' to set the variable
9649 `description' to provide a suggestion for the descriptive text to
9650 be used for this link when it gets inserted into an Org-mode
9653 (defvar org-execute-file-search-functions nil
9654 "List of functions to execute a file search triggered by a link.
9656 Functions added to this hook must accept a single argument, the
9657 search string that was part of the file link, the part after the
9658 double colon. The function must first check if it would like to
9659 handle this search, for example by checking the `major-mode' or
9660 the file extension. If it decides not to handle this search, it
9661 should just return nil to give other functions a chance. If it
9662 does handle the search, it must return a non-nil value to keep
9663 other functions from trying.
9665 Each function can access the current prefix argument through the
9666 variable `current-prefix-argument'. Note that a single prefix is
9667 used to force opening a link in Emacs, so it may be good to only
9668 use a numeric or double prefix to guide the search function.
9670 In case this is needed, a function in this hook can also restore
9671 the window configuration before `org-open-at-point' was called using:
9673 (set-window-configuration org-window-config-before-follow-link)")
9675 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9676 (defun org-link-search (s &optional type avoid-pos)
9677 "Search for a link search option.
9678 If S is surrounded by forward slashes, it is interpreted as a
9679 regular expression. In org-mode files, this will create an `org-occur'
9680 sparse tree. In ordinary files, `occur' will be used to list matches.
9681 If the current buffer is in `dired-mode', grep will be used to search
9682 in all files. If AVOID-POS is given, ignore matches near that position."
9683 (let ((case-fold-search t)
9687 org-emphasis-alist)
9689 (pos (point))
9690 (pre nil) (post nil)
9691 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9692 (cond
9693 ;; First check if there are any special search functions
9694 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9695 ;; Now try the builtin stuff
9696 ((and (equal (string-to-char s0) ?#)
9697 (> (length s0) 1)
9698 (save-excursion
9699 (goto-char (point-min))
9700 (and
9701 (re-search-forward
9703 (setq type 'dedicated
9704 pos (match-beginning 0))))
9705 ;; There is an exact target for this
9706 (goto-char pos)
9707 (org-back-to-heading t)))
9708 ((save-excursion
9709 (goto-char (point-min))
9710 (and
9711 (re-search-forward
9712 (concat "<<" (regexp-quote s0) ">>") nil t)
9713 (setq type 'dedicated
9714 pos (match-beginning 0))))
9715 ;; There is an exact target for this
9716 (goto-char pos))
9718 (save-excursion
9719 (goto-char (point-min))
9720 (and
9721 (re-search-forward
9722 (concat "[^[]" (regexp-quote
9723 (format org-coderef-label-format
9724 (match-string 1 s0))))
9725 nil t)
9726 (setq type 'dedicated
9727 pos (1+ (match-beginning 0))))))
9728 ;; There is a coderef target for this
9729 (goto-char pos))
9731 ;; A regular expression
9732 (cond
9733 ((org-mode-p)
9734 (org-occur (match-string 1 s)))
9735 ;;((eq major-mode 'dired-mode)
9736 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9737 (t (org-do-occur (match-string 1 s)))))
9738 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9739 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9740 (goto-char (point-min))
9741 (cond
9742 ((let (case-fold-search)
9743 (re-search-forward (format org-complex-heading-regexp-format
9744 (regexp-quote s))
9745 nil t))
9746 ;; OK, found a match
9747 (setq type 'dedicated)
9748 (goto-char (match-beginning 0)))
9749 ((and (not org-link-search-inhibit-query)
9750 (eq org-link-search-must-match-exact-headline 'query-to-create)
9751 (y-or-n-p "No match - create this as a new heading? "))
9752 (goto-char (point-max))
9753 (or (bolp) (newline))
9755 (beginning-of-line 0))
9756 (t
9757 (goto-char pos)
9758 (error "No match"))))
9759 (t
9760 ;; A normal search string
9761 (when (equal (string-to-char s) ?*)
9762 ;; Anchor on headlines, post may include tags.
9765 s (substring s 1)))
9766 (remove-text-properties
9767 0 (length s)
9768 '(face nil mouse-face nil keymap nil fontified nil) s)
9769 ;; Make a series of regular expressions to find a match
9778 re4 (concat "[^a-zA-Z_]" re4_)
9780 re1 (concat pre re2 post)
9781 re3 (concat pre (if pre re4_ re4) post)
9782 re5 (concat pre ".*" re4)
9783 re2 (concat pre re2)
9784 re2a (concat pre (if pre re2a_ re2a))
9785 re4 (concat pre (if pre re4_ re4))
9789 ))
9790 (cond
9791 ((eq type 'org-occur) (org-occur reall))
9792 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9793 (t (goto-char (point-min))
9794 (setq type 'fuzzy)
9795 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9796 (org-search-not-self 1 re1 nil t)
9797 (org-search-not-self 1 re2 nil t)
9798 (org-search-not-self 1 re2a nil t)
9799 (org-search-not-self 1 re3 nil t)
9800 (org-search-not-self 1 re4 nil t)
9801 (org-search-not-self 1 re5 nil t)
9802 )
9803 (goto-char (match-beginning 1))
9804 (goto-char pos)
9805 (error "No match"))))))
9806 (and (org-mode-p) (org-show-context 'link-search))
9807 type))
9809 (defun org-search-not-self (group &rest args)
9810 "Execute `re-search-forward', but only accept matches that do not
9811 enclose the position of `org-open-link-marker'."
9812 (let ((m org-open-link-marker))
9813 (catch 'exit
9814 (while (apply 're-search-forward args)
9815 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9816 (goto-char (match-end group))
9817 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9818 (> (match-beginning 0) (marker-position m))
9819 (< (match-end 0) (marker-position m)))
9820 (save-match-data
9821 (or (not (org-in-regexp
9822 org-bracket-link-analytic-regexp 1))
9823 (not (match-end 4)) ; no description
9824 (and (<= (match-beginning 4) (point))
9825 (>= (match-end 4) (point))))))
9826 (throw 'exit (point))))))))
9828 (defun org-get-buffer-for-internal-link (buffer)
9829 "Return a buffer to be used for displaying the link target of internal links."
9830 (cond
9831 ((not org-display-internal-link-with-indirect-buffer)
9832 buffer)
9833 ((string-match "(Clone)$" (buffer-name buffer))
9834 (message "Buffer is already a clone, not making another one")
9835 ;; we also do not modify visibility in this case
9836 buffer)
9837 (t ; make a new indirect buffer for displaying the link
9838 (let* ((bn (buffer-name buffer))
9839 (ibn (concat bn "(Clone)"))
9840 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9841 (with-current-buffer ib (org-overview))
9842 ib))))
9844 (defun org-do-occur (regexp &optional cleanup)
9845 "Call the Emacs command `occur'.
9846 If CLEANUP is non-nil, remove the printout of the regular expression
9847 in the *Occur* buffer. This is useful if the regex is long and not useful
9848 to read."
9849 (occur regexp)
9850 (when cleanup
9851 (let ((cwin (selected-window)) win beg end)
9852 (when (setq win (get-buffer-window "*Occur*"))
9853 (select-window win))
9854 (goto-char (point-min))
9855 (when (re-search-forward "match[a-z]+" nil t)
9856 (setq beg (match-end 0))
9858 (setq end (1- (match-beginning 0)))))
9859 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9860 (goto-char (point-min))
9861 (select-window cwin))))
9863 ;;; The mark ring for links jumps
9865 (defvar org-mark-ring nil
9866 "Mark ring for positions before jumps in Org-mode.")
9867 (defvar org-mark-ring-last-goto nil
9868 "Last position in the mark ring used to go back.")
9869 ;; Fill and close the ring
9870 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9871 (loop for i from 1 to org-mark-ring-length do
9872 (push (make-marker) org-mark-ring))
9873 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9874 org-mark-ring)
9876 (defun org-mark-ring-push (&optional pos buffer)
9877 "Put the current position or POS into the mark ring and rotate it."
9878 (interactive)
9879 (setq pos (or pos (point)))
9880 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9881 (move-marker (car org-mark-ring)
9882 (or pos (point))
9883 (or buffer (current-buffer)))
9884 (message "%s"
9885 (substitute-command-keys
9888 (defun org-mark-ring-goto (&optional n)
9889 "Jump to the previous position in the mark ring.
9890 With prefix arg N, jump back that many stored positions. When
9891 called several times in succession, walk through the entire ring.
9892 Org-mode commands jumping to a different position in the current file,
9893 or to another Org-mode file, automatically push the old position
9894 onto the ring."
9895 (interactive "p")
9896 (let (p m)
9897 (if (eq last-command this-command)
9898 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9899 (setq p org-mark-ring))
9900 (setq org-mark-ring-last-goto p)
9901 (setq m (car p))
9902 (org-pop-to-buffer-same-window (marker-buffer m))
9903 (goto-char m)
9904 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9906 (defun org-remove-angle-brackets (s)
9907 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9908 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9909 s)
9910 (defun org-add-angle-brackets (s)
9911 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9912 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9913 s)
9914 (defun org-remove-double-quotes (s)
9917 s)
9919 ;;; Following specific links
9921 (defun org-follow-timestamp-link ()
9922 (cond
9923 ((org-at-date-range-p t)
9924 (let ((org-agenda-start-on-weekday)
9925 (t1 (match-string 1))
9926 (t2 (match-string 2)))
9927 (setq t1 (time-to-days (org-time-string-to-time t1))
9928 t2 (time-to-days (org-time-string-to-time t2)))
9929 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9930 ((org-at-timestamp-p t)
9931 (org-agenda-list nil (time-to-days (org-time-string-to-time
9932 (substring (match-string 1) 0 10)))
9933 1))
9934 (t (error "This should not happen"))))
9937 ;;; Following file links
9938 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9939 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9940 (declare-function mailcap-mime-info
9941 "mailcap" (string &optional request no-decode))
9942 (defvar org-wait nil)
9943 (defun org-open-file (path &optional in-emacs line search)
9944 "Open the file at PATH.
9945 First, this expands any special file name abbreviations. Then the
9946 configuration variable `org-file-apps' is checked if it contains an
9947 entry for this file type, and if yes, the corresponding command is launched.
9949 If no application is found, Emacs simply visits the file.
9951 With optional prefix argument IN-EMACS, Emacs will visit the file.
9953 prefix arg, Org tries to avoid opening in Emacs
9954 and to use an external application to visit the file.
9956 Optional LINE specifies a line to go to, optional SEARCH a string
9957 to search for. If LINE or SEARCH is given, the file will be
9958 opened in Emacs, unless an entry from org-file-apps that makes
9959 use of groups in a regexp matches.
9961 If you want to change the way frames are used when following a
9962 link, please customize `org-link-frame-setup'.
9964 If the file does not exist, an error is thrown."
9965 (let* ((file (if (equal path "")
9966 buffer-file-name
9967 (substitute-in-file-name (expand-file-name path))))
9968 (file-apps (append org-file-apps (org-default-apps)))
9969 (apps (org-remove-if
9970 'org-file-apps-entry-match-against-dlink-p file-apps))
9971 (apps-dlink (org-remove-if-not
9972 'org-file-apps-entry-match-against-dlink-p file-apps))
9973 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9974 (dirp (if remp nil (file-directory-p file)))
9975 (file (if (and dirp org-open-directory-means-index-dot-org)
9976 (concat (file-name-as-directory file) "index.org")
9977 file))
9978 (a-m-a-p (assq 'auto-mode apps))
9979 (dfile (downcase file))
9980 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9981 (link (cond ((and (eq line nil)
9982 (eq search nil))
9983 file)
9984 (line
9985 (concat file "::" (number-to-string line)))
9986 (search
9987 (concat file "::" search))))
9988 (dlink (downcase link))
9989 (old-buffer (current-buffer))
9990 (old-pos (point))
9991 (old-mode major-mode)
9992 ext cmd link-match-data)
9994 (setq ext (match-string 1 dfile))
9996 (setq ext (match-string 1 dfile))))
9997 (cond
9998 ((member in-emacs '((16) system))
9999 (setq cmd (cdr (assoc 'system apps))))
10000 (in-emacs (setq cmd 'emacs))
10001 (t
10002 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10003 (and dirp (cdr (assoc 'directory apps)))
10004 ; first, try matching against apps-dlink
10005 ; if we get a match here, store the match data for later
10006 (let ((match (assoc-default dlink apps-dlink
10007 'string-match)))
10008 (if match
10009 (progn (setq link-match-data (match-data))
10010 match)
10011 (progn (setq in-emacs (or in-emacs line search))
10012 nil))) ; if we have no match in apps-dlink,
10013 ; always open the file in emacs if line or search
10014 ; is given (for backwards compatibility)
10015 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10016 'string-match)
10017 (cdr (assoc ext apps))
10018 (cdr (assoc t apps))))))
10019 (when (eq cmd 'system)
10020 (setq cmd (cdr (assoc 'system apps))))
10021 (when (eq cmd 'default)
10022 (setq cmd (cdr (assoc t apps))))
10023 (when (eq cmd 'mailcap)
10024 (require 'mailcap)
10025 (mailcap-parse-mailcaps)
10026 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10027 (command (mailcap-mime-info mime-type)))
10028 (if (stringp command)
10029 (setq cmd command)
10030 (setq cmd 'emacs))))
10031 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10032 (not (file-exists-p file))
10033 (not org-open-non-existing-files))
10034 (error "No such file: %s" file))
10035 (cond
10037 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10039 (setq cmd (replace-match "%s" t t cmd)))
10040 (while (string-match "%s" cmd)
10041 (setq cmd (replace-match
10042 (save-match-data
10043 (shell-quote-argument
10044 (convert-standard-filename file)))
10045 t t cmd)))
10047 ;; Replace "%1", "%2" etc. in command with group matches from regex
10048 (save-match-data
10049 (let ((match-index 1)
10050 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10051 (set-match-data link-match-data)
10052 (while (<= match-index number-of-groups)
10053 (let ((regex (concat "%" (number-to-string match-index)))
10054 (replace-with (match-string match-index dlink)))
10055 (while (string-match regex cmd)
10056 (setq cmd (replace-match replace-with t t cmd))))
10057 (setq match-index (+ match-index 1)))))
10059 (save-window-excursion
10060 (start-process-shell-command cmd nil cmd)
10061 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10062 ))
10063 ((or (stringp cmd)
10064 (eq cmd 'emacs))
10065 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10066 (widen)
10067 (if line (org-goto-line line)
10068 (if search (org-link-search search))))
10069 ((consp cmd)
10070 (let ((file (convert-standard-filename file)))
10071 (save-match-data
10072 (set-match-data link-match-data)
10073 (eval cmd))))
10074 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10075 (and (org-mode-p) (eq old-mode 'org-mode)
10076 (or (not (equal old-buffer (current-buffer)))
10077 (not (equal old-pos (point))))
10078 (org-mark-ring-push old-pos old-buffer))))
10080 (defun org-file-apps-entry-match-against-dlink-p (entry)
10081 "This function returns non-nil if `entry' uses a regular
10082 expression which should be matched against the whole link by
10083 org-open-file.
10085 It assumes that is the case when the entry uses a regular
10086 expression which has at least one grouping construct and the
10087 action is either a lisp form or a command string containing
10088 '%1', i.e. using at least one subexpression match as a
10089 parameter."
10090 (let ((selector (car entry))
10091 (action (cdr entry)))
10092 (if (stringp selector)
10093 (and (> (regexp-opt-depth selector) 0)
10094 (or (and (stringp action)
10095 (string-match "%[0-9]" action))
10096 (consp action)))
10097 nil)))
10099 (defun org-default-apps ()
10100 "Return the default applications for this operating system."
10101 (cond
10102 ((eq system-type 'darwin)
10103 org-file-apps-defaults-macosx)
10104 ((eq system-type 'windows-nt)
10105 org-file-apps-defaults-windowsnt)
10106 (t org-file-apps-defaults-gnu)))
10108 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10109 "Convert extensions to regular expressions in the cars of LIST.
10110 Also, weed out any non-string entries, because the return value is used
10111 only for regexp matching.
10112 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10113 point to the symbol `emacs', indicating that the file should
10114 be opened in Emacs."
10115 (append
10116 (delq nil
10117 (mapcar (lambda (x)
10118 (if (not (stringp (car x)))
10119 nil
10121 x
10123 list))
10124 (if add-auto-mode
10125 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10127 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10128 (defun org-file-remote-p (file)
10129 "Test whether FILE specifies a location on a remote system.
10130 Return non-nil if the location is indeed remote.
10134 (cond ((fboundp 'file-remote-p)
10135 (file-remote-p file))
10136 ((fboundp 'tramp-handle-file-remote-p)
10137 (tramp-handle-file-remote-p file))
10138 ((and (boundp 'ange-ftp-name-format)
10139 (string-match (car ange-ftp-name-format) file))
10140 t)
10141 (t nil)))
10144 ;;;; Refiling
10146 (defun org-get-org-file ()
10147 "Read a filename, with default directory `org-directory'."
10148 (let ((default (or org-default-notes-file remember-data-file)))
10149 (read-file-name (format "File name [%s]: " default)
10150 (file-name-as-directory org-directory)
10151 default)))
10153 (defun org-notes-order-reversed-p ()
10154 "Check if the current file should receive notes in reversed order."
10155 (cond
10156 ((not org-reverse-note-order) nil)
10157 ((eq t org-reverse-note-order) t)
10158 ((not (listp org-reverse-note-order)) nil)
10159 (t (catch 'exit
10160 (let ((all org-reverse-note-order)
10161 entry)
10162 (while (setq entry (pop all))
10163 (if (string-match (car entry) buffer-file-name)
10164 (throw 'exit (cdr entry))))
10165 nil)))))
10167 (defvar org-refile-target-table nil
10168 "The list of refile targets, created by `org-refile'.")
10170 (defvar org-agenda-new-buffers nil
10171 "Buffers created to visit agenda files.")
10173 (defvar org-refile-cache nil
10174 "Cache for refile targets.")
10176 (defvar org-refile-markers nil
10177 "All the markers used for caching refile locations.")
10179 (defun org-refile-marker (pos)
10180 "Get a new refile marker, but only if caching is in use."
10181 (if (not org-refile-use-cache)
10182 pos
10183 (let ((m (make-marker)))
10184 (move-marker m pos)
10185 (push m org-refile-markers)
10186 m)))
10188 (defun org-refile-cache-clear ()
10189 "Clear the refile cache and disable all the markers."
10190 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10191 (setq org-refile-markers nil)
10192 (setq org-refile-cache nil)
10193 (message "Refile cache has been cleared"))
10195 (defun org-refile-cache-check-set (set)
10196 "Check if all the markers in the cache still have live buffers."
10197 (let (marker)
10198 (catch 'exit
10199 (while (and set (setq marker (nth 3 (pop set))))
10200 ;; if org-refile-use-outline-path is 'file, marker may be nil
10201 (when (and marker (null (marker-buffer marker)))
10202 (message "not found") (sit-for 3)
10203 (throw 'exit nil)))
10204 t)))
10206 (defun org-refile-cache-put (set &rest identifiers)
10207 "Push the refile targets SET into the cache, under IDENTIFIERS."
10208 (let* ((key (sha1 (prin1-to-string identifiers)))
10209 (entry (assoc key org-refile-cache)))
10210 (if entry
10211 (setcdr entry set)
10212 (push (cons key set) org-refile-cache))))
10214 (defun org-refile-cache-get (&rest identifiers)
10215 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10216 (cond
10217 ((not org-refile-cache) nil)
10218 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10219 (t
10220 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10221 org-refile-cache))))
10222 (and set (org-refile-cache-check-set set) set)))))
10224 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10225 "Produce a table with refile targets."
10226 (let ((case-fold-search nil)
10227 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10228 (entries (or org-refile-targets '((nil . (:level . 1)))))
10229 targets tgs txt re files f desc descre fast-path-p level pos0)
10230 (message "Getting targets...")
10231 (with-current-buffer (or default-buffer (current-buffer))
10232 (while (setq entry (pop entries))
10233 (setq files (car entry) desc (cdr entry))
10234 (setq fast-path-p nil)
10235 (cond
10236 ((null files) (setq files (list (current-buffer))))
10237 ((eq files 'org-agenda-files)
10238 (setq files (org-agenda-files 'unrestricted)))
10239 ((and (symbolp files) (fboundp files))
10240 (setq files (funcall files)))
10241 ((and (symbolp files) (boundp files))
10242 (setq files (symbol-value files))))
10243 (if (stringp files) (setq files (list files)))
10244 (cond
10245 ((eq (car desc) :tag)
10247 ((eq (car desc) :todo)
10249 ((eq (car desc) :regexp)
10250 (setq descre (cdr desc)))
10251 ((eq (car desc) :level)
10253 (if org-odd-levels-only
10254 (1- (* 2 (cdr desc)))
10255 (cdr desc)))
10257 ((eq (car desc) :maxlevel)
10258 (setq fast-path-p t)
10260 (if org-odd-levels-only
10261 (1- (* 2 (cdr desc)))
10262 (cdr desc)))
10264 (t (error "Bad refiling target description %s" desc)))
10265 (while (setq f (pop files))
10266 (with-current-buffer
10267 (if (bufferp f) f (org-get-agenda-file-buffer f))
10268 (or
10269 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10270 (progn
10271 (if (bufferp f) (setq f (buffer-file-name
10272 (buffer-base-buffer f))))
10273 (setq f (and f (expand-file-name f)))
10274 (if (eq org-refile-use-outline-path 'file)
10275 (push (list (file-name-nondirectory f) f nil nil) tgs))
10276 (save-excursion
10277 (save-restriction
10278 (widen)
10279 (goto-char (point-min))
10280 (while (re-search-forward descre nil t)
10281 (goto-char (setq pos0 (point-at-bol)))
10282 (catch 'next
10283 (when org-refile-target-verify-function
10284 (save-match-data
10285 (or (funcall org-refile-target-verify-function)
10286 (throw 'next t))))
10287 (when (and (looking-at org-complex-heading-regexp)
10288 (not (member (match-string 4) excluded-entries)))
10289 (setq level (org-reduced-level
10290 (- (match-end 1) (match-beginning 1)))
10291 txt (org-link-display-format (match-string 4))
10293 re (format org-complex-heading-regexp-format
10294 (regexp-quote (match-string 4))))
10295 (when org-refile-use-outline-path
10296 (setq txt (mapconcat
10297 'org-protect-slash
10298 (append
10299 (if (eq org-refile-use-outline-path
10300 'file)
10301 (list (file-name-nondirectory
10302 (buffer-file-name
10303 (buffer-base-buffer))))
10304 (if (eq org-refile-use-outline-path
10305 'full-file-path)
10306 (list (buffer-file-name
10307 (buffer-base-buffer)))))
10308 (org-get-outline-path fast-path-p
10309 level txt)
10310 (list txt))
10311 "/")))
10312 (push (list txt f re (org-refile-marker (point)))
10313 tgs)))
10314 (when (= (point) pos0)
10315 ;; verification function has not moved point
10316 (goto-char (point-at-eol))))))))
10317 (when org-refile-use-cache
10318 (org-refile-cache-put tgs (buffer-file-name) descre))
10319 (setq targets (append tgs targets))
10320 ))))
10321 (message "Getting targets...done")
10322 (nreverse targets)))
10324 (defun org-protect-slash (s)
10325 (while (string-match "/" s)
10327 s)
10329 (defvar org-olpa (make-vector 20 nil))
10331 (defun org-get-outline-path (&optional fastp level heading)
10332 "Return the outline path to the current entry, as a list.
10334 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10335 routine which makes outline path derivations for an entire file,
10336 avoiding backtracing. Refile target collection makes use of that."
10337 (if fastp
10338 (progn
10339 (if (> level 19)
10340 (error "Outline path failure, more than 19 levels"))
10341 (loop for i from level upto 19 do
10342 (aset org-olpa i nil))
10343 (prog1
10344 (delq nil (append org-olpa nil))
10345 (aset org-olpa level heading)))
10346 (let (rtn case-fold-search)
10347 (save-excursion
10348 (save-restriction
10349 (widen)
10350 (while (org-up-heading-safe)
10351 (when (looking-at org-complex-heading-regexp)
10352 (push (org-match-string-no-properties 4) rtn)))
10353 rtn)))))
10355 (defun org-format-outline-path (path &optional width prefix)
10356 "Format the outline path PATH for display.
10357 Width is the maximum number of characters that is available.
10358 Prefix is a prefix to be included in the returned string,
10359 such as the file name."
10360 (setq width (or width 79))
10361 (if prefix (setq width (- width (length prefix))))
10362 (if (not path)
10363 (or prefix "")
10364 (let* ((nsteps (length path))
10365 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10366 (maxwidth (if (<= total-width width)
10367 10000 ;; everything fits
10368 ;; we need to shorten the level headings
10369 (/ (- width nsteps) nsteps)))
10370 (org-odd-levels-only nil)
10371 (n 0)
10372 (total (1+ (length prefix))))
10373 (setq maxwidth (max maxwidth 10))
10374 (concat prefix
10375 (mapconcat
10376 (lambda (h)
10377 (setq n (1+ n))
10378 (if (and (= n nsteps) (< maxwidth 10000))
10379 (setq maxwidth (- total-width total)))
10380 (if (< (length h) maxwidth)
10381 (progn (setq total (+ total (length h) 1)) h)
10382 (setq h (substring h 0 (- maxwidth 2))
10383 total (+ total maxwidth 1))
10385 (setq h (substring h 0 (match-beginning 0))))
10386 (setq h (concat h "..")))
10387 (org-add-props h nil 'face
10388 (nth (% (1- n) org-n-level-faces)
10389 org-level-faces))
10390 h)
10391 path "/")))))
10393 (defun org-display-outline-path (&optional file current)
10394 "Display the current outline path in the echo area."
10395 (interactive "P")
10396 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10397 (case-fold-search nil)
10398 (path (and (org-mode-p) (org-get-outline-path))))
10399 (if current (setq path (append path
10400 (save-excursion
10401 (org-back-to-heading t)
10402 (if (looking-at org-complex-heading-regexp)
10403 (list (match-string 4)))))))
10404 (message "%s"
10405 (org-format-outline-path
10406 path
10407 (1- (frame-width))
10408 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10410 (defvar org-refile-history nil
10411 "History for refiling operations.")
10413 (defvar org-after-refile-insert-hook nil
10414 "Hook run after `org-refile' has inserted its stuff at the new location.
10415 Note that this is still *before* the stuff will be removed from
10416 the *old* location.")
10418 (defvar org-capture-last-stored-marker)
10419 (defun org-refile (&optional goto default-buffer rfloc)
10420 "Move the entry or entries at point to another heading.
10421 The list of target headings is compiled using the information in
10422 `org-refile-targets', which see.
10424 At the target location, the entry is filed as a subitem of the target
10425 heading. Depending on `org-reverse-note-order', the new subitem will
10426 either be the first or the last subitem.
10428 If there is an active region, all entries in that region will be moved.
10429 However, the region must fulfill the requirement that the first heading
10430 is the first one sets the top-level of the moved text - at most siblings
10431 below it are allowed.
10433 With prefix arg GOTO, the command will only visit the target location
10434 and not actually move anything.
10437 go to the location where the last refiling operation has put the subtree.
10438 With a prefix argument of `2', refile to the running clock.
10440 RFLOC can be a refile location obtained in a different way.
10442 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10444 If you are using target caching (see `org-refile-use-cache'),
10445 You have to clear the target cache in order to find new targets.
10446 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10447 prefix argument (`C-u C-u C-u C-c C-w')."
10449 (interactive "P")
10450 (if (member goto '(0 (64)))
10451 (org-refile-cache-clear)
10452 (let* ((cbuf (current-buffer))
10453 (regionp (org-region-active-p))
10454 (region-start (and regionp (region-beginning)))
10455 (region-end (and regionp (region-end)))
10456 (region-length (and regionp (- region-end region-start)))
10457 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10458 pos it nbuf file re level reversed)
10459 (setq last-command nil)
10460 (when regionp
10461 (goto-char region-start)
10462 (or (bolp) (goto-char (point-at-bol)))
10463 (setq region-start (point))
10464 (unless (or (org-kill-is-subtree-p
10465 (buffer-substring region-start region-end))
10466 (prog1 org-refile-active-region-within-subtree
10467 (org-toggle-heading)))
10468 (error "The region is not a (sequence of) subtree(s)")))
10469 (if (equal goto '(16))
10470 (org-refile-goto-last-stored)
10471 (when (or
10472 (and (equal goto 2)
10473 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10474 (prog1
10475 (setq it (list (or org-clock-heading "running clock")
10476 (buffer-file-name
10477 (marker-buffer org-clock-hd-marker))
10478 ""
10479 (marker-position org-clock-hd-marker)))
10480 (setq goto nil)))
10481 (setq it (or rfloc
10482 (save-excursion
10483 (unless goto (org-back-to-heading t))
10484 (org-refile-get-location
10485 (cond (goto "Goto")
10486 (regionp "Refile region to")
10487 (t "Refile subtree to")) default-buffer
10488 org-refile-allow-creating-parent-nodes
10489 goto)))))
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 no-exclude)
10570 "Prompt the user for a refile location, using PROMPT.
10571 PROMPT should not be suffixed with a colon and a space, because
10572 this function appends the default value from
10573 `org-refile-history' automatically, if that is not empty.
10574 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10575 this is used for the GOTO interface."
10576 (let ((org-refile-targets org-refile-targets)
10577 (org-refile-use-outline-path org-refile-use-outline-path)
10578 excluded-entries)
10579 (when (and (eq major-mode 'org-mode)
10580 (not org-refile-use-cache)
10581 (not no-exclude))
10582 (org-map-tree
10583 (lambda()
10584 (setq excluded-entries
10585 (append excluded-entries (list (org-get-heading t t)))))))
10586 (setq org-refile-target-table
10587 (org-refile-get-targets default-buffer excluded-entries)))
10588 (unless org-refile-target-table
10589 (error "No refile targets"))
10590 (let* ((prompt (concat prompt
10591 (and (car org-refile-history)
10592 (concat " (default " (car org-refile-history) ")"))
10593 ": "))
10594 (cbuf (current-buffer))
10595 (partial-completion-mode nil)
10596 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10597 (cfunc (if (and org-refile-use-outline-path
10598 org-outline-path-complete-in-steps)
10599 'org-olpath-completing-read
10600 'org-icompleting-read))
10601 (extra (if org-refile-use-outline-path "/" ""))
10602 (filename (and cfn (expand-file-name cfn)))
10603 (tbl (mapcar
10604 (lambda (x)
10605 (if (and (not (member org-refile-use-outline-path
10606 '(file full-file-path)))
10607 (not (equal filename (nth 1 x))))
10608 (cons (concat (car x) extra " ("
10609 (file-name-nondirectory (nth 1 x)) ")")
10610 (cdr x))
10611 (cons (concat (car x) extra) (cdr x))))
10612 org-refile-target-table))
10613 (completion-ignore-case t)
10614 pa answ parent-target child parent old-hist)
10615 (setq old-hist org-refile-history)
10616 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10617 nil 'org-refile-history (car org-refile-history)))
10618 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10619 (org-refile-check-position pa)
10620 (if pa
10621 (progn
10622 (when (or (not org-refile-history)
10623 (not (eq old-hist org-refile-history))
10624 (not (equal (car pa) (car org-refile-history))))
10625 (setq org-refile-history
10626 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10627 org-refile-history
10628 (cdr org-refile-history))))
10629 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10630 (pop org-refile-history)))
10631 pa)
10633 (progn
10634 (setq parent (match-string 1 answ)
10635 child (match-string 2 answ))
10636 (setq parent-target (or (assoc parent tbl)
10637 (assoc (concat parent "/") tbl)))
10638 (when (and parent-target
10639 (or (eq new-nodes t)
10640 (and (eq new-nodes 'confirm)
10642 child)))))
10643 (org-refile-new-child parent-target child)))
10644 (error "Invalid target location")))))
10646 (defun org-refile-check-position (refile-pointer)
10647 "Check if the refile pointer matches the readline to which it points."
10648 (let* ((file (nth 1 refile-pointer))
10649 (re (nth 2 refile-pointer))
10650 (pos (nth 3 refile-pointer))
10651 buffer)
10652 (when (org-string-nw-p re)
10653 (setq buffer (if (markerp pos)
10654 (marker-buffer pos)
10655 (or (find-buffer-visiting file)
10656 (find-file-noselect file))))
10657 (with-current-buffer buffer
10658 (save-excursion
10659 (save-restriction
10660 (widen)
10661 (goto-char pos)
10662 (beginning-of-line 1)
10663 (unless (org-looking-at-p re)
10664 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10666 (defun org-refile-new-child (parent-target child)
10667 "Use refile target PARENT-TARGET to add new CHILD below it."
10668 (unless parent-target
10669 (error "Cannot find parent for new node"))
10670 (let ((file (nth 1 parent-target))
10671 (pos (nth 3 parent-target))
10672 level)
10673 (with-current-buffer (or (find-buffer-visiting file)
10674 (find-file-noselect file))
10675 (save-excursion
10676 (save-restriction
10677 (widen)
10678 (if pos
10679 (goto-char pos)
10680 (goto-char (point-max))
10681 (if (not (bolp)) (newline)))
10682 (when (looking-at org-outline-regexp)
10683 (setq level (funcall outline-level))
10684 (org-end-of-subtree t t))
10685 (org-back-over-empty-lines)
10687 (if pos (org-get-valid-level level 1) 1) ?*)
10689 (beginning-of-line 0)
10690 (list (concat (car parent-target) "/" child) file "" (point)))))))
10692 (defun org-olpath-completing-read (prompt collection &rest args)
10693 "Read an outline path like a file name."
10694 (let ((thetable collection)
10695 (org-completion-use-ido nil) ; does not work with ido.
10696 (org-completion-use-iswitchb nil)) ; or iswitchb
10697 (apply
10698 'org-icompleting-read prompt
10699 (lambda (string predicate &optional flag)
10700 (let (rtn r f (l (length string)))
10701 (cond
10702 ((eq flag nil)
10703 ;; try completion
10704 (try-completion string thetable))
10705 ((eq flag t)
10706 ;; all-completions
10707 (setq rtn (all-completions string thetable predicate))
10708 (mapcar
10709 (lambda (x)
10710 (setq r (substring x l))
10711 (if (string-match " ([^)]*)$" x)
10712 (setq f (match-string 0 x))
10713 (setq f ""))
10714 (if (string-match "/" r)
10715 (concat string (substring r 0 (match-end 0)) f)
10716 x))
10717 rtn))
10718 ((eq flag 'lambda)
10719 ;; exact match?
10720 (assoc string thetable)))
10721 ))
10722 args)))
10724 ;;;; Dynamic blocks
10726 (defun org-find-dblock (name)
10727 "Find the first dynamic block with name NAME in the buffer.
10728 If not found, stay at current position and return nil."
10729 (let (pos)
10730 (save-excursion
10731 (goto-char (point-min))
10733 nil t)
10734 (match-beginning 0))))
10735 (if pos (goto-char pos))
10736 pos))
10738 (defconst org-dblock-start-re
10740 "Matches the start line of a dynamic block, with parameters.")
10743 "Matches the end of a dynamic block.")
10745 (defun org-create-dblock (plist)
10746 "Create a dynamic block section, with parameters taken from PLIST.
10747 PLIST must contain a :name entry which is used as name of the block."
10749 (end-of-line 1)
10750 (newline))
10751 (let ((col (current-column))
10752 (name (plist-get plist :name)))
10753 (insert "#+BEGIN: " name)
10754 (while plist
10755 (if (eq (car plist) :name)
10756 (setq plist (cddr plist))
10757 (insert " " (prin1-to-string (pop plist)))))
10759 (beginning-of-line -2)))
10761 (defun org-prepare-dblock ()
10762 "Prepare dynamic block for refresh.
10763 This empties the block, puts the cursor at the insert position and returns
10764 the property list including an extra property :name with the block name."
10765 (unless (looking-at org-dblock-start-re)
10766 (error "Not at a dynamic block"))
10767 (let* ((begdel (1+ (match-end 0)))
10768 (name (org-no-properties (match-string 1)))
10769 (params (append (list :name name)
10770 (read (concat "(" (match-string 3) ")")))))
10771 (save-excursion
10772 (beginning-of-line 1)
10774 (setq params (plist-put params :indentation-column (current-column))))
10775 (unless (re-search-forward org-dblock-end-re nil t)
10776 (error "Dynamic block not terminated"))
10777 (setq params
10778 (append params
10779 (list :content (buffer-substring
10780 begdel (match-beginning 0)))))
10781 (delete-region begdel (match-beginning 0))
10782 (goto-char begdel)
10783 (open-line 1)
10784 params))
10786 (defun org-map-dblocks (&optional command)
10787 "Apply COMMAND to all dynamic blocks in the current buffer.
10788 If COMMAND is not given, use `org-update-dblock'."
10789 (let ((cmd (or command 'org-update-dblock)))
10790 (save-excursion
10791 (goto-char (point-min))
10792 (while (re-search-forward org-dblock-start-re nil t)
10793 (goto-char (match-beginning 0))
10794 (save-excursion
10795 (condition-case nil
10796 (funcall cmd)
10797 (error (message "Error during update of dynamic block"))))
10798 (unless (re-search-forward org-dblock-end-re nil t)
10799 (error "Dynamic block not terminated"))))))
10801 (defun org-dblock-update (&optional arg)
10802 "User command for updating dynamic blocks.
10803 Update the dynamic block at point. With prefix ARG, update all dynamic
10804 blocks in the buffer."
10805 (interactive "P")
10806 (if arg
10807 (org-update-all-dblocks)
10808 (or (looking-at org-dblock-start-re)
10809 (org-beginning-of-dblock))
10810 (org-update-dblock)))
10812 (defun org-update-dblock ()
10813 "Update the dynamic block at point.
10814 This means to empty the block, parse for parameters and then call
10815 the correct writing function."
10816 (interactive)
10817 (save-window-excursion
10818 (let* ((pos (point))
10819 (line (org-current-line))
10820 (params (org-prepare-dblock))
10821 (name (plist-get params :name))
10822 (indent (plist-get params :indentation-column))
10823 (cmd (intern (concat "org-dblock-write:" name))))
10824 (message "Updating dynamic block `%s' at line %d..." name line)
10825 (funcall cmd params)
10826 (message "Updating dynamic block `%s' at line %d...done" name line)
10827 (goto-char pos)
10828 (when (and indent (> indent 0))
10829 (setq indent (make-string indent ?\ ))
10830 (save-excursion
10831 (org-beginning-of-dblock)
10832 (forward-line 1)
10833 (while (not (looking-at org-dblock-end-re))
10834 (insert indent)
10835 (beginning-of-line 2))
10836 (when (looking-at org-dblock-end-re)
10838 (replace-match ""))
10839 (insert indent)))))))
10841 (defun org-beginning-of-dblock ()
10842 "Find the beginning of the dynamic block at point.
10843 Error if there is no such block at point."
10844 (let ((pos (point))
10845 beg)
10846 (end-of-line 1)
10847 (if (and (re-search-backward org-dblock-start-re nil t)
10848 (setq beg (match-beginning 0))
10849 (re-search-forward org-dblock-end-re nil t)
10850 (> (match-end 0) pos))
10851 (goto-char beg)
10852 (goto-char pos)
10853 (error "Not in a dynamic block"))))
10855 (defun org-update-all-dblocks ()
10856 "Update all dynamic blocks in the buffer.
10857 This function can be used in a hook."
10858 (interactive)
10859 (when (org-mode-p)
10860 (org-map-dblocks 'org-update-dblock)))
10863 ;;;; Completion
10865 (defconst org-additional-option-like-keywords
10866 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10867 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10868 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10869 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10870 "BEGIN:" "END:"
10871 "ORGTBL" "TBLFM:" "TBLNAME:"
10872 "BEGIN_EXAMPLE" "END_EXAMPLE"
10873 "BEGIN_QUOTE" "END_QUOTE"
10874 "BEGIN_VERSE" "END_VERSE"
10875 "BEGIN_CENTER" "END_CENTER"
10876 "BEGIN_SRC" "END_SRC"
10877 "BEGIN_RESULT" "END_RESULT"
10878 "SOURCE:" "SRCNAME:" "FUNCTION:"
10879 "RESULTS:" "DATA:"
10880 "HEADER:" "HEADERS:"
10881 "BABEL:"
10882 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10883 "CAPTION:" "LABEL:"
10884 "SETUPFILE:"
10885 "INCLUDE:"
10886 "BIND:"
10887 "MACRO:"))
10889 (defcustom org-structure-template-alist
10890 '(
10903 ("L" "#+latex: "
10907 ("H" "#+html: "
10910 ("A" "#+ascii: ")
10911 ("i" "#+index: ?"
10912 "#+index: ?")
10913 ("I" "#+include %file ?"
10915 )
10916 "Structure completion elements.
10917 This is a list of abbreviation keys and values. The value gets inserted
10918 if you type `<' followed by the key and then press the completion key,
10919 usually `M-TAB'. %file will be replaced by a file name after prompting
10920 for the file using completion. The cursor will be placed at the position
10921 of the `?` in the template.
10922 There are two templates for each key, the first uses the original Org syntax,
10923 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10924 the default when the /org-mtags.el/ module has been loaded. See also the
10925 variable `org-mtags-prefer-muse-templates'.
10926 This is an experimental feature, it is undecided if it is going to stay in."
10927 :group 'org-completion
10928 :type '(repeat
10929 (string :tag "Key")
10930 (string :tag "Template")
10931 (string :tag "Muse Template")))
10933 (defun org-try-structure-completion ()
10934 "Try to complete a structure template before point.
10936 expands them."
10937 (let ((l (buffer-substring (point-at-bol) (point)))
10938 a)
10941 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10942 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10943 (match-beginning 1)) a)
10944 t)))
10946 (defun org-complete-expand-structure-template (start cell)
10947 "Expand a structure template."
10948 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10949 (rpl (nth (if musep 2 1) cell))
10950 (ind ""))
10951 (delete-region start (point))
10953 (cond
10954 ((bolp))
10956 (setq ind (buffer-substring (point-at-bol) (point))))
10957 (t (newline))))
10958 (setq start (point))
10959 (if (string-match "%file" rpl)
10960 (setq rpl (replace-match
10961 (concat
10963 (save-match-data
10964 (abbreviate-file-name (read-file-name "Include file: ")))
10966 t t rpl)))
10969 (insert rpl)
10972 ;;;; TODO, DEADLINE, Comments
10974 (defun org-toggle-comment ()
10975 "Change the COMMENT state of an entry."
10976 (interactive)
10977 (save-excursion
10978 (org-back-to-heading)
10979 (let (case-fold-search)
10980 (if (looking-at (concat org-outline-regexp
10982 (replace-match "" t t nil 1)
10983 (if (looking-at org-outline-regexp)
10984 (progn
10985 (goto-char (match-end 0))
10986 (insert org-comment-string " ")))))))
10988 (defvar org-last-todo-state-is-todo nil
10989 "This is non-nil when the last TODO state change led to a TODO state.
10990 If the last change removed the TODO tag or switched to DONE, then
10991 this is nil.")
10993 (defvar org-setting-tags nil) ; dynamically skipped
10995 (defvar org-todo-setup-filter-hook nil
10996 "Hook for functions that pre-filter todo specs.
10997 Each function takes a todo spec and returns either nil or the spec
10998 transformed into canonical form." )
11000 (defvar org-todo-get-default-hook nil
11001 "Hook for functions that get a default item for todo.
11002 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11003 nil or a string to be used for the todo mark." )
11005 (defvar org-agenda-headline-snapshot-before-repeat)
11007 (defun org-current-effective-time ()
11008 "Return current time adjusted for `org-extend-today-until' variable"
11009 (let* ((ct (org-current-time))
11010 (dct (decode-time ct))
11011 (ct1
11012 (if (and org-use-effective-time
11013 (< (nth 2 dct) org-extend-today-until))
11014 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11015 ct)))
11016 ct1))
11018 (defun org-todo-yesterday (&optional arg)
11019 "Like `org-todo' but the time of change will be 23:59 of yesterday"
11020 (interactive "P")
11021 (let* ((hour (third (decode-time
11022 (org-current-time))))
11023 (org-extend-today-until (1+ hour)))
11024 (org-todo arg)))
11026 (defun org-todo (&optional arg)
11027 "Change the TODO state of an item.
11028 The state of an item is given by a keyword at the start of the heading,
11029 like
11030 *** TODO Write paper
11031 *** DONE Call mom
11033 The different keywords are specified in the variable `org-todo-keywords'.
11035 So for this example: when the item starts with TODO, it is changed to DONE.
11036 When it starts with DONE, the DONE is removed. And when neither TODO nor
11037 DONE are present, add TODO at the beginning of the heading.
11040 state.
11041 With numeric prefix arg, switch to that state.
11043 keywords (nextset).
11046 For calling through lisp, arg is also interpreted in the following way:
11047 'none -> empty state
11049 'done -> switch to DONE
11050 'nextset -> switch to the next set of keywords
11051 'previousset -> switch to the previous set of keywords
11053 really is a member of `org-todo-keywords'."
11054 (interactive "P")
11055 (if (equal arg '(16)) (setq arg 'nextset))
11056 (let ((org-blocker-hook org-blocker-hook)
11057 (case-fold-search nil))
11058 (when (equal arg '(64))
11059 (setq arg nil org-blocker-hook nil))
11060 (when (and org-blocker-hook
11061 (or org-inhibit-blocking
11062 (org-entry-get nil "NOBLOCKING")))
11063 (setq org-blocker-hook nil))
11064 (save-excursion
11065 (catch 'exit
11066 (org-back-to-heading t)
11067 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11069 (looking-at " *"))
11070 (let* ((match-data (match-data))
11071 (startpos (point-at-bol))
11072 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11073 (org-log-done org-log-done)
11074 (org-log-repeat org-log-repeat)
11075 (org-todo-log-states org-todo-log-states)
11076 (this (match-string 1))
11077 (hl-pos (match-beginning 0))
11078 (head (org-get-todo-sequence-head this))
11079 (ass (assoc head org-todo-kwd-alist))
11080 (interpret (nth 1 ass))
11081 (done-word (nth 3 ass))
11082 (final-done-word (nth 4 ass))
11083 (last-state (or this ""))
11084 (completion-ignore-case t)
11085 (member (member this org-todo-keywords-1))
11086 (tail (cdr member))
11087 (state (cond
11088 ((and org-todo-key-trigger
11089 (or (and (equal arg '(4))
11090 (eq org-use-fast-todo-selection 'prefix))
11091 (and (not arg) org-use-fast-todo-selection
11092 (not (eq org-use-fast-todo-selection
11093 'prefix)))))
11094 ;; Use fast selection
11095 (org-fast-todo-selection))
11096 ((and (equal arg '(4))
11097 (or (not org-use-fast-todo-selection)
11098 (not org-todo-key-trigger)))
11099 ;; Read a state with completion
11100 (org-icompleting-read
11101 "State: " (mapcar (lambda(x) (list x))
11102 org-todo-keywords-1)
11103 nil t))
11104 ((eq arg 'right)
11105 (if this
11106 (if tail (car tail) nil)
11107 (car org-todo-keywords-1)))
11108 ((eq arg 'left)
11109 (if (equal member org-todo-keywords-1)
11110 nil
11111 (if this
11112 (nth (- (length org-todo-keywords-1)
11113 (length tail) 2)
11114 org-todo-keywords-1)
11115 (org-last org-todo-keywords-1))))
11116 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11117 (setq arg nil))) ; hack to fall back to cycling
11118 (arg
11119 ;; user or caller requests a specific state
11120 (cond
11121 ((equal arg "") nil)
11122 ((eq arg 'none) nil)
11123 ((eq arg 'done) (or done-word (car org-done-keywords)))
11124 ((eq arg 'nextset)
11125 (or (car (cdr (member head org-todo-heads)))
11126 (car org-todo-heads)))
11127 ((eq arg 'previousset)
11128 (let ((org-todo-heads (reverse org-todo-heads)))
11129 (or (car (cdr (member head org-todo-heads)))
11130 (car org-todo-heads))))
11131 ((car (member arg org-todo-keywords-1)))
11132 ((stringp arg)
11133 (error "State `%s' not valid in this file" arg))
11134 ((nth (1- (prefix-numeric-value arg))
11135 org-todo-keywords-1))))
11136 ((null member) (or head (car org-todo-keywords-1)))
11137 ((equal this final-done-word) nil) ;; -> make empty
11138 ((null tail) nil) ;; -> first entry
11139 ((memq interpret '(type priority))
11140 (if (eq this-command last-command)
11141 (car tail)
11142 (if (> (length tail) 0)
11143 (or done-word (car org-done-keywords))
11144 nil)))
11145 (t
11146 (car tail))))
11147 (state (or
11148 (run-hook-with-args-until-success
11149 'org-todo-get-default-hook state last-state)
11150 state))
11151 (next (if state (concat " " state " ") " "))
11152 (change-plist (list :type 'todo-state-change :from this :to state
11153 :position startpos))
11154 dolog now-done-p)
11155 (when org-blocker-hook
11156 (setq org-last-todo-state-is-todo
11157 (not (member this org-done-keywords)))
11158 (unless (save-excursion
11159 (save-match-data
11160 (org-with-wide-buffer
11161 (run-hook-with-args-until-failure
11162 'org-blocker-hook change-plist))))
11163 (if (org-called-interactively-p 'interactive)
11164 (error "TODO state change from %s to %s blocked" this state)
11165 ;; fail silently
11166 (message "TODO state change from %s to %s blocked" this state)
11167 (throw 'exit nil))))
11168 (store-match-data match-data)
11169 (replace-match next t t)
11170 (unless (pos-visible-in-window-p hl-pos)
11171 (message "TODO state changed to %s" (org-trim next)))
11172 (unless head
11173 (setq head (org-get-todo-sequence-head state)
11174 ass (assoc head org-todo-kwd-alist)
11175 interpret (nth 1 ass)
11176 done-word (nth 3 ass)
11177 final-done-word (nth 4 ass)))
11178 (when (memq arg '(nextset previousset))
11179 (message "Keyword-Set %d/%d: %s"
11180 (- (length org-todo-sets) -1
11181 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11182 (length org-todo-sets)
11183 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11184 (setq org-last-todo-state-is-todo
11185 (not (member state org-done-keywords)))
11186 (setq now-done-p (and (member state org-done-keywords)
11187 (not (member this org-done-keywords))))
11188 (and logging (org-local-logging logging))
11189 (when (and (or org-todo-log-states org-log-done)
11190 (not (eq org-inhibit-logging t))
11191 (not (memq arg '(nextset previousset))))
11192 ;; we need to look at recording a time and note
11193 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11194 (nth 2 (assoc this org-todo-log-states))))
11195 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11196 (setq dolog 'time))
11197 (when (and state
11198 (member state org-not-done-keywords)
11199 (not (member this org-not-done-keywords)))
11200 ;; This is now a todo state and was not one before
11201 ;; If there was a CLOSED time stamp, get rid of it.
11202 (org-add-planning-info nil nil 'closed))
11203 (when (and now-done-p org-log-done)
11204 ;; It is now done, and it was not done before
11205 (org-add-planning-info 'closed (org-current-effective-time))
11206 (if (and (not dolog) (eq 'note org-log-done))
11207 (org-add-log-setup 'done state this 'findpos 'note)))
11208 (when (and state dolog)
11209 ;; This is a non-nil state, and we need to log it
11210 (org-add-log-setup 'state state this 'findpos dolog)))
11211 ;; Fixup tag positioning
11212 (org-todo-trigger-tag-changes state)
11213 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11214 (when org-provide-todo-statistics
11215 (org-update-parent-todo-statistics))
11216 (run-hooks 'org-after-todo-state-change-hook)
11217 (if (and arg (not (member state org-done-keywords)))
11218 (setq head (org-get-todo-sequence-head state)))
11219 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11220 ;; Do we need to trigger a repeat?
11221 (when now-done-p
11222 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11223 ;; This is for the agenda, take a snapshot of the headline.
11224 (save-match-data
11225 (setq org-agenda-headline-snapshot-before-repeat
11226 (org-get-heading))))
11227 (org-auto-repeat-maybe state))
11228 ;; Fixup cursor location if close to the keyword
11229 (if (and (outline-on-heading-p)
11230 (not (bolp))
11231 (save-excursion (beginning-of-line 1)
11232 (looking-at org-todo-line-regexp))
11233 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11234 (progn
11235 (goto-char (or (match-end 2) (match-end 1)))
11236 (and (looking-at " ") (just-one-space))))
11237 (when org-trigger-hook
11238 (save-excursion
11239 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11241 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11242 "Block turning an entry into a TODO, using the hierarchy.
11243 This checks whether the current task should be blocked from state
11244 changes. Such blocking occurs when:
11246 1. The task has children which are not all in a completed state.
11248 2. A task has a parent with the property :ORDERED:, and there
11249 are siblings prior to the current task with incomplete
11250 status.
11252 3. The parent of the task is blocked because it has siblings that should
11253 be done first, or is child of a block grandparent TODO entry."
11255 (if (not org-enforce-todo-dependencies)
11256 t ; if locally turned off don't block
11257 (catch 'dont-block
11258 ;; If this is not a todo state change, or if this entry is already DONE,
11259 ;; do not block
11260 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11261 (member (plist-get change-plist :from)
11262 (cons 'done org-done-keywords))
11263 (member (plist-get change-plist :to)
11264 (cons 'todo org-not-done-keywords))
11265 (not (plist-get change-plist :to)))
11266 (throw 'dont-block t))
11267 ;; If this task has children, and any are undone, it's blocked
11268 (save-excursion
11269 (org-back-to-heading t)
11270 (let ((this-level (funcall outline-level)))
11271 (outline-next-heading)
11272 (let ((child-level (funcall outline-level)))
11273 (while (and (not (eobp))
11274 (> child-level this-level))
11275 ;; this todo has children, check whether they are all
11276 ;; completed
11277 (if (and (not (org-entry-is-done-p))
11278 (org-entry-is-todo-p))
11279 (throw 'dont-block nil))
11280 (outline-next-heading)
11281 (setq child-level (funcall outline-level))))))
11282 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11283 ;; any previous siblings are undone, it's blocked
11284 (save-excursion
11285 (org-back-to-heading t)
11286 (let* ((pos (point))
11287 (parent-pos (and (org-up-heading-safe) (point))))
11288 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11289 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11290 (forward-line 1)
11291 (re-search-forward org-not-done-heading-regexp pos t))
11292 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11293 ;; Search further up the hierarchy, to see if an anchestor is blocked
11294 (while t
11295 (goto-char parent-pos)
11296 (if (not (looking-at org-not-done-heading-regexp))
11297 (throw 'dont-block t)) ; do not block, parent is not a TODO
11298 (setq pos (point))
11299 (setq parent-pos (and (org-up-heading-safe) (point)))
11300 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11301 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11302 (forward-line 1)
11303 (re-search-forward org-not-done-heading-regexp pos t))
11304 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11306 (defcustom org-track-ordered-property-with-tag nil
11307 "Should the ORDERED property also be shown as a tag?
11308 The ORDERED property decides if an entry should require subtasks to be
11309 completed in sequence. Since a property is not very visible, setting
11310 this option means that toggling the ORDERED property with the command
11311 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11312 not relevant for the behavior, but it makes things more visible.
11314 Note that toggling the tag with tags commands will not change the property
11315 and therefore not influence behavior!
11317 This can be t, meaning the tag ORDERED should be used, It can also be a
11318 string to select a different tag for this task."
11319 :group 'org-todo
11320 :type '(choice
11321 (const :tag "No tracking" nil)
11322 (const :tag "Track with ORDERED tag" t)
11323 (string :tag "Use other tag")))
11325 (defun org-toggle-ordered-property ()
11326 "Toggle the ORDERED property of the current entry.
11327 For better visibility, you can track the value of this property with a tag.
11328 See variable `org-track-ordered-property-with-tag'."
11329 (interactive)
11330 (let* ((t1 org-track-ordered-property-with-tag)
11331 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11332 (save-excursion
11333 (org-back-to-heading)
11334 (if (org-entry-get nil "ORDERED")
11335 (progn
11336 (org-delete-property "ORDERED")
11337 (and tag (org-toggle-tag tag 'off))
11338 (message "Subtasks can be completed in arbitrary order"))
11339 (org-entry-put nil "ORDERED" "t")
11340 (and tag (org-toggle-tag tag 'on))
11341 (message "Subtasks must be completed in sequence")))))
11343 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11344 (defun org-block-todo-from-checkboxes (change-plist)
11345 "Block turning an entry into a TODO, using checkboxes.
11346 This checks whether the current task should be blocked from state
11347 changes because there are unchecked boxes in this entry."
11348 (if (not org-enforce-todo-checkbox-dependencies)
11349 t ; if locally turned off don't block
11350 (catch 'dont-block
11351 ;; If this is not a todo state change, or if this entry is already DONE,
11352 ;; do not block
11353 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11354 (member (plist-get change-plist :from)
11355 (cons 'done org-done-keywords))
11356 (member (plist-get change-plist :to)
11357 (cons 'todo org-not-done-keywords))
11358 (not (plist-get change-plist :to)))
11359 (throw 'dont-block t))
11360 ;; If this task has checkboxes that are not checked, it's blocked
11361 (save-excursion
11362 (org-back-to-heading t)
11363 (let ((beg (point)) end)
11364 (outline-next-heading)
11365 (setq end (point))
11366 (goto-char beg)
11367 (if (org-list-search-forward
11368 (concat (org-item-beginning-re)
11371 end t)
11372 (progn
11373 (if (boundp 'org-blocked-by-checkboxes)
11374 (setq org-blocked-by-checkboxes t))
11375 (throw 'dont-block nil)))))
11376 t))) ; do not block
11378 (defun org-entry-blocked-p ()
11379 "Is the current entry blocked?"
11380 (if (org-entry-get nil "NOBLOCKING")
11381 nil ;; Never block this entry
11382 (not
11383 (run-hook-with-args-until-failure
11384 'org-blocker-hook
11385 (list :type 'todo-state-change
11386 :position (point)
11387 :from 'todo
11388 :to 'done)))))
11390 (defun org-update-statistics-cookies (all)
11391 "Update the statistics cookie, either from TODO or from checkboxes.
11392 This should be called with the cursor in a line with a statistics cookie."
11393 (interactive "P")
11394 (if all
11395 (progn
11396 (org-update-checkbox-count 'all)
11397 (org-map-entries 'org-update-parent-todo-statistics))
11398 (if (not (org-on-heading-p))
11399 (org-update-checkbox-count)
11400 (let ((pos (move-marker (make-marker) (point)))
11401 end l1 l2)
11402 (ignore-errors (org-back-to-heading t))
11403 (if (not (org-on-heading-p))
11404 (org-update-checkbox-count)
11405 (setq l1 (org-outline-level))
11406 (setq end (save-excursion
11407 (outline-next-heading)
11408 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11409 (point)))
11410 (if (and (save-excursion
11411 (re-search-forward
11413 (not (save-excursion (re-search-forward
11415 (org-update-checkbox-count)
11416 (if (and l2 (> l2 l1))
11417 (progn
11418 (goto-char end)
11419 (org-update-parent-todo-statistics))
11420 (goto-char pos)
11421 (beginning-of-line 1)
11422 (while (re-search-forward
11424 (point-at-eol) t)
11425 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11426 (goto-char pos)
11427 (move-marker pos nil)))))
11429 (defvar org-entry-property-inherited-from) ;; defined below
11430 (defun org-update-parent-todo-statistics ()
11431 "Update any statistics cookie in the parent of the current headline.
11432 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11433 the entire subtree and this will travel up the hierarchy and update
11434 statistics everywhere."
11435 (let* ((prop (save-excursion (org-up-heading-safe)
11436 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11437 (recursive (or (not org-hierarchical-todo-statistics)
11439 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11440 0))
11441 (first t)
11443 level ltoggle l1 new ndel
11444 (cnt-all 0) (cnt-done 0) is-percent kwd
11445 checkbox-beg ov ovs ove cookie-present)
11446 (catch 'exit
11447 (save-excursion
11448 (beginning-of-line 1)
11449 (setq ltoggle (funcall outline-level))
11450 ;; Three situations are to consider:
11452 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11453 ;; to the top-level ancestor on the headline;
11455 ;; 2. If parent has "recursive" property, repeat up to the
11456 ;; headline setting that property, taking inheritance into
11457 ;; account;
11459 ;; 3. Else, move up to direct parent and proceed only once.
11460 (while (and (setq level (org-up-heading-safe))
11461 (or recursive first)
11462 (>= (point) lim))
11463 (setq first nil cookie-present nil)
11464 (unless (and level
11465 (not (string-match
11467 (downcase (or (org-entry-get nil "COOKIE_DATA")
11468 "")))))
11469 (throw 'exit nil))
11470 (while (re-search-forward box-re (point-at-eol) t)
11471 (setq cnt-all 0 cnt-done 0 cookie-present t)
11472 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11473 (save-match-data
11474 (unless (outline-next-heading) (throw 'exit nil))
11475 (while (and (looking-at org-complex-heading-regexp)
11476 (> (setq l1 (length (match-string 1))) level))
11477 (setq kwd (and (or recursive (= l1 ltoggle))
11478 (match-string 2)))
11479 (if (or (eq org-provide-todo-statistics 'all-headlines)
11480 (and (listp org-provide-todo-statistics)
11481 (or (member kwd org-provide-todo-statistics)
11482 (member kwd org-done-keywords))))
11483 (setq cnt-all (1+ cnt-all))
11484 (if (eq org-provide-todo-statistics t)
11485 (and kwd (setq cnt-all (1+ cnt-all)))))
11486 (and (member kwd org-done-keywords)
11487 (setq cnt-done (1+ cnt-done)))
11488 (outline-next-heading)))
11489 (setq new
11490 (if is-percent
11491 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11492 (format "[%d/%d]" cnt-done cnt-all))
11493 ndel (- (match-end 0) checkbox-beg))
11494 ;; handle overlays when updating cookie from column view
11495 (when (setq ov (car (overlays-at checkbox-beg)))
11496 (setq ovs (overlay-start ov) ove (overlay-end ov))
11497 (delete-overlay ov))
11498 (goto-char checkbox-beg)
11499 (insert new)
11500 (delete-region (point) (+ (point) ndel))
11501 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11502 (when ov (move-overlay ov ovs ove)))
11503 (when cookie-present
11504 (run-hook-with-args 'org-after-todo-statistics-hook
11505 cnt-done (- cnt-all cnt-done))))))
11506 (run-hooks 'org-todo-statistics-hook)))
11508 (defvar org-after-todo-statistics-hook nil
11509 "Hook that is called after a TODO statistics cookie has been updated.
11510 Each function is called with two arguments: the number of not-done entries
11511 and the number of done entries.
11513 For example, the following function, when added to this hook, will switch
11514 an entry to DONE when all children are done, and back to TODO when new
11515 entries are set to a TODO status. Note that this hook is only called
11516 when there is a statistics cookie in the headline!
11518 (defun org-summary-todo (n-done n-not-done)
11520 (let (org-log-done org-log-states) ; turn off logging
11522 ")
11524 (defvar org-todo-statistics-hook nil
11525 "Hook that is run whenever Org thinks TODO statistics should be updated.
11526 This hook runs even if there is no statistics cookie present, in which case
11527 `org-after-todo-statistics-hook' would not run.")
11529 (defun org-todo-trigger-tag-changes (state)
11530 "Apply the changes defined in `org-todo-state-tags-triggers'."
11531 (let ((l org-todo-state-tags-triggers)
11532 changes)
11533 (when (or (not state) (equal state ""))
11534 (setq changes (append changes (cdr (assoc "" l)))))
11535 (when (and (stringp state) (> (length state) 0))
11536 (setq changes (append changes (cdr (assoc state l)))))
11537 (when (member state org-not-done-keywords)
11538 (setq changes (append changes (cdr (assoc 'todo l)))))
11539 (when (member state org-done-keywords)
11540 (setq changes (append changes (cdr (assoc 'done l)))))
11541 (dolist (c changes)
11542 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11544 (defun org-local-logging (value)
11545 "Get logging settings from a property VALUE."
11546 (let* (words w a)
11547 ;; directly set the variables, they are already local.
11548 (setq org-log-done nil
11549 org-log-repeat nil
11550 org-todo-log-states nil)
11551 (setq words (org-split-string value))
11552 (while (setq w (pop words))
11553 (cond
11554 ((setq a (assoc w org-startup-options))
11555 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11556 (set (nth 1 a) (nth 2 a))))
11557 ((setq a (org-extract-log-state-settings w))
11558 (and (member (car a) org-todo-keywords-1)
11559 (push a org-todo-log-states)))))))
11561 (defun org-get-todo-sequence-head (kwd)
11562 "Return the head of the TODO sequence to which KWD belongs.
11563 If KWD is not set, check if there is a text property remembering the
11564 right sequence."
11565 (let (p)
11566 (cond
11567 ((not kwd)
11568 (or (get-text-property (point-at-bol) 'org-todo-head)
11569 (progn
11570 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11571 nil (point-at-eol)))
11572 (get-text-property p 'org-todo-head))))
11573 ((not (member kwd org-todo-keywords-1))
11574 (car org-todo-keywords-1))
11575 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11577 (defun org-fast-todo-selection ()
11578 "Fast TODO keyword selection with single keys.
11579 Returns the new TODO keyword, or nil if no state change should occur."
11580 (let* ((fulltable org-todo-key-alist)
11581 (done-keywords org-done-keywords) ;; needed for the faces.
11582 (maxlen (apply 'max (mapcar
11583 (lambda (x)
11584 (if (stringp (car x)) (string-width (car x)) 0))
11585 fulltable)))
11586 (expert nil)
11587 (fwidth (+ maxlen 3 1 3))
11588 (ncol (/ (- (window-width) 4) fwidth))
11589 tg cnt e c tbl
11590 groups ingroup)
11591 (save-excursion
11592 (save-window-excursion
11593 (if expert
11594 (set-buffer (get-buffer-create " *Org todo*"))
11595 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11596 (erase-buffer)
11597 (org-set-local 'org-done-keywords done-keywords)
11598 (setq tbl fulltable cnt 0)
11599 (while (setq e (pop tbl))
11600 (cond
11601 ((equal e '(:startgroup))
11602 (push '() groups) (setq ingroup t)
11603 (when (not (= cnt 0))
11604 (setq cnt 0)
11606 (insert "{ "))
11607 ((equal e '(:endgroup))
11608 (setq ingroup nil cnt 0)
11610 ((equal e '(:newline))
11611 (when (not (= cnt 0))
11612 (setq cnt 0)
11614 (setq e (car tbl))
11615 (while (equal (car tbl) '(:newline))
11617 (setq tbl (cdr tbl)))))
11618 (t
11619 (setq tg (car e) c (cdr e))
11620 (if ingroup (push tg (car groups)))
11621 (setq tg (org-add-props tg nil 'face
11622 (org-get-todo-face tg)))
11623 (if (and (= cnt 0) (not ingroup)) (insert " "))
11624 (insert "[" c "] " tg (make-string
11625 (- fwidth 4 (length tg)) ?\ ))
11626 (when (= (setq cnt (1+ cnt)) ncol)
11628 (if ingroup (insert " "))
11629 (setq cnt 0)))))
11631 (goto-char (point-min))
11632 (if (not expert) (org-fit-window-to-buffer))
11633 (message "[a-z..]:Set [SPC]:clear")
11634 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11635 (cond
11636 ((or (= c ?\C-g)
11637 (and (= c ?q) (not (rassoc c fulltable))))
11638 (setq quit-flag t))
11639 ((= c ?\ ) nil)
11640 ((setq e (rassoc c fulltable) tg (car e))
11641 tg)
11642 (t (setq quit-flag t)))))))
11644 (defun org-entry-is-todo-p ()
11645 (member (org-get-todo-state) org-not-done-keywords))
11647 (defun org-entry-is-done-p ()
11648 (member (org-get-todo-state) org-done-keywords))
11650 (defun org-get-todo-state ()
11651 (save-excursion
11652 (org-back-to-heading t)
11653 (and (looking-at org-todo-line-regexp)
11654 (match-end 2)
11655 (match-string 2))))
11657 (defun org-at-date-range-p (&optional inactive-ok)
11658 "Is the cursor inside a date range?"
11659 (interactive)
11660 (save-excursion
11661 (catch 'exit
11662 (let ((pos (point)))
11664 (skip-chars-backward "<[")
11665 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11666 (>= (match-end 0) pos)
11667 (throw 'exit t))
11669 (skip-chars-backward "<[")
11670 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11671 (>= (match-end 0) pos)
11672 (throw 'exit t)))
11673 nil)))
11675 (defun org-get-repeat (&optional tagline)
11676 "Check if there is a deadline/schedule with repeater in this entry."
11677 (save-match-data
11678 (save-excursion
11679 (org-back-to-heading t)
11680 (and (re-search-forward (if tagline
11682 org-repeat-re)
11683 (org-entry-end-position) t)
11684 (match-string-no-properties 1)))))
11686 (defvar org-last-changed-timestamp)
11687 (defvar org-last-inserted-timestamp)
11688 (defvar org-log-post-message)
11689 (defvar org-log-note-purpose)
11690 (defvar org-log-note-how)
11691 (defvar org-log-note-extra)
11692 (defun org-auto-repeat-maybe (done-word)
11693 "Check if the current headline contains a repeated deadline/schedule.
11694 If yes, set TODO state back to what it was and change the base date
11695 of repeating deadline/scheduled time stamps to new date.
11696 This function is run automatically after each state change to a DONE state."
11697 ;; last-state is dynamically scoped into this function
11698 (let* ((repeat (org-get-repeat))
11699 (aa (assoc last-state org-todo-kwd-alist))
11700 (interpret (nth 1 aa))
11701 (head (nth 2 aa))
11702 (whata '(("d" . day) ("m" . month) ("y" . year)))
11703 (msg "Entry repeats: ")
11704 (org-log-done nil)
11705 (org-todo-log-states nil)
11706 re type n what ts time to-state)
11707 (when repeat
11708 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11709 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11710 org-todo-repeat-to-state))
11711 (unless (and to-state (member to-state org-todo-keywords-1))
11712 (setq to-state (if (eq interpret 'type) last-state head)))
11713 (org-todo to-state)
11714 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11715 (org-entry-put nil "LAST_REPEAT" (format-time-string
11716 (org-time-stamp-format t t))))
11717 (when org-log-repeat
11718 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11719 (memq 'org-add-log-note post-command-hook))
11720 ;; OK, we are already setup for some record
11721 (if (eq org-log-repeat 'note)
11722 ;; make sure we take a note, not only a time stamp
11723 (setq org-log-note-how 'note))
11724 ;; Set up for taking a record
11725 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11726 last-state
11727 'findpos org-log-repeat)))
11728 (org-back-to-heading t)
11729 (org-add-planning-info nil nil 'closed)
11733 (while (re-search-forward
11734 re (save-excursion (outline-next-heading) (point)) t)
11735 (setq type (if (match-end 1) org-scheduled-string
11736 (if (match-end 3) org-deadline-string "Plain:"))
11737 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11739 (setq n (string-to-number (match-string 2 ts))
11740 what (match-string 3 ts))
11741 (if (equal what "w") (setq n (* n 7) what "d"))
11742 ;; Preparation, see if we need to modify the start date for the change
11743 (when (match-end 1)
11744 (setq time (save-match-data (org-time-string-to-time ts)))
11745 (cond
11746 ((equal (match-string 1 ts) ".")
11747 ;; Shift starting date to today
11748 (org-timestamp-change
11749 (- (org-today) (time-to-days time))
11750 'day))
11751 ((equal (match-string 1 ts) "+")
11752 (let ((nshiftmax 10) (nshift 0))
11753 (while (or (= nshift 0)
11754 (<= (time-to-days time)
11755 (time-to-days (current-time))))
11756 (when (= (incf nshift) nshiftmax)
11757 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11758 (error "Abort")))
11759 (org-timestamp-change n (cdr (assoc what whata)))
11760 (org-at-timestamp-p t)
11761 (setq ts (match-string 1))
11762 (setq time (save-match-data (org-time-string-to-time ts)))))
11763 (org-timestamp-change (- n) (cdr (assoc what whata)))
11764 ;; rematch, so that we have everything in place for the real shift
11765 (org-at-timestamp-p t)
11766 (setq ts (match-string 1))
11768 (org-timestamp-change n (cdr (assoc what whata)))
11769 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11770 (setq org-log-post-message msg)
11771 (message "%s" msg))))
11773 (defun org-show-todo-tree (arg)
11774 "Make a compact tree which shows all headlines marked with TODO.
11775 The tree will show the lines where the regexp matches, and all higher
11776 headlines above the match.
11778 With a numeric prefix N, construct a sparse tree for the Nth element
11779 of `org-todo-keywords-1'."
11780 (interactive "P")
11781 (let ((case-fold-search nil)
11782 (kwd-re
11783 (cond ((null arg) org-not-done-regexp)
11784 ((equal arg '(4))
11785 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11786 (mapcar 'list org-todo-keywords-1))))
11790 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11791 (regexp-quote (nth (1- (prefix-numeric-value arg))
11792 org-todo-keywords-1)))
11793 (t (error "Invalid prefix argument: %s" arg)))))
11794 (message "%d TODO entries found"
11795 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11797 (defun org-deadline (&optional remove time)
11799 With argument REMOVE, remove any deadline from the item.
11800 With argument TIME, set the deadline at the corresponding date. TIME
11802 (interactive "P")
11803 (let* ((old-date (org-entry-get nil "DEADLINE"))
11804 (repeater (and old-date
11805 (string-match
11807 old-date)
11808 (match-string 1 old-date))))
11809 (if remove
11810 (progn
11811 (when (and old-date org-log-redeadline)
11812 (org-add-log-setup 'deldeadline nil old-date 'findpos
11813 org-log-redeadline))
11814 (org-remove-timestamp-with-keyword org-deadline-string)
11815 (message "Item no longer has a deadline."))
11816 (org-add-planning-info 'deadline time 'closed)
11817 (when (and old-date org-log-redeadline
11818 (not (equal old-date
11819 (substring org-last-inserted-timestamp 1 -1))))
11820 (org-add-log-setup 'redeadline nil old-date 'findpos
11821 org-log-redeadline))
11822 (when repeater
11823 (save-excursion
11824 (org-back-to-heading t)
11825 (when (re-search-forward (concat org-deadline-string " "
11826 org-last-inserted-timestamp)
11827 (save-excursion
11828 (outline-next-heading) (point)) t)
11829 (goto-char (1- (match-end 0)))
11830 (insert " " repeater)
11831 (setq org-last-inserted-timestamp
11832 (concat (substring org-last-inserted-timestamp 0 -1)
11833 " " repeater
11834 (substring org-last-inserted-timestamp -1))))))
11835 (message "Deadline on %s" org-last-inserted-timestamp))))
11837 (defun org-schedule (&optional remove time)
11838 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11839 With argument REMOVE, remove any scheduling date from the item.
11840 With argument TIME, scheduled at the corresponding date. TIME can
11842 (interactive "P")
11843 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11844 (repeater (and old-date
11845 (string-match
11847 old-date)
11848 (match-string 1 old-date))))
11849 (if remove
11850 (progn
11851 (when (and old-date org-log-reschedule)
11852 (org-add-log-setup 'delschedule nil old-date 'findpos
11853 org-log-reschedule))
11854 (org-remove-timestamp-with-keyword org-scheduled-string)
11855 (message "Item is no longer scheduled."))
11856 (org-add-planning-info 'scheduled time 'closed)
11857 (when (and old-date org-log-reschedule
11858 (not (equal old-date
11859 (substring org-last-inserted-timestamp 1 -1))))
11860 (org-add-log-setup 'reschedule nil old-date 'findpos
11861 org-log-reschedule))
11862 (when repeater
11863 (save-excursion
11864 (org-back-to-heading t)
11865 (when (re-search-forward (concat org-scheduled-string " "
11866 org-last-inserted-timestamp)
11867 (save-excursion
11868 (outline-next-heading) (point)) t)
11869 (goto-char (1- (match-end 0)))
11870 (insert " " repeater)
11871 (setq org-last-inserted-timestamp
11872 (concat (substring org-last-inserted-timestamp 0 -1)
11873 " " repeater
11874 (substring org-last-inserted-timestamp -1))))))
11875 (message "Scheduled to %s" org-last-inserted-timestamp))))
11877 (defun org-get-scheduled-time (pom &optional inherit)
11878 "Get the scheduled time as a time tuple, of a format suitable
11879 for calling org-schedule with, or if there is no scheduling,
11880 returns nil."
11881 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11882 (when time
11883 (apply 'encode-time (org-parse-time-string time)))))
11885 (defun org-get-deadline-time (pom &optional inherit)
11886 "Get the deadline as a time tuple, of a format suitable for
11887 calling org-deadline with, or if there is no scheduling, returns
11888 nil."
11889 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11890 (when time
11891 (apply 'encode-time (org-parse-time-string time)))))
11893 (defun org-remove-timestamp-with-keyword (keyword)
11894 "Remove all time stamps with KEYWORD in the current entry."
11896 beg)
11897 (save-excursion
11898 (org-back-to-heading t)
11899 (setq beg (point))
11900 (outline-next-heading)
11901 (while (re-search-backward re beg t)
11902 (replace-match "")
11904 (equal (char-before) ?\ ))
11905 (backward-delete-char 1)
11907 (point-at-bol) (point-at-eol)))
11908 (delete-region (point-at-bol)
11909 (min (point-max) (1+ (point-at-eol))))))))))
11911 (defun org-add-planning-info (what &optional time &rest remove)
11912 "Insert new timestamp with keyword in the line directly after the headline.
11913 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11914 If non is given, the user is prompted for a date.
11915 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11916 be removed."
11917 (interactive)
11918 (let (org-time-was-given org-end-time-was-given ts
11919 end default-time default-input)
11921 (catch 'exit
11922 (when (and (memq what '(scheduled deadline))
11923 (or (not time)
11924 (and (stringp time)
11925 (string-match "^[-+]+[0-9]" time))))
11926 ;; Try to get a default date/time from existing timestamp
11927 (save-excursion
11928 (org-back-to-heading t)
11929 (setq end (save-excursion (outline-next-heading) (point)))
11930 (when (re-search-forward (if (eq what 'scheduled)
11931 org-scheduled-time-regexp
11932 org-deadline-time-regexp)
11933 end t)
11934 (setq ts (match-string 1)
11935 default-time
11936 (apply 'encode-time (org-parse-time-string ts))
11937 default-input (and ts (org-get-compact-tod ts))))))
11938 (when what
11939 (setq time
11940 (if (and (stringp time)
11941 (string-match "^[-+]+[0-9]" time))
11942 ;; This is a relative time, set the proper date
11943 (apply 'encode-time
11944 (org-read-date-analyze
11945 time default-time (decode-time default-time)))
11946 ;; If necessary, get the time from the user
11947 (or time (org-read-date nil 'to-time nil nil
11948 default-time default-input)))))
11950 (when (and org-insert-labeled-timestamps-at-point
11951 (member what '(scheduled deadline)))
11952 (insert
11953 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11954 (org-insert-time-stamp time org-time-was-given
11955 nil nil nil (list org-end-time-was-given))
11956 (setq what nil))
11957 (save-excursion
11958 (save-restriction
11959 (let (col list elt ts buffer-invisibility-spec)
11960 (org-back-to-heading t)
11962 (goto-char (match-end 1))
11963 (setq col (current-column))
11964 (goto-char (match-end 0))
11966 (when (and (not what)
11967 (not (looking-at
11969 org-keyword-time-not-clock-regexp))))
11970 ;; Nothing to add, nothing to remove...... :-)
11971 (throw 'exit nil))
11972 (if (and (not (looking-at org-outline-regexp))
11975 (not (equal (match-string 1) org-clock-string)))
11976 (narrow-to-region (match-beginning 0) (match-end 0))
11978 (backward-char 1)
11979 (narrow-to-region (point) (point))
11980 (and org-adapt-indentation (org-indent-to-column col)))
11981 ;; Check if we have to remove something.
11982 (setq list (cons what remove))
11983 (while list
11984 (setq elt (pop list))
11985 (when (or (and (eq elt 'scheduled)
11986 (re-search-forward org-scheduled-time-regexp nil t))
11987 (and (eq elt 'deadline)
11988 (re-search-forward org-deadline-time-regexp nil t))
11989 (and (eq elt 'closed)
11990 (re-search-forward org-closed-time-regexp nil t)))
11991 (replace-match "")
11992 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11994 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11995 (when what
11996 (insert
11997 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11998 (cond ((eq what 'scheduled) org-scheduled-string)
11999 ((eq what 'deadline) org-deadline-string)
12000 ((eq what 'closed) org-closed-string))
12001 " ")
12002 (setq ts (org-insert-time-stamp
12003 time
12004 (or org-time-was-given
12005 (and (eq what 'closed) org-log-done-with-time))
12006 (eq what 'closed)
12007 nil nil (list org-end-time-was-given)))
12008 (insert
12009 (if (not (or (bolp) (eq (char-before) ?\ )
12010 (memq (char-after) '(32 10))
12011 (eobp))) " " ""))
12012 (end-of-line 1))
12013 (goto-char (point-min))
12014 (widen)
12017 (delete-region (1- (point)) (point-at-eol)))
12018 ts))))))
12020 (defvar org-log-note-marker (make-marker))
12021 (defvar org-log-note-purpose nil)
12022 (defvar org-log-note-state nil)
12023 (defvar org-log-note-previous-state nil)
12024 (defvar org-log-note-how nil)
12025 (defvar org-log-note-extra nil)
12026 (defvar org-log-note-window-configuration nil)
12027 (defvar org-log-note-return-to (make-marker))
12028 (defvar org-log-note-effective-time nil
12029 "Remembered current time so that dynamically scoped
12030 `org-extend-today-until' affects tha timestamps in state change
12031 log")
12033 (defvar org-log-post-message nil
12034 "Message to be displayed after a log note has been stored.
12035 The auto-repeater uses this.")
12037 (defun org-add-note ()
12038 "Add a note to the current entry.
12039 This is done in the same way as adding a state change note."
12040 (interactive)
12041 (org-add-log-setup 'note nil nil 'findpos nil))
12043 (defvar org-property-end-re)
12044 (defun org-add-log-setup (&optional purpose state prev-state
12045 findpos how extra)
12046 "Set up the post command hook to take a note.
12047 If this is about to TODO state change, the new state is expected in STATE.
12048 When FINDPOS is non-nil, find the correct position for the note in
12049 the current entry. If not, assume that it can be inserted at point.
12050 HOW is an indicator what kind of note should be created.
12051 EXTRA is additional text that will be inserted into the notes buffer."
12052 (let* ((org-log-into-drawer (org-log-into-drawer))
12053 (drawer (cond ((stringp org-log-into-drawer)
12054 org-log-into-drawer)
12055 (org-log-into-drawer "LOGBOOK")
12056 (t nil))))
12057 (save-restriction
12058 (save-excursion
12059 (when findpos
12060 (org-back-to-heading t)
12061 (narrow-to-region (point) (save-excursion
12062 (outline-next-heading) (point)))
12066 (goto-char (match-end 0))
12067 (cond
12068 (drawer
12070 nil t)
12071 (progn
12072 (goto-char (match-end 0))
12073 (or org-log-states-order-reversed
12074 (and (re-search-forward org-property-end-re nil t)
12075 (goto-char (1- (match-beginning 0))))))
12077 (beginning-of-line 0)
12078 (org-indent-line-function)
12079 (beginning-of-line 2)
12080 (org-indent-line-function)
12081 (end-of-line 0)))
12082 ((and org-log-state-notes-insert-after-drawers
12083 (save-excursion
12084 (forward-line) (looking-at org-drawer-regexp)))
12085 (forward-line)
12086 (while (looking-at org-drawer-regexp)
12087 (goto-char (match-end 0))
12088 (re-search-forward org-property-end-re (point-max) t)
12089 (forward-line))
12090 (forward-line -1)))
12091 (unless org-log-states-order-reversed
12093 (org-skip-over-state-notes)
12095 (move-marker org-log-note-marker (point))
12096 (setq org-log-note-purpose purpose
12097 org-log-note-state state
12098 org-log-note-previous-state prev-state
12099 org-log-note-how how
12100 org-log-note-extra extra
12101 org-log-note-effective-time (org-current-effective-time))
12102 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12104 (defun org-skip-over-state-notes ()
12105 "Skip past the list of State notes in an entry."
12107 (when (ignore-errors (goto-char (org-in-item-p)))
12108 (let* ((struct (org-list-struct))
12109 (prevs (org-list-prevs-alist struct)))
12111 (goto-char (or (org-list-get-next-item (point) struct prevs)
12112 (org-list-get-item-end (point) struct)))))))
12114 (defun org-add-log-note (&optional purpose)
12115 "Pop up a window for taking a note, and add this note later at point."
12116 (remove-hook 'post-command-hook 'org-add-log-note)
12117 (setq org-log-note-window-configuration (current-window-configuration))
12118 (delete-other-windows)
12119 (move-marker org-log-note-return-to (point))
12120 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12121 (goto-char org-log-note-marker)
12122 (org-switch-to-buffer-other-window "*Org Note*")
12123 (erase-buffer)
12124 (if (memq org-log-note-how '(time state))
12125 (let (current-prefix-arg) (org-store-log-note))
12126 (let ((org-inhibit-startup t)) (org-mode))
12127 (insert (format "# Insert note for %s.
12129 (cond
12130 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12131 ((eq org-log-note-purpose 'done) "closed todo item")
12132 ((eq org-log-note-purpose 'state)
12134 (or org-log-note-previous-state "")
12135 (or org-log-note-state "")))
12136 ((eq org-log-note-purpose 'reschedule)
12137 "rescheduling")
12138 ((eq org-log-note-purpose 'delschedule)
12139 "no longer scheduled")
12140 ((eq org-log-note-purpose 'redeadline)
12141 "changing deadline")
12142 ((eq org-log-note-purpose 'deldeadline)
12143 "removing deadline")
12144 ((eq org-log-note-purpose 'refile)
12145 "refiling")
12146 ((eq org-log-note-purpose 'note)
12147 "this entry")
12148 (t (error "This should not happen")))))
12149 (if org-log-note-extra (insert org-log-note-extra))
12150 (org-set-local 'org-finish-function 'org-store-log-note)
12151 (run-hooks 'org-log-buffer-setup-hook)))
12153 (defvar org-note-abort nil) ; dynamically scoped
12154 (defun org-store-log-note ()
12155 "Finish taking a log note, and insert it to where it belongs."
12156 (let ((txt (buffer-string))
12157 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12158 lines ind bul)
12159 (kill-buffer (current-buffer))
12161 (setq txt (replace-match "" t t txt)))
12163 (setq txt (replace-match "" t t txt)))
12166 (setq note
12167 (org-replace-escapes
12168 note
12169 (list (cons "%u" (user-login-name))
12170 (cons "%U" user-full-name)
12171 (cons "%t" (format-time-string
12172 (org-time-stamp-format 'long 'inactive)
12173 org-log-note-effective-time))
12174 (cons "%T" (format-time-string
12175 (org-time-stamp-format 'long nil)
12176 org-log-note-effective-time))
12177 (cons "%s" (if org-log-note-state
12179 ""))
12180 (cons "%S" (if org-log-note-previous-state
12184 (push note lines))
12185 (when (or current-prefix-arg org-note-abort)
12186 (when org-log-into-drawer
12187 (org-remove-empty-drawer-at
12188 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12189 org-log-note-marker))
12190 (setq lines nil))
12191 (when lines
12192 (with-current-buffer (marker-buffer org-log-note-marker)
12193 (save-excursion
12194 (goto-char org-log-note-marker)
12195 (move-marker org-log-note-marker nil)
12196 (end-of-line 1)
12198 (setq ind (save-excursion
12199 (if (ignore-errors (goto-char (org-in-item-p)))
12200 (let ((struct (org-list-struct)))
12201 (org-list-get-ind
12202 (org-list-get-top-point struct) struct))
12204 (cond
12205 ((and (org-at-heading-p)
12206 org-adapt-indentation)
12207 (1+ (org-current-level)))
12208 ((org-at-heading-p) 0)
12209 (t (org-get-indentation))))))
12210 (setq bul (org-list-bullet-string "-"))
12211 (org-indent-line-to ind)
12212 (insert bul (pop lines))
12213 (let ((ind-body (+ (length bul) ind)))
12214 (while lines
12216 (org-indent-line-to ind-body)
12217 (insert (pop lines))))
12218 (message "Note stored")
12219 (org-back-to-heading t)
12220 (org-cycle-hide-drawers 'children)))))
12221 (set-window-configuration org-log-note-window-configuration)
12222 (with-current-buffer (marker-buffer org-log-note-return-to)
12223 (goto-char org-log-note-return-to))
12224 (move-marker org-log-note-return-to nil)
12225 (and org-log-post-message (message "%s" org-log-post-message)))
12227 (defun org-remove-empty-drawer-at (drawer pos)
12228 "Remove an empty drawer DRAWER at position POS.
12229 POS may also be a marker."
12230 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12231 (save-excursion
12232 (save-restriction
12233 (widen)
12234 (goto-char pos)
12235 (if (org-in-regexp
12237 (replace-match ""))))))
12239 (defun org-sparse-tree (&optional arg)
12240 "Create a sparse tree, prompt for the details.
12241 This command can create sparse trees. You first need to select the type
12242 of match used to create the tree:
12244 t Show all TODO entries.
12245 T Show entries with a specific TODO keyword.
12246 m Show entries selected by a tags/property match.
12247 p Enter a property name and its value (both with completion on existing
12248 names/values) and show entries with that property.
12249 r Show entries matching a regular expression (`/' can be used as well)
12250 d Show deadlines due within `org-deadline-warning-days'.
12251 b Show deadlines and scheduled items before a date.
12252 a Show deadlines and scheduled items after a date."
12253 (interactive "P")
12254 (let (ans kwd value)
12255 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12256 (setq ans (read-char-exclusive))
12257 (cond
12258 ((equal ans ?d)
12259 (call-interactively 'org-check-deadlines))
12260 ((equal ans ?b)
12261 (call-interactively 'org-check-before-date))
12262 ((equal ans ?a)
12263 (call-interactively 'org-check-after-date))
12264 ((equal ans ?t)
12265 (org-show-todo-tree nil))
12266 ((equal ans ?T)
12267 (org-show-todo-tree '(4)))
12268 ((member ans '(?T ?m))
12269 (call-interactively 'org-match-sparse-tree))
12270 ((member ans '(?p ?P))
12271 (setq kwd (org-icompleting-read "Property: "
12272 (mapcar 'list (org-buffer-property-keys))))
12273 (setq value (org-icompleting-read "Value: "
12274 (mapcar 'list (org-property-values kwd))))
12277 (org-match-sparse-tree arg (concat kwd "=" value)))
12278 ((member ans '(?r ?R ?/))
12279 (call-interactively 'org-occur))
12282 (defvar org-occur-highlights nil
12283 "List of overlays used for occur matches.")
12284 (make-variable-buffer-local 'org-occur-highlights)
12285 (defvar org-occur-parameters nil
12286 "Parameters of the active org-occur calls.
12287 This is a list, each call to org-occur pushes as cons cell,
12288 containing the regular expression and the callback, onto the list.
12289 The list can contain several entries if `org-occur' has been called
12290 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12291 will only contain one set of parameters. When the highlights are
12292 removed (for example with `C-c C-c', or with the next edit (depending
12293 on `org-remove-highlights-with-change'), this variable is emptied
12294 as well.")
12295 (make-variable-buffer-local 'org-occur-parameters)
12297 (defun org-occur (regexp &optional keep-previous callback)
12298 "Make a compact tree which shows all matches of REGEXP.
12299 The tree will show the lines where the regexp matches, and all higher
12300 headlines above the match. It will also show the heading after the match,
12301 to make sure editing the matching entry is easy.
12302 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12303 call to `org-occur' will be kept, to allow stacking of calls to this
12304 command.
12305 If CALLBACK is non-nil, it is a function which is called to confirm
12306 that the match should indeed be shown."
12308 (when (equal regexp "")
12309 (error "Regexp cannot be empty"))
12310 (unless keep-previous
12311 (org-remove-occur-highlights nil nil t))
12312 (push (cons regexp callback) org-occur-parameters)
12313 (let ((cnt 0))
12314 (save-excursion
12315 (goto-char (point-min))
12316 (if (or (not keep-previous) ; do not want to keep
12317 (not org-occur-highlights)) ; no previous matches
12318 ;; hide everything
12319 (org-overview))
12320 (while (re-search-forward regexp nil t)
12321 (when (or (not callback)
12322 (save-match-data (funcall callback)))
12323 (setq cnt (1+ cnt))
12324 (when org-highlight-sparse-tree-matches
12325 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12326 (org-show-context 'occur-tree))))
12327 (when org-remove-highlights-with-change
12328 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12329 nil 'local))
12330 (unless org-sparse-tree-open-archived-trees
12331 (org-hide-archived-subtrees (point-min) (point-max)))
12332 (run-hooks 'org-occur-hook)
12333 (if (org-called-interactively-p 'interactive)
12334 (message "%d match(es) for regexp %s" cnt regexp))
12335 cnt))
12337 (defun org-occur-next-match (&optional n reset)
12338 "Function for `next-error-function' to find sparse tree matches.
12339 N is the number of matches to move, when negative move backwards.
12340 RESET is entirely ignored - this function always goes back to the
12341 starting point when no match is found."
12342 (let* ((limit (if (< n 0) (point-min) (point-max)))
12343 (search-func (if (< n 0)
12344 'previous-single-char-property-change
12345 'next-single-char-property-change))
12346 (n (abs n))
12347 (pos (point))
12348 p1)
12349 (catch 'exit
12350 (while (setq p1 (funcall search-func (point) 'org-type))
12351 (when (equal p1 limit)
12352 (goto-char pos)
12353 (error "No more matches"))
12354 (when (equal (get-char-property p1 'org-type) 'org-occur)
12355 (setq n (1- n))
12356 (when (= n 0)
12357 (goto-char p1)
12358 (throw 'exit (point))))
12359 (goto-char p1))
12360 (goto-char p1)
12361 (error "No more matches"))))
12363 (defun org-show-context (&optional key)
12364 "Make sure point and context are visible.
12365 How much context is shown depends upon the variables
12366 `org-show-hierarchy-above', `org-show-following-heading'. and
12367 `org-show-siblings'."
12368 (let ((heading-p (org-on-heading-p t))
12369 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12370 (following-p (org-get-alist-option org-show-following-heading key))
12371 (entry-p (org-get-alist-option org-show-entry-below key))
12372 (siblings-p (org-get-alist-option org-show-siblings key)))
12373 (catch 'exit
12374 ;; Show heading or entry text
12375 (if (and heading-p (not entry-p))
12376 (org-flag-heading nil) ; only show the heading
12377 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12378 (org-show-hidden-entry))) ; show entire entry
12379 (when following-p
12380 ;; Show next sibling, or heading below text
12381 (save-excursion
12382 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12383 (org-flag-heading nil))))
12384 (when siblings-p (org-show-siblings))
12385 (when hierarchy-p
12386 ;; show all higher headings, possibly with siblings
12387 (save-excursion
12388 (while (and (condition-case nil
12389 (progn (org-up-heading-all 1) t)
12390 (error nil))
12391 (not (bobp)))
12392 (org-flag-heading nil)
12393 (when siblings-p (org-show-siblings))))))))
12395 (defvar org-reveal-start-hook nil
12396 "Hook run before revealing a location.")
12398 (defun org-reveal (&optional siblings)
12399 "Show current entry, hierarchy above it, and the following headline.
12400 This can be used to show a consistent set of context around locations
12401 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12402 not t for the search context.
12404 With optional argument SIBLINGS, on each level of the hierarchy all
12405 siblings are shown. This repairs the tree structure to what it would
12406 look like when opened with hierarchical calls to `org-cycle'.
12408 go to the parent and show the
12409 entire tree."
12410 (interactive "P")
12411 (run-hooks 'org-reveal-start-hook)
12412 (let ((org-show-hierarchy-above t)
12413 (org-show-following-heading t)
12414 (org-show-siblings (if siblings t org-show-siblings)))
12415 (org-show-context nil))
12416 (when (equal siblings '(16))
12417 (save-excursion
12418 (when (org-up-heading-safe)
12419 (org-show-subtree)
12420 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12422 (defun org-highlight-new-match (beg end)
12423 "Highlight from BEG to END and mark the highlight is an occur headline."
12424 (let ((ov (make-overlay beg end)))
12425 (overlay-put ov 'face 'secondary-selection)
12426 (overlay-put ov 'org-type 'org-occur)
12427 (push ov org-occur-highlights)))
12429 (defun org-remove-occur-highlights (&optional beg end noremove)
12430 "Remove the occur highlights from the buffer.
12431 BEG and END are ignored. If NOREMOVE is nil, remove this function
12432 from the `before-change-functions' in the current buffer."
12433 (interactive)
12434 (unless org-inhibit-highlight-removal
12435 (mapc 'delete-overlay org-occur-highlights)
12436 (setq org-occur-highlights nil)
12437 (setq org-occur-parameters nil)
12438 (unless noremove
12439 (remove-hook 'before-change-functions
12440 'org-remove-occur-highlights 'local))))
12442 ;;;; Priorities
12445 "Regular expression matching the priority indicator.")
12447 (defvar org-remove-priority-next-time nil)
12449 (defun org-priority-up ()
12450 "Increase the priority of the current item."
12451 (interactive)
12452 (org-priority 'up))
12454 (defun org-priority-down ()
12455 "Decrease the priority of the current item."
12456 (interactive)
12457 (org-priority 'down))
12459 (defun org-priority (&optional action)
12460 "Change the priority of an item by ARG.
12461 ACTION can be `set', `up', `down', or a character."
12462 (interactive)
12463 (unless org-enable-priority-commands
12464 (error "Priority commands are disabled"))
12465 (setq action (or action 'set))
12466 (let (current new news have remove)
12467 (save-excursion
12468 (org-back-to-heading t)
12469 (if (looking-at org-priority-regexp)
12470 (setq current (string-to-char (match-string 2))
12471 have t))
12472 (cond
12473 ((eq action 'remove)
12474 (setq remove t new ?\ ))
12475 ((or (eq action 'set)
12476 (if (featurep 'xemacs) (characterp action) (integerp action)))
12477 (if (not (eq action 'set))
12478 (setq new action)
12479 (message "Priority %c-%c, SPC to remove: "
12480 org-highest-priority org-lowest-priority)
12481 (save-match-data
12482 (setq new (read-char-exclusive))))
12483 (if (and (= (upcase org-highest-priority) org-highest-priority)
12484 (= (upcase org-lowest-priority) org-lowest-priority))
12485 (setq new (upcase new)))
12486 (cond ((equal new ?\ ) (setq remove t))
12487 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12488 (error "Priority must be between `%c' and `%c'"
12489 org-highest-priority org-lowest-priority))))
12490 ((eq action 'up)
12491 (setq new (if have
12492 (1- current) ; normal cycling
12493 ;; last priority was empty
12494 (if (eq last-command this-command)
12495 org-lowest-priority ; wrap around empty to lowest
12496 ;; default
12497 (if org-priority-start-cycle-with-default
12498 org-default-priority
12499 (1- org-default-priority))))))
12500 ((eq action 'down)
12501 (setq new (if have
12502 (1+ current) ; normal cycling
12503 ;; last priority was empty
12504 (if (eq last-command this-command)
12505 org-highest-priority ; wrap around empty to highest
12506 ;; default
12507 (if org-priority-start-cycle-with-default
12508 org-default-priority
12509 (1+ org-default-priority))))))
12510 (t (error "Invalid action")))
12511 (if (or (< (upcase new) org-highest-priority)
12512 (> (upcase new) org-lowest-priority))
12513 (if (and (memq action '(up down))
12514 (not have) (not (eq last-command this-command)))
12515 ;; `new' is from default priority
12516 (error
12517 "The default can not be set, see `org-default-priority' why")
12518 ;; normal cycling: `new' is beyond highest/lowest priority
12519 ;; and is wrapped around to the empty priority
12520 (setq remove t)))
12521 (setq news (format "%c" new))
12522 (if have
12523 (if remove
12524 (replace-match "" t t nil 1)
12525 (replace-match news t t nil 2))
12526 (if remove
12527 (error "No priority cookie found in line")
12528 (let ((case-fold-search nil))
12529 (looking-at org-todo-line-regexp))
12530 (if (match-end 2)
12531 (progn
12532 (goto-char (match-end 2))
12533 (insert " [#" news "]"))
12534 (goto-char (match-beginning 3))
12535 (insert "[#" news "] "))))
12536 (org-preserve-lc (org-set-tags nil 'align)))
12537 (if remove
12538 (message "Priority removed")
12539 (message "Priority of current item set to %s" news))))
12541 (defun org-get-priority (s)
12542 "Find priority cookie and return priority."
12543 (if (functionp org-get-priority-function)
12544 (funcall org-get-priority-function)
12545 (save-match-data
12546 (if (not (string-match org-priority-regexp s))
12547 (* 1000 (- org-lowest-priority org-default-priority))
12548 (* 1000 (- org-lowest-priority
12549 (string-to-char (match-string 2 s))))))))
12551 ;;;; Tags
12553 (defvar org-agenda-archives-mode)
12554 (defvar org-map-continue-from nil
12555 "Position from where mapping should continue.
12556 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12558 (defvar org-scanner-tags nil
12559 "The current tag list while the tags scanner is running.")
12560 (defvar org-trust-scanner-tags nil
12561 "Should `org-get-tags-at' use the tags for the scanner.
12562 This is for internal dynamical scoping only.
12563 When this is non-nil, the function `org-get-tags-at' will return the value
12564 of `org-scanner-tags' instead of building the list by itself. This
12565 can lead to large speed-ups when the tags scanner is used in a file with
12566 many entries, and when the list of tags is retrieved, for example to
12567 obtain a list of properties. Building the tags list for each entry in such
12568 a file becomes an N^2 operation - but with this variable set, it scales
12569 as N.")
12571 (defun org-scan-tags (action matcher &optional todo-only)
12572 "Scan headline tags with inheritance and produce output ACTION.
12574 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12575 or `agenda' to produce an entry list for an agenda view. It can also be
12576 a Lisp form or a function that should be called at each matched headline, in
12577 this case the return value is a list of all return values from these calls.
12579 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12580 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12581 only lines with a TODO keyword are included in the output."
12582 (require 'org-agenda)
12585 (org-re
12587 (props (list 'face 'default
12588 'done-face 'org-agenda-done
12589 'undone-face 'default
12590 'mouse-face 'highlight
12591 'org-not-done-regexp org-not-done-regexp
12592 'org-todo-regexp org-todo-regexp
12593 'help-echo
12594 (format "mouse-2 or RET jump to org file %s"
12595 (abbreviate-file-name
12596 (or (buffer-file-name (buffer-base-buffer))
12597 (buffer-name (buffer-base-buffer)))))))
12598 (case-fold-search nil)
12599 (org-map-continue-from nil)
12600 lspos tags tags-list
12601 (tags-alist (list (cons 0 org-file-tags)))
12602 (llast 0) rtn rtn1 level category i txt
12603 todo marker entry priority)
12604 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12605 (setq action (list 'lambda nil action)))
12606 (save-excursion
12607 (goto-char (point-min))
12608 (when (eq action 'sparse-tree)
12609 (org-overview)
12610 (org-remove-occur-highlights))
12611 (while (re-search-forward re nil t)
12612 (catch :skip
12613 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12614 tags (if (match-end 4) (org-match-string-no-properties 4)))
12615 (goto-char (setq lspos (match-beginning 0)))
12616 (setq level (org-reduced-level (funcall outline-level))
12617 category (org-get-category))
12618 (setq i llast llast level)
12619 ;; remove tag lists from same and sublevels
12620 (while (>= i level)
12621 (when (setq entry (assoc i tags-alist))
12622 (setq tags-alist (delete entry tags-alist)))
12623 (setq i (1- i)))
12624 ;; add the next tags
12625 (when tags
12626 (setq tags (org-split-string tags ":")
12627 tags-alist
12628 (cons (cons level tags) tags-alist)))
12629 ;; compile tags for current headline
12630 (setq tags-list
12631 (if org-use-tag-inheritance
12632 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12633 tags)
12634 org-scanner-tags tags-list)
12635 (when org-use-tag-inheritance
12636 (setcdr (car tags-alist)
12637 (mapcar (lambda (x)
12638 (setq x (copy-sequence x))
12639 (org-add-prop-inherited x))
12640 (cdar tags-alist))))
12641 (when (and tags org-use-tag-inheritance
12642 (or (not (eq t org-use-tag-inheritance))
12643 org-tags-exclude-from-inheritance))
12644 ;; selective inheritance, remove uninherited ones
12645 (setcdr (car tags-alist)
12646 (org-remove-uninherited-tags (cdar tags-alist))))
12647 (when (and
12649 ;; eval matcher only when the todo condition is OK
12650 (and (or (not todo-only) (member todo org-not-done-keywords))
12651 (let ((case-fold-search t)) (eval matcher)))
12653 ;; Call the skipper, but return t if it does not skip,
12654 ;; so that the `and' form continues evaluating
12655 (progn
12656 (unless (eq action 'sparse-tree) (org-agenda-skip))
12657 t)
12659 ;; Check if timestamps are deselecting this entry
12660 (or (not todo-only)
12661 (and (member todo org-not-done-keywords)
12662 (or (not org-agenda-tags-todo-honor-ignore-options)
12663 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12665 ;; Extra check for the archive tag
12666 ;; FIXME: Does the skipper already do this????
12667 (or
12668 (not (member org-archive-tag tags-list))
12669 ;; we have an archive tag, should we use this anyway?
12670 (or (not org-agenda-skip-archived-trees)
12671 (and (eq action 'agenda) org-agenda-archives-mode))))
12673 ;; select this headline
12675 (cond
12676 ((eq action 'sparse-tree)
12677 (and org-highlight-sparse-tree-matches
12678 (org-get-heading) (match-end 0)
12679 (org-highlight-new-match
12680 (match-beginning 0) (match-beginning 1)))
12681 (org-show-context 'tags-tree))
12682 ((eq action 'agenda)
12683 (setq txt (org-format-agenda-item
12684 ""
12685 (concat
12686 (if (eq org-tags-match-list-sublevels 'indented)
12687 (make-string (1- level) ?.) "")
12688 (org-get-heading))
12689 category
12690 tags-list
12691 )
12692 priority (org-get-priority txt))
12693 (goto-char lspos)
12694 (setq marker (org-agenda-new-marker))
12695 (org-add-props txt props
12696 'org-marker marker 'org-hd-marker marker 'org-category category
12697 'todo-state todo
12698 'priority priority 'type "tagsmatch")
12699 (push txt rtn))
12700 ((functionp action)
12701 (setq org-map-continue-from nil)
12702 (save-excursion
12703 (setq rtn1 (funcall action))
12704 (push rtn1 rtn)))
12705 (t (error "Invalid action")))
12707 ;; if we are to skip sublevels, jump to end of subtree
12708 (unless org-tags-match-list-sublevels
12709 (org-end-of-subtree t)
12710 (backward-char 1))))
12711 ;; Get the correct position from where to continue
12712 (if org-map-continue-from
12713 (goto-char org-map-continue-from)
12714 (and (= (point) lspos) (end-of-line 1)))))
12715 (when (and (eq action 'sparse-tree)
12716 (not org-sparse-tree-open-archived-trees))
12717 (org-hide-archived-subtrees (point-min) (point-max)))
12718 (nreverse rtn)))
12720 (defun org-remove-uninherited-tags (tags)
12721 "Remove all tags that are not inherited from the list TAGS."
12722 (cond
12723 ((eq org-use-tag-inheritance t)
12724 (if org-tags-exclude-from-inheritance
12725 (org-delete-all org-tags-exclude-from-inheritance tags)
12726 tags))
12727 ((not org-use-tag-inheritance) nil)
12728 ((stringp org-use-tag-inheritance)
12729 (delq nil (mapcar
12730 (lambda (x)
12731 (if (and (string-match org-use-tag-inheritance x)
12732 (not (member x org-tags-exclude-from-inheritance)))
12733 x nil))
12734 tags)))
12735 ((listp org-use-tag-inheritance)
12736 (delq nil (mapcar
12737 (lambda (x)
12738 (if (member x org-use-tag-inheritance) x nil))
12739 tags)))))
12741 (defvar todo-only) ;; dynamically scoped
12743 (defun org-match-sparse-tree (&optional todo-only match)
12744 "Create a sparse tree according to tags string MATCH.
12745 MATCH can contain positive and negative selection of tags, like
12747 If optional argument TODO-ONLY is non-nil, only select lines that are
12748 also TODO lines."
12749 (interactive "P")
12750 (org-prepare-agenda-buffers (list (current-buffer)))
12751 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12753 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12755 (defvar org-cached-props nil)
12756 (defun org-cached-entry-get (pom property)
12757 (if (or (eq t org-use-property-inheritance)
12758 (and (stringp org-use-property-inheritance)
12759 (string-match org-use-property-inheritance property))
12760 (and (listp org-use-property-inheritance)
12761 (member property org-use-property-inheritance)))
12762 ;; Caching is not possible, check it directly
12763 (org-entry-get pom property 'inherit)
12764 ;; Get all properties, so that we can do complicated checks easily
12765 (cdr (assoc property (or org-cached-props
12766 (setq org-cached-props
12767 (org-entry-properties pom)))))))
12769 (defun org-global-tags-completion-table (&optional files)
12770 "Return the list of all tags in all agenda buffer/files.
12771 Optional FILES argument is a list of files to which can be used
12772 instead of the agenda files."
12773 (save-excursion
12774 (org-uniquify
12775 (delq nil
12776 (apply 'append
12777 (mapcar
12778 (lambda (file)
12779 (set-buffer (find-file-noselect file))
12780 (append (org-get-buffer-tags)
12781 (mapcar (lambda (x) (if (stringp (car-safe x))
12782 (list (car-safe x)) nil))
12783 org-tag-alist)))
12784 (if (and files (car files))
12785 files
12786 (org-agenda-files))))))))
12788 (defun org-make-tags-matcher (match)
12789 "Create the TAGS/TODO matcher form for the selection string MATCH."
12790 ;; todo-only is scoped dynamically into this function, and the function
12791 ;; may change it if the matcher asks for it.
12792 (unless match
12793 ;; Get a new match request, with completion
12794 (let ((org-last-tags-completion-table
12795 (org-global-tags-completion-table)))
12796 (setq match (org-completing-read-no-i
12797 "Match: " 'org-tags-completion-function nil nil nil
12798 'org-tags-history))))
12800 ;; Parse the string and create a lisp form
12801 (let ((match0 match)
12802 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12803 minus tag mm
12804 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12805 orterms term orlist re-p str-p level-p level-op time-p
12806 prop-p pn pv po gv rest)
12807 (if (string-match "/+" match)
12808 ;; match contains also a todo-matching request
12809 (progn
12810 (setq tagsmatch (substring match 0 (match-beginning 0))
12811 todomatch (substring match (match-end 0)))
12812 (if (string-match "^!" todomatch)
12813 (setq todo-only t todomatch (substring todomatch 1)))
12815 (setq todomatch nil)))
12816 ;; only matching tags
12817 (setq tagsmatch match todomatch nil))
12819 ;; Make the tags matcher
12821 (setq tagsmatcher t)
12822 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12823 (while (setq term (pop orterms))
12825 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12826 (while (string-match re term)
12827 (setq rest (substring term (match-end 0))
12828 minus (and (match-end 1)
12829 (equal (match-string 1 term) "-"))
12830 tag (save-match-data (replace-regexp-in-string
12832 (match-string 2 term)))
12833 re-p (equal (string-to-char tag) ?{)
12834 level-p (match-end 4)
12835 prop-p (match-end 5)
12836 mm (cond
12837 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12838 (level-p
12839 (setq level-op (org-op-to-function (match-string 3 term)))
12840 `(,level-op level ,(string-to-number
12841 (match-string 4 term))))
12842 (prop-p
12843 (setq pn (match-string 5 term)
12844 po (match-string 6 term)
12845 pv (match-string 7 term)
12846 re-p (equal (string-to-char pv) ?{)
12848 time-p (save-match-data
12850 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12851 (if time-p (setq pv (org-matcher-time pv)))
12852 (setq po (org-op-to-function po (if time-p 'time str-p)))
12853 (cond
12854 ((equal pn "CATEGORY")
12855 (setq gv '(get-text-property (point) 'org-category)))
12856 ((equal pn "TODO")
12857 (setq gv 'todo))
12858 (t
12859 (setq gv `(org-cached-entry-get nil ,pn))))
12860 (if re-p
12861 (if (eq po 'org<>)
12862 `(not (string-match ,pv (or ,gv "")))
12863 `(string-match ,pv (or ,gv "")))
12864 (if str-p
12865 `(,po (or ,gv "") ,pv)
12866 `(,po (string-to-number (or ,gv ""))
12867 ,(string-to-number pv) ))))
12868 (t `(member ,tag tags-list)))
12869 mm (if minus (list 'not mm) mm)
12870 term rest)
12871 (push mm tagsmatcher))
12872 (push (if (> (length tagsmatcher) 1)
12873 (cons 'and tagsmatcher)
12874 (car tagsmatcher))
12875 orlist)
12876 (setq tagsmatcher nil))
12877 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12878 (setq tagsmatcher
12879 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12880 ;; Make the todo matcher
12882 (setq todomatcher t)
12883 (setq orterms (org-split-string todomatch "|") orlist nil)
12884 (while (setq term (pop orterms))
12885 (while (string-match re term)
12886 (setq minus (and (match-end 1)
12887 (equal (match-string 1 term) "-"))
12888 kwd (match-string 2 term)
12889 re-p (equal (string-to-char kwd) ?{)
12890 term (substring term (match-end 0))
12891 mm (if re-p
12892 `(string-match ,(substring kwd 1 -1) todo)
12893 (list 'equal 'todo kwd))
12894 mm (if minus (list 'not mm) mm))
12895 (push mm todomatcher))
12896 (push (if (> (length todomatcher) 1)
12897 (cons 'and todomatcher)
12898 (car todomatcher))
12899 orlist)
12900 (setq todomatcher nil))
12901 (setq todomatcher (if (> (length orlist) 1)
12902 (cons 'or orlist) (car orlist))))
12904 ;; Return the string and lisp forms of the matcher
12905 (setq matcher (if todomatcher
12906 (list 'and tagsmatcher todomatcher)
12907 tagsmatcher))
12908 (cons match0 matcher)))
12910 (defun org-op-to-function (op &optional stringp)
12911 "Turn an operator into the appropriate function."
12912 (setq op
12913 (cond
12914 ((equal op "<" ) '(< string< org-time<))
12915 ((equal op ">" ) '(> org-string> org-time>))
12916 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12917 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12918 ((member op '("=" "==")) '(= string= org-time=))
12919 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12920 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12922 (defun org<> (a b) (not (= a b)))
12923 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12924 (defun org-string>= (a b) (not (string< a b)))
12925 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12926 (defun org-string<> (a b) (not (string= a b)))
12927 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12928 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12929 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12930 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12931 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12932 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12933 (defun org-2ft (s)
12934 "Convert S to a floating point time.
12935 If S is already a number, just return it. If it is a string, parse
12936 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12937 (cond
12938 ((numberp s) s)
12939 ((stringp s)
12940 (condition-case nil
12941 (float-time (apply 'encode-time (org-parse-time-string s)))
12942 (error 0.)))
12943 (t 0.)))
12945 (defun org-time-today ()
12946 "Time in seconds today at 0:00.
12947 Returns the float number of seconds since the beginning of the
12948 epoch to the beginning of today (00:00)."
12949 (float-time (apply 'encode-time
12950 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12952 (defun org-matcher-time (s)
12953 "Interpret a time comparison value."
12954 (save-match-data
12955 (cond
12956 ((string= s "<now>") (float-time))
12957 ((string= s "<today>") (org-time-today))
12958 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12959 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12961 (+ (org-time-today)
12962 (* (string-to-number (match-string 1 s))
12963 (cdr (assoc (match-string 2 s)
12964 '(("d" . 86400.0) ("w" . 604800.0)
12965 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12966 (t (org-2ft s)))))
12968 (defun org-match-any-p (re list)
12969 "Does re match any element of list?"
12970 (setq list (mapcar (lambda (x) (string-match re x)) list))
12971 (delq nil list))
12973 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12974 (defvar org-tags-overlay (make-overlay 1 1))
12975 (org-detach-overlay org-tags-overlay)
12977 (defun org-get-local-tags-at (&optional pos)
12978 "Get a list of tags defined in the current headline."
12979 (org-get-tags-at pos 'local))
12981 (defun org-get-local-tags ()
12982 "Get a list of tags defined in the current headline."
12983 (org-get-tags-at nil 'local))
12985 (defun org-get-tags-at (&optional pos local)
12986 "Get a list of all headline tags applicable at POS.
12987 POS defaults to point. If tags are inherited, the list contains
12988 the targets in the same sequence as the headlines appear, i.e.
12989 the tags of the current headline come last.
12990 When LOCAL is non-nil, only return tags from the current headline,
12991 ignore inherited ones."
12992 (interactive)
12993 (if (and org-trust-scanner-tags
12994 (or (not pos) (equal pos (point)))
12995 (not local))
12996 org-scanner-tags
12997 (let (tags ltags lastpos parent)
12998 (save-excursion
12999 (save-restriction
13000 (widen)
13001 (goto-char (or pos (point)))
13002 (save-match-data
13003 (catch 'done
13004 (condition-case nil
13005 (progn
13006 (org-back-to-heading t)
13007 (while (not (equal lastpos (point)))
13008 (setq lastpos (point))
13009 (when (looking-at
13011 (setq ltags (org-split-string
13012 (org-match-string-no-properties 1) ":"))
13013 (when parent
13014 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13015 (setq tags (append
13016 (if parent
13017 (org-remove-uninherited-tags ltags)
13018 ltags)
13019 tags)))
13020 (or org-use-tag-inheritance (throw 'done t))
13021 (if local (throw 'done t))
13022 (or (org-up-heading-safe) (error nil))
13023 (setq parent t)))
13024 (error nil)))))
13025 (if local
13026 tags
13027 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13029 (defun org-add-prop-inherited (s)
13030 (add-text-properties 0 (length s) '(inherited t) s)
13031 s)
13033 (defun org-toggle-tag (tag &optional onoff)
13034 "Toggle the tag TAG for the current line.
13035 If ONOFF is `on' or `off', don't toggle but set to this state."
13036 (let (res current)
13037 (save-excursion
13038 (org-back-to-heading t)
13040 (point-at-eol) t)
13041 (progn
13042 (setq current (match-string 1))
13043 (replace-match ""))
13044 (setq current ""))
13045 (setq current (nreverse (org-split-string current ":")))
13046 (cond
13047 ((eq onoff 'on)
13048 (setq res t)
13049 (or (member tag current) (push tag current)))
13050 ((eq onoff 'off)
13051 (or (not (member tag current)) (setq current (delete tag current))))
13052 (t (if (member tag current)
13053 (setq current (delete tag current))
13054 (setq res t)
13055 (push tag current))))
13056 (end-of-line 1)
13057 (if current
13058 (progn
13059 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13060 (org-set-tags nil t))
13061 (delete-horizontal-space))
13062 (run-hooks 'org-after-tags-change-hook))
13063 res))
13065 (defun org-align-tags-here (to-col)
13066 ;; Assumes that this is a headline
13067 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13068 (beginning-of-line 1)
13070 (< pos (match-beginning 2)))
13071 (progn
13072 (setq tags-l (- (match-end 2) (match-beginning 2)))
13073 (goto-char (match-beginning 1))
13074 (insert " ")
13075 (delete-region (point) (1+ (match-beginning 2)))
13076 (setq ncol (max (current-column)
13077 (1+ col)
13078 (if (> to-col 0)
13079 to-col
13080 (- (abs to-col) tags-l))))
13081 (setq p (point))
13082 (insert (make-string (- ncol (current-column)) ?\ ))
13083 (setq ncol (current-column))
13084 (when indent-tabs-mode (tabify p (point-at-eol)))
13085 (org-move-to-column (min ncol col) t))
13086 (goto-char pos))))
13088 (defun org-set-tags-command (&optional arg just-align)
13089 "Call the set-tags command for the current entry."
13090 (interactive "P")
13091 (if (org-on-heading-p)
13092 (org-set-tags arg just-align)
13093 (save-excursion
13094 (org-back-to-heading t)
13095 (org-set-tags arg just-align))))
13097 (defun org-set-tags-to (data)
13098 "Set the tags of the current entry to DATA, replacing the current tags.
13099 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13100 If DATA is nil or the empty string, any tags will be removed."
13101 (interactive "sTags: ")
13102 (setq data
13103 (cond
13104 ((eq data nil) "")
13105 ((equal data "") "")
13106 ((stringp data)
13107 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13108 ":"))
13109 ((listp data)
13110 (concat ":" (mapconcat 'identity data ":") ":"))
13111 (t nil)))
13112 (when data
13113 (save-excursion
13114 (org-back-to-heading t)
13115 (when (looking-at org-complex-heading-regexp)
13116 (if (match-end 5)
13117 (progn
13118 (goto-char (match-beginning 5))
13119 (insert data)
13120 (delete-region (point) (point-at-eol))
13121 (org-set-tags nil 'align))
13122 (goto-char (point-at-eol))
13123 (insert " " data)
13124 (org-set-tags nil 'align)))
13125 (beginning-of-line 1)
13127 (delete-region (match-beginning 1) (match-end 1))))))
13129 (defun org-align-all-tags ()
13130 "Align the tags i all headings."
13131 (interactive)
13132 (save-excursion
13133 (or (ignore-errors (org-back-to-heading t))
13134 (outline-next-heading))
13135 (if (org-on-heading-p)
13136 (org-set-tags t)
13137 (message "No headings"))))
13139 (defvar org-indent-indentation-per-level)
13140 (defun org-set-tags (&optional arg just-align)
13141 "Set the tags for the current headline.
13142 With prefix ARG, realign all tags in headings in the current buffer."
13143 (interactive "P")
13144 (let* ((re org-outline-regexp-bol)
13145 (current (org-get-tags-string))
13146 (col (current-column))
13147 (org-setting-tags t)
13148 table current-tags inherited-tags ; computed below when needed
13149 tags p0 c0 c1 rpl di tc level)
13150 (if arg
13151 (save-excursion
13152 (goto-char (point-min))
13153 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13154 (while (re-search-forward re nil t)
13155 (org-set-tags nil t)
13156 (end-of-line 1)))
13157 (message "All tags realigned to column %d" org-tags-column))
13158 (if just-align
13159 (setq tags current)
13160 ;; Get a new set of tags from the user
13161 (save-excursion
13162 (setq table (append org-tag-persistent-alist
13163 (or org-tag-alist (org-get-buffer-tags))
13164 (and
13165 org-complete-tags-always-offer-all-agenda-tags
13166 (org-global-tags-completion-table
13167 (org-agenda-files))))
13168 org-last-tags-completion-table table
13169 current-tags (org-split-string current ":")
13170 inherited-tags (nreverse
13171 (nthcdr (length current-tags)
13172 (nreverse (org-get-tags-at))))
13173 tags
13174 (if (or (eq t org-use-fast-tag-selection)
13175 (and org-use-fast-tag-selection
13176 (delq nil (mapcar 'cdr table))))
13177 (org-fast-tag-selection
13178 current-tags inherited-tags table
13179 (if org-fast-tag-selection-include-todo
13180 org-todo-key-alist))
13181 (let ((org-add-colon-after-tag-completion t))
13182 (org-trim
13183 (org-icompleting-read "Tags: "
13184 'org-tags-completion-function
13185 nil nil current 'org-tags-history))))))
13186 (while (string-match "[-+&]+" tags)
13187 ;; No boolean logic, just a list
13188 (setq tags (replace-match ":" t t tags))))
13190 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13192 (if org-tags-sort-function
13193 (setq tags (mapconcat 'identity
13194 (sort (org-split-string
13195 tags (org-re "[^[:alnum:]_@#%]+"))
13196 org-tags-sort-function) ":")))
13199 (setq tags "")
13200 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13201 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13203 ;; Insert new tags at the correct column
13204 (beginning-of-line 1)
13205 (setq level (or (and (looking-at org-outline-regexp)
13206 (- (match-end 0) (point) 1))
13207 1))
13208 (cond
13209 ((and (equal current "") (equal tags "")))
13210 ((re-search-forward
13212 (point-at-eol) t)
13213 (if (equal tags "")
13214 (setq rpl "")
13215 (goto-char (match-beginning 0))
13216 (setq c0 (current-column)
13217 ;; compute offset for the case of org-indent-mode active
13218 di (if org-indent-mode
13219 (* (1- org-indent-indentation-per-level) (1- level))
13220 0)
13221 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13222 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13223 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13224 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13225 (replace-match rpl t t)
13226 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13227 tags)
13228 (t (error "Tags alignment failed")))
13229 (org-move-to-column col)
13230 (unless just-align
13231 (run-hooks 'org-after-tags-change-hook)))))
13233 (defun org-change-tag-in-region (beg end tag off)
13234 "Add or remove TAG for each entry in the region.
13235 This works in the agenda, and also in an org-mode buffer."
13236 (interactive
13237 (list (region-beginning) (region-end)
13238 (let ((org-last-tags-completion-table
13239 (if (org-mode-p)
13240 (org-get-buffer-tags)
13241 (org-global-tags-completion-table))))
13242 (org-icompleting-read
13243 "Tag: " 'org-tags-completion-function nil nil nil
13244 'org-tags-history))
13245 (progn
13247 (equal (read-char-exclusive) ?r))))
13248 (if (fboundp 'deactivate-mark) (deactivate-mark))
13249 (let ((agendap (equal major-mode 'org-agenda-mode))
13250 l1 l2 m buf pos newhead (cnt 0))
13251 (goto-char end)
13252 (setq l2 (1- (org-current-line)))
13253 (goto-char beg)
13254 (setq l1 (org-current-line))
13255 (loop for l from l1 to l2 do
13256 (org-goto-line l)
13257 (setq m (get-text-property (point) 'org-hd-marker))
13258 (when (or (and (org-mode-p) (org-on-heading-p))
13259 (and agendap m))
13260 (setq buf (if agendap (marker-buffer m) (current-buffer))
13261 pos (if agendap m (point)))
13262 (with-current-buffer buf
13263 (save-excursion
13264 (save-restriction
13265 (goto-char pos)
13266 (setq cnt (1+ cnt))
13267 (org-toggle-tag tag (if off 'off 'on))
13268 (setq newhead (org-get-heading)))))
13269 (and agendap (org-agenda-change-all-lines newhead m))))
13270 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13272 (defun org-tags-completion-function (string predicate &optional flag)
13273 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13274 (confirm (lambda (x) (stringp (car x)))))
13276 (setq s1 (match-string 1 string)
13277 s2 (match-string 2 string))
13278 (setq s1 "" s2 string))
13279 (cond
13280 ((eq flag nil)
13281 ;; try completion
13282 (setq rtn (try-completion s2 ctable confirm))
13283 (if (stringp rtn)
13284 (setq rtn
13285 (concat s1 s2 (substring rtn (length s2))
13286 (if (and org-add-colon-after-tag-completion
13287 (assoc rtn ctable))
13288 ":" ""))))
13289 rtn)
13290 ((eq flag t)
13291 ;; all-completions
13292 (all-completions s2 ctable confirm)
13293 )
13294 ((eq flag 'lambda)
13295 ;; exact match?
13296 (assoc s2 ctable)))
13297 ))
13299 (defun org-fast-tag-insert (kwd tags face &optional end)
13300 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13301 (insert (format "%-12s" (concat kwd ":"))
13302 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13303 (or end "")))
13305 (defun org-fast-tag-show-exit (flag)
13306 (save-excursion
13307 (org-goto-line 3)
13309 (replace-match ""))
13310 (when flag
13311 (end-of-line 1)
13312 (org-move-to-column (- (window-width) 19) t)
13313 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13315 (defun org-set-current-tags-overlay (current prefix)
13316 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13317 (if (featurep 'xemacs)
13318 (org-overlay-display org-tags-overlay (concat prefix s)
13319 'secondary-selection)
13320 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13321 (org-overlay-display org-tags-overlay (concat prefix s)))))
13323 (defvar org-last-tag-selection-key nil)
13324 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13325 "Fast tag selection with single keys.
13326 CURRENT is the current list of tags in the headline, INHERITED is the
13327 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13328 possibly with grouping information. TODO-TABLE is a similar table with
13329 TODO keywords, should these have keys assigned to them.
13330 If the keys are nil, a-z are automatically assigned.
13331 Returns the new tags string, or nil to not change the current settings."
13332 (let* ((fulltable (append table todo-table))
13333 (maxlen (apply 'max (mapcar
13334 (lambda (x)
13335 (if (stringp (car x)) (string-width (car x)) 0))
13336 fulltable)))
13337 (buf (current-buffer))
13338 (expert (eq org-fast-tag-selection-single-key 'expert))
13339 (buffer-tags nil)
13340 (fwidth (+ maxlen 3 1 3))
13341 (ncol (/ (- (window-width) 4) fwidth))
13342 (i-face 'org-done)
13343 (c-face 'org-todo)
13344 tg cnt e c char c1 c2 ntable tbl rtn
13345 ov-start ov-end ov-prefix
13346 (exit-after-next org-fast-tag-selection-single-key)
13347 (done-keywords org-done-keywords)
13348 groups ingroup)
13349 (save-excursion
13350 (beginning-of-line 1)
13351 (if (looking-at
13353 (setq ov-start (match-beginning 1)
13354 ov-end (match-end 1)
13355 ov-prefix "")
13356 (setq ov-start (1- (point-at-eol))
13357 ov-end (1+ ov-start))
13359 (setq ov-prefix
13360 (concat
13361 (buffer-substring (1- (point)) (point))
13362 (if (> (current-column) org-tags-column)
13363 " "
13364 (make-string (- org-tags-column (current-column)) ?\ ))))))
13365 (move-overlay org-tags-overlay ov-start ov-end)
13366 (save-window-excursion
13367 (if expert
13368 (set-buffer (get-buffer-create " *Org tags*"))
13369 (delete-other-windows)
13370 (split-window-vertically)
13371 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13372 (erase-buffer)
13373 (org-set-local 'org-done-keywords done-keywords)
13376 (org-fast-tag-show-exit exit-after-next)
13377 (org-set-current-tags-overlay current ov-prefix)
13378 (setq tbl fulltable char ?a cnt 0)
13379 (while (setq e (pop tbl))
13380 (cond
13381 ((equal (car e) :startgroup)
13382 (push '() groups) (setq ingroup t)
13383 (when (not (= cnt 0))
13384 (setq cnt 0)
13386 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13387 ((equal (car e) :endgroup)
13388 (setq ingroup nil cnt 0)
13390 ((equal e '(:newline))
13391 (when (not (= cnt 0))
13392 (setq cnt 0)
13394 (setq e (car tbl))
13395 (while (equal (car tbl) '(:newline))
13397 (setq tbl (cdr tbl)))))
13398 (t
13399 (setq tg (copy-sequence (car e)) c2 nil)
13400 (if (cdr e)
13401 (setq c (cdr e))
13402 ;; automatically assign a character.
13403 (setq c1 (string-to-char
13404 (downcase (substring
13405 tg (if (= (string-to-char tg) ?@) 1 0)))))
13406 (if (or (rassoc c1 ntable) (rassoc c1 table))
13407 (while (or (rassoc char ntable) (rassoc char table))
13408 (setq char (1+ char)))
13409 (setq c2 c1))
13410 (setq c (or c2 char)))
13411 (if ingroup (push tg (car groups)))
13412 (setq tg (org-add-props tg nil 'face
13413 (cond
13414 ((not (assoc tg table))
13415 (org-get-todo-face tg))
13416 ((member tg current) c-face)
13417 ((member tg inherited) i-face)
13418 (t nil))))
13419 (if (and (= cnt 0) (not ingroup)) (insert " "))
13420 (insert "[" c "] " tg (make-string
13421 (- fwidth 4 (length tg)) ?\ ))
13422 (push (cons tg c) ntable)
13423 (when (= (setq cnt (1+ cnt)) ncol)
13425 (if ingroup (insert " "))
13426 (setq cnt 0)))))
13427 (setq ntable (nreverse ntable))
13429 (goto-char (point-min))
13430 (if (not expert) (org-fit-window-to-buffer))
13431 (setq rtn
13432 (catch 'exit
13433 (while t
13434 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13435 (if (not groups) "no " "")
13436 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13437 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13438 (setq org-last-tag-selection-key c)
13439 (cond
13441 ((= c ?!)
13442 (setq groups (not groups))
13443 (goto-char (point-min))
13444 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13445 ((= c ?\C-c)
13446 (if (not expert)
13447 (org-fast-tag-show-exit
13448 (setq exit-after-next (not exit-after-next)))
13449 (setq expert nil)
13450 (delete-other-windows)
13451 (set-window-buffer (split-window-vertically) " *Org tags*")
13452 (org-switch-to-buffer-other-window " *Org tags*")
13453 (org-fit-window-to-buffer)))
13454 ((or (= c ?\C-g)
13455 (and (= c ?q) (not (rassoc c ntable))))
13456 (org-detach-overlay org-tags-overlay)
13457 (setq quit-flag t))
13458 ((= c ?\ )
13459 (setq current nil)
13460 (if exit-after-next (setq exit-after-next 'now)))
13462 (condition-case nil
13463 (setq tg (org-icompleting-read
13464 "Tag: "
13465 (or buffer-tags
13466 (with-current-buffer buf
13467 (org-get-buffer-tags)))))
13468 (quit (setq tg "")))
13470 (add-to-list 'buffer-tags (list tg))
13471 (if (member tg current)
13472 (setq current (delete tg current))
13473 (push tg current)))
13474 (if exit-after-next (setq exit-after-next 'now)))
13475 ((setq e (rassoc c todo-table) tg (car e))
13476 (with-current-buffer buf
13477 (save-excursion (org-todo tg)))
13478 (if exit-after-next (setq exit-after-next 'now)))
13479 ((setq e (rassoc c ntable) tg (car e))
13480 (if (member tg current)
13481 (setq current (delete tg current))
13482 (loop for g in groups do
13483 (if (member tg g)
13484 (mapc (lambda (x)
13485 (setq current (delete x current)))
13486 g)))
13487 (push tg current))
13488 (if exit-after-next (setq exit-after-next 'now))))
13490 ;; Create a sorted list
13491 (setq current
13492 (sort current
13493 (lambda (a b)
13494 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13495 (if (eq exit-after-next 'now) (throw 'exit t))
13496 (goto-char (point-min))
13497 (beginning-of-line 2)
13498 (delete-region (point) (point-at-eol))
13499 (org-fast-tag-insert "Current" current c-face)
13500 (org-set-current-tags-overlay current ov-prefix)
13501 (while (re-search-forward
13503 (setq tg (match-string 1))
13504 (add-text-properties
13505 (match-beginning 1) (match-end 1)
13506 (list 'face
13507 (cond
13508 ((member tg current) c-face)
13509 ((member tg inherited) i-face)
13510 (t (get-text-property (match-beginning 1) 'face))))))
13511 (goto-char (point-min)))))
13512 (org-detach-overlay org-tags-overlay)
13513 (if rtn
13514 (mapconcat 'identity current ":")
13515 nil))))
13517 (defun org-get-tags-string ()
13518 "Get the TAGS string in the current headline."
13519 (unless (org-on-heading-p t)
13520 (error "Not on a heading"))
13521 (save-excursion
13522 (beginning-of-line 1)
13524 (org-match-string-no-properties 1)
13525 "")))
13527 (defun org-get-tags ()
13528 "Get the list of tags specified in the current headline."
13529 (org-split-string (org-get-tags-string) ":"))
13531 (defun org-get-buffer-tags ()
13532 "Get a table of all tags used in the buffer, for completion."
13533 (let (tags)
13534 (save-excursion
13535 (goto-char (point-min))
13536 (while (re-search-forward
13538 (when (equal (char-after (point-at-bol 0)) ?*)
13539 (mapc (lambda (x) (add-to-list 'tags x))
13540 (org-split-string (org-match-string-no-properties 1) ":")))))
13541 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13542 (mapcar 'list tags)))
13544 ;;;; The mapping API
13546 ;;;###autoload
13547 (defun org-map-entries (func &optional match scope &rest skip)
13548 "Call FUNC at each headline selected by MATCH in SCOPE.
13550 FUNC is a function or a lisp form. The function will be called without
13551 arguments, with the cursor positioned at the beginning of the headline.
13552 The return values of all calls to the function will be collected and
13553 returned as a list.
13555 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13556 does not need to preserve point. After evaluation, the cursor will be
13557 moved to the end of the line (presumably of the headline of the
13558 processed entry) and search continues from there. Under some
13559 circumstances, this may not produce the wanted results. For example,
13560 if you have removed (e.g. archived) the current (sub)tree it could
13561 mean that the next entry will be skipped entirely. In such cases, you
13562 can specify the position from where search should continue by making
13563 FUNC set the variable `org-map-continue-from' to the desired buffer
13564 position.
13566 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13567 Only headlines that are matched by this query will be considered during
13568 the iteration. When MATCH is nil or t, all headlines will be
13569 visited by the iteration.
13571 SCOPE determines the scope of this command. It can be any of:
13573 nil The current buffer, respecting the restriction if any
13574 tree The subtree started with the entry at point
13575 region The entries within the active region, if any
13576 file The current buffer, without restriction
13577 file-with-archives
13578 The current buffer, and any archives associated with it
13579 agenda All agenda files
13580 agenda-with-archives
13581 All agenda files with any archive files associated with them
13582 \(file1 file2 ...)
13583 If this is a list, all files in the list will be scanned
13585 The remaining args are treated as settings for the skipping facilities of
13586 the scanner. The following items can be given here:
13588 archive skip trees with the archive tag.
13589 comment skip trees with the COMMENT keyword
13590 function or Emacs Lisp form:
13591 will be used as value for `org-agenda-skip-function', so whenever
13592 the function returns t, FUNC will not be called for that
13593 entry and search will continue from the point where the
13594 function leaves it.
13596 If your function needs to retrieve the tags including inherited tags
13597 at the *current* entry, you can use the value of the variable
13598 `org-scanner-tags' which will be much faster than getting the value
13599 with `org-get-tags-at'. If your function gets properties with
13600 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13601 to t around the call to `org-entry-properties' to get the same speedup.
13602 Note that if your function moves around to retrieve tags and properties at
13603 a *different* entry, you cannot use these techniques."
13604 (let* ((org-agenda-archives-mode nil) ; just to make sure
13605 (org-agenda-skip-archived-trees (memq 'archive skip))
13606 (org-agenda-skip-comment-trees (memq 'comment skip))
13607 (org-agenda-skip-function
13608 (car (org-delete-all '(comment archive) skip)))
13609 (org-tags-match-list-sublevels t)
13610 matcher file res
13611 org-todo-keywords-for-agenda
13612 org-done-keywords-for-agenda
13613 org-todo-keyword-alist-for-agenda
13614 org-drawers-for-agenda
13615 org-tag-alist-for-agenda)
13617 (cond
13618 ((eq match t) (setq matcher t))
13619 ((eq match nil) (setq matcher t))
13620 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13622 (save-excursion
13623 (save-restriction
13624 (cond ((eq scope 'tree)
13625 (org-back-to-heading t)
13626 (org-narrow-to-subtree)
13627 (setq scope nil))
13628 ((and (eq scope 'region) (org-region-active-p))
13629 (narrow-to-region (region-beginning) (region-end))
13630 (setq scope nil)))
13632 (if (not scope)
13633 (progn
13634 (org-prepare-agenda-buffers
13635 (list (buffer-file-name (current-buffer))))
13636 (setq res (org-scan-tags func matcher)))
13637 ;; Get the right scope
13638 (cond
13639 ((and scope (listp scope) (symbolp (car scope)))
13640 (setq scope (eval scope)))
13641 ((eq scope 'agenda)
13642 (setq scope (org-agenda-files t)))
13643 ((eq scope 'agenda-with-archives)
13644 (setq scope (org-agenda-files t))
13645 (setq scope (org-add-archive-files scope)))
13646 ((eq scope 'file)
13647 (setq scope (list (buffer-file-name))))
13648 ((eq scope 'file-with-archives)
13649 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13650 (org-prepare-agenda-buffers scope)
13651 (while (setq file (pop scope))
13652 (with-current-buffer (org-find-base-buffer-visiting file)
13653 (save-excursion
13654 (save-restriction
13655 (widen)
13656 (goto-char (point-min))
13657 (setq res (append res (org-scan-tags func matcher))))))))))
13658 res))
13660 ;;;; Properties
13662 ;;; Setting and retrieving properties
13664 (defconst org-special-properties
13665 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13666 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13667 "The special properties valid in Org-mode.
13669 These are properties that are not defined in the property drawer,
13670 but in some other way.")
13672 (defconst org-default-properties
13673 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13674 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13675 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13676 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13677 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13678 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13679 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13680 "Some properties that are used by Org-mode for various purposes.
13681 Being in this list makes sure that they are offered for completion.")
13684 "Regular expression matching the first line of a property drawer.")
13687 "Regular expression matching the last line of a property drawer.")
13690 "Regular expression matching the first line of a property drawer.")
13693 "Regular expression matching the first line of a property drawer.")
13695 (defconst org-property-drawer-re
13698 "Matches an entire property drawer.")
13700 (defconst org-clock-drawer-re
13703 "Matches an entire clock drawer.")
13705 (defsubst org-re-property (property)
13706 "Return a regexp matching PROPERTY.
13707 Match group 1 will be set to the value "
13710 (defun org-property-action ()
13711 "Do an action on properties."
13712 (interactive)
13713 (let (c)
13714 (org-at-property-p)
13715 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13716 (setq c (read-char-exclusive))
13717 (cond
13718 ((equal c ?s)
13719 (call-interactively 'org-set-property))
13720 ((equal c ?d)
13721 (call-interactively 'org-delete-property))
13722 ((equal c ?D)
13723 (call-interactively 'org-delete-property-globally))
13724 ((equal c ?c)
13725 (call-interactively 'org-compute-property-at-point))
13726 (t (error "No such property action %c" c)))))
13728 (defun org-set-effort (&optional value)
13729 "Set the effort property of the current entry.
13730 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13731 allowed value."
13732 (interactive "P")
13733 (if (equal value 0) (setq value 10))
13734 (let* ((completion-ignore-case t)
13735 (prop org-effort-property)
13736 (cur (org-entry-get nil prop))
13737 (allowed (org-property-get-allowed-values nil prop 'table))
13738 (existing (mapcar 'list (org-property-values prop)))
13739 rpl
13740 (val (cond
13741 ((stringp value) value)
13742 ((and allowed (integerp value))
13743 (or (car (nth (1- value) allowed))
13744 (car (org-last allowed))))
13745 (allowed
13746 (message "Select 1-9,0, [RET%s]: %s"
13747 (if cur (concat "=" cur) "")
13748 (mapconcat 'car allowed " "))
13749 (setq rpl (read-char-exclusive))
13751 cur
13752 (setq rpl (- rpl ?0))
13753 (if (equal rpl 0) (setq rpl 10))
13754 (if (and (> rpl 0) (<= rpl (length allowed)))
13755 (car (nth (1- rpl) allowed))
13756 (org-completing-read "Effort: " allowed nil))))
13757 (t
13758 (let (org-completion-use-ido org-completion-use-iswitchb)
13759 (org-completing-read
13761 (concat "[" cur "]") "")
13762 ": ")
13763 existing nil nil "" nil cur))))))
13764 (unless (equal (org-entry-get nil prop) val)
13765 (org-entry-put nil prop val))
13766 (message "%s is now %s" prop val)))
13768 (defun org-at-property-p ()
13769 "Is cursor inside a property drawer?"
13770 (save-excursion
13771 (beginning-of-line 1)
13773 (save-match-data ;; Used by calling procedures
13774 (let ((p (point))
13775 (range (unless (org-before-first-heading-p)
13776 (org-get-property-block))))
13777 (and range (<= (car range) p) (< p (cdr range))))))))
13779 (defun org-get-property-block (&optional beg end force)
13780 "Return the (beg . end) range of the body of the property drawer.
13781 BEG and END can be beginning and end of subtree, if not given
13782 they will be found.
13783 If the drawer does not exist and FORCE is non-nil, create the drawer."
13784 (catch 'exit
13785 (save-excursion
13786 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13787 (end (or end (progn (outline-next-heading) (point)))))
13788 (goto-char beg)
13789 (if (re-search-forward org-property-start-re end t)
13790 (setq beg (1+ (match-end 0)))
13791 (if force
13792 (save-excursion
13793 (org-insert-property-drawer)
13794 (setq end (progn (outline-next-heading) (point))))
13795 (throw 'exit nil))
13796 (goto-char beg)
13797 (if (re-search-forward org-property-start-re end t)
13798 (setq beg (1+ (match-end 0)))))
13799 (if (re-search-forward org-property-end-re end t)
13800 (setq end (match-beginning 0))
13801 (or force (throw 'exit nil))
13802 (goto-char beg)
13803 (setq end beg)
13804 (org-indent-line-function)
13806 (cons beg end)))))
13808 (defun org-entry-properties (&optional pom which specific)
13809 "Get all properties of the entry at point-or-marker POM.
13810 This includes the TODO keyword, the tags, time strings for deadline,
13811 scheduled, and clocking, and any additional properties defined in the
13812 entry. The return value is an alist, keys may occur multiple times
13813 if the property key was used several times.
13814 POM may also be nil, in which case the current entry is used.
13815 If WHICH is nil or `all', get all properties. If WHICH is
13816 `special' or `standard', only get that subclass. If WHICH
13817 is a string only get exactly this property. SPECIFIC can be a string, the
13818 specific property we are interested in. Specifying it can speed
13819 things up because then unnecessary parsing is avoided."
13820 (setq which (or which 'all))
13821 (org-with-point-at pom
13822 (let ((clockstr (substring org-clock-string 0 -1))
13823 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13824 (case-fold-search nil)
13825 beg end range props sum-props key key1 value string clocksum)
13826 (save-excursion
13827 (when (condition-case nil
13828 (and (org-mode-p) (org-back-to-heading t))
13829 (error nil))
13830 (setq beg (point))
13831 (setq sum-props (get-text-property (point) 'org-summaries))
13832 (setq clocksum (get-text-property (point) :org-clock-minutes))
13833 (outline-next-heading)
13834 (setq end (point))
13835 (when (memq which '(all special))
13836 ;; Get the special properties, like TODO and tags
13837 (goto-char beg)
13838 (when (and (or (not specific) (string= specific "TODO"))
13839 (looking-at org-todo-line-regexp) (match-end 2))
13840 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13841 (when (and (or (not specific) (string= specific "PRIORITY"))
13842 (looking-at org-priority-regexp))
13843 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13844 (when (or (not specific) (string= specific "FILE"))
13845 (push (cons "FILE" buffer-file-name) props))
13846 (when (and (or (not specific) (string= specific "TAGS"))
13847 (setq value (org-get-tags-string))
13849 (push (cons "TAGS" value) props))
13850 (when (and (or (not specific) (string= specific "ALLTAGS"))
13851 (setq value (org-get-tags-at)))
13852 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13853 ":"))
13854 props))
13855 (when (or (not specific) (string= specific "BLOCKED"))
13856 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13857 (when (or (not specific)
13858 (member specific
13859 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13860 "TIMESTAMP" "TIMESTAMP_IA")))
13861 (catch 'match
13862 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13863 (setq key (if (match-end 1)
13864 (substring (org-match-string-no-properties 1)
13865 0 -1))
13866 string (if (equal key clockstr)
13867 (org-no-properties
13868 (org-trim
13869 (buffer-substring
13870 (match-beginning 3) (goto-char
13871 (point-at-eol)))))
13872 (substring (org-match-string-no-properties 3)
13873 1 -1)))
13874 ;; Get the correct property name from the key. This is
13875 ;; necessary if the user has configured time keywords.
13876 (setq key1 (concat key ":"))
13877 (cond
13878 ((not key)
13879 (setq key
13880 (if (= (char-after (match-beginning 3)) ?\[)
13881 "TIMESTAMP_IA" "TIMESTAMP")))
13882 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13883 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13884 ((equal key1 org-closed-string) (setq key "CLOSED"))
13885 ((equal key1 org-clock-string) (setq key "CLOCK")))
13886 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13887 (progn
13888 (push (cons key string) props)
13889 ;; no need to search further if match is found
13890 (throw 'match t))
13891 (when (or (equal key "CLOCK") (not (assoc key props)))
13892 (push (cons key string) props))))))
13893 )
13895 (when (memq which '(all standard))
13896 ;; Get the standard properties, like :PROP: ...
13897 (setq range (org-get-property-block beg end))
13898 (when range
13899 (goto-char (car range))
13900 (while (re-search-forward
13902 (cdr range) t)
13903 (setq key (org-match-string-no-properties 1)
13904 value (org-trim (or (org-match-string-no-properties 2) "")))
13905 (unless (member key excluded)
13906 (push (cons key (or value "")) props)))))
13907 (if clocksum
13908 (push (cons "CLOCKSUM"
13909 (org-columns-number-to-string (/ (float clocksum) 60.)
13910 'add_times))
13911 props))
13912 (unless (assoc "CATEGORY" props)
13913 (push (cons "CATEGORY" (org-get-category)) props))
13914 (append sum-props (nreverse props)))))))
13916 (defun org-entry-get (pom property &optional inherit literal-nil)
13917 "Get value of PROPERTY for entry at point-or-marker POM.
13918 If INHERIT is non-nil and the entry does not have the property,
13919 then also check higher levels of the hierarchy.
13920 If INHERIT is the symbol `selective', use inheritance only if the setting
13921 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13922 If the property is present but empty, the return value is the empty string.
13923 If the property is not present at all, nil is returned.
13926 do not interpret it as the list atom nil. This is used for inheritance
13928 (org-with-point-at pom
13929 (if (and inherit (if (eq inherit 'selective)
13930 (org-property-inherit-p property)
13931 t))
13932 (org-entry-get-with-inheritance property literal-nil)
13933 (if (member property org-special-properties)
13934 ;; We need a special property. Use `org-entry-properties' to
13935 ;; retrieve it, but specify the wanted property
13936 (cdr (assoc property (org-entry-properties nil 'special property)))
13937 (let ((range (unless (org-before-first-heading-p)
13938 (org-get-property-block))))
13939 (if (and range
13940 (goto-char (car range))
13941 (re-search-forward
13942 (org-re-property property)
13943 (cdr range) t))
13944 ;; Found the property, return it.
13945 (if (match-end 1)
13946 (if literal-nil
13947 (org-match-string-no-properties 1)
13948 (org-not-nil (org-match-string-no-properties 1)))
13949 "")))))))
13951 (defun org-property-or-variable-value (var &optional inherit)
13952 "Check if there is a property fixing the value of VAR.
13953 If yes, return this value. If not, return the current value of the variable."
13954 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13956 (read prop)
13957 (symbol-value var))))
13959 (defun org-entry-delete (pom property)
13960 "Delete the property PROPERTY from entry at point-or-marker POM."
13961 (org-with-point-at pom
13962 (if (member property org-special-properties)
13963 nil ; cannot delete these properties.
13964 (let ((range (org-get-property-block)))
13965 (if (and range
13966 (goto-char (car range))
13967 (re-search-forward
13968 (org-re-property property)
13969 (cdr range) t))
13970 (progn
13971 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13972 t)
13973 nil)))))
13975 ;; Multi-values properties are properties that contain multiple values
13976 ;; These values are assumed to be single words, separated by whitespace.
13977 (defun org-entry-add-to-multivalued-property (pom property value)
13978 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13979 (let* ((old (org-entry-get pom property))
13981 (setq value (org-entry-protect-space value))
13982 (unless (member value values)
13983 (setq values (cons value values))
13984 (org-entry-put pom property
13985 (mapconcat 'identity values " ")))))
13987 (defun org-entry-remove-from-multivalued-property (pom property value)
13988 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13989 (let* ((old (org-entry-get pom property))
13991 (setq value (org-entry-protect-space value))
13992 (when (member value values)
13993 (setq values (delete value values))
13994 (org-entry-put pom property
13995 (mapconcat 'identity values " ")))))
13997 (defun org-entry-member-in-multivalued-property (pom property value)
13998 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13999 (let* ((old (org-entry-get pom property))
14001 (setq value (org-entry-protect-space value))
14002 (member value values)))
14004 (defun org-entry-get-multivalued-property (pom property)
14005 "Return a list of values in a multivalued property."
14006 (let* ((value (org-entry-get pom property))
14008 (mapcar 'org-entry-restore-space values)))
14010 (defun org-entry-put-multivalued-property (pom property &rest values)
14011 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14012 VALUES should be a list of strings. Spaces will be protected."
14013 (org-entry-put pom property
14014 (mapconcat 'org-entry-protect-space values " "))
14015 (let* ((value (org-entry-get pom property))
14017 (mapcar 'org-entry-restore-space values)))
14019 (defun org-entry-protect-space (s)
14020 "Protect spaces and newline in string S."
14021 (while (string-match " " s)
14022 (setq s (replace-match "%20" t t s)))
14024 (setq s (replace-match "%0A" t t s)))
14025 s)
14027 (defun org-entry-restore-space (s)
14028 "Restore spaces and newline in string S."
14029 (while (string-match "%20" s)
14030 (setq s (replace-match " " t t s)))
14031 (while (string-match "%0A" s)
14033 s)
14035 (defvar org-entry-property-inherited-from (make-marker)
14036 "Marker pointing to the entry from where a property was inherited.
14037 Each call to `org-entry-get-with-inheritance' will set this marker to the
14038 location of the entry where the inheritance search matched. If there was
14039 no match, the marker will point nowhere.
14040 Note that also `org-entry-get' calls this function, if the INHERIT flag
14041 is set.")
14043 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14044 "Get entry property, and search higher levels if not present.
14045 The search will stop at the first ancestor which has the property defined.
14047 should be considered as undefined (this is the meaning of nil here).
14049 (move-marker org-entry-property-inherited-from nil)
14050 (let (tmp)
14051 (unless (org-before-first-heading-p)
14052 (save-excursion
14053 (save-restriction
14054 (widen)
14055 (catch 'ex
14056 (while t
14057 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14058 (org-back-to-heading t)
14059 (move-marker org-entry-property-inherited-from (point))
14060 (throw 'ex tmp))
14061 (or (org-up-heading-safe) (throw 'ex nil)))))))
14062 (setq tmp (or tmp
14063 (cdr (assoc property org-file-properties))
14064 (cdr (assoc property org-global-properties))
14065 (cdr (assoc property org-global-properties-fixed))))
14066 (if literal-nil tmp (org-not-nil tmp))))
14068 (defvar org-property-changed-functions nil
14069 "Hook called when the value of a property has changed.
14070 Each hook function should accept two arguments, the name of the property
14071 and the new value.")
14073 (defun org-entry-put (pom property value)
14074 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14075 (org-with-point-at pom
14076 (org-back-to-heading t)
14077 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14078 range)
14079 (cond
14080 ((equal property "TODO")
14082 (not (member value org-todo-keywords-1)))
14084 (if (or (not value)
14086 (setq value 'none))
14087 (org-todo value)
14088 (org-set-tags nil 'align))
14089 ((equal property "PRIORITY")
14091 (string-to-char value) ?\ ))
14092 (org-set-tags nil 'align))
14093 ((equal property "SCHEDULED")
14094 (if (re-search-forward org-scheduled-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-schedule)))
14099 (call-interactively 'org-schedule)))
14100 ((equal property "DEADLINE")
14101 (if (re-search-forward org-deadline-time-regexp end t)
14102 (cond
14103 ((eq value 'earlier) (org-timestamp-change -1 'day))
14104 ((eq value 'later) (org-timestamp-change 1 'day))
14105 (t (call-interactively 'org-deadline)))
14106 (call-interactively 'org-deadline)))
14107 ((member property org-special-properties)
14108 (error "The %s property can not yet be set with `org-entry-put'"
14109 property))
14110 (t ; a non-special property
14111 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14112 (setq range (org-get-property-block beg end 'force))
14113 (goto-char (car range))
14114 (if (re-search-forward
14115 (org-re-property property) (cdr range) t)
14116 (progn
14117 (delete-region (match-beginning 0) (match-end 0))
14118 (goto-char (match-beginning 0)))
14119 (goto-char (cdr range))
14121 (backward-char 1)
14122 (org-indent-line-function))
14123 (insert ":" property ":")
14124 (and value (insert " " value))
14125 (org-indent-line-function)))))
14126 (run-hook-with-args 'org-property-changed-functions property value)))
14128 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14129 "Get all property keys in the current buffer.
14130 With INCLUDE-SPECIALS, also list the special properties that reflect things
14131 like tags and TODO state.
14132 With INCLUDE-DEFAULTS, also include properties that has special meaning
14133 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14134 and others.
14135 With INCLUDE-COLUMNS, also include property names given in COLUMN
14136 formats in the current buffer."
14137 (let (rtn range cfmt s p)
14138 (save-excursion
14139 (save-restriction
14140 (widen)
14141 (goto-char (point-min))
14142 (while (re-search-forward org-property-start-re nil t)
14143 (setq range (org-get-property-block))
14144 (goto-char (car range))
14145 (while (re-search-forward
14147 (cdr range) t)
14148 (add-to-list 'rtn (org-match-string-no-properties 1)))
14149 (outline-next-heading))))
14151 (when include-specials
14152 (setq rtn (append org-special-properties rtn)))
14154 (when include-defaults
14155 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14156 (add-to-list 'rtn org-effort-property))
14158 (when include-columns
14159 (save-excursion
14160 (save-restriction
14161 (widen)
14162 (goto-char (point-min))
14163 (while (re-search-forward
14165 nil t)
14166 (setq cfmt (match-string 2) s 0)
14168 cfmt s)
14169 (setq s (match-end 0)
14170 p (match-string 1 cfmt))
14171 (unless (or (equal p "ITEM")
14172 (member p org-special-properties))
14173 (add-to-list 'rtn (match-string 1 cfmt))))))))
14175 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14177 (defun org-property-values (key)
14178 "Return a list of all values of property KEY in the current buffer."
14179 (save-excursion
14180 (save-restriction
14181 (widen)
14182 (goto-char (point-min))
14183 (let ((re (org-re-property key))
14184 values)
14185 (while (re-search-forward re nil t)
14186 (add-to-list 'values (org-trim (match-string 1))))
14187 (delete "" values)))))
14189 (defun org-insert-property-drawer ()
14190 "Insert a property drawer into the current entry."
14191 (interactive)
14192 (org-back-to-heading t)
14193 (looking-at org-outline-regexp)
14194 (let ((indent (if org-adapt-indentation
14195 (- (match-end 0)(match-beginning 0))
14196 0))
14197 (beg (point))
14199 end hiddenp)
14200 (outline-next-heading)
14201 (setq end (point))
14202 (goto-char beg)
14203 (while (re-search-forward re end t))
14204 (setq hiddenp (outline-invisible-p))
14205 (end-of-line 1)
14208 (if (member (match-string 1) '("CLOCK:" ":END:"))
14209 ;; just skip this line
14210 (beginning-of-line 2)
14211 ;; Drawer start, find the end
14213 (beginning-of-line 1)))
14214 (org-skip-over-state-notes)
14216 (if (eq (char-before) ?*) (forward-char 1))
14218 (beginning-of-line 0)
14219 (org-indent-to-column indent)
14220 (beginning-of-line 2)
14221 (org-indent-to-column indent)
14222 (beginning-of-line 0)
14223 (if hiddenp
14224 (save-excursion
14225 (org-back-to-heading t)
14226 (hide-entry))
14227 (org-flag-drawer t))))
14229 (defvar org-property-set-functions-alist nil
14230 "Property set function alist.
14231 Each entry should have the following format:
14233 (PROPERTY . READ-FUNCTION)
14235 The read function will be called with the same argument as
14236 `org-completing-read'.")
14238 (defun org-set-property-function (property)
14239 "Get the function that should be used to set PROPERTY.
14240 This is computed according to `org-property-set-functions-alist'."
14241 (or (cdr (assoc property org-property-set-functions-alist))
14242 'org-completing-read))
14244 (defun org-read-property-value (property)
14245 "Read PROPERTY value from user."
14246 (let* ((completion-ignore-case t)
14247 (allowed (org-property-get-allowed-values nil property 'table))
14248 (cur (org-entry-get nil property))
14249 (prompt (concat property " value"
14251 (concat " [" cur "]") "") ": "))
14252 (set-function (org-set-property-function property))
14253 (val (if allowed
14254 (funcall set-function prompt allowed nil
14255 (not (get-text-property 0 'org-unrestricted
14256 (caar allowed))))
14257 (let (org-completion-use-ido org-completion-use-iswitchb)
14258 (funcall set-function prompt
14259 (mapcar 'list (org-property-values property))
14260 nil nil "" nil cur)))))
14261 (if (equal val "")
14262 cur
14263 val)))
14265 (defvar org-last-set-property nil)
14266 (defun org-read-property-name ()
14267 "Read a property name."
14268 (let* ((completion-ignore-case t)
14269 (keys (org-buffer-property-keys nil t t))
14270 (default-prop (or (save-excursion
14271 (save-match-data
14272 (beginning-of-line)
14274 (null (string= (match-string 1) "END"))
14275 (match-string 1))))
14276 org-last-set-property))
14277 (property (org-icompleting-read
14278 (concat "Property"
14279 (if default-prop (concat " [" default-prop "]") "")
14280 ": ")
14281 (mapcar 'list keys)
14282 nil nil nil nil
14283 default-prop
14284 )))
14285 (if (member property keys)
14286 property
14287 (or (cdr (assoc (downcase property)
14288 (mapcar (lambda (x) (cons (downcase x) x))
14289 keys)))
14290 property))))
14292 (defun org-set-property (property value)
14293 "In the current entry, set PROPERTY to VALUE.
14294 When called interactively, this will prompt for a property name, offering
14295 completion on existing and default properties. And then it will prompt
14296 for a value, offering completion either on allowed values (via an inherited
14297 xxx_ALL property) or on existing values in other instances of this property
14298 in the current file."
14299 (interactive (list nil nil))
14300 (let* ((property (or property (org-read-property-name)))
14301 (value (or value (org-read-property-value property)))
14302 (fn (assoc property org-properties-postprocess-alist)))
14303 (setq org-last-set-property property)
14304 ;; Possibly postprocess the inserted value:
14305 (when fn (setq value (funcall (cadr fn) value)))
14306 (unless (equal (org-entry-get nil property) value)
14307 (org-entry-put nil property value))))
14309 (defun org-delete-property (property)
14310 "In the current entry, delete PROPERTY."
14311 (interactive
14312 (let* ((completion-ignore-case t)
14313 (prop (org-icompleting-read "Property: "
14314 (org-entry-properties nil 'standard))))
14315 (list prop)))
14316 (message "Property %s %s" property
14317 (if (org-entry-delete nil property)
14318 "deleted"
14319 "was not present in the entry")))
14321 (defun org-delete-property-globally (property)
14322 "Remove PROPERTY globally, from all entries."
14323 (interactive
14324 (let* ((completion-ignore-case t)
14325 (prop (org-icompleting-read
14326 "Globally remove property: "
14327 (mapcar 'list (org-buffer-property-keys)))))
14328 (list prop)))
14329 (save-excursion
14330 (save-restriction
14331 (widen)
14332 (goto-char (point-min))
14333 (let ((cnt 0))
14334 (while (re-search-forward
14335 (org-re-property property)
14336 nil t)
14337 (setq cnt (1+ cnt))
14338 (replace-match ""))
14341 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14343 (defun org-compute-property-at-point ()
14344 "Compute the property at point.
14345 This looks for an enclosing column format, extracts the operator and
14346 then applies it to the property in the column format's scope."
14347 (interactive)
14348 (unless (org-at-property-p)
14349 (error "Not at a property"))
14350 (let ((prop (org-match-string-no-properties 2)))
14351 (org-columns-get-format-and-top-level)
14352 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14353 (error "No operator defined for property %s" prop))
14354 (org-columns-compute prop)))
14356 (defvar org-property-allowed-value-functions nil
14357 "Hook for functions supplying allowed values for a specific property.
14358 The functions must take a single argument, the name of the property, and
14360 the values, this means that these values are intended as defaults for
14361 completion, but that other values should be allowed too.
14362 The functions must return nil if they are not responsible for this
14363 property.")
14365 (defun org-property-get-allowed-values (pom property &optional table)
14366 "Get allowed values for the property PROPERTY.
14367 When TABLE is non-nil, return an alist that can directly be used for
14368 completion."
14369 (let (vals)
14370 (cond
14371 ((equal property "TODO")
14372 (setq vals (org-with-point-at pom
14373 (append org-todo-keywords-1 '("")))))
14374 ((equal property "PRIORITY")
14375 (let ((n org-lowest-priority))
14376 (while (>= n org-highest-priority)
14377 (push (char-to-string n) vals)
14378 (setq n (1- n)))))
14379 ((member property org-special-properties))
14380 ((setq vals (run-hook-with-args-until-success
14381 'org-property-allowed-value-functions property)))
14382 (t
14383 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14385 (setq vals (car (read-from-string (concat "(" vals ")"))))
14386 (setq vals (mapcar (lambda (x)
14387 (cond ((stringp x) x)
14388 ((numberp x) (number-to-string x))
14389 ((symbolp x) (symbol-name x))
14390 (t "???")))
14391 vals)))))
14392 (when (member ":ETC" vals)
14393 (setq vals (remove ":ETC" vals))
14394 (org-add-props (car vals) '(org-unrestricted t)))
14395 (if table (mapcar 'list vals) vals)))
14397 (defun org-property-previous-allowed-value (&optional previous)
14398 "Switch to the next allowed value for this property."
14399 (interactive)
14400 (org-property-next-allowed-value t))
14402 (defun org-property-next-allowed-value (&optional previous)
14403 "Switch to the next allowed value for this property."
14404 (interactive)
14405 (unless (org-at-property-p)
14406 (error "Not at a property"))
14407 (let* ((key (match-string 2))
14408 (value (match-string 3))
14409 (allowed (or (org-property-get-allowed-values (point) key)
14410 (and (member value '("[ ]" "[-]" "[X]"))
14411 '("[ ]" "[X]"))))
14412 nval)
14413 (unless allowed
14414 (error "Allowed values for this property have not been defined"))
14415 (if previous (setq allowed (reverse allowed)))
14416 (if (member value allowed)
14417 (setq nval (car (cdr (member value allowed)))))
14418 (setq nval (or nval (car allowed)))
14419 (if (equal nval value)
14420 (error "Only one allowed value for this property"))
14421 (org-at-property-p)
14422 (replace-match (concat " :" key ": " nval) t t)
14423 (org-indent-line-function)
14424 (beginning-of-line 1)
14426 (run-hook-with-args 'org-property-changed-functions key nval)))
14428 (defun org-find-olp (path &optional this-buffer)
14429 "Return a marker pointing to the entry at outline path OLP.
14430 If anything goes wrong, throw an error.
14431 You can wrap this call to catch the error like this:
14433 (condition-case msg
14434 (org-mobile-locate-entry (match-string 4))
14435 (error (nth 1 msg)))
14437 The return value will then be either a string with the error message,
14438 or a marker if everything is OK.
14440 If THIS-BUFFER is set, the outline path does not contain a file,
14441 only headings."
14442 (let* ((file (if this-buffer buffer-file-name (pop path)))
14443 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14444 (level 1)
14445 (lmin 1)
14446 (lmax 1)
14447 limit re end found pos heading cnt flevel)
14448 (unless buffer (error "File not found :%s" file))
14449 (with-current-buffer buffer
14450 (save-excursion
14451 (save-restriction
14452 (widen)
14453 (setq limit (point-max))
14454 (goto-char (point-min))
14455 (while (setq heading (pop path))
14456 (setq re (format org-complex-heading-regexp-format
14457 (regexp-quote heading)))
14458 (setq cnt 0 pos (point))
14459 (while (re-search-forward re end t)
14460 (setq level (- (match-end 1) (match-beginning 1)))
14461 (if (and (>= level lmin) (<= level lmax))
14462 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14463 (when (= cnt 0) (error "Heading not found on level %d: %s"
14464 lmax heading))
14465 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14466 lmax heading))
14467 (goto-char found)
14468 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14469 (setq end (save-excursion (org-end-of-subtree t t))))
14470 (when (org-on-heading-p)
14471 (move-marker (make-marker) (point))))))))
14473 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14474 "Find node HEADING in BUFFER.
14475 Return a marker to the heading if it was found, or nil if not.
14476 If POS-ONLY is set, return just the position instead of a marker.
14478 The heading text must match exact, but it may have a TODO keyword,
14479 a priority cookie and tags in the standard locations."
14480 (with-current-buffer (or buffer (current-buffer))
14481 (save-excursion
14482 (save-restriction
14483 (widen)
14484 (goto-char (point-min))
14485 (let (case-fold-search)
14486 (if (re-search-forward
14487 (format org-complex-heading-regexp-format
14488 (regexp-quote heading)) nil t)
14489 (if pos-only
14490 (match-beginning 0)
14491 (move-marker (make-marker) (match-beginning 0)))))))))
14493 (defun org-find-exact-heading-in-directory (heading &optional dir)
14494 "Find Org node headline HEADING in all .org files in directory DIR.
14495 When the target headline is found, return a marker to this location."
14496 (let ((files (directory-files (or dir default-directory)
14498 file visiting m buffer)
14499 (catch 'found
14500 (while (setq file (pop files))
14501 (message "trying %s" file)
14502 (setq visiting (org-find-base-buffer-visiting file))
14503 (setq buffer (or visiting (find-file-noselect file)))
14504 (setq m (org-find-exact-headline-in-buffer
14505 heading buffer))
14506 (when (and (not m) (not visiting)) (kill-buffer buffer))
14507 (and m (throw 'found m))))))
14509 (defun org-find-entry-with-id (ident)
14510 "Locate the entry that contains the ID property with exact value IDENT.
14511 IDENT can be a string, a symbol or a number, this function will search for
14512 the string representation of it.
14513 Return the position where this entry starts, or nil if there is no such entry."
14514 (interactive "sID: ")
14515 (let ((id (cond
14516 ((stringp ident) ident)
14517 ((symbol-name ident) (symbol-name ident))
14518 ((numberp ident) (number-to-string ident))
14519 (t (error "IDENT %s must be a string, symbol or number" ident))))
14520 (case-fold-search nil))
14521 (save-excursion
14522 (save-restriction
14523 (widen)
14524 (goto-char (point-min))
14525 (when (re-search-forward
14527 nil t)
14528 (org-back-to-heading t)
14529 (point))))))
14531 ;;;; Timestamps
14533 (defvar org-last-changed-timestamp nil)
14534 (defvar org-last-inserted-timestamp nil
14535 "The last time stamp inserted with `org-insert-time-stamp'.")
14536 (defvar org-time-was-given) ; dynamically scoped parameter
14537 (defvar org-end-time-was-given) ; dynamically scoped parameter
14538 (defvar org-ts-what) ; dynamically scoped parameter
14540 (defun org-time-stamp (arg &optional inactive)
14541 "Prompt for a date/time and insert a time stamp.
14542 If the user specifies a time like HH:MM, or if this command is called
14543 with a prefix argument, the time stamp will contain date and time.
14544 Otherwise, only the date will be included. All parts of a date not
14545 specified by the user will be filled in from the current date/time.
14546 So if you press just return without typing anything, the time stamp
14547 will represent the current date/time. If there is already a timestamp
14548 at the cursor, it will be modified."
14549 (interactive "P")
14550 (let* ((ts nil)
14551 (default-time
14552 ;; Default time is either today, or, when entering a range,
14553 ;; the range start.
14554 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14555 (save-excursion
14556 (re-search-backward
14558 (- (point) 20) t)))
14559 (apply 'encode-time (org-parse-time-string (match-string 1)))
14560 (current-time)))
14561 (default-input (and ts (org-get-compact-tod ts)))
14562 (repeater (save-excursion
14563 (save-match-data
14564 (beginning-of-line)
14565 (when (re-search-forward
14567 (save-excursion (progn (end-of-line) (point))) t)
14568 (match-string 0)))))
14569 org-time-was-given org-end-time-was-given time)
14570 (cond
14571 ((and (org-at-timestamp-p t)
14572 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14573 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14574 (insert "--")
14575 (setq time (let ((this-command this-command))
14576 (org-read-date arg 'totime nil nil
14577 default-time default-input)))
14578 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14579 ((org-at-timestamp-p t)
14580 (setq time (let ((this-command this-command))
14581 (org-read-date arg 'totime nil nil default-time default-input)))
14582 (when (org-at-timestamp-p t) ; just to get the match data
14583 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14584 (replace-match "")
14585 (setq org-last-changed-timestamp
14586 (org-insert-time-stamp
14587 time (or org-time-was-given arg)
14588 inactive nil nil (list org-end-time-was-given)))
14589 (when repeater (goto-char (1- (point))) (insert " " repeater)
14590 (setq org-last-changed-timestamp
14591 (concat (substring org-last-inserted-timestamp 0 -1)
14592 " " repeater ">"))))
14593 (message "Timestamp updated"))
14594 (t
14595 (setq time (let ((this-command this-command))
14596 (org-read-date arg 'totime nil nil default-time default-input)))
14597 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14598 nil nil (list org-end-time-was-given))))))
14600 ;; FIXME: can we use this for something else, like computing time differences?
14601 (defun org-get-compact-tod (s)
14602 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14603 (let* ((t1 (match-string 1 s))
14604 (h1 (string-to-number (match-string 2 s)))
14605 (m1 (string-to-number (match-string 3 s)))
14606 (t2 (and (match-end 4) (match-string 5 s)))
14607 (h2 (and t2 (string-to-number (match-string 6 s))))
14608 (m2 (and t2 (string-to-number (match-string 7 s))))
14609 dh dm)
14610 (if (not t2)
14611 t1
14612 (setq dh (- h2 h1) dm (- m2 m1))
14613 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14614 (concat t1 "+" (number-to-string dh)
14615 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14617 (defun org-time-stamp-inactive (&optional arg)
14618 "Insert an inactive time stamp.
14619 An inactive time stamp is enclosed in square brackets instead of angle
14620 brackets. It is inactive in the sense that it does not trigger agenda entries,
14621 does not link to the calendar and cannot be changed with the S-cursor keys.
14622 So these are more for recording a certain time/date."
14623 (interactive "P")
14624 (org-time-stamp arg 'inactive))
14626 (defvar org-date-ovl (make-overlay 1 1))
14627 (overlay-put org-date-ovl 'face 'org-warning)
14628 (org-detach-overlay org-date-ovl)
14630 (defvar org-ans1) ; dynamically scoped parameter
14631 (defvar org-ans2) ; dynamically scoped parameter
14633 (defvar org-plain-time-of-day-regexp) ; defined below
14635 (defvar org-overriding-default-time nil) ; dynamically scoped
14636 (defvar org-read-date-overlay nil)
14637 (defvar org-dcst nil) ; dynamically scoped
14638 (defvar org-read-date-history nil)
14639 (defvar org-read-date-final-answer nil)
14640 (defvar org-read-date-analyze-futurep nil)
14641 (defvar org-read-date-analyze-forced-year nil)
14643 (defun org-read-date (&optional with-time to-time from-string prompt
14644 default-time default-input)
14645 "Read a date, possibly a time, and make things smooth for the user.
14646 The prompt will suggest to enter an ISO date, but you can also enter anything
14647 which will at least partially be understood by `parse-time-string'.
14648 Unrecognized parts of the date will default to the current day, month, year,
14649 hour and minute. If this command is called to replace a timestamp at point,
14650 of to enter the second timestamp of a range, the default time is taken
14651 from the existing stamp. Furthermore, the command prefers the future,
14652 so if you are giving a date where the year is not given, and the day-month
14653 combination is already past in the current year, it will assume you
14654 mean next year. For details, see the manual. A few examples:
14656 3-2-5 --> 2003-02-05
14657 feb 15 --> currentyear-02-15
14658 2/15 --> currentyear-02-15
14659 sep 12 9 --> 2009-09-12
14660 12:45 --> today 12:45
14661 22 sept 0:34 --> currentyear-09-22 0:34
14662 12 --> currentyear-currentmonth-12
14663 Fri --> nearest Friday (today or later)
14664 etc.
14666 Furthermore you can specify a relative date by giving, as the *first* thing
14667 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14668 change in days weeks, months, years.
14669 With a single plus or minus, the date is relative to today. With a double
14670 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14671 +4d --> four days from today
14672 +4 --> same as above
14673 +2w --> two weeks from today
14674 ++5 --> five days from default date
14676 The function understands only English month and weekday abbreviations,
14677 but this can be configured with the variables `parse-time-months' and
14678 `parse-time-weekdays'.
14680 While prompting, a calendar is popped up - you can also select the
14681 date with the mouse (button 1). The calendar shows a period of three
14682 months. To scroll it to other months, use the keys `>' and `<'.
14683 If you don't like the calendar, turn it off with
14684 \(setq org-read-date-popup-calendar nil)
14686 With optional argument TO-TIME, the date will immediately be converted
14687 to an internal time.
14688 With an optional argument WITH-TIME, the prompt will suggest to also
14689 insert a time. Note that when WITH-TIME is not set, you can still
14690 enter a time, and this function will inform the calling routine about
14691 this change. The calling routine may then choose to change the format
14692 used to insert the time stamp into the buffer to include the time.
14693 With optional argument FROM-STRING, read from this string instead from
14694 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14695 the time/date that is used for everything that is not specified by the
14696 user."
14697 (require 'parse-time)
14698 (let* ((org-time-stamp-rounding-minutes
14699 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14700 (org-dcst org-display-custom-times)
14701 (ct (org-current-time))
14702 (def (or org-overriding-default-time default-time ct))
14703 (defdecode (decode-time def))
14704 (dummy (progn
14705 (when (< (nth 2 defdecode) org-extend-today-until)
14706 (setcar (nthcdr 2 defdecode) -1)
14707 (setcar (nthcdr 1 defdecode) 59)
14708 (setq def (apply 'encode-time defdecode)
14709 defdecode (decode-time def)))))
14710 (calendar-frame-setup nil)
14711 (calendar-setup nil)
14712 (calendar-move-hook nil)
14713 (calendar-view-diary-initially-flag nil)
14714 (calendar-view-holidays-initially-flag nil)
14715 (timestr (format-time-string
14716 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14717 (prompt (concat (if prompt (concat prompt " ") "")
14718 (format "Date+time [%s]: " timestr)))
14719 ans (org-ans0 "") org-ans1 org-ans2 final)
14721 (cond
14722 (from-string (setq ans from-string))
14723 (org-read-date-popup-calendar
14724 (save-excursion
14725 (save-window-excursion
14726 (calendar)
14727 (unwind-protect
14728 (progn
14729 (calendar-forward-day (- (time-to-days def)
14730 (calendar-absolute-from-gregorian
14731 (calendar-current-date))))
14732 (org-eval-in-calendar nil t)
14733 (let* ((old-map (current-local-map))
14734 (map (copy-keymap calendar-mode-map))
14735 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14736 (org-defkey map (kbd "RET") 'org-calendar-select)
14737 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14738 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14739 (org-defkey minibuffer-local-map [(meta shift left)]
14740 (lambda () (interactive)
14741 (org-eval-in-calendar '(calendar-backward-month 1))))
14742 (org-defkey minibuffer-local-map [(meta shift right)]
14743 (lambda () (interactive)
14744 (org-eval-in-calendar '(calendar-forward-month 1))))
14745 (org-defkey minibuffer-local-map [(meta shift up)]
14746 (lambda () (interactive)
14747 (org-eval-in-calendar '(calendar-backward-year 1))))
14748 (org-defkey minibuffer-local-map [(meta shift down)]
14749 (lambda () (interactive)
14750 (org-eval-in-calendar '(calendar-forward-year 1))))
14751 (org-defkey minibuffer-local-map [?\e (shift left)]
14752 (lambda () (interactive)
14753 (org-eval-in-calendar '(calendar-backward-month 1))))
14754 (org-defkey minibuffer-local-map [?\e (shift right)]
14755 (lambda () (interactive)
14756 (org-eval-in-calendar '(calendar-forward-month 1))))
14757 (org-defkey minibuffer-local-map [?\e (shift up)]
14758 (lambda () (interactive)
14759 (org-eval-in-calendar '(calendar-backward-year 1))))
14760 (org-defkey minibuffer-local-map [?\e (shift down)]
14761 (lambda () (interactive)
14762 (org-eval-in-calendar '(calendar-forward-year 1))))
14763 (org-defkey minibuffer-local-map [(shift up)]
14764 (lambda () (interactive)
14765 (org-eval-in-calendar '(calendar-backward-week 1))))
14766 (org-defkey minibuffer-local-map [(shift down)]
14767 (lambda () (interactive)
14768 (org-eval-in-calendar '(calendar-forward-week 1))))
14769 (org-defkey minibuffer-local-map [(shift left)]
14770 (lambda () (interactive)
14771 (org-eval-in-calendar '(calendar-backward-day 1))))
14772 (org-defkey minibuffer-local-map [(shift right)]
14773 (lambda () (interactive)
14774 (org-eval-in-calendar '(calendar-forward-day 1))))
14775 (org-defkey minibuffer-local-map ">"
14776 (lambda () (interactive)
14777 (org-eval-in-calendar '(scroll-calendar-left 1))))
14778 (org-defkey minibuffer-local-map "<"
14779 (lambda () (interactive)
14780 (org-eval-in-calendar '(scroll-calendar-right 1))))
14781 (org-defkey minibuffer-local-map "\C-v"
14782 (lambda () (interactive)
14783 (org-eval-in-calendar
14784 '(calendar-scroll-left-three-months 1))))
14785 (org-defkey minibuffer-local-map "\M-v"
14786 (lambda () (interactive)
14787 (org-eval-in-calendar
14788 '(calendar-scroll-right-three-months 1))))
14789 (run-hooks 'org-read-date-minibuffer-setup-hook)
14790 (unwind-protect
14791 (progn
14792 (use-local-map map)
14793 (add-hook 'post-command-hook 'org-read-date-display)
14794 (setq org-ans0 (read-string prompt default-input
14795 'org-read-date-history nil))
14796 ;; org-ans0: from prompt
14797 ;; org-ans1: from mouse click
14798 ;; org-ans2: from calendar motion
14799 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14800 (remove-hook 'post-command-hook 'org-read-date-display)
14801 (use-local-map old-map)
14802 (when org-read-date-overlay
14803 (delete-overlay org-read-date-overlay)
14804 (setq org-read-date-overlay nil)))))
14805 (bury-buffer "*Calendar*")))))
14807 (t ; Naked prompt only
14808 (unwind-protect
14809 (setq ans (read-string prompt default-input
14810 'org-read-date-history timestr))
14811 (when org-read-date-overlay
14812 (delete-overlay org-read-date-overlay)
14813 (setq org-read-date-overlay nil)))))
14815 (setq final (org-read-date-analyze ans def defdecode))
14817 (when org-read-date-analyze-forced-year
14818 (message "Year was forced into %s"
14819 (if org-read-date-force-compatible-dates
14820 "compatible range (1970-2037)"
14821 "range representable on this machine"))
14822 (ding))
14824 ;; One round trip to get rid of 34th of August and stuff like that....
14825 (setq final (decode-time (apply 'encode-time final)))
14827 (setq org-read-date-final-answer ans)
14829 (if to-time
14830 (apply 'encode-time final)
14831 (if (and (boundp 'org-time-was-given) org-time-was-given)
14832 (format "%04d-%02d-%02d %02d:%02d"
14833 (nth 5 final) (nth 4 final) (nth 3 final)
14834 (nth 2 final) (nth 1 final))
14835 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14837 (defvar def)
14838 (defvar defdecode)
14839 (defvar with-time)
14840 (defun org-read-date-display ()
14841 "Display the current date prompt interpretation in the minibuffer."
14842 (when org-read-date-display-live
14843 (when org-read-date-overlay
14844 (delete-overlay org-read-date-overlay))
14845 (let ((p (point)))
14846 (end-of-line 1)
14847 (while (not (equal (buffer-substring
14848 (max (point-min) (- (point) 4)) (point))
14849 " "))
14850 (insert " "))
14851 (goto-char p))
14852 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14853 " " (or org-ans1 org-ans2)))
14854 (org-end-time-was-given nil)
14855 (f (org-read-date-analyze ans def defdecode))
14856 (fmts (if org-dcst
14857 org-time-stamp-custom-formats
14858 org-time-stamp-formats))
14859 (fmt (if (or with-time
14860 (and (boundp 'org-time-was-given) org-time-was-given))
14861 (cdr fmts)
14862 (car fmts)))
14863 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14864 (when (and org-end-time-was-given
14865 (string-match org-plain-time-of-day-regexp txt))
14866 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14867 org-end-time-was-given
14868 (substring txt (match-end 0)))))
14869 (when org-read-date-analyze-futurep
14870 (setq txt (concat txt " (=>F)")))
14871 (setq org-read-date-overlay
14872 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14873 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14875 (defun org-read-date-analyze (ans def defdecode)
14876 "Analyze the combined answer of the date prompt."
14877 ;; FIXME: cleanup and comment
14878 (let ((nowdecode (decode-time (current-time)))
14879 delta deltan deltaw deltadef year month day
14880 hour minute second wday pm h2 m2 tl wday1
14881 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14882 (setq org-read-date-analyze-futurep nil
14883 org-read-date-analyze-forced-year nil)
14885 (setq ans "+0"))
14887 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14888 (setq ans (replace-match "" t t ans)
14889 deltan (car delta)
14890 deltaw (nth 1 delta)
14891 deltadef (nth 2 delta)))
14893 ;; Check if there is an iso week date in there
14894 ;; If yes, store the info and postpone interpreting it until the rest
14895 ;; of the parsing is done
14896 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14897 (setq iso-year (if (match-end 1)
14898 (org-small-year-to-year
14899 (string-to-number (match-string 1 ans))))
14900 iso-weekday (if (match-end 3)
14901 (string-to-number (match-string 3 ans)))
14902 iso-week (string-to-number (match-string 2 ans)))
14903 (setq ans (replace-match "" t t ans)))
14905 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14906 (when (string-match
14908 (setq year (if (match-end 2)
14909 (string-to-number (match-string 2 ans))
14910 (progn (setq kill-year t)
14911 (string-to-number (format-time-string "%Y"))))
14912 month (string-to-number (match-string 3 ans))
14913 day (string-to-number (match-string 4 ans)))
14914 (if (< year 100) (setq year (+ 2000 year)))
14916 t nil ans)))
14918 ;; Help matching dottet european dates
14919 (when (string-match
14920 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14921 (setq year (if (match-end 3)
14922 (string-to-number (match-string 3 ans))
14923 (progn (setq kill-year t)
14924 (string-to-number (format-time-string "%Y"))))
14925 day (string-to-number (match-string 1 ans))
14926 month (string-to-number (match-string 2 ans))
14928 t nil ans)))
14930 ;; Help matching american dates, like 5/30 or 5/30/7
14931 (when (string-match
14932 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14933 (setq year (if (match-end 4)
14934 (string-to-number (match-string 4 ans))
14935 (progn (setq kill-year t)
14936 (string-to-number (format-time-string "%Y"))))
14937 month (string-to-number (match-string 1 ans))
14938 day (string-to-number (match-string 2 ans)))
14939 (if (< year 100) (setq year (+ 2000 year)))
14941 t nil ans)))
14942 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14943 ;; If there is a time with am/pm, and *no* time without it, we convert
14944 ;; so that matching will be successful.
14945 (loop for i from 1 to 2 do ; twice, for end time as well
14948 (setq hour (string-to-number (match-string 1 ans))
14949 minute (if (match-end 3)
14950 (string-to-number (match-string 3 ans))
14951 0)
14952 pm (equal ?p
14953 (string-to-char (downcase (match-string 4 ans)))))
14954 (if (and (= hour 12) (not pm))
14955 (setq hour 0)
14956 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14957 (setq ans (replace-match (format "%02d:%02d" hour minute)
14958 t t ans))))
14960 ;; Check if a time range is given as a duration
14961 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14962 (setq hour (string-to-number (match-string 1 ans))
14963 h2 (+ hour (string-to-number (match-string 3 ans)))
14964 minute (string-to-number (match-string 2 ans))
14965 m2 (+ minute (if (match-end 5) (string-to-number
14966 (match-string 5 ans))0)))
14967 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14968 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14969 t t ans)))
14971 ;; Check if there is a time range
14972 (when (boundp 'org-end-time-was-given)
14973 (setq org-time-was-given nil)
14974 (when (and (string-match org-plain-time-of-day-regexp ans)
14975 (match-end 8))
14976 (setq org-end-time-was-given (match-string 8 ans))
14977 (setq ans (concat (substring ans 0 (match-beginning 7))
14978 (substring ans (match-end 7))))))
14980 (setq tl (parse-time-string ans)
14981 day (or (nth 3 tl) (nth 3 defdecode))
14982 month (or (nth 4 tl)
14983 (if (and org-read-date-prefer-future
14984 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14985 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14986 (nth 4 defdecode)))
14987 year (or (and (not kill-year) (nth 5 tl))
14988 (if (and org-read-date-prefer-future
14989 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14990 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14991 (nth 5 defdecode)))
14992 hour (or (nth 2 tl) (nth 2 defdecode))
14993 minute (or (nth 1 tl) (nth 1 defdecode))
14994 second (or (nth 0 tl) 0)
14995 wday (nth 6 tl))
14997 (when (and (eq org-read-date-prefer-future 'time)
14998 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14999 (equal day (nth 3 nowdecode))
15000 (equal month (nth 4 nowdecode))
15001 (equal year (nth 5 nowdecode))
15002 (nth 2 tl)
15003 (or (< (nth 2 tl) (nth 2 nowdecode))
15004 (and (= (nth 2 tl) (nth 2 nowdecode))
15005 (nth 1 tl)
15006 (< (nth 1 tl) (nth 1 nowdecode)))))
15007 (setq day (1+ day)
15008 futurep t))
15010 ;; Special date definitions below
15011 (cond
15012 (iso-week
15013 ;; There was an iso week
15014 (require 'cal-iso)
15015 (setq futurep nil)
15016 (setq year (or iso-year year)
15017 day (or iso-weekday wday 1)
15018 wday nil ; to make sure that the trigger below does not match
15019 iso-date (calendar-gregorian-from-absolute
15020 (calendar-absolute-from-iso
15021 (list iso-week day year))))
15022 ; FIXME: Should we also push ISO weeks into the future?
15023 ; (when (and org-read-date-prefer-future
15024 ; (not iso-year)
15025 ; (< (calendar-absolute-from-gregorian iso-date)
15026 ; (time-to-days (current-time))))
15027 ; (setq year (1+ year)
15028 ; iso-date (calendar-gregorian-from-absolute
15029 ; (calendar-absolute-from-iso
15030 ; (list iso-week day year)))))
15031 (setq month (car iso-date)
15032 year (nth 2 iso-date)
15033 day (nth 1 iso-date)))
15034 (deltan
15035 (setq futurep nil)
15036 (unless deltadef
15037 (let ((now (decode-time (current-time))))
15038 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15039 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15040 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15041 ((equal deltaw "m") (setq month (+ month deltan)))
15042 ((equal deltaw "y") (setq year (+ year deltan)))))
15043 ((and wday (not (nth 3 tl)))
15044 (setq futurep nil)
15045 ;; Weekday was given, but no day, so pick that day in the week
15046 ;; on or after the derived date.
15047 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15048 (unless (equal wday wday1)
15049 (setq day (+ day (% (- wday wday1 -7) 7))))))
15050 (if (and (boundp 'org-time-was-given)
15051 (nth 2 tl))
15052 (setq org-time-was-given t))
15053 (if (< year 100) (setq year (+ 2000 year)))
15054 ;; Check of the date is representable
15055 (if org-read-date-force-compatible-dates
15056 (progn
15057 (if (< year 1970)
15058 (setq year 1970 org-read-date-analyze-forced-year t))
15059 (if (> year 2037)
15060 (setq year 2037 org-read-date-analyze-forced-year t)))
15061 (condition-case nil
15062 (ignore (encode-time second minute hour day month year))
15063 (error
15064 (setq year (nth 5 defdecode))
15065 (setq org-read-date-analyze-forced-year t))))
15066 (setq org-read-date-analyze-futurep futurep)
15067 (list second minute hour day month year)))
15069 (defvar parse-time-weekdays)
15071 (defun org-read-date-get-relative (s today default)
15072 "Check string S for special relative date string.
15073 TODAY and DEFAULT are internal times, for today and for a default.
15074 Return shift list (N what def-flag)
15076 N is the number of WHATs to shift.
15077 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15078 the DEFAULT date rather than TODAY."
15079 (when (and
15080 (string-match
15081 (concat
15086 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15087 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15088 (string-to-char (substring (match-string 1 s) -1))
15089 ?+))
15090 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15091 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15092 (what (if (match-end 3) (match-string 3 s) "d"))
15093 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15094 (date (if rel default today))
15095 (wday (nth 6 (decode-time date)))
15096 delta)
15097 (if wday1
15098 (progn
15099 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15100 (if (= dir ?-) (setq delta (- delta 7)))
15101 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15102 (list delta "d" rel))
15103 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15105 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15106 "Turn a user-specified date into the internal representation.
15107 The internal representation needed by the calendar is (month day year).
15108 This is a wrapper to handle the brain-dead convention in calendar that
15109 user function argument order change dependent on argument order."
15110 (if (boundp 'calendar-date-style)
15111 (cond
15112 ((eq calendar-date-style 'american)
15113 (list arg1 arg2 arg3))
15114 ((eq calendar-date-style 'european)
15115 (list arg2 arg1 arg3))
15116 ((eq calendar-date-style 'iso)
15117 (list arg2 arg3 arg1)))
15118 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15119 (if (org-bound-and-true-p european-calendar-style)
15120 (list arg2 arg1 arg3)
15121 (list arg1 arg2 arg3)))))
15123 (defun org-eval-in-calendar (form &optional keepdate)
15124 "Eval FORM in the calendar window and return to current window.
15125 Also, store the cursor date in variable org-ans2."
15126 (let ((sf (selected-frame))
15127 (sw (selected-window)))
15128 (select-window (get-buffer-window "*Calendar*" t))
15129 (eval form)
15130 (when (and (not keepdate) (calendar-cursor-to-date))
15131 (let* ((date (calendar-cursor-to-date))
15132 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15133 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15134 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15135 (select-window sw)
15136 (org-select-frame-set-input-focus sf)))
15138 (defun org-calendar-select ()
15139 "Return to `org-read-date' with the date currently selected.
15140 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15141 (interactive)
15142 (when (calendar-cursor-to-date)
15143 (let* ((date (calendar-cursor-to-date))
15144 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15145 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15146 (if (active-minibuffer-window) (exit-minibuffer))))
15148 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15149 "Insert a date stamp for the date given by the internal TIME.
15150 WITH-HM means use the stamp format that includes the time of the day.
15151 INACTIVE means use square brackets instead of angular ones, so that the
15152 stamp will not contribute to the agenda.
15153 PRE and POST are optional strings to be inserted before and after the
15154 stamp.
15155 The command returns the inserted time stamp."
15156 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15157 stamp)
15158 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15159 (insert-before-markers (or pre ""))
15160 (when (listp extra)
15161 (setq extra (car extra))
15162 (if (and (stringp extra)
15164 (setq extra (format "-%02d:%02d"
15165 (string-to-number (match-string 1 extra))
15166 (string-to-number (match-string 2 extra))))
15167 (setq extra nil)))
15168 (when extra
15169 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15170 (insert-before-markers (setq stamp (format-time-string fmt time)))
15171 (insert-before-markers (or post ""))
15172 (setq org-last-inserted-timestamp stamp)))
15174 (defun org-toggle-time-stamp-overlays ()
15175 "Toggle the use of custom time stamp formats."
15176 (interactive)
15177 (setq org-display-custom-times (not org-display-custom-times))
15178 (unless org-display-custom-times
15179 (let ((p (point-min)) (bmp (buffer-modified-p)))
15180 (while (setq p (next-single-property-change p 'display))
15181 (if (and (get-text-property p 'display)
15182 (eq (get-text-property p 'face) 'org-date))
15183 (remove-text-properties
15184 p (setq p (next-single-property-change p 'display))
15185 '(display t))))
15186 (set-buffer-modified-p bmp)))
15187 (if (featurep 'xemacs)
15188 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15189 (org-restart-font-lock)
15190 (setq org-table-may-need-update t)
15191 (if org-display-custom-times
15192 (message "Time stamps are overlayed with custom format")
15193 (message "Time stamp overlays removed")))
15195 (defun org-display-custom-time (beg end)
15196 "Overlay modified time stamp format over timestamp between BEG and END."
15197 (let* ((ts (buffer-substring beg end))
15198 t1 w1 with-hm tf time str w2 (off 0))
15199 (save-match-data
15200 (setq t1 (org-parse-time-string ts t))
15201 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15202 (setq off (- (match-end 0) (match-beginning 0)))))
15203 (setq end (- end off))
15204 (setq w1 (- end beg)
15205 with-hm (and (nth 1 t1) (nth 2 t1))
15206 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15207 time (org-fix-decoded-time t1)
15208 str (org-add-props
15209 (format-time-string
15210 (substring tf 1 -1) (apply 'encode-time time))
15211 nil 'mouse-face 'highlight)
15212 w2 (length str))
15213 (if (not (= w2 w1))
15214 (add-text-properties (1+ beg) (+ 2 beg)
15215 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15216 (if (featurep 'xemacs)
15217 (progn
15218 (put-text-property beg end 'invisible t)
15219 (put-text-property beg end 'end-glyph (make-glyph str)))
15220 (put-text-property beg end 'display str))))
15222 (defun org-translate-time (string)
15223 "Translate all timestamps in STRING to custom format.
15224 But do this only if the variable `org-display-custom-times' is set."
15225 (when org-display-custom-times
15226 (save-match-data
15227 (let* ((start 0)
15228 (re org-ts-regexp-both)
15229 t1 with-hm inactive tf time str beg end)
15230 (while (setq start (string-match re string start))
15231 (setq beg (match-beginning 0)
15232 end (match-end 0)
15233 t1 (save-match-data
15234 (org-parse-time-string (substring string beg end) t))
15235 with-hm (and (nth 1 t1) (nth 2 t1))
15236 inactive (equal (substring string beg (1+ beg)) "[")
15237 tf (funcall (if with-hm 'cdr 'car)
15238 org-time-stamp-custom-formats)
15239 time (org-fix-decoded-time t1)
15240 str (format-time-string
15241 (concat
15242 (if inactive "[" "<") (substring tf 1 -1)
15243 (if inactive "]" ">"))
15244 (apply 'encode-time time))
15245 string (replace-match str t t string)
15246 start (+ start (length str)))))))
15247 string)
15249 (defun org-fix-decoded-time (time)
15250 "Set 0 instead of nil for the first 6 elements of time.
15251 Don't touch the rest."
15252 (let ((n 0))
15253 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15255 (defun org-days-to-time (timestamp-string)
15256 "Difference between TIMESTAMP-STRING and now in days."
15257 (- (time-to-days (org-time-string-to-time timestamp-string))
15258 (time-to-days (current-time))))
15260 (defun org-deadline-close (timestamp-string &optional ndays)
15261 "Is the time in TIMESTAMP-STRING close to the current date?"
15262 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15263 (and (< (org-days-to-time timestamp-string) ndays)
15264 (not (org-entry-is-done-p))))
15266 (defun org-get-wdays (ts)
15267 "Get the deadline lead time appropriate for timestring TS."
15268 (cond
15269 ((<= org-deadline-warning-days 0)
15270 ;; 0 or negative, enforce this value no matter what
15271 (- org-deadline-warning-days))
15273 ;; lead time is specified.
15274 (floor (* (string-to-number (match-string 1 ts))
15275 (cdr (assoc (match-string 2 ts)
15276 '(("d" . 1) ("w" . 7)
15277 ("m" . 30.4) ("y" . 365.25)))))))
15278 ;; go for the default.
15279 (t org-deadline-warning-days)))
15281 (defun org-calendar-select-mouse (ev)
15282 "Return to `org-read-date' with the date currently selected.
15283 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15284 (interactive "e")
15285 (mouse-set-point ev)
15286 (when (calendar-cursor-to-date)
15287 (let* ((date (calendar-cursor-to-date))
15288 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15289 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15290 (if (active-minibuffer-window) (exit-minibuffer))))
15292 (defun org-check-deadlines (ndays)
15293 "Check if there are any deadlines due or past due.
15294 A deadline is considered due if it happens within `org-deadline-warning-days'
15295 days from today's date. If the deadline appears in an entry marked DONE,
15296 it is not shown. The prefix arg NDAYS can be used to test that many
15298 (interactive "P")
15299 (let* ((org-warn-days
15300 (cond
15301 ((equal ndays '(4)) 100000)
15302 (ndays (prefix-numeric-value ndays))
15303 (t (abs org-deadline-warning-days))))
15304 (case-fold-search nil)
15306 (callback
15307 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15309 (message "%d deadlines past-due or due within %d days"
15310 (org-occur regexp nil callback)
15311 org-warn-days)))
15313 (defun org-check-before-date (date)
15314 "Check if there are deadlines or scheduled entries before DATE."
15315 (interactive (list (org-read-date)))
15316 (let ((case-fold-search nil)
15320 (callback
15321 (lambda () (time-less-p
15322 (org-time-string-to-time (match-string 2))
15323 (org-time-string-to-time date)))))
15324 (message "%d entries before %s"
15325 (org-occur regexp nil callback) date)))
15327 (defun org-check-after-date (date)
15328 "Check if there are deadlines or scheduled entries after DATE."
15329 (interactive (list (org-read-date)))
15330 (let ((case-fold-search nil)
15334 (callback
15335 (lambda () (not
15336 (time-less-p
15337 (org-time-string-to-time (match-string 2))
15338 (org-time-string-to-time date))))))
15339 (message "%d entries after %s"
15340 (org-occur regexp nil callback) date)))
15342 (defun org-evaluate-time-range (&optional to-buffer)
15343 "Evaluate a time range by computing the difference between start and end.
15344 Normally the result is just printed in the echo area, but with prefix arg
15345 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15346 If the time range is actually in a table, the result is inserted into the
15347 next column.
15348 For time difference computation, a year is assumed to be exactly 365
15349 days in order to avoid rounding problems."
15350 (interactive "P")
15351 (or
15352 (org-clock-update-time-maybe)
15353 (save-excursion
15354 (unless (org-at-date-range-p t)
15355 (goto-char (point-at-bol))
15356 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15357 (if (not (org-at-date-range-p t))
15358 (error "Not at a time-stamp range, and none found in current line")))
15359 (let* ((ts1 (match-string 1))
15360 (ts2 (match-string 2))
15361 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15362 (match-end (match-end 0))
15363 (time1 (org-time-string-to-time ts1))
15364 (time2 (org-time-string-to-time ts2))
15365 (t1 (org-float-time time1))
15366 (t2 (org-float-time time2))
15367 (diff (abs (- t2 t1)))
15368 (negative (< (- t2 t1) 0))
15369 ;; (ys (floor (* 365 24 60 60)))
15370 (ds (* 24 60 60))
15371 (hs (* 60 60))
15372 (fy "%dy %dd %02d:%02d")
15373 (fy1 "%dy %dd")
15374 (fd "%dd %02d:%02d")
15375 (fd1 "%dd")
15376 (fh "%02d:%02d")
15377 y d h m align)
15378 (if havetime
15379 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15380 y 0
15381 d (floor (/ diff ds)) diff (mod diff ds)
15382 h (floor (/ diff hs)) diff (mod diff hs)
15383 m (floor (/ diff 60)))
15384 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15385 y 0
15386 d (floor (+ (/ diff ds) 0.5))
15387 h 0 m 0))
15388 (if (not to-buffer)
15389 (message "%s" (org-make-tdiff-string y d h m))
15390 (if (org-at-table-p)
15391 (progn
15392 (goto-char match-end)
15393 (setq align t)
15394 (and (looking-at " *|") (goto-char (match-end 0))))
15395 (goto-char match-end))
15396 (if (looking-at
15398 (replace-match ""))
15399 (if negative (insert " -"))
15400 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15401 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15402 (insert " " (format fh h m))))
15403 (if align (org-table-align))
15404 (message "Time difference inserted")))))
15406 (defun org-make-tdiff-string (y d h m)
15407 (let ((fmt "")
15408 (l nil))
15409 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15410 l (push y l)))
15411 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15412 l (push d l)))
15413 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15414 l (push h l)))
15415 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15416 l (push m l)))
15417 (apply 'format fmt (nreverse l))))
15419 (defun org-time-string-to-time (s &optional buffer pos)
15420 (condition-case errdata
15421 (apply 'encode-time (org-parse-time-string s))
15423 s (if (not (and buffer pos))
15424 ""
15425 (format " at %d in buffer `%s'" pos buffer))
15426 (cdr errdata)))))
15428 (defun org-time-string-to-seconds (s)
15429 (org-float-time (org-time-string-to-time s)))
15431 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15432 "Convert a time stamp to an absolute day number.
15433 If there is a specifier for a cyclic time stamp, get the closest date to
15434 DAYNR.
15435 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15436 The variable date is bound by the calendar when this is called."
15437 (cond
15439 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15440 daynr
15441 (+ daynr 1000)))
15443 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15444 (time-to-days (current-time))) (match-string 0 s)
15445 prefer show-all))
15446 (t (time-to-days
15447 (condition-case errdata
15448 (apply 'encode-time (org-parse-time-string s))
15450 s (if (not (and buffer pos))
15451 ""
15452 (format " at %d in buffer `%s'" pos buffer))
15453 (cdr errdata))))))))
15455 (defun org-days-to-iso-week (days)
15456 "Return the iso week number."
15457 (require 'cal-iso)
15458 (car (calendar-iso-from-absolute days)))
15460 (defun org-small-year-to-year (year)
15461 "Convert 2-digit years into 4-digit years.
15462 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15463 The year 2000 cannot be abbreviated. Any year larger than 99
15464 is returned unchanged."
15465 (if (< year 38)
15466 (setq year (+ 2000 year))
15467 (if (< year 100)
15468 (setq year (+ 1900 year))))
15469 year)
15471 (defun org-time-from-absolute (d)
15472 "Return the time corresponding to date D.
15473 D may be an absolute day number, or a calendar-type list (month day year)."
15474 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15475 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15477 (defun org-calendar-holiday ()
15478 "List of holidays, for Diary display in Org-mode."
15479 (require 'holidays)
15480 (let ((hl (funcall
15481 (if (fboundp 'calendar-check-holidays)
15482 'calendar-check-holidays 'check-calendar-holidays) date)))
15483 (if hl (mapconcat 'identity hl "; "))))
15485 (defun org-diary-sexp-entry (sexp entry date)
15486 "Process a SEXP diary ENTRY for DATE."
15487 (require 'diary-lib)
15488 (let ((result (if calendar-debug-sexp
15489 (let ((stack-trace-on-error t))
15490 (eval (car (read-from-string sexp))))
15491 (condition-case nil
15492 (eval (car (read-from-string sexp)))
15493 (error
15494 (beep)
15495 (message "Bad sexp at line %d in %s: %s"
15496 (org-current-line)
15497 (buffer-file-name) sexp)
15498 (sleep-for 2))))))
15499 (cond ((stringp result) (split-string result "; "))
15500 ((and (consp result)
15501 (not (consp (cdr result)))
15502 (stringp (cdr result))) (cdr result))
15503 ((and (consp result)
15504 (stringp (car result))) result)
15505 (result entry)
15506 (t nil))))
15508 (defun org-diary-to-ical-string (frombuf)
15509 "Get iCalendar entries from diary entries in buffer FROMBUF.
15510 This uses the icalendar.el library."
15511 (let* ((tmpdir (if (featurep 'xemacs)
15512 (temp-directory)
15513 temporary-file-directory))
15514 (tmpfile (make-temp-name
15515 (expand-file-name "orgics" tmpdir)))
15516 buf rtn b e)
15517 (with-current-buffer frombuf
15518 (icalendar-export-region (point-min) (point-max) tmpfile)
15519 (setq buf (find-buffer-visiting tmpfile))
15520 (set-buffer buf)
15521 (goto-char (point-min))
15522 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15523 (setq b (match-beginning 0)))
15524 (goto-char (point-max))
15525 (if (re-search-backward "^END:VEVENT" nil t)
15526 (setq e (match-end 0)))
15528 (kill-buffer buf)
15529 (delete-file tmpfile)
15530 rtn))
15532 (defun org-closest-date (start current change prefer show-all)
15533 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15534 When PREFER is `past', return a date that is either CURRENT or past.
15535 When PREFER is `future', return a date that is either CURRENT or future.
15536 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15537 ;; Make the proper lists from the dates
15538 (catch 'exit
15539 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15540 dn dw sday cday n1 n2 n0
15541 d m y y1 y2 date1 date2 nmonths nm ny m2)
15543 (setq start (org-date-to-gregorian start)
15544 current (org-date-to-gregorian
15545 (if show-all
15546 current
15547 (time-to-days (current-time))))
15548 sday (calendar-absolute-from-gregorian start)
15549 cday (calendar-absolute-from-gregorian current))
15551 (if (<= cday sday) (throw 'exit sday))
15554 (setq dn (string-to-number (match-string 1 change))
15555 dw (cdr (assoc (match-string 2 change) a1)))
15556 (error "Invalid change specifier: %s" change))
15557 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15558 (cond
15559 ((eq dw 'day)
15560 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15561 n2 (+ n1 dn)))
15562 ((eq dw 'year)
15563 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15564 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15565 (setq date1 (list m d y1)
15566 n1 (calendar-absolute-from-gregorian date1)
15567 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15568 n2 (calendar-absolute-from-gregorian date2)))
15569 ((eq dw 'month)
15570 ;; approx number of month between the two dates
15571 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15572 ;; How often does dn fit in there?
15573 (setq d (nth 1 start) m (car start) y (nth 2 start)
15574 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15575 m (+ m nm)
15576 ny (floor (/ m 12))
15577 y (+ y ny)
15578 m (- m (* ny 12)))
15579 (while (> m 12) (setq m (- m 12) y (1+ y)))
15580 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15581 (setq m2 (+ m dn) y2 y)
15582 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15583 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15584 (while (<= n2 cday)
15585 (setq n1 n2 m m2 y y2)
15586 (setq m2 (+ m dn) y2 y)
15587 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15588 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15589 ;; Make sure n1 is the earlier date
15590 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15591 (if show-all
15592 (cond
15593 ((eq prefer 'past) (if (= cday n2) n2 n1))
15594 ((eq prefer 'future) (if (= cday n1) n1 n2))
15595 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15596 (cond
15597 ((eq prefer 'past) (if (= cday n2) n2 n1))
15598 ((eq prefer 'future) (if (= cday n1) n1 n2))
15599 (t (if (= cday n1) n1 n2)))))))
15601 (defun org-date-to-gregorian (date)
15602 "Turn any specification of DATE into a Gregorian date for the calendar."
15603 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15604 ((and (listp date) (= (length date) 3)) date)
15605 ((stringp date)
15606 (setq date (org-parse-time-string date))
15607 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15608 ((listp date)
15609 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15611 (defun org-parse-time-string (s &optional nodefault)
15612 "Parse the standard Org-mode time string.
15613 This should be a lot faster than the normal `parse-time-string'.
15614 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15615 hour and minute fields will be nil if not given."
15616 (if (string-match org-ts-regexp0 s)
15617 (list 0
15618 (if (or (match-beginning 8) (not nodefault))
15619 (string-to-number (or (match-string 8 s) "0")))
15620 (if (or (match-beginning 7) (not nodefault))
15621 (string-to-number (or (match-string 7 s) "0")))
15622 (string-to-number (match-string 4 s))
15623 (string-to-number (match-string 3 s))
15624 (string-to-number (match-string 2 s))
15625 nil nil nil)
15626 (error "Not a standard Org-mode time string: %s" s)))
15628 (defun org-timestamp-up (&optional arg)
15629 "Increase the date item at the cursor by one.
15630 If the cursor is on the year, change the year. If it is on the month,
15631 the day or the time, change that.
15632 With prefix ARG, change by that many units."
15633 (interactive "p")
15634 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15636 (defun org-timestamp-down (&optional arg)
15637 "Decrease the date item at the cursor by one.
15638 If the cursor is on the year, change the year. If it is on the month,
15639 the day or the time, change that.
15640 With prefix ARG, change by that many units."
15641 (interactive "p")
15642 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15644 (defun org-timestamp-up-day (&optional arg)
15645 "Increase the date in the time stamp by one day.
15646 With prefix ARG, change that many days."
15647 (interactive "p")
15648 (if (and (not (org-at-timestamp-p t))
15649 (org-on-heading-p))
15650 (org-todo 'up)
15651 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15653 (defun org-timestamp-down-day (&optional arg)
15654 "Decrease the date in the time stamp by one day.
15655 With prefix ARG, change that many days."
15656 (interactive "p")
15657 (if (and (not (org-at-timestamp-p t))
15658 (org-on-heading-p))
15659 (org-todo 'down)
15660 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15662 (defun org-at-timestamp-p (&optional inactive-ok)
15663 "Determine if the cursor is in or at a timestamp."
15664 (interactive)
15665 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15666 (pos (point))
15667 (ans (or (looking-at tsr)
15668 (save-excursion
15670 (if (> (point) (point-min)) (backward-char 1))
15671 (and (looking-at tsr)
15672 (> (- (match-end 0) pos) -1))))))
15673 (and ans
15674 (boundp 'org-ts-what)
15675 (setq org-ts-what
15676 (cond
15677 ((= pos (match-beginning 0)) 'bracket)
15678 ;; Point is considered to be "on the bracket" whether
15679 ;; it's really on it or right after it.
15680 ((or (= pos (1- (match-end 0)))
15681 (= pos (match-end 0))) 'bracket)
15682 ((org-pos-in-match-range pos 2) 'year)
15683 ((org-pos-in-match-range pos 3) 'month)
15684 ((org-pos-in-match-range pos 7) 'hour)
15685 ((org-pos-in-match-range pos 8) 'minute)
15686 ((or (org-pos-in-match-range pos 4)
15687 (org-pos-in-match-range pos 5)) 'day)
15688 ((and (> pos (or (match-end 8) (match-end 5)))
15689 (< pos (match-end 0)))
15690 (- pos (or (match-end 8) (match-end 5))))
15691 (t 'day))))
15692 ans))
15694 (defun org-toggle-timestamp-type ()
15695 "Toggle the type (<active> or [inactive]) of a time stamp."
15696 (interactive)
15697 (when (org-at-timestamp-p t)
15698 (let ((beg (match-beginning 0)) (end (match-end 0))
15699 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15700 (save-excursion
15701 (goto-char beg)
15702 (while (re-search-forward "[][<>]" end t)
15703 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15704 t t)))
15705 (message "Timestamp is now %sactive"
15706 (if (equal (char-after beg) ?<) "" "in")))))
15708 (defun org-timestamp-change (n &optional what updown)
15709 "Change the date in the time stamp at point.
15710 The date will be changed by N times WHAT. WHAT can be `day', `month',
15711 `year', `minute', `second'. If WHAT is not given, the cursor position
15712 in the timestamp determines what will be changed."
15713 (let ((origin (point)) origin-cat
15714 with-hm inactive
15715 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15716 org-ts-what
15717 extra rem
15718 ts time time0)
15719 (if (not (org-at-timestamp-p t))
15720 (error "Not at a timestamp"))
15721 (if (and (not what) (eq org-ts-what 'bracket))
15722 (org-toggle-timestamp-type)
15723 ;; Point isn't on brackets. Remember the part of the time-stamp
15724 ;; the point was in. Indeed, size of time-stamps may change,
15725 ;; but point must be kept in the same category nonetheless.
15726 (setq origin-cat org-ts-what)
15727 (if (and (not what) (not (eq org-ts-what 'day))
15728 org-display-custom-times
15729 (get-text-property (point) 'display)
15730 (not (get-text-property (1- (point)) 'display)))
15731 (setq org-ts-what 'day))
15732 (setq org-ts-what (or what org-ts-what)
15733 inactive (= (char-after (match-beginning 0)) ?\[)
15734 ts (match-string 0))
15735 (replace-match "")
15736 (if (string-match
15738 ts)
15739 (setq extra (match-string 1 ts)))
15741 (setq with-hm t))
15742 (setq time0 (org-parse-time-string ts))
15743 (when (and updown
15744 (eq org-ts-what 'minute)
15745 (not current-prefix-arg))
15746 ;; This looks like s-up and s-down. Change by one rounding step.
15747 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15748 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15749 (setcar (cdr time0) (+ (nth 1 time0)
15750 (if (> n 0) (- rem) (- dm rem))))))
15751 (setq time
15752 (encode-time (or (car time0) 0)
15753 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15754 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15755 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15756 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15757 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15758 (nthcdr 6 time0)))
15759 (when (and (member org-ts-what '(hour minute))
15760 extra
15762 (setq extra (org-modify-ts-extra
15763 extra
15764 (if (eq org-ts-what 'hour) 2 5)
15765 n dm)))
15766 (when (integerp org-ts-what)
15767 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15768 (if (eq what 'calendar)
15769 (let ((cal-date (org-get-date-from-calendar)))
15770 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15771 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15772 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15773 (setcar time0 (or (car time0) 0))
15774 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15775 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15776 (setq time (apply 'encode-time time0))))
15777 ;; Insert the new time-stamp, and ensure point stays in the same
15778 ;; category as before (i.e. not after the last position in that
15779 ;; category).
15780 (let ((pos (point)))
15781 ;; Stay before inserted string. `save-excursion' is of no use.
15782 (setq org-last-changed-timestamp
15783 (org-insert-time-stamp time with-hm inactive nil nil extra))
15784 (goto-char pos))
15785 (save-match-data
15786 (looking-at org-ts-regexp3)
15787 (goto-char (cond
15788 ;; `day' category ends before `hour' if any, or at
15789 ;; the end of the day name.
15790 ((eq origin-cat 'day)
15791 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15792 ((eq origin-cat 'hour) (min (match-end 7) origin))
15793 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15794 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15795 ;; `year' and `month' have both fixed size: point
15796 ;; couldn't have moved into another part.
15797 (t origin))))
15798 ;; Update clock if on a CLOCK line.
15799 (org-clock-update-time-maybe)
15800 ;; Try to recenter the calendar window, if any.
15801 (if (and org-calendar-follow-timestamp-change
15802 (get-buffer-window "*Calendar*" t)
15803 (memq org-ts-what '(day month year)))
15804 (org-recenter-calendar (time-to-days time))))))
15806 (defun org-modify-ts-extra (s pos n dm)
15807 "Change the different parts of the lead-time and repeat fields in timestamp."
15808 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15809 ng h m new rem)
15810 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15811 (cond
15812 ((or (org-pos-in-match-range pos 2)
15813 (org-pos-in-match-range pos 3))
15814 (setq m (string-to-number (match-string 3 s))
15815 h (string-to-number (match-string 2 s)))
15816 (if (org-pos-in-match-range pos 2)
15817 (setq h (+ h n))
15818 (setq n (* dm (org-no-warnings (signum n))))
15819 (when (not (= 0 (setq rem (% m dm))))
15820 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15821 (setq m (+ m n)))
15822 (if (< m 0) (setq m (+ m 60) h (1- h)))
15823 (if (> m 59) (setq m (- m 60) h (1+ h)))
15824 (setq h (min 24 (max 0 h)))
15825 (setq ng 1 new (format "-%02d:%02d" h m)))
15826 ((org-pos-in-match-range pos 6)
15827 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15828 ((org-pos-in-match-range pos 5)
15829 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15831 ((org-pos-in-match-range pos 9)
15832 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15833 ((org-pos-in-match-range pos 8)
15834 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15836 (when ng
15837 (setq s (concat
15838 (substring s 0 (match-beginning ng))
15839 new
15840 (substring s (match-end ng))))))
15841 s))
15843 (defun org-recenter-calendar (date)
15844 "If the calendar is visible, recenter it to DATE."
15845 (let* ((win (selected-window))
15846 (cwin (get-buffer-window "*Calendar*" t))
15847 (calendar-move-hook nil))
15848 (when cwin
15849 (select-window cwin)
15850 (calendar-goto-date (if (listp date) date
15851 (calendar-gregorian-from-absolute date)))
15852 (select-window win))))
15854 (defun org-goto-calendar (&optional arg)
15855 "Go to the Emacs calendar at the current date.
15856 If there is a time stamp in the current line, go to that date.
15857 A prefix ARG can be used to force the current date."
15858 (interactive "P")
15859 (let ((tsr org-ts-regexp) diff
15860 (calendar-move-hook nil)
15861 (calendar-view-holidays-initially-flag nil)
15862 (calendar-view-diary-initially-flag nil))
15863 (if (or (org-at-timestamp-p)
15864 (save-excursion
15865 (beginning-of-line 1)
15866 (looking-at (concat ".*" tsr))))
15867 (let ((d1 (time-to-days (current-time)))
15868 (d2 (time-to-days
15869 (org-time-string-to-time (match-string 1)))))
15870 (setq diff (- d2 d1))))
15871 (calendar)
15872 (calendar-goto-today)
15873 (if (and diff (not arg)) (calendar-forward-day diff))))
15875 (defun org-get-date-from-calendar ()
15876 "Return a list (month day year) of date at point in calendar."
15877 (with-current-buffer "*Calendar*"
15878 (save-match-data
15879 (calendar-cursor-to-date))))
15881 (defun org-date-from-calendar ()
15882 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15883 If there is already a time stamp at the cursor position, update it."
15884 (interactive)
15885 (if (org-at-timestamp-p t)
15886 (org-timestamp-change 0 'calendar)
15887 (let ((cal-date (org-get-date-from-calendar)))
15888 (org-insert-time-stamp
15889 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15891 (defun org-minutes-to-hh:mm-string (m)
15892 "Compute H:MM from a number of minutes."
15893 (let ((h (/ m 60)))
15894 (setq m (- m (* 60 h)))
15895 (format org-time-clocksum-format h m)))
15897 (defun org-hh:mm-string-to-minutes (s)
15898 "Convert a string H:MM to a number of minutes.
15899 If the string is just a number, interpret it as minutes.
15900 In fact, the first hh:mm or number in the string will be taken,
15901 there can be extra stuff in the string.
15902 If no number is found, the return value is 0."
15903 (cond
15904 ((integerp s) s)
15906 (+ (* (string-to-number (match-string 1 s)) 60)
15907 (string-to-number (match-string 2 s))))
15909 (string-to-number (match-string 1 s)))
15910 (t 0)))
15912 (defcustom org-effort-durations
15913 `(("h" . 60)
15914 ("d" . ,(* 60 8))
15915 ("w" . ,(* 60 8 5))
15916 ("m" . ,(* 60 8 5 4))
15917 ("y" . ,(* 60 8 5 40)))
15918 "Conversion factor to minutes for an effort modifier.
15920 Each entry has the form (MODIFIER . MINUTES).
15922 In an effort string, a number followed by MODIFIER is multiplied
15923 by the specified number of MINUTES to obtain an effort in
15924 minutes.
15928 :group 'org-agenda
15929 :type '(alist :key-type (string :tag "Modifier")
15930 :value-type (number :tag "Minutes")))
15932 (defun org-duration-string-to-minutes (s)
15933 "Convert a duration string S to minutes.
15935 A bare number is interpreted as minutes, modifiers can be set by
15936 customizing `org-effort-durations' (which see).
15938 Entries containing a colon are interpreted as H:MM by
15939 `org-hh:mm-string-to-minutes'."
15940 (let ((result 0)
15942 (regexp-opt (mapcar 'car org-effort-durations))
15944 (while (string-match re s)
15945 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15946 (string-to-number (match-string 1 s))))
15947 (setq s (replace-match "" nil t s)))
15948 (incf result (org-hh:mm-string-to-minutes s))
15949 result))
15951 ;;;; Files
15953 (defun org-save-all-org-buffers ()
15954 "Save all Org-mode buffers without user confirmation."
15955 (interactive)
15956 (message "Saving all Org-mode buffers...")
15957 (save-some-buffers t 'org-mode-p)
15958 (when (featurep 'org-id) (org-id-locations-save))
15959 (message "Saving all Org-mode buffers... done"))
15961 (defun org-revert-all-org-buffers ()
15962 "Revert all Org-mode buffers.
15963 Prompt for confirmation when there are unsaved changes.
15964 Be sure you know what you are doing before letting this function
15965 overwrite your changes.
15967 This function is useful in a setup where one tracks org files
15968 with a version control system, to revert on one machine after pulling
15969 changes from another. I believe the procedure must be like this:
15971 1. M-x org-save-all-org-buffers
15972 2. Pull changes from the other machine, resolve conflicts
15973 3. M-x org-revert-all-org-buffers"
15974 (interactive)
15975 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15976 (error "Abort"))
15977 (save-excursion
15978 (save-window-excursion
15979 (mapc
15980 (lambda (b)
15981 (when (and (with-current-buffer b (org-mode-p))
15982 (with-current-buffer b buffer-file-name))
15983 (org-pop-to-buffer-same-window b)
15984 (revert-buffer t 'no-confirm)))
15985 (buffer-list))
15986 (when (and (featurep 'org-id) org-id-track-globally)
15987 (org-id-locations-load)))))
15989 ;;;; Agenda files
15991 ;;;###autoload
15992 (defun org-switchb (&optional arg)
15993 "Switch between Org buffers.
15994 With a prefix argument, restrict available to files.
15995 With two prefix arguments, restrict available buffers to agenda files.
15997 Defaults to `iswitchb' for buffer name completion.
15998 Set `org-completion-use-ido' to make it use ido instead."
15999 (interactive "P")
16000 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16001 ((equal arg '(16)) (org-buffer-list 'agenda))
16002 (t (org-buffer-list))))
16003 (org-completion-use-iswitchb org-completion-use-iswitchb)
16004 (org-completion-use-ido org-completion-use-ido))
16005 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16006 (setq org-completion-use-iswitchb t))
16007 (org-pop-to-buffer-same-window
16008 (org-icompleting-read "Org buffer: "
16009 (mapcar 'list (mapcar 'buffer-name blist))
16010 nil t))))
16012 ;;; Define some older names previously used for this functionality
16013 ;;;###autoload
16014 (defalias 'org-ido-switchb 'org-switchb)
16015 ;;;###autoload
16016 (defalias 'org-iswitchb 'org-switchb)
16018 (defun org-buffer-list (&optional predicate exclude-tmp)
16019 "Return a list of Org buffers.
16020 PREDICATE can be `export', `files' or `agenda'.
16022 export restrict the list to Export buffers.
16023 files restrict the list to buffers visiting Org files.
16024 agenda restrict the list to buffers visiting agenda files.
16026 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16027 (let* ((bfn nil)
16028 (agenda-files (and (eq predicate 'agenda)
16029 (mapcar 'file-truename (org-agenda-files t))))
16030 (filter
16031 (cond
16032 ((eq predicate 'files)
16033 (lambda (b) (with-current-buffer b (org-mode-p))))
16034 ((eq predicate 'export)
16035 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16036 ((eq predicate 'agenda)
16037 (lambda (b)
16038 (with-current-buffer b
16039 (and (org-mode-p)
16040 (setq bfn (buffer-file-name b))
16041 (member (file-truename bfn) agenda-files)))))
16042 (t (lambda (b) (with-current-buffer b
16043 (or (org-mode-p)
16044 (string-match "\*Org .*Export"
16045 (buffer-name b)))))))))
16046 (delq nil
16047 (mapcar
16048 (lambda(b)
16049 (if (and (funcall filter b)
16050 (or (not exclude-tmp)
16051 (not (string-match "tmp" (buffer-name b)))))
16052 b
16053 nil))
16054 (buffer-list)))))
16056 (defun org-agenda-files (&optional unrestricted archives)
16057 "Get the list of agenda files.
16058 Optional UNRESTRICTED means return the full list even if a restriction
16059 is currently in place.
16060 When ARCHIVES is t, include all archive files that are really being
16061 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16062 `org-agenda-archives-mode' is t."
16063 (let ((files
16064 (cond
16065 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16066 ((stringp org-agenda-files) (org-read-agenda-file-list))
16067 ((listp org-agenda-files) org-agenda-files)
16068 (t (error "Invalid value of `org-agenda-files'")))))
16069 (setq files (apply 'append
16070 (mapcar (lambda (f)
16071 (if (file-directory-p f)
16072 (directory-files
16073 f t org-agenda-file-regexp)
16074 (list f)))
16075 files)))
16076 (when org-agenda-skip-unavailable-files
16077 (setq files (delq nil
16078 (mapcar (function
16079 (lambda (file)
16080 (and (file-readable-p file) file)))
16081 files))))
16082 (when (or (eq archives t)
16083 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16084 (setq files (org-add-archive-files files)))
16085 files))
16087 (defun org-agenda-file-p (&optional file)
16088 "Return non-nil, if FILE is an agenda file.
16089 If FILE is omitted, use the file associated with the current
16090 buffer."
16091 (member (or file (buffer-file-name))
16092 (org-agenda-files t)))
16094 (defun org-edit-agenda-file-list ()
16095 "Edit the list of agenda files.
16096 Depending on setup, this either uses customize to edit the variable
16097 `org-agenda-files', or it visits the file that is holding the list. In the
16098 latter case, the buffer is set up in a way that saving it automatically kills
16099 the buffer and restores the previous window configuration."
16100 (interactive)
16101 (if (stringp org-agenda-files)
16102 (let ((cw (current-window-configuration)))
16103 (find-file org-agenda-files)
16104 (org-set-local 'org-window-configuration cw)
16105 (org-add-hook 'after-save-hook
16106 (lambda ()
16107 (set-window-configuration
16108 (prog1 org-window-configuration
16109 (kill-buffer (current-buffer))))
16110 (org-install-agenda-files-menu)
16111 (message "New agenda file list installed"))
16112 nil 'local)
16113 (message "%s" (substitute-command-keys
16115 (customize-variable 'org-agenda-files)))
16117 (defun org-store-new-agenda-file-list (list)
16118 "Set new value for the agenda file list and save it correctly."
16119 (if (stringp org-agenda-files)
16120 (let ((fe (org-read-agenda-file-list t)) b u)
16121 (while (setq b (find-buffer-visiting org-agenda-files))
16122 (kill-buffer b))
16123 (with-temp-file org-agenda-files
16124 (insert
16125 (mapconcat
16126 (lambda (f) ;; Keep un-expanded entries.
16127 (if (setq u (assoc f fe))
16128 (cdr u)
16129 f))
16132 (let ((org-mode-hook nil) (org-inhibit-startup t)
16133 (org-insert-mode-line-in-empty-file nil))
16134 (setq org-agenda-files list)
16135 (customize-save-variable 'org-agenda-files org-agenda-files))))
16137 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16138 "Read the list of agenda files from a file.
16139 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16140 filenames, used by `org-store-new-agenda-file-list' to write back
16141 un-expanded file names."
16142 (when (file-directory-p org-agenda-files)
16143 (error "`org-agenda-files' cannot be a single directory"))
16144 (when (stringp org-agenda-files)
16145 (with-temp-buffer
16146 (insert-file-contents org-agenda-files)
16147 (mapcar
16148 (lambda (f)
16149 (let ((e (expand-file-name (substitute-in-file-name f)
16150 org-directory)))
16151 (if pair-with-expansion
16152 (cons e f)
16153 e)))
16156 ;;;###autoload
16157 (defun org-cycle-agenda-files ()
16158 "Cycle through the files in `org-agenda-files'.
16159 If the current buffer visits an agenda file, find the next one in the list.
16160 If the current buffer does not, find the first agenda file."
16161 (interactive)
16162 (let* ((fs (org-agenda-files t))
16163 (files (append fs (list (car fs))))
16164 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16165 file)
16166 (unless files (error "No agenda files"))
16167 (catch 'exit
16168 (while (setq file (pop files))
16169 (if (equal (file-truename file) tcf)
16170 (when (car files)
16171 (find-file (car files))
16172 (throw 'exit t))))
16173 (find-file (car fs)))
16174 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16176 (defun org-agenda-file-to-front (&optional to-end)
16177 "Move/add the current file to the top of the agenda file list.
16178 If the file is not present in the list, it is added to the front. If it is
16179 present, it is moved there. With optional argument TO-END, add/move to the
16180 end of the list."
16181 (interactive "P")
16182 (let ((org-agenda-skip-unavailable-files nil)
16183 (file-alist (mapcar (lambda (x)
16184 (cons (file-truename x) x))
16185 (org-agenda-files t)))
16186 (ctf (file-truename buffer-file-name))
16187 x had)
16188 (setq x (assoc ctf file-alist) had x)
16190 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16191 (if to-end
16192 (setq file-alist (append (delq x file-alist) (list x)))
16193 (setq file-alist (cons x (delq x file-alist))))
16194 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16195 (org-install-agenda-files-menu)
16196 (message "File %s to %s of agenda file list"
16197 (if had "moved" "added") (if to-end "end" "front"))))
16199 (defun org-remove-file (&optional file)
16200 "Remove current file from the list of files in variable `org-agenda-files'.
16201 These are the files which are being checked for agenda entries.
16202 Optional argument FILE means use this file instead of the current."
16203 (interactive)
16204 (let* ((org-agenda-skip-unavailable-files nil)
16205 (file (or file buffer-file-name))
16206 (true-file (file-truename file))
16207 (afile (abbreviate-file-name file))
16208 (files (delq nil (mapcar
16209 (lambda (x)
16210 (if (equal true-file
16211 (file-truename x))
16212 nil x))
16213 (org-agenda-files t)))))
16214 (if (not (= (length files) (length (org-agenda-files t))))
16215 (progn
16216 (org-store-new-agenda-file-list files)
16217 (org-install-agenda-files-menu)
16218 (message "Removed file: %s" afile))
16219 (message "File was not in list: %s (not removed)" afile))))
16221 (defun org-file-menu-entry (file)
16222 (vector file (list 'find-file file) t))
16224 (defun org-check-agenda-file (file)
16225 "Make sure FILE exists. If not, ask user what to do."
16226 (when (not (file-exists-p file))
16227 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16228 (abbreviate-file-name file))
16229 (let ((r (downcase (read-char-exclusive))))
16230 (cond
16231 ((equal r ?r)
16232 (org-remove-file file)
16233 (throw 'nextfile t))
16234 (t (error "Abort"))))))
16236 (defun org-get-agenda-file-buffer (file)
16237 "Get a buffer visiting FILE. If the buffer needs to be created, add
16238 it to the list of buffers which might be released later."
16239 (let ((buf (org-find-base-buffer-visiting file)))
16240 (if buf
16241 buf ; just return it
16242 ;; Make a new buffer and remember it
16243 (setq buf (find-file-noselect file))
16244 (if buf (push buf org-agenda-new-buffers))
16245 buf)))
16247 (defun org-release-buffers (blist)
16248 "Release all buffers in list, asking the user for confirmation when needed.
16249 When a buffer is unmodified, it is just killed. When modified, it is saved
16250 \(if the user agrees) and then killed."
16251 (let (buf file)
16252 (while (setq buf (pop blist))
16253 (setq file (buffer-file-name buf))
16254 (when (and (buffer-modified-p buf)
16255 file
16256 (y-or-n-p (format "Save file %s? " file)))
16257 (with-current-buffer buf (save-buffer)))
16258 (kill-buffer buf))))
16260 (defun org-prepare-agenda-buffers (files)
16261 "Create buffers for all agenda files, protect archived trees and comments."
16262 (interactive)
16263 (let ((pa '(:org-archived t))
16264 (pc '(:org-comment t))
16265 (pall '(:org-archived t :org-comment t))
16266 (inhibit-read-only t)
16267 (rea (concat ":" org-archive-tag ":"))
16268 bmp file re)
16269 (save-excursion
16270 (save-restriction
16271 (while (setq file (pop files))
16272 (catch 'nextfile
16273 (if (bufferp file)
16274 (set-buffer file)
16275 (org-check-agenda-file file)
16276 (set-buffer (org-get-agenda-file-buffer file)))
16277 (widen)
16278 (setq bmp (buffer-modified-p))
16279 (org-refresh-category-properties)
16280 (setq org-todo-keywords-for-agenda
16281 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16282 (setq org-done-keywords-for-agenda
16283 (append org-done-keywords-for-agenda org-done-keywords))
16284 (setq org-todo-keyword-alist-for-agenda
16285 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16286 (setq org-drawers-for-agenda
16287 (append org-drawers-for-agenda org-drawers))
16288 (setq org-tag-alist-for-agenda
16289 (append org-tag-alist-for-agenda org-tag-alist))
16291 (save-excursion
16292 (remove-text-properties (point-min) (point-max) pall)
16293 (when org-agenda-skip-archived-trees
16294 (goto-char (point-min))
16295 (while (re-search-forward rea nil t)
16296 (if (org-on-heading-p t)
16297 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16298 (goto-char (point-min))
16300 (while (re-search-forward re nil t)
16301 (add-text-properties
16302 (match-beginning 0) (org-end-of-subtree t) pc)))
16303 (set-buffer-modified-p bmp)))))
16304 (setq org-todo-keywords-for-agenda
16305 (org-uniquify org-todo-keywords-for-agenda))
16306 (setq org-todo-keyword-alist-for-agenda
16307 (org-uniquify org-todo-keyword-alist-for-agenda)
16308 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16310 ;;;; Embedded LaTeX
16312 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16313 "Keymap for the minor `org-cdlatex-mode'.")
16315 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16316 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16317 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16318 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16319 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16321 (defvar org-cdlatex-texmathp-advice-is-done nil
16322 "Flag remembering if we have applied the advice to texmathp already.")
16324 (define-minor-mode org-cdlatex-mode
16325 "Toggle the minor `org-cdlatex-mode'.
16326 This mode supports entering LaTeX environment and math in LaTeX fragments
16327 in Org-mode.
16329 nil " OCDL" nil
16330 (when org-cdlatex-mode (require 'cdlatex))
16331 (unless org-cdlatex-texmathp-advice-is-done
16332 (setq org-cdlatex-texmathp-advice-is-done t)
16333 (defadvice texmathp (around org-math-always-on activate)
16334 "Always return t in org-mode buffers.
16335 This is because we want to insert math symbols without dollars even outside
16336 the LaTeX math segments. If Orgmode thinks that point is actually inside
16337 an embedded LaTeX fragment, let texmathp do its job.
16339 (interactive)
16340 (let (p)
16341 (cond
16342 ((not (org-mode-p)) ad-do-it)
16343 ((eq this-command 'cdlatex-math-symbol)
16344 (setq ad-return-value t
16345 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16346 (t
16347 (let ((p (org-inside-LaTeX-fragment-p)))
16348 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16349 (setq ad-return-value t
16350 texmathp-why '("Org-mode embedded math" . 0))
16351 (if p ad-do-it)))))))))
16353 (defun turn-on-org-cdlatex ()
16354 "Unconditionally turn on `org-cdlatex-mode'."
16355 (org-cdlatex-mode 1))
16357 (defun org-inside-LaTeX-fragment-p ()
16358 "Test if point is inside a LaTeX fragment.
16360 sequence appearing also before point.
16361 Even though the matchers for math are configurable, this function assumes
16363 delimiters are skipped when they have been removed by customization.
16364 The return value is nil, or a cons cell with the delimiter and the
16365 position of this delimiter.
16367 This function does a reasonably good job, but can locally be fooled by
16368 for example currency specifications. For example it will assume being in
16370 fragments that are properly closed, but during editing, we have to live
16371 with the uncertainty caused by missing closing delimiters. This function
16372 looks only before point, not after."
16373 (catch 'exit
16374 (let ((pos (point))
16375 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16376 (lim (progn
16378 (point)))
16379 dd-on str (start 0) m re)
16380 (goto-char pos)
16381 (when dodollar
16383 re (nth 1 (assoc "$" org-latex-regexps)))
16384 (while (string-match re str start)
16385 (cond
16386 ((= (match-end 0) (length str))
16387 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16388 ((= (match-end 0) (- (length str) 5))
16389 (throw 'exit nil))
16390 (t (setq start (match-end 0))))))
16391 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16392 (goto-char pos)
16393 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16394 (and (match-beginning 2) (throw 'exit nil))
16395 ;; count $$
16397 (setq dd-on (not dd-on)))
16398 (goto-char pos)
16399 (if dd-on (cons "$$" m))))))
16401 (defun org-inside-latex-macro-p ()
16402 "Is point inside a LaTeX macro or its arguments?"
16403 (save-match-data
16404 (org-in-regexp
16407 (defun org-try-cdlatex-tab ()
16408 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16409 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16410 - inside a LaTeX fragment, or
16411 - after the first word in a line, where an abbreviation expansion could
16412 insert a LaTeX environment."
16413 (when org-cdlatex-mode
16414 (cond
16415 ((save-excursion
16416 (skip-chars-backward "a-zA-Z0-9*")
16418 (bolp))
16419 (cdlatex-tab) t)
16420 ((org-inside-LaTeX-fragment-p)
16421 (cdlatex-tab) t)
16422 (t nil))))
16424 (defun org-cdlatex-underscore-caret (&optional arg)
16425 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16426 Revert to the normal definition outside of these fragments."
16427 (interactive "P")
16428 (if (org-inside-LaTeX-fragment-p)
16429 (call-interactively 'cdlatex-sub-superscript)
16430 (let (org-cdlatex-mode)
16431 (call-interactively (key-binding (vector last-input-event))))))
16433 (defun org-cdlatex-math-modify (&optional arg)
16434 "Execute `cdlatex-math-modify' in LaTeX fragments.
16435 Revert to the normal definition outside of these fragments."
16436 (interactive "P")
16437 (if (org-inside-LaTeX-fragment-p)
16438 (call-interactively 'cdlatex-math-modify)
16439 (let (org-cdlatex-mode)
16440 (call-interactively (key-binding (vector last-input-event))))))
16442 (defvar org-latex-fragment-image-overlays nil
16443 "List of overlays carrying the images of latex fragments.")
16444 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16446 (defun org-remove-latex-fragment-image-overlays ()
16447 "Remove all overlays with LaTeX fragment images in current buffer."
16448 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16449 (setq org-latex-fragment-image-overlays nil))
16451 (defun org-preview-latex-fragment (&optional subtree)
16452 "Preview the LaTeX fragment at point, or all locally or globally.
16453 If the cursor is in a LaTeX fragment, create the image and overlay
16454 it over the source code. If there is no fragment at point, display
16455 all fragments in the current text, from one headline to the next. With
16456 prefix SUBTREE, display all fragments in the current subtree. With a
16458 the cursor is before the first headline,
16459 display all fragments in the buffer.
16461 (interactive "P")
16462 (org-remove-latex-fragment-image-overlays)
16463 (save-excursion
16464 (save-restriction
16465 (let (beg end at msg)
16466 (cond
16467 ((or (equal subtree '(16))
16468 (not (save-excursion
16469 (re-search-backward org-outline-regexp-bol nil t))))
16470 (setq beg (point-min) end (point-max)
16471 msg "Creating images for buffer...%s"))
16472 ((equal subtree '(4))
16473 (org-back-to-heading)
16474 (setq beg (point) end (org-end-of-subtree t)
16475 msg "Creating images for subtree...%s"))
16476 (t
16477 (if (setq at (org-inside-LaTeX-fragment-p))
16478 (goto-char (max (point-min) (- (cdr at) 2)))
16479 (org-back-to-heading))
16480 (setq beg (point) end (progn (outline-next-heading) (point))
16481 msg (if at "Creating image...%s"
16482 "Creating images for entry...%s"))))
16483 (message msg "")
16484 (narrow-to-region beg end)
16485 (goto-char beg)
16486 (org-format-latex
16487 (concat "ltxpng/" (file-name-sans-extension
16488 (file-name-nondirectory
16489 buffer-file-name)))
16490 default-directory 'overlays msg at 'forbuffer 'dvipng)
16491 (message msg "done. Use `C-c C-c' to remove images.")))))
16493 (defvar org-latex-regexps
16495 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16498 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16502 "Regular expressions for matching embedded LaTeX.")
16504 (defvar org-export-have-math nil) ;; dynamic scoping
16505 (defun org-format-latex (prefix &optional dir overlays msg at
16506 forbuffer processing-type)
16507 "Replace LaTeX fragments with links to an image, and produce images.
16508 Some of the options can be changed using the variable
16509 `org-format-latex-options'."
16510 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16511 (let* ((prefixnodir (file-name-nondirectory prefix))
16512 (absprefix (expand-file-name prefix dir))
16513 (todir (file-name-directory absprefix))
16514 (opt org-format-latex-options)
16515 (matchers (plist-get opt :matchers))
16516 (re-list org-latex-regexps)
16517 (org-format-latex-header-extra
16518 (plist-get (org-infile-export-plist) :latex-header-extra))
16519 (cnt 0) txt hash link beg end re e checkdir
16520 executables-checked string
16521 m n block linkfile movefile ov)
16522 ;; Check the different regular expressions
16523 (while (setq e (pop re-list))
16524 (setq m (car e) re (nth 1 e) n (nth 2 e)
16526 (when (member m matchers)
16527 (goto-char (point-min))
16528 (while (re-search-forward re nil t)
16529 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16530 (not (get-text-property (match-beginning n)
16531 'org-protected))
16532 (or (not overlays)
16533 (not (eq (get-char-property (match-beginning n)
16534 'org-overlay-type)
16535 'org-latex-overlay))))
16536 (setq org-export-have-math t)
16537 (cond
16538 ((eq processing-type 'verbatim)
16539 ;; Leave the text verbatim, just protect it
16540 (add-text-properties (match-beginning n) (match-end n)
16541 '(org-protected t)))
16542 ((eq processing-type 'mathjax)
16543 ;; Prepare for MathJax processing
16544 (setq string (match-string n))
16545 (if (member m '("$" "$1"))
16546 (save-excursion
16547 (delete-region (match-beginning n) (match-end n))
16548 (goto-char (match-beginning n))
16551 '(org-protected t))))
16552 (add-text-properties (match-beginning n) (match-end n)
16553 '(org-protected t))))
16554 ((or (eq processing-type 'dvipng) t)
16555 ;; Process to an image
16556 (setq txt (match-string n)
16557 beg (match-beginning n) end (match-end n)
16558 cnt (1+ cnt))
16559 (let (print-length print-level) ; make sure full list is printed
16560 (setq hash (sha1 (prin1-to-string
16561 (list org-format-latex-header
16562 org-format-latex-header-extra
16563 org-export-latex-default-packages-alist
16564 org-export-latex-packages-alist
16565 org-format-latex-options
16566 forbuffer txt)))
16567 linkfile (format "%s_%s.png" prefix hash)
16568 movefile (format "%s_%s.png" absprefix hash)))
16569 (setq link (concat block "[[file:" linkfile "]]" block))
16570 (if msg (message msg cnt))
16571 (goto-char beg)
16572 (unless checkdir ; make sure the directory exists
16573 (setq checkdir t)
16574 (or (file-directory-p todir) (make-directory todir t)))
16576 (unless executables-checked
16577 (org-check-external-command
16578 "latex" "needed to convert LaTeX fragments to images")
16579 (org-check-external-command
16580 "dvipng" "needed to convert LaTeX fragments to images")
16581 (setq executables-checked t))
16583 (unless (file-exists-p movefile)
16584 (org-create-formula-image
16585 txt movefile opt forbuffer))
16586 (if overlays
16587 (progn
16588 (mapc (lambda (o)
16589 (if (eq (overlay-get o 'org-overlay-type)
16590 'org-latex-overlay)
16591 (delete-overlay o)))
16592 (overlays-in beg end))
16593 (setq ov (make-overlay beg end))
16594 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16595 (if (featurep 'xemacs)
16596 (progn
16597 (overlay-put ov 'invisible t)
16598 (overlay-put
16599 ov 'end-glyph
16600 (make-glyph (vector 'png :file movefile))))
16601 (overlay-put
16602 ov 'display
16603 (list 'image :type 'png :file movefile :ascent 'center)))
16604 (push ov org-latex-fragment-image-overlays)
16605 (goto-char end))
16606 (delete-region beg end)
16607 (insert (org-add-props link
16608 (list 'org-latex-src
16609 (replace-regexp-in-string
16612 ;; This function borrows from Ganesh Swami's latex2png.el
16613 (defun org-create-formula-image (string tofile options buffer)
16614 "This calls dvipng."
16615 (require 'org-latex)
16616 (let* ((tmpdir (if (featurep 'xemacs)
16617 (temp-directory)
16618 temporary-file-directory))
16619 (texfilebase (make-temp-name
16620 (expand-file-name "orgtex" tmpdir)))
16621 (texfile (concat texfilebase ".tex"))
16622 (dvifile (concat texfilebase ".dvi"))
16623 (pngfile (concat texfilebase ".png"))
16624 (fnh (if (featurep 'xemacs)
16625 (font-height (get-face-font 'default))
16626 (face-attribute 'default :height nil)))
16627 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16628 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16629 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16630 "Black"))
16631 (bg (or (plist-get options (if buffer :background :html-background))
16632 "Transparent")))
16633 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16634 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16635 (with-temp-file texfile
16636 (insert (org-splice-latex-header
16637 org-format-latex-header
16638 org-export-latex-default-packages-alist
16639 org-export-latex-packages-alist t
16640 org-format-latex-header-extra))
16642 (require 'org-latex)
16643 (org-export-latex-fix-inputenc))
16644 (let ((dir default-directory))
16645 (condition-case nil
16646 (progn
16647 (cd tmpdir)
16648 (call-process "latex" nil nil nil texfile))
16649 (error nil))
16650 (cd dir))
16651 (if (not (file-exists-p dvifile))
16652 (progn (message "Failed to create dvi file from %s" texfile) nil)
16653 (condition-case nil
16654 (call-process "dvipng" nil nil nil
16655 "-fg" fg "-bg" bg
16656 "-D" dpi
16657 ;;"-x" scale "-y" scale
16658 "-T" "tight"
16659 "-o" pngfile
16660 dvifile)
16661 (error nil))
16662 (if (not (file-exists-p pngfile))
16663 (if org-format-latex-signal-error
16664 (error "Failed to create png file from %s" texfile)
16665 (message "Failed to create png file from %s" texfile)
16666 nil)
16667 ;; Use the requested file name and clean up
16668 (copy-file pngfile tofile 'replace)
16669 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16670 (delete-file (concat texfilebase e)))
16671 pngfile))))
16673 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16674 "Fill a LaTeX header template TPL.
16675 In the template, the following place holders will be recognized:
16678 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16680 [NO-PACKAGES] do not include PKG
16681 [EXTRA] the string EXTRA
16682 [NO-EXTRA] do not include EXTRA
16684 For backward compatibility, if both the positive and the negative place
16686 assumed to be present at the end of the template.
16687 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16688 EXTRA is a string.
16689 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16690 (let (rpl (end ""))
16692 (setq rpl (if (or (match-end 1) (not def-pkg))
16693 "" (org-latex-packages-to-string def-pkg snippets-p t))
16694 tpl (replace-match rpl t t tpl))
16695 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16698 (setq rpl (if (or (match-end 1) (not pkg))
16699 "" (org-latex-packages-to-string pkg snippets-p t))
16700 tpl (replace-match rpl t t tpl))
16701 (if pkg (setq end
16703 (org-latex-packages-to-string pkg snippets-p)))))
16706 (setq rpl (if (or (match-end 1) (not extra))
16708 tpl (replace-match rpl t t tpl))
16714 tpl)))
16716 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16718 (setq pkg (mapconcat (lambda(p)
16719 (cond
16720 ((stringp p) p)
16721 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16722 (format "%% Package %s omitted" (cadr p)))
16723 ((equal "" (car p))
16725 (t
16727 (car p) (cadr p)))))
16728 pkg
16732 (defun org-dvipng-color (attr)
16733 "Return an rgb color specification for dvipng."
16734 (apply 'format "rgb %s %s %s"
16735 (mapcar 'org-normalize-color
16736 (color-values (face-attribute 'default attr nil)))))
16738 (defun org-normalize-color (value)
16739 "Return string to be used as color value for an RGB component."
16740 (format "%g" (/ value 65535.0)))
16742 ;; Image display
16745 (defvar org-inline-image-overlays nil)
16746 (make-variable-buffer-local 'org-inline-image-overlays)
16748 (defun org-toggle-inline-images (&optional include-linked)
16749 "Toggle the display of inline images.
16750 INCLUDE-LINKED is passed to `org-display-inline-images'."
16751 (interactive "P")
16752 (if org-inline-image-overlays
16753 (progn
16754 (org-remove-inline-images)
16755 (message "Inline image display turned off"))
16756 (org-display-inline-images include-linked)
16757 (if org-inline-image-overlays
16758 (message "%d images displayed inline"
16759 (length org-inline-image-overlays))
16760 (message "No images to display inline"))))
16762 (defun org-display-inline-images (&optional include-linked refresh beg end)
16763 "Display inline images.
16764 Normally only links without a description part are inlined, because this
16765 is how it will work for export. When INCLUDE-LINKED is set, also links
16766 with a description part will be inlined. This can be nice for a quick
16767 look at those images, but it does not reflect what exported files will look
16768 like.
16769 When REFRESH is set, refresh existing images between BEG and END.
16770 This will create new image displays only if necessary.
16771 BEG and END default to the buffer boundaries."
16772 (interactive "P")
16773 (unless refresh
16774 (org-remove-inline-images)
16775 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16776 (save-excursion
16777 (save-restriction
16778 (widen)
16779 (setq beg (or beg (point-min)) end (or end (point-max)))
16780 (goto-char (point-min))
16782 (substring (org-image-file-name-regexp) 0 -2)
16784 old file ov img)
16785 (while (re-search-forward re end t)
16786 (setq old (get-char-property-and-overlay (match-beginning 1)
16787 'org-image-overlay))
16788 (setq file (expand-file-name
16789 (concat (or (match-string 3) "") (match-string 4))))
16790 (when (file-exists-p file)
16791 (if (and (car-safe old) refresh)
16792 (image-refresh (overlay-get (cdr old) 'display))
16793 (setq img (save-match-data (create-image file)))
16794 (when img
16795 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16796 (overlay-put ov 'display img)
16797 (overlay-put ov 'face 'default)
16798 (overlay-put ov 'org-image-overlay t)
16799 (overlay-put ov 'modification-hooks
16800 (list 'org-display-inline-modification-hook))
16801 (push ov org-inline-image-overlays)))))))))
16803 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16804 "Remove inline-display overlay if a corresponding region is modified."
16805 (let ((inhibit-modification-hooks t))
16806 (when (and ov after)
16807 (delete ov org-inline-image-overlays)
16808 (delete-overlay ov))))
16810 (defun org-remove-inline-images ()
16811 "Remove inline display of images."
16812 (interactive)
16813 (mapc 'delete-overlay org-inline-image-overlays)
16814 (setq org-inline-image-overlays nil))
16816 ;;;; Key bindings
16818 ;; Make `C-c C-x' a prefix key
16819 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16821 ;; TAB key with modifiers
16822 (org-defkey org-mode-map "\C-i" 'org-cycle)
16823 (org-defkey org-mode-map [(tab)] 'org-cycle)
16824 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16825 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16827 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16828 ;; The following line is necessary under Suse GNU/Linux
16829 (unless (featurep 'xemacs)
16830 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16831 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16832 (define-key org-mode-map [backtab] 'org-shifttab)
16834 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16835 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16836 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16838 ;; Cursor keys with modifiers
16839 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16840 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16841 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16842 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16844 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16845 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16846 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16847 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16849 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16850 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16851 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16852 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16854 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16855 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16856 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16857 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16859 ;; Babel keys
16860 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16861 (mapc (lambda (pair)
16862 (define-key org-babel-map (car pair) (cdr pair)))
16863 org-babel-key-bindings)
16865 ;;; Extra keys for tty access.
16866 ;; We only set them when really needed because otherwise the
16867 ;; menus don't show the simple keys
16869 (when (or org-use-extra-keys
16870 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16871 (not window-system))
16872 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16873 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16874 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16875 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16876 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16877 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16878 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16879 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16880 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16881 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16882 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16883 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16884 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16885 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16886 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16887 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16888 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16889 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16890 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16891 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16892 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16893 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16894 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16895 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16896 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16897 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16898 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16899 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16901 ;; All the other keys
16903 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16904 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16905 (if (boundp 'narrow-map)
16906 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16907 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16908 (if (boundp 'narrow-map)
16909 (org-defkey narrow-map "b" 'org-narrow-to-block)
16910 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16911 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16912 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16913 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16914 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16915 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16916 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16917 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16918 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16919 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16920 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16921 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16922 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16923 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16924 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16925 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16926 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16928 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16929 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16930 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16931 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16932 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16933 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16934 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16935 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16936 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16937 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16938 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16939 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16940 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16941 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16942 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16943 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16944 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16945 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16946 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16947 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16949 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16950 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16951 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16952 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16953 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16954 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16955 (org-defkey org-mode-map "\C-c^" 'org-sort)
16956 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16957 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16958 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16959 (org-defkey org-mode-map "\C-m" 'org-return)
16960 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16961 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16962 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16963 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16964 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16965 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16966 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16967 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16968 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16969 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16970 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16971 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16972 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16973 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16974 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16975 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16976 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16977 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16978 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16979 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16980 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16981 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16983 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16984 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16985 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16986 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16988 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16989 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16990 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16991 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16992 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16993 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16994 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16995 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16996 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16997 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16999 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17000 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17001 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17002 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17003 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17004 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17005 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17007 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17008 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17009 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17010 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17011 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17013 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17015 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17017 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17018 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17020 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17023 (when (featurep 'xemacs)
17024 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17027 (defconst org-speed-commands-default
17028 '(
17029 ("Outline Navigation")
17030 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17031 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17032 ("f" . (org-speed-move-safe 'org-forward-same-level))
17033 ("b" . (org-speed-move-safe 'org-backward-same-level))
17034 ("u" . (org-speed-move-safe 'outline-up-heading))
17035 ("j" . org-goto)
17036 ("g" . (org-refile t))
17037 ("Outline Visibility")
17038 ("c" . org-cycle)
17039 ("C" . org-shifttab)
17040 (" " . org-display-outline-path)
17041 ("Outline Structure Editing")
17042 ("U" . org-shiftmetaup)
17043 ("D" . org-shiftmetadown)
17044 ("r" . org-metaright)
17045 ("l" . org-metaleft)
17046 ("R" . org-shiftmetaright)
17047 ("L" . org-shiftmetaleft)
17048 ("i" . (progn (forward-char 1) (call-interactively
17049 'org-insert-heading-respect-content)))
17050 ("^" . org-sort)
17051 ("w" . org-refile)
17052 ("a" . org-archive-subtree-default-with-confirmation)
17053 ("." . org-mark-subtree)
17054 ("Clock Commands")
17055 ("I" . org-clock-in)
17056 ("O" . org-clock-out)
17057 ("Meta Data Editing")
17058 ("t" . org-todo)
17059 ("0" . (org-priority ?\ ))
17060 ("1" . (org-priority ?A))
17061 ("2" . (org-priority ?B))
17062 ("3" . (org-priority ?C))
17063 (";" . org-set-tags-command)
17064 ("e" . org-set-effort)
17065 ("Agenda Views etc")
17066 ("v" . org-agenda)
17067 ("/" . org-sparse-tree)
17068 ("Misc")
17069 ("o" . org-open-at-point)
17070 ("?" . org-speed-command-help)
17071 ("<" . (org-agenda-set-restriction-lock 'subtree))
17072 (">" . (org-agenda-remove-restriction-lock))
17073 )
17074 "The default speed commands.")
17076 (defun org-print-speed-command (e)
17077 (if (> (length (car e)) 1)
17078 (progn
17080 (princ (car e))
17082 (princ (make-string (length (car e)) ?-))
17084 (princ (car e))
17085 (princ " ")
17086 (if (symbolp (cdr e))
17087 (princ (symbol-name (cdr e)))
17088 (prin1 (cdr e)))
17091 (defun org-speed-command-help ()
17092 "Show the available speed commands."
17093 (interactive)
17094 (if (not org-use-speed-commands)
17095 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17096 (with-output-to-temp-buffer "*Help*"
17098 (mapc 'org-print-speed-command org-speed-commands-user)
17101 (mapc 'org-print-speed-command org-speed-commands-default))
17102 (with-current-buffer "*Help*"
17103 (setq truncate-lines t))))
17105 (defun org-speed-move-safe (cmd)
17106 "Execute CMD, but make sure that the cursor always ends up in a headline.
17107 If not, return to the original position and throw an error."
17108 (interactive)
17109 (let ((pos (point)))
17110 (call-interactively cmd)
17111 (unless (and (bolp) (org-on-heading-p))
17112 (goto-char pos)
17113 (error "Boundary reached while executing %s" cmd))))
17115 (defvar org-self-insert-command-undo-counter 0)
17117 (defvar org-table-auto-blank-field) ; defined in org-table.el
17118 (defvar org-speed-command nil)
17120 (defun org-speed-command-default-hook (keys)
17121 "Hook for activating single-letter speed commands.
17122 `org-speed-commands-default' specifies a minimal command set.
17123 Use `org-speed-commands-user' for further customization."
17124 (when (or (and (bolp) (looking-at org-outline-regexp))
17125 (and (functionp org-use-speed-commands)
17126 (funcall org-use-speed-commands)))
17127 (cdr (assoc keys (append org-speed-commands-user
17128 org-speed-commands-default)))))
17130 (defun org-babel-speed-command-hook (keys)
17131 "Hook for activating single-letter code block commands."
17132 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17133 (cdr (assoc keys org-babel-key-bindings))))
17135 (defcustom org-speed-command-hook
17136 '(org-speed-command-default-hook org-babel-speed-command-hook)
17137 "Hook for activating speed commands at strategic locations.
17138 Hook functions are called in sequence until a valid handler is
17139 found.
17141 Each hook takes a single argument, a user-pressed command key
17142 which is also a `self-insert-command' from the global map.
17144 Within the hook, examine the cursor position and the command key
17145 and return nil or a valid handler as appropriate. Handler could
17146 be one of an interactive command, a function, or a form.
17148 Set `org-use-speed-commands' to non-nil value to enable this
17149 hook. The default setting is `org-speed-command-default-hook'."
17150 :group 'org-structure
17151 :type 'hook)
17153 (defun org-self-insert-command (N)
17154 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17155 If the cursor is in a table looking at whitespace, the whitespace is
17156 overwritten, and the table is not marked as requiring realignment."
17157 (interactive "p")
17158 (cond
17159 ((and org-use-speed-commands
17160 (setq org-speed-command
17161 (run-hook-with-args-until-success
17162 'org-speed-command-hook (this-command-keys))))
17163 (cond
17164 ((commandp org-speed-command)
17165 (setq this-command org-speed-command)
17166 (call-interactively org-speed-command))
17167 ((functionp org-speed-command)
17168 (funcall org-speed-command))
17169 ((and org-speed-command (listp org-speed-command))
17170 (eval org-speed-command))
17171 (t (let (org-use-speed-commands)
17172 (call-interactively 'org-self-insert-command)))))
17173 ((and
17174 (org-table-p)
17175 (progn
17176 ;; check if we blank the field, and if that triggers align
17177 (and (featurep 'org-table) org-table-auto-blank-field
17178 (member last-command
17179 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17181 ;; got extra space, this field does not determine column width
17182 (let (org-table-may-need-update) (org-table-blank-field))
17183 ;; no extra space, this field may determine column width
17184 (org-table-blank-field)))
17185 t)
17186 (eq N 1)
17188 (let (org-table-may-need-update)
17189 (goto-char (1- (match-end 0)))
17190 (delete-char -1)
17191 (goto-char (match-beginning 0))
17192 (self-insert-command N)))
17193 (t
17194 (setq org-table-may-need-update t)
17195 (self-insert-command N)
17196 (org-fix-tags-on-the-fly)
17197 (if org-self-insert-cluster-for-undo
17198 (if (not (eq last-command 'org-self-insert-command))
17199 (setq org-self-insert-command-undo-counter 1)
17200 (if (>= org-self-insert-command-undo-counter 20)
17201 (setq org-self-insert-command-undo-counter 1)
17202 (and (> org-self-insert-command-undo-counter 0)
17203 buffer-undo-list (listp buffer-undo-list)
17204 (not (cadr buffer-undo-list)) ; remove nil entry
17205 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17206 (setq org-self-insert-command-undo-counter
17207 (1+ org-self-insert-command-undo-counter))))))))
17209 (defun org-fix-tags-on-the-fly ()
17210 (when (and (equal (char-after (point-at-bol)) ?*)
17211 (org-on-heading-p))
17212 (org-align-tags-here org-tags-column)))
17214 (defun org-delete-backward-char (N)
17215 "Like `delete-backward-char', insert whitespace at field end in tables.
17216 When deleting backwards, in tables this function will insert whitespace in
17218 still be marked for re-alignment if the field did fill the entire column,
17219 because, in this case the deletion might narrow the column."
17220 (interactive "p")
17221 (if (and (org-table-p)
17222 (eq N 1)
17223 (string-match "|" (buffer-substring (point-at-bol) (point)))
17224 (looking-at ".*?|"))
17225 (let ((pos (point))
17227 (c org-table-may-need-update))
17228 (backward-delete-char N)
17229 (if (not overwrite-mode)
17230 (progn
17231 (skip-chars-forward "^|")
17232 (insert " ")
17233 (goto-char (1- pos))))
17234 ;; noalign: if there were two spaces at the end, this field
17235 ;; does not determine the width of the column.
17236 (if noalign (setq org-table-may-need-update c)))
17237 (backward-delete-char N)
17238 (org-fix-tags-on-the-fly)))
17240 (defun org-delete-char (N)
17241 "Like `delete-char', but insert whitespace at field end in tables.
17242 When deleting characters, in tables this function will insert whitespace in
17244 still be marked for re-alignment if the field did fill the entire column,
17245 because, in this case the deletion might narrow the column."
17246 (interactive "p")
17247 (if (and (org-table-p)
17248 (not (bolp))
17249 (not (= (char-after) ?|))
17250 (eq N 1))
17251 (if (looking-at ".*?|")
17252 (let ((pos (point))
17254 (c org-table-may-need-update))
17255 (replace-match (concat
17256 (substring (match-string 0) 1 -1)
17257 " |"))
17258 (goto-char pos)
17259 ;; noalign: if there were two spaces at the end, this field
17260 ;; does not determine the width of the column.
17261 (if noalign (setq org-table-may-need-update c)))
17262 (delete-char N))
17263 (delete-char N)
17264 (org-fix-tags-on-the-fly)))
17266 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17267 (put 'org-self-insert-command 'delete-selection t)
17268 (put 'orgtbl-self-insert-command 'delete-selection t)
17269 (put 'org-delete-char 'delete-selection 'supersede)
17270 (put 'org-delete-backward-char 'delete-selection 'supersede)
17271 (put 'org-yank 'delete-selection 'yank)
17273 ;; Make `flyspell-mode' delay after some commands
17274 (put 'org-self-insert-command 'flyspell-delayed t)
17275 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17276 (put 'org-delete-char 'flyspell-delayed t)
17277 (put 'org-delete-backward-char 'flyspell-delayed t)
17279 ;; Make pabbrev-mode expand after org-mode commands
17280 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17281 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17283 ;; How to do this: Measure non-white length of current string
17284 ;; If equal to column width, we should realign.
17286 (defun org-remap (map &rest commands)
17287 "In MAP, remap the functions given in COMMANDS.
17288 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17289 (let (new old)
17290 (while commands
17291 (setq old (pop commands) new (pop commands))
17292 (if (fboundp 'command-remapping)
17293 (org-defkey map (vector 'remap old) new)
17294 (substitute-key-definition old new map global-map)))))
17296 (when (eq org-enable-table-editor 'optimized)
17297 ;; If the user wants maximum table support, we need to hijack
17298 ;; some standard editing functions
17299 (org-remap org-mode-map
17300 'self-insert-command 'org-self-insert-command
17301 'delete-char 'org-delete-char
17302 'delete-backward-char 'org-delete-backward-char)
17303 (org-defkey org-mode-map "|" 'org-force-self-insert))
17305 (defvar org-ctrl-c-ctrl-c-hook nil
17306 "Hook for functions attaching themselves to `C-c C-c'.
17308 This can be used to add additional functionality to the C-c C-c
17309 key which executes context-dependent commands. This hook is run
17310 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17311 run after the last test.
17313 Each function will be called with no arguments. The function
17314 must check if the context is appropriate for it to act. If yes,
17315 it should do its thing and then return a non-nil value. If the
17316 context is wrong, just do nothing and return nil.")
17318 (defvar org-ctrl-c-ctrl-c-final-hook nil
17319 "Hook for functions attaching themselves to `C-c C-c'.
17321 This can be used to add additional functionality to the C-c C-c
17322 key which executes context-dependent commands. This hook is run
17323 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17324 before the first test.
17326 Each function will be called with no arguments. The function
17327 must check if the context is appropriate for it to act. If yes,
17328 it should do its thing and then return a non-nil value. If the
17329 context is wrong, just do nothing and return nil.")
17331 (defvar org-tab-first-hook nil
17332 "Hook for functions to attach themselves to TAB.
17333 See `org-ctrl-c-ctrl-c-hook' for more information.
17334 This hook runs as the first action when TAB is pressed, even before
17335 `org-cycle' messes around with the `outline-regexp' to cater for
17336 inline tasks and plain list item folding.
17337 If any function in this hook returns t, any other actions that
17338 would have been caused by TAB (such as table field motion or visibility
17339 cycling) will not occur.")
17341 (defvar org-tab-after-check-for-table-hook nil
17342 "Hook for functions to attach themselves to TAB.
17343 See `org-ctrl-c-ctrl-c-hook' for more information.
17344 This hook runs after it has been established that the cursor is not in a
17345 table, but before checking if the cursor is in a headline or if global cycling
17346 should be done.
17347 If any function in this hook returns t, not other actions like visibility
17348 cycling will be done.")
17350 (defvar org-tab-after-check-for-cycling-hook nil
17351 "Hook for functions to attach themselves to TAB.
17352 See `org-ctrl-c-ctrl-c-hook' for more information.
17353 This hook runs after it has been established that not table field motion and
17354 not visibility should be done because of current context. This is probably
17355 the place where a package like yasnippets can hook in.")
17357 (defvar org-tab-before-tab-emulation-hook nil
17358 "Hook for functions to attach themselves to TAB.
17359 See `org-ctrl-c-ctrl-c-hook' for more information.
17360 This hook runs after every other options for TAB have been exhausted, but
17363 (defvar org-metaleft-hook nil
17364 "Hook for functions attaching themselves to `M-left'.
17365 See `org-ctrl-c-ctrl-c-hook' for more information.")
17366 (defvar org-metaright-hook nil
17367 "Hook for functions attaching themselves to `M-right'.
17368 See `org-ctrl-c-ctrl-c-hook' for more information.")
17369 (defvar org-metaup-hook nil
17370 "Hook for functions attaching themselves to `M-up'.
17371 See `org-ctrl-c-ctrl-c-hook' for more information.")
17372 (defvar org-metadown-hook nil
17373 "Hook for functions attaching themselves to `M-down'.
17374 See `org-ctrl-c-ctrl-c-hook' for more information.")
17375 (defvar org-shiftmetaleft-hook nil
17376 "Hook for functions attaching themselves to `M-S-left'.
17377 See `org-ctrl-c-ctrl-c-hook' for more information.")
17378 (defvar org-shiftmetaright-hook nil
17379 "Hook for functions attaching themselves to `M-S-right'.
17380 See `org-ctrl-c-ctrl-c-hook' for more information.")
17381 (defvar org-shiftmetaup-hook nil
17382 "Hook for functions attaching themselves to `M-S-up'.
17383 See `org-ctrl-c-ctrl-c-hook' for more information.")
17384 (defvar org-shiftmetadown-hook nil
17385 "Hook for functions attaching themselves to `M-S-down'.
17386 See `org-ctrl-c-ctrl-c-hook' for more information.")
17387 (defvar org-metareturn-hook nil
17388 "Hook for functions attaching themselves to `M-RET'.
17389 See `org-ctrl-c-ctrl-c-hook' for more information.")
17390 (defvar org-shiftup-hook nil
17391 "Hook for functions attaching themselves to `S-up'.
17392 See `org-ctrl-c-ctrl-c-hook' for more information.")
17393 (defvar org-shiftup-final-hook nil
17394 "Hook for functions attaching themselves to `S-up'.
17395 This one runs after all other options except shift-select have been excluded.
17396 See `org-ctrl-c-ctrl-c-hook' for more information.")
17397 (defvar org-shiftdown-hook nil
17398 "Hook for functions attaching themselves to `S-down'.
17399 See `org-ctrl-c-ctrl-c-hook' for more information.")
17400 (defvar org-shiftdown-final-hook nil
17401 "Hook for functions attaching themselves to `S-down'.
17402 This one runs after all other options except shift-select have been excluded.
17403 See `org-ctrl-c-ctrl-c-hook' for more information.")
17404 (defvar org-shiftleft-hook nil
17405 "Hook for functions attaching themselves to `S-left'.
17406 See `org-ctrl-c-ctrl-c-hook' for more information.")
17407 (defvar org-shiftleft-final-hook nil
17408 "Hook for functions attaching themselves to `S-left'.
17409 This one runs after all other options except shift-select have been excluded.
17410 See `org-ctrl-c-ctrl-c-hook' for more information.")
17411 (defvar org-shiftright-hook nil
17412 "Hook for functions attaching themselves to `S-right'.
17413 See `org-ctrl-c-ctrl-c-hook' for more information.")
17414 (defvar org-shiftright-final-hook nil
17415 "Hook for functions attaching themselves to `S-right'.
17416 This one runs after all other options except shift-select have been excluded.
17417 See `org-ctrl-c-ctrl-c-hook' for more information.")
17419 (defun org-modifier-cursor-error ()
17420 "Throw an error, a modified cursor command was applied in wrong context."
17421 (error "This command is active in special context like tables, headlines or items"))
17423 (defun org-shiftselect-error ()
17424 "Throw an error because Shift-Cursor command was applied in wrong context."
17425 (if (and (boundp 'shift-select-mode) shift-select-mode)
17426 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17427 (error "This command works only in special context like headlines or timestamps")))
17429 (defun org-call-for-shift-select (cmd)
17430 (let ((this-command-keys-shift-translated t))
17431 (call-interactively cmd)))
17433 (defun org-shifttab (&optional arg)
17434 "Global visibility cycling or move to previous table field.
17435 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17436 on context.
17437 See the individual commands for more information."
17438 (interactive "P")
17439 (cond
17440 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17441 ((integerp arg)
17442 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17443 (message "Content view to level: %d" arg)
17444 (org-content (prefix-numeric-value arg2))
17445 (setq org-cycle-global-status 'overview)))
17446 (t (call-interactively 'org-global-cycle))))
17448 (defun org-shiftmetaleft ()
17449 "Promote subtree or delete table column.
17450 Calls `org-promote-subtree', `org-outdent-item',
17451 or `org-table-delete-column', depending on context.
17452 See the individual commands for more information."
17453 (interactive)
17454 (cond
17455 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17456 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17457 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17458 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17459 (t (org-modifier-cursor-error))))
17461 (defun org-shiftmetaright ()
17462 "Demote subtree or insert table column.
17463 Calls `org-demote-subtree', `org-indent-item',
17464 or `org-table-insert-column', depending on context.
17465 See the individual commands for more information."
17466 (interactive)
17467 (cond
17468 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17469 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17470 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17471 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17472 (t (org-modifier-cursor-error))))
17474 (defun org-shiftmetaup (&optional arg)
17475 "Move subtree up or kill table row.
17476 Calls `org-move-subtree-up' or `org-table-kill-row' or
17477 `org-move-item-up' depending on context. See the individual commands
17478 for more information."
17479 (interactive "P")
17480 (cond
17481 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17482 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17483 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17484 ((org-at-item-p) (call-interactively 'org-move-item-up))
17485 (t (org-modifier-cursor-error))))
17487 (defun org-shiftmetadown (&optional arg)
17488 "Move subtree down or insert table row.
17489 Calls `org-move-subtree-down' or `org-table-insert-row' or
17490 `org-move-item-down', depending on context. See the individual
17491 commands for more information."
17492 (interactive "P")
17493 (cond
17494 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17495 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17496 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17497 ((org-at-item-p) (call-interactively 'org-move-item-down))
17498 (t (org-modifier-cursor-error))))
17500 (defsubst org-hidden-tree-error ()
17501 (error
17502 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17504 (defun org-metaleft (&optional arg)
17505 "Promote heading or move table column to left.
17506 Calls `org-do-promote' or `org-table-move-column', depending on context.
17507 With no specific context, calls the Emacs default `backward-word'.
17508 See the individual commands for more information."
17509 (interactive "P")
17510 (cond
17511 ((run-hook-with-args-until-success 'org-metaleft-hook))
17512 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17513 ((org-with-limited-levels
17514 (or (org-on-heading-p)
17515 (and (org-region-active-p)
17516 (save-excursion
17517 (goto-char (region-beginning))
17518 (org-on-heading-p)))))
17519 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17520 (call-interactively 'org-do-promote))
17521 ;; At an inline task.
17522 ((org-on-heading-p)
17523 (call-interactively 'org-inlinetask-promote))
17524 ((or (org-at-item-p)
17525 (and (org-region-active-p)
17526 (save-excursion
17527 (goto-char (region-beginning))
17528 (org-at-item-p))))
17529 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17530 (call-interactively 'org-outdent-item))
17531 (t (call-interactively 'backward-word))))
17533 (defun org-metaright (&optional arg)
17534 "Demote subtree or move table column to right.
17535 Calls `org-do-demote' or `org-table-move-column', depending on context.
17536 With no specific context, calls the Emacs default `forward-word'.
17537 See the individual commands for more information."
17538 (interactive "P")
17539 (cond
17540 ((run-hook-with-args-until-success 'org-metaright-hook))
17541 ((org-at-table-p) (call-interactively 'org-table-move-column))
17542 ((org-with-limited-levels
17543 (or (org-on-heading-p)
17544 (and (org-region-active-p)
17545 (save-excursion
17546 (goto-char (region-beginning))
17547 (org-on-heading-p)))))
17548 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17549 (call-interactively 'org-do-demote))
17550 ;; At an inline task.
17551 ((org-on-heading-p)
17552 (call-interactively 'org-inlinetask-demote))
17553 ((or (org-at-item-p)
17554 (and (org-region-active-p)
17555 (save-excursion
17556 (goto-char (region-beginning))
17557 (org-at-item-p))))
17558 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17559 (call-interactively 'org-indent-item))
17560 (t (call-interactively 'forward-word))))
17562 (defun org-check-for-hidden (what)
17563 "Check if there are hidden headlines/items in the current visual line.
17564 WHAT can be either `headlines' or `items'. If the current line is
17565 an outline or item heading and it has a folded subtree below it,
17566 this function returns t, nil otherwise."
17567 (let ((re (cond
17568 ((eq what 'headlines) org-outline-regexp-bol)
17569 ((eq what 'items) (org-item-beginning-re))
17570 (t (error "This should not happen"))))
17571 beg end)
17572 (save-excursion
17573 (catch 'exit
17574 (unless (org-region-active-p)
17575 (setq beg (point-at-bol))
17576 (beginning-of-line 2)
17577 (while (and (not (eobp)) ;; this is like `next-line'
17578 (get-char-property (1- (point)) 'invisible))
17579 (beginning-of-line 2))
17580 (setq end (point))
17581 (goto-char beg)
17582 (goto-char (point-at-eol))
17583 (setq end (max end (point)))
17584 (while (re-search-forward re end t)
17585 (if (get-char-property (match-beginning 0) 'invisible)
17586 (throw 'exit t))))
17587 nil))))
17589 (defun org-metaup (&optional arg)
17590 "Move subtree up or move table row up.
17591 Calls `org-move-subtree-up' or `org-table-move-row' or
17592 `org-move-item-up', depending on context. See the individual commands
17593 for more information."
17594 (interactive "P")
17595 (cond
17596 ((run-hook-with-args-until-success 'org-metaup-hook))
17597 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17598 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17599 ((org-at-item-p) (call-interactively 'org-move-item-up))
17600 (t (transpose-lines 1) (beginning-of-line -1))))
17602 (defun org-metadown (&optional arg)
17603 "Move subtree down or move table row down.
17604 Calls `org-move-subtree-down' or `org-table-move-row' or
17605 `org-move-item-down', depending on context. See the individual
17606 commands for more information."
17607 (interactive "P")
17608 (cond
17609 ((run-hook-with-args-until-success 'org-metadown-hook))
17610 ((org-at-table-p) (call-interactively 'org-table-move-row))
17611 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17612 ((org-at-item-p) (call-interactively 'org-move-item-down))
17613 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17615 (defun org-shiftup (&optional arg)
17616 "Increase item in timestamp or increase priority of current headline.
17617 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17618 depending on context. See the individual commands for more information."
17619 (interactive "P")
17620 (cond
17621 ((run-hook-with-args-until-success 'org-shiftup-hook))
17622 ((and org-support-shift-select (org-region-active-p))
17623 (org-call-for-shift-select 'previous-line))
17624 ((org-at-timestamp-p t)
17625 (call-interactively (if org-edit-timestamp-down-means-later
17626 'org-timestamp-down 'org-timestamp-up)))
17627 ((and (not (eq org-support-shift-select 'always))
17628 org-enable-priority-commands
17629 (org-on-heading-p))
17630 (call-interactively 'org-priority-up))
17631 ((and (not org-support-shift-select) (org-at-item-p))
17632 (call-interactively 'org-previous-item))
17633 ((org-clocktable-try-shift 'up arg))
17634 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17635 (org-support-shift-select
17636 (org-call-for-shift-select 'previous-line))
17637 (t (org-shiftselect-error))))
17639 (defun org-shiftdown (&optional arg)
17640 "Decrease item in timestamp or decrease priority of current headline.
17641 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17642 depending on context. See the individual commands for more information."
17643 (interactive "P")
17644 (cond
17645 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17646 ((and org-support-shift-select (org-region-active-p))
17647 (org-call-for-shift-select 'next-line))
17648 ((org-at-timestamp-p t)
17649 (call-interactively (if org-edit-timestamp-down-means-later
17650 'org-timestamp-up 'org-timestamp-down)))
17651 ((and (not (eq org-support-shift-select 'always))
17652 org-enable-priority-commands
17653 (org-on-heading-p))
17654 (call-interactively 'org-priority-down))
17655 ((and (not org-support-shift-select) (org-at-item-p))
17656 (call-interactively 'org-next-item))
17657 ((org-clocktable-try-shift 'down arg))
17658 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17659 (org-support-shift-select
17660 (org-call-for-shift-select 'next-line))
17661 (t (org-shiftselect-error))))
17663 (defun org-shiftright (&optional arg)
17664 "Cycle the thing at point or in the current line, depending on context.
17665 Depending on context, this does one of the following:
17667 - switch a timestamp at point one day into the future
17668 - on a headline, switch to the next TODO keyword.
17669 - on an item, switch entire list to the next bullet type
17670 - on a property line, switch to the next allowed value
17671 - on a clocktable definition line, move time block into the future"
17672 (interactive "P")
17673 (cond
17674 ((run-hook-with-args-until-success 'org-shiftright-hook))
17675 ((and org-support-shift-select (org-region-active-p))
17676 (org-call-for-shift-select 'forward-char))
17677 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17678 ((and (not (eq org-support-shift-select 'always))
17679 (org-on-heading-p))
17680 (let ((org-inhibit-logging
17681 (not org-treat-S-cursor-todo-selection-as-state-change))
17682 (org-inhibit-blocking
17683 (not org-treat-S-cursor-todo-selection-as-state-change)))
17684 (org-call-with-arg 'org-todo 'right)))
17685 ((or (and org-support-shift-select
17686 (not (eq org-support-shift-select 'always))
17687 (org-at-item-bullet-p))
17688 (and (not org-support-shift-select) (org-at-item-p)))
17689 (org-call-with-arg 'org-cycle-list-bullet nil))
17690 ((and (not (eq org-support-shift-select 'always))
17691 (org-at-property-p))
17692 (call-interactively 'org-property-next-allowed-value))
17693 ((org-clocktable-try-shift 'right arg))
17694 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17695 (org-support-shift-select
17696 (org-call-for-shift-select 'forward-char))
17697 (t (org-shiftselect-error))))
17699 (defun org-shiftleft (&optional arg)
17700 "Cycle the thing at point or in the current line, depending on context.
17701 Depending on context, this does one of the following:
17703 - switch a timestamp at point one day into the past
17704 - on a headline, switch to the previous TODO keyword.
17705 - on an item, switch entire list to the previous bullet type
17706 - on a property line, switch to the previous allowed value
17707 - on a clocktable definition line, move time block into the past"
17708 (interactive "P")
17709 (cond
17710 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17711 ((and org-support-shift-select (org-region-active-p))
17712 (org-call-for-shift-select 'backward-char))
17713 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17714 ((and (not (eq org-support-shift-select 'always))
17715 (org-on-heading-p))
17716 (let ((org-inhibit-logging
17717 (not org-treat-S-cursor-todo-selection-as-state-change))
17718 (org-inhibit-blocking
17719 (not org-treat-S-cursor-todo-selection-as-state-change)))
17720 (org-call-with-arg 'org-todo 'left)))
17721 ((or (and org-support-shift-select
17722 (not (eq org-support-shift-select 'always))
17723 (org-at-item-bullet-p))
17724 (and (not org-support-shift-select) (org-at-item-p)))
17725 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17726 ((and (not (eq org-support-shift-select 'always))
17727 (org-at-property-p))
17728 (call-interactively 'org-property-previous-allowed-value))
17729 ((org-clocktable-try-shift 'left arg))
17730 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17731 (org-support-shift-select
17732 (org-call-for-shift-select 'backward-char))
17733 (t (org-shiftselect-error))))
17735 (defun org-shiftcontrolright ()
17736 "Switch to next TODO set."
17737 (interactive)
17738 (cond
17739 ((and org-support-shift-select (org-region-active-p))
17740 (org-call-for-shift-select 'forward-word))
17741 ((and (not (eq org-support-shift-select 'always))
17742 (org-on-heading-p))
17743 (org-call-with-arg 'org-todo 'nextset))
17744 (org-support-shift-select
17745 (org-call-for-shift-select 'forward-word))
17746 (t (org-shiftselect-error))))
17748 (defun org-shiftcontrolleft ()
17749 "Switch to previous TODO set."
17750 (interactive)
17751 (cond
17752 ((and org-support-shift-select (org-region-active-p))
17753 (org-call-for-shift-select 'backward-word))
17754 ((and (not (eq org-support-shift-select 'always))
17755 (org-on-heading-p))
17756 (org-call-with-arg 'org-todo 'previousset))
17757 (org-support-shift-select
17758 (org-call-for-shift-select 'backward-word))
17759 (t (org-shiftselect-error))))
17761 (defun org-shiftcontrolup ()
17762 "Change timestamps synchronously up in CLOCK log lines."
17763 (interactive)
17764 (cond ((and (not org-support-shift-select)
17765 (org-at-clock-log-p)
17766 (org-at-timestamp-p t))
17767 (org-clock-timestamps-up))
17768 (t (org-shiftselect-error))))
17770 (defun org-shiftcontroldown ()
17771 "Change timestamps synchronously down in CLOCK log lines."
17772 (interactive)
17773 (cond ((and (not org-support-shift-select)
17774 (org-at-clock-log-p)
17775 (org-at-timestamp-p t))
17776 (org-clock-timestamps-down))
17777 (t (org-shiftselect-error))))
17779 (defun org-ctrl-c-ret ()
17780 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17781 (interactive)
17782 (cond
17783 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17784 (t (call-interactively 'org-insert-heading))))
17786 (defun org-find-visible ()
17787 (let ((s (point)))
17788 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17789 (get-char-property s 'invisible)))
17790 s))
17791 (defun org-find-invisible ()
17792 (let ((s (point)))
17793 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17794 (not (get-char-property s 'invisible))))
17795 s))
17797 (defun org-copy-visible (beg end)
17798 "Copy the visible parts of the region."
17799 (interactive "r")
17800 (let (snippets s)
17801 (save-excursion
17802 (save-restriction
17803 (narrow-to-region beg end)
17804 (setq s (goto-char (point-min)))
17805 (while (not (= (point) (point-max)))
17806 (goto-char (org-find-invisible))
17807 (push (buffer-substring s (point)) snippets)
17808 (setq s (goto-char (org-find-visible))))))
17809 (kill-new (apply 'concat (nreverse snippets)))))
17811 (defun org-copy-special ()
17812 "Copy region in table or copy current subtree.
17813 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17814 See the individual commands for more information."
17815 (interactive)
17816 (call-interactively
17817 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17819 (defun org-cut-special ()
17820 "Cut region in table or cut current subtree.
17821 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17822 See the individual commands for more information."
17823 (interactive)
17824 (call-interactively
17825 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17827 (defun org-paste-special (arg)
17828 "Paste rectangular region into table, or past subtree relative to level.
17829 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17830 See the individual commands for more information."
17831 (interactive "P")
17832 (if (org-at-table-p)
17833 (org-table-paste-rectangle)
17834 (org-paste-subtree arg)))
17836 (defun org-edit-special (&optional arg)
17837 "Call a special editor for the stuff at point.
17838 When at a table, call the formula editor with `org-table-edit-formulas'.
17839 When at the first line of an src example, call `org-edit-src-code'.
17840 When in an #+include line, visit the include file. Otherwise call
17841 `ffap' to visit the file at point."
17842 (interactive)
17843 ;; possibly prep session before editing source
17844 (when arg
17845 (let* ((info (org-babel-get-src-block-info))
17846 (lang (nth 0 info))
17847 (params (nth 2 info))
17848 (session (cdr (assoc :session params))))
17849 (when (and info session) ;; we are in a source-code block with a session
17850 (funcall
17851 (intern (concat "org-babel-prep-session:" lang)) session params))))
17852 (cond ;; proceed with `org-edit-special'
17853 ((save-excursion
17854 (beginning-of-line 1)
17855 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17856 (find-file (org-trim (match-string 1))))
17857 ((org-edit-src-code))
17858 ((org-edit-fixed-width-region))
17859 ((org-at-table.el-p)
17860 (org-edit-src-code))
17861 ((or (org-at-table-p)
17862 (save-excursion
17863 (beginning-of-line 1)
17865 (call-interactively 'org-table-edit-formulas))
17866 (t (call-interactively 'ffap))))
17868 (defun org-ctrl-c-ctrl-c (&optional arg)
17869 "Set tags in headline, or update according to changed information at point.
17871 This command does many different things, depending on context:
17873 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17874 this is what we do.
17876 - If the cursor is on a statistics cookie, update it.
17878 - If the cursor is in a headline, prompt for tags and insert them
17879 into the current line, aligned to `org-tags-column'. When called
17880 with prefix arg, realign all tags in the current buffer.
17882 - If the cursor is in one of the special #+KEYWORD lines, this
17883 triggers scanning the buffer for these lines and updating the
17884 information.
17886 - If the cursor is inside a table, realign the table. This command
17887 works even if the automatic table editor has been turned off.
17889 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17890 the entire table.
17892 - If the cursor is at a footnote reference or definition, jump to
17893 the corresponding definition or references, respectively.
17895 - If the cursor is a the beginning of a dynamic block, update it.
17897 - If the current buffer is a capture buffer, close note and file it.
17899 - If the cursor is on a <<<target>>>, update radio targets and
17900 corresponding links in this buffer.
17902 - If the cursor is on a numbered item in a plain list, renumber the
17903 ordered list.
17905 - If the cursor is on a checkbox, toggle it.
17907 - If the cursor is on a code block, evaluate it. The variable
17908 `org-confirm-babel-evaluate' can be used to control prompting
17909 before code block evaluation, by default every code block
17910 evaluation requires confirmation. Code block evaluation can be
17911 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17912 (interactive "P")
17913 (let ((org-enable-table-editor t))
17914 (cond
17915 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17916 org-occur-highlights
17917 org-latex-fragment-image-overlays)
17918 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17919 (org-remove-occur-highlights)
17920 (org-remove-latex-fragment-image-overlays)
17921 (message "Temporary highlights/overlays removed from current buffer"))
17922 ((and (local-variable-p 'org-finish-function (current-buffer))
17923 (fboundp org-finish-function))
17924 (funcall org-finish-function))
17925 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17926 ((or (looking-at org-property-start-re)
17927 (org-at-property-p))
17928 (call-interactively 'org-property-action))
17929 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17931 (or (org-on-heading-p) (org-at-item-p)))
17932 (call-interactively 'org-update-statistics-cookies))
17933 ((org-on-heading-p) (call-interactively 'org-set-tags))
17934 ((org-at-table.el-p)
17935 (message "Use C-c ' to edit table.el tables"))
17936 ((org-at-table-p)
17937 (org-table-maybe-eval-formula)
17938 (if arg
17939 (call-interactively 'org-table-recalculate)
17940 (org-table-maybe-recalculate-line))
17941 (call-interactively 'org-table-align)
17942 (orgtbl-send-table 'maybe))
17943 ((or (org-footnote-at-reference-p)
17944 (org-footnote-at-definition-p))
17945 (call-interactively 'org-footnote-action))
17946 ((org-at-item-checkbox-p)
17947 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17948 ;; list only if at top item.
17949 (let* ((cbox (match-string 1))
17950 (struct (org-list-struct))
17951 (old-struct (copy-tree struct))
17952 (parents (org-list-parents-alist struct))
17953 (orderedp (org-entry-get nil "ORDERED"))
17954 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17955 block-item)
17956 ;; Use a light version of `org-toggle-checkbox' to avoid
17957 ;; computing list structure twice.
17958 (org-list-set-checkbox (point-at-bol) struct
17959 (cond
17960 ((equal arg '(16)) "[-]")
17961 ((equal arg '(4)) nil)
17962 ((equal "[X]" cbox) "[ ]")
17963 (t "[X]")))
17964 ;; Replicate `org-list-write-struct', while grabbing a return
17965 ;; value from `org-list-struct-fix-box'.
17966 (org-list-struct-fix-ind struct parents 2)
17967 (org-list-struct-fix-item-end struct)
17968 (let ((prevs (org-list-prevs-alist struct)))
17969 (org-list-struct-fix-bul struct prevs)
17970 (org-list-struct-fix-ind struct parents)
17971 (setq block-item
17972 (org-list-struct-fix-box struct parents prevs orderedp)))
17973 (org-list-struct-apply-struct struct old-struct)
17974 (org-update-checkbox-count-maybe)
17975 (when block-item
17976 (message
17977 "Checkboxes were removed due to unchecked box at line %d"
17978 (org-current-line block-item)))
17979 (when firstp (org-list-send-list 'maybe))))
17980 ((org-at-item-p)
17981 ;; Cursor at an item: repair list. Do checkbox related actions
17982 ;; only if function was called with an argument. Send list only
17983 ;; if at top item.
17984 (let* ((struct (org-list-struct))
17985 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17986 (when arg (org-list-set-checkbox (point-at-bol) struct "[ ]"))
17987 (org-list-write-struct struct (org-list-parents-alist struct))
17988 (when arg (org-update-checkbox-count-maybe))
17989 (when firstp (org-list-send-list 'maybe))))
17990 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17991 ;; Dynamic block
17992 (beginning-of-line 1)
17993 (save-excursion (org-update-dblock)))
17994 ((save-excursion
17995 (beginning-of-line 1)
17997 (cond
17998 ((equal (match-string 1) "TBLFM")
17999 ;; Recalculate the table before this line
18000 (save-excursion
18001 (beginning-of-line 1)
18003 (if (org-at-table-p)
18004 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18005 (t
18006 (let ((org-inhibit-startup-visibility-stuff t)
18007 (org-startup-align-all-tables nil))
18008 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18009 (message "Local setup has been refreshed"))))
18010 ((org-clock-update-time-maybe))
18011 (t
18012 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18013 (error "C-c C-c can do nothing useful at this location"))))))
18015 (defun org-mode-restart ()
18016 "Restart Org-mode, to scan again for special lines.
18017 Also updates the keyword regular expressions."
18018 (interactive)
18019 (org-mode)
18020 (message "Org-mode restarted"))
18022 (defun org-kill-note-or-show-branches ()
18023 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18024 (interactive)
18025 (if (not org-finish-function)
18026 (progn
18027 (hide-subtree)
18028 (call-interactively 'show-branches))
18029 (let ((org-note-abort t))
18030 (funcall org-finish-function))))
18032 (defun org-return (&optional indent)
18033 "Goto next table row or insert a newline.
18034 Calls `org-table-next-row' or `newline', depending on context.
18035 See the individual commands for more information."
18036 (interactive)
18037 (cond
18038 ((bobp) (if indent (newline-and-indent) (newline)))
18039 ((org-at-table-p)
18040 (org-table-justify-field-maybe)
18041 (call-interactively 'org-table-next-row))
18042 ;; when `newline-and-indent' is called within a list, make sure
18043 ;; text moved stays inside the item.
18044 ((and (org-in-item-p) indent)
18045 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18046 (progn
18047 (save-match-data (newline))
18048 (org-indent-line-to (length (match-string 0))))
18049 (let ((ind (org-get-indentation)))
18050 (newline)
18051 (if (org-looking-back org-list-end-re)
18052 (org-indent-line-function)
18053 (org-indent-line-to ind)))))
18054 ((and org-return-follows-link
18055 (eq (get-text-property (point) 'face) 'org-link))
18056 (call-interactively 'org-open-at-point))
18057 ((and (org-at-heading-p)
18058 (looking-at
18060 (org-show-entry)
18061 (end-of-line 1)
18062 (newline))
18063 (t (if indent (newline-and-indent) (newline)))))
18065 (defun org-return-indent ()
18066 "Goto next table row or insert a newline and indent.
18067 Calls `org-table-next-row' or `newline-and-indent', depending on
18068 context. See the individual commands for more information."
18069 (interactive)
18070 (org-return t))
18072 (defun org-ctrl-c-star ()
18073 "Compute table, or change heading status of lines.
18074 Calls `org-table-recalculate' or `org-toggle-heading',
18075 depending on context."
18076 (interactive)
18077 (cond
18078 ((org-at-table-p)
18079 (call-interactively 'org-table-recalculate))
18080 (t
18081 ;; Convert all lines in region to list items
18082 (call-interactively 'org-toggle-heading))))
18084 (defun org-ctrl-c-minus ()
18085 "Insert separator line in table or modify bullet status of line.
18086 Also turns a plain line or a region of lines into list items.
18087 Calls `org-table-insert-hline', `org-toggle-item', or
18088 `org-cycle-list-bullet', depending on context."
18089 (interactive)
18090 (cond
18091 ((org-at-table-p)
18092 (call-interactively 'org-table-insert-hline))
18093 ((org-region-active-p)
18094 (call-interactively 'org-toggle-item))
18095 ((org-in-item-p)
18096 (call-interactively 'org-cycle-list-bullet))
18097 (t
18098 (call-interactively 'org-toggle-item))))
18100 (defun org-toggle-item (arg)
18101 "Convert headings or normal lines to items, items to normal lines.
18102 If there is no active region, only the current line is considered.
18104 If the first non blank line in the region is an headline, convert
18105 all headlines to items, shifting text accordingly.
18107 If it is an item, convert all items to normal lines.
18109 If it is normal text, change region into an item. With a prefix
18110 argument ARG, change each line in region into an item."
18111 (interactive "P")
18112 (let ((shift-text
18113 (function
18114 ;; Shift text in current section to IND, from point to END.
18115 ;; The function leaves point to END line.
18116 (lambda (ind end)
18117 (let ((min-i 1000) (end (copy-marker end)))
18118 ;; First determine the minimum indentation (MIN-I) of
18119 ;; the text.
18120 (save-excursion
18121 (catch 'exit
18122 (while (< (point) end)
18123 (let ((i (org-get-indentation)))
18124 (cond
18125 ;; Skip blank lines and inline tasks.
18127 ((looking-at org-outline-regexp-bol))
18128 ;; We can't find less than 0 indentation.
18129 ((zerop i) (throw 'exit (setq min-i 0)))
18130 ((< i min-i) (setq min-i i))))
18131 (forward-line))))
18132 ;; Then indent each line so that a line indented to
18133 ;; MIN-I becomes indented to IND. Ignore blank lines
18134 ;; and inline tasks in the process.
18135 (let ((delta (- ind min-i)))
18136 (while (< (point) end)
18138 (looking-at org-outline-regexp-bol))
18139 (org-indent-line-to (+ (org-get-indentation) delta)))
18140 (forward-line)))))))
18141 (skip-blanks
18142 (function
18143 ;; Return beginning of first non-blank line, starting from
18144 ;; line at POS.
18145 (lambda (pos)
18146 (save-excursion
18147 (goto-char pos)
18149 (point-at-bol)))))
18150 beg end)
18151 ;; Determine boundaries of changes.
18152 (if (org-region-active-p)
18153 (setq beg (funcall skip-blanks (region-beginning))
18154 end (copy-marker (region-end)))
18155 (setq beg (funcall skip-blanks (point-at-bol))
18156 end (copy-marker (point-at-eol))))
18157 ;; Depending on the starting line, choose an action on the text
18158 ;; between BEG and END.
18159 (org-with-limited-levels
18160 (save-excursion
18161 (goto-char beg)
18162 (cond
18163 ;; Case 1. Start at an item: de-itemize. Note that it only
18164 ;; happens when a region is active: `org-ctrl-c-minus'
18165 ;; would call `org-cycle-list-bullet' otherwise.
18166 ((org-at-item-p)
18167 (while (< (point) end)
18168 (when (org-at-item-p)
18170 (delete-region (point) (match-end 0)))
18171 (forward-line)))
18172 ;; Case 2. Start at an heading: convert to items.
18173 ((org-on-heading-p)
18174 (let* ((bul (org-list-bullet-string "-"))
18175 (bul-len (length bul))
18176 ;; Indentation of the first heading. It should be
18177 ;; relative to the indentation of its parent, if any.
18178 (start-ind (save-excursion
18179 (cond
18180 ((not org-adapt-indentation) 0)
18181 ((not (outline-previous-heading)) 0)
18182 (t (length (match-string 0))))))
18183 ;; Level of first heading. Further headings will be
18184 ;; compared to it to determine hierarchy in the list.
18185 (ref-level (org-reduced-level (org-outline-level))))
18186 (while (< (point) end)
18187 (let* ((level (org-reduced-level (org-outline-level)))
18188 (delta (max 0 (- level ref-level))))
18189 ;; If current headline is less indented than the first
18190 ;; one, set it as reference, in order to preserve
18191 ;; subtrees.
18192 (when (< level ref-level) (setq ref-level level))
18193 (replace-match bul t t)
18194 (org-indent-line-to (+ start-ind (* delta bul-len)))
18195 ;; Ensure all text down to END (or SECTION-END) belongs
18196 ;; to the newly created item.
18197 (let ((section-end (save-excursion
18198 (or (outline-next-heading) (point)))))
18199 (forward-line)
18200 (funcall shift-text
18201 (+ start-ind (* (1+ delta) bul-len))
18202 (min end section-end)))))))
18203 ;; Case 3. Normal line with ARG: turn each non-item line into
18204 ;; an item.
18205 (arg
18206 (while (< (point) end)
18207 (unless (or (org-on-heading-p) (org-at-item-p))
18209 (replace-match
18211 (forward-line)))
18212 ;; Case 4. Normal line without ARG: make the first line of
18213 ;; region an item, and shift indentation of others
18214 ;; lines to set them as item's body.
18215 (t (let* ((bul (org-list-bullet-string "-"))
18216 (bul-len (length bul))
18217 (ref-ind (org-get-indentation)))
18219 (insert bul)
18220 (forward-line)
18221 (while (< (point) end)
18222 ;; Ensure that lines less indented than first one
18223 ;; still get included in item body.
18224 (funcall shift-text
18225 (+ ref-ind bul-len)
18226 (min end (save-excursion (or (outline-next-heading)
18227 (point)))))
18228 (forward-line)))))))))
18230 (defun org-toggle-heading (&optional nstars)
18231 "Convert headings to normal text, or items or text to headings.
18232 If there is no active region, only the current line is considered.
18234 If the first non blank line is an headline, remove the stars from
18235 all headlines in the region.
18237 If it is a plain list item, turn all plain list items into headings.
18239 If it is a normal line, turn each and every normal line (i.e. not
18240 an heading or an item) in the region into a heading.
18242 When converting a line into a heading, the number of stars is chosen
18243 such that the lines become children of the current entry. However,
18244 when a prefix argument is given, its value determines the number of
18245 stars to add."
18246 (interactive "P")
18247 (let ((skip-blanks
18248 (function
18249 ;; Return beginning of first non-blank line, starting from
18250 ;; line at POS.
18251 (lambda (pos)
18252 (save-excursion
18253 (goto-char pos)
18255 (point-at-bol)))))
18256 beg end)
18257 ;; Determine boundaries of changes. If region ends at a bol, do
18258 ;; not consider the last line to be in the region.
18259 (if (org-region-active-p)
18260 (setq beg (funcall skip-blanks (region-beginning))
18261 end (copy-marker (save-excursion
18262 (goto-char (region-end))
18263 (if (bolp) (point) (point-at-eol)))))
18264 (setq beg (funcall skip-blanks (point-at-bol))
18265 end (copy-marker (point-at-eol))))
18266 ;; Ensure inline tasks don't count as headings.
18267 (org-with-limited-levels
18268 (save-excursion
18269 (goto-char beg)
18270 (cond
18271 ;; Case 1. Started at an heading: de-star headings.
18272 ((org-on-heading-p)
18273 (while (< (point) end)
18274 (when (org-on-heading-p t)
18275 (looking-at org-outline-regexp) (replace-match ""))
18276 (forward-line)))
18277 ;; Case 2. Started at an item: change items into headlines.
18278 ;; One star will be added by `org-list-to-subtree'.
18279 ((org-at-item-p)
18280 (let* ((stars (make-string
18281 (if nstars
18282 ;; subtract the star that will be added again by
18283 ;; `org-list-to-subtree'
18284 (1- (prefix-numeric-value current-prefix-arg))
18285 (or (org-current-level) 0))
18286 ?*))
18287 (add-stars
18288 (cond (nstars "") ; stars from prefix only
18289 ((equal stars "") "") ; before first heading
18290 (org-odd-levels-only "*") ; inside heading, odd
18291 (t "")))) ; inside heading, oddeven
18292 (while (< (point) end)
18293 (when (org-at-item-p)
18294 ;; Pay attention to cases when region ends before list.
18295 (let* ((struct (org-list-struct))
18296 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18297 (save-restriction
18298 (narrow-to-region (point) list-end)
18299 (insert
18300 (org-list-to-subtree
18301 (org-list-parse-list t)
18302 '(:istart (concat stars add-stars (funcall get-stars depth))
18303 :icount (concat stars add-stars (funcall get-stars depth))))))))
18304 (forward-line))))
18305 ;; Case 3. Started at normal text: make every line an heading,
18306 ;; skipping headlines and items.
18307 (t (let* ((stars (make-string
18308 (if nstars
18309 (prefix-numeric-value current-prefix-arg)
18310 (or (org-current-level) 0))
18311 ?*))
18312 (add-stars
18313 (cond (nstars "") ; stars from prefix only
18314 ((equal stars "") "*") ; before first heading
18315 (org-odd-levels-only "**") ; inside heading, odd
18316 (t "*"))) ; inside heading, oddeven
18317 (rpl (concat stars add-stars " ")))
18318 (while (< (point) end)
18319 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18321 (replace-match (concat rpl (match-string 2))))
18322 (forward-line)))))))))
18324 (defun org-meta-return (&optional arg)
18325 "Insert a new heading or wrap a region in a table.
18326 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18327 See the individual commands for more information."
18328 (interactive "P")
18329 (cond
18330 ((run-hook-with-args-until-success 'org-metareturn-hook))
18331 ((org-at-table-p)
18332 (call-interactively 'org-table-wrap-region))
18333 (t (call-interactively 'org-insert-heading))))
18335 ;;; Menu entries
18337 ;; Define the Org-mode menus
18338 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18339 '("Tbl"
18340 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18341 ["Next Field" org-cycle (org-at-table-p)]
18342 ["Previous Field" org-shifttab (org-at-table-p)]
18343 ["Next Row" org-return (org-at-table-p)]
18344 "--"
18345 ["Blank Field" org-table-blank-field (org-at-table-p)]
18346 ["Edit Field" org-table-edit-field (org-at-table-p)]
18347 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18348 "--"
18349 ("Column"
18350 ["Move Column Left" org-metaleft (org-at-table-p)]
18351 ["Move Column Right" org-metaright (org-at-table-p)]
18352 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18353 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18354 ("Row"
18355 ["Move Row Up" org-metaup (org-at-table-p)]
18356 ["Move Row Down" org-metadown (org-at-table-p)]
18357 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18358 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18359 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18360 "--"
18361 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18362 ("Rectangle"
18363 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18364 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18365 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18366 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18367 "--"
18368 ("Calculate"
18369 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18370 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18371 ["Edit Formulas" org-edit-special (org-at-table-p)]
18372 "--"
18373 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18374 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18375 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18376 "--"
18377 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18378 "--"
18379 ["Sum Column/Rectangle" org-table-sum
18380 (or (org-at-table-p) (org-region-active-p))]
18381 ["Which Column?" org-table-current-column (org-at-table-p)])
18382 ["Debug Formulas"
18383 org-table-toggle-formula-debugger
18384 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18385 ["Show Col/Row Numbers"
18386 org-table-toggle-coordinate-overlays
18387 :style toggle
18388 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18389 "--"
18390 ["Create" org-table-create (and (not (org-at-table-p))
18391 org-enable-table-editor)]
18392 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18393 ["Import from File" org-table-import (not (org-at-table-p))]
18394 ["Export to File" org-table-export (org-at-table-p)]
18395 "--"
18396 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18398 (easy-menu-define org-org-menu org-mode-map "Org menu"
18399 '("Org"
18400 ("Show/Hide"
18401 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18402 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18403 ["Sparse Tree..." org-sparse-tree t]
18404 ["Reveal Context" org-reveal t]
18405 ["Show All" show-all t]
18406 "--"
18407 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18408 "--"
18409 ["New Heading" org-insert-heading t]
18410 ("Navigate Headings"
18411 ["Up" outline-up-heading t]
18412 ["Next" outline-next-visible-heading t]
18413 ["Previous" outline-previous-visible-heading t]
18414 ["Next Same Level" outline-forward-same-level t]
18415 ["Previous Same Level" outline-backward-same-level t]
18416 "--"
18417 ["Jump" org-goto t])
18418 ("Edit Structure"
18419 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18420 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18421 "--"
18422 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18423 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18424 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18425 "--"
18426 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18427 "--"
18428 ["Copy visible text" org-copy-visible t]
18429 "--"
18430 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18431 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18432 ["Demote Heading" org-metaright (not (org-at-table-p))]
18433 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18434 "--"
18435 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18436 "--"
18437 ["Convert to odd levels" org-convert-to-odd-levels t]
18438 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18439 ("Editing"
18440 ["Emphasis..." org-emphasize t]
18441 ["Edit Source Example" org-edit-special t]
18442 "--"
18443 ["Footnote new/jump" org-footnote-action t]
18444 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18445 ("Archive"
18446 ["Archive (default method)" org-archive-subtree-default t]
18447 "--"
18448 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18449 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18450 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18451 )
18452 "--"
18453 ("Hyperlinks"
18454 ["Store Link (Global)" org-store-link t]
18455 ["Find existing link to here" org-occur-link-in-agenda-files t]
18456 ["Insert Link" org-insert-link t]
18457 ["Follow Link" org-open-at-point t]
18458 "--"
18459 ["Next link" org-next-link t]
18460 ["Previous link" org-previous-link t]
18461 "--"
18462 ["Descriptive Links"
18463 org-toggle-link-display
18464 :style radio
18465 :selected org-descriptive-links
18466 ]
18467 ["Literal Links"
18468 org-toggle-link-display
18469 :style radio
18470 :selected (not org-descriptive-links)])
18471 "--"
18472 ("TODO Lists"
18473 ["TODO/DONE/-" org-todo t]
18474 ("Select keyword"
18475 ["Next keyword" org-shiftright (org-on-heading-p)]
18476 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18477 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18478 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18479 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18480 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18481 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18482 "--"
18483 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18484 :selected org-enforce-todo-dependencies :style toggle :active t]
18485 "Settings for tree at point"
18486 ["Do Children sequentially" org-toggle-ordered-property :style radio
18487 :selected (org-entry-get nil "ORDERED")
18488 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18489 ["Do Children parallel" org-toggle-ordered-property :style radio
18490 :selected (not (org-entry-get nil "ORDERED"))
18491 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18492 "--"
18493 ["Set Priority" org-priority t]
18494 ["Priority Up" org-shiftup t]
18495 ["Priority Down" org-shiftdown t]
18496 "--"
18497 ["Get news from all feeds" org-feed-update-all t]
18498 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18499 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18500 ("TAGS and Properties"
18501 ["Set Tags" org-set-tags-command t]
18502 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18503 "--"
18504 ["Set property" org-set-property t]
18505 ["Column view of properties" org-columns t]
18506 ["Insert Column View DBlock" org-insert-columns-dblock t])
18507 ("Dates and Scheduling"
18508 ["Timestamp" org-time-stamp t]
18509 ["Timestamp (inactive)" org-time-stamp-inactive t]
18510 ("Change Date"
18511 ["1 Day Later" org-shiftright t]
18512 ["1 Day Earlier" org-shiftleft t]
18513 ["1 ... Later" org-shiftup t]
18514 ["1 ... Earlier" org-shiftdown t])
18515 ["Compute Time Range" org-evaluate-time-range t]
18516 ["Schedule Item" org-schedule t]
18517 ["Deadline" org-deadline t]
18518 "--"
18519 ["Custom time format" org-toggle-time-stamp-overlays
18520 :style radio :selected org-display-custom-times]
18521 "--"
18522 ["Goto Calendar" org-goto-calendar t]
18523 ["Date from Calendar" org-date-from-calendar t]
18524 "--"
18525 ["Start/Restart Timer" org-timer-start t]
18526 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18527 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18528 ["Insert Timer String" org-timer t]
18529 ["Insert Timer Item" org-timer-item t])
18530 ("Logging work"
18531 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18532 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18533 ["Clock out" org-clock-out t]
18534 ["Clock cancel" org-clock-cancel t]
18535 "--"
18536 ["Mark as default task" org-clock-mark-default-task t]
18537 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18538 ["Goto running clock" org-clock-goto t]
18539 "--"
18540 ["Display times" org-clock-display t]
18541 ["Create clock table" org-clock-report t]
18542 "--"
18543 ["Record DONE time"
18544 (progn (setq org-log-done (not org-log-done))
18545 (message "Switching to %s will %s record a timestamp"
18546 (car org-done-keywords)
18547 (if org-log-done "automatically" "not")))
18548 :style toggle :selected org-log-done])
18549 "--"
18550 ["Agenda Command..." org-agenda t]
18551 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18552 ("File List for Agenda")
18553 ("Special views current file"
18554 ["TODO Tree" org-show-todo-tree t]
18555 ["Check Deadlines" org-check-deadlines t]
18556 ["Timeline" org-timeline t]
18557 ["Tags/Property tree" org-match-sparse-tree t])
18558 "--"
18559 ["Export/Publish..." org-export t]
18560 ("LaTeX"
18561 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18562 :selected org-cdlatex-mode]
18563 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18564 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18565 ["Modify math symbol" org-cdlatex-math-modify
18566 (org-inside-LaTeX-fragment-p)]
18567 ["Insert citation" org-reftex-citation t]
18568 "--"
18569 ["Template for BEAMER" org-insert-beamer-options-template t])
18570 "--"
18571 ("MobileOrg"
18572 ["Push Files and Views" org-mobile-push t]
18573 ["Get Captured and Flagged" org-mobile-pull t]
18574 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18575 "--"
18576 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18577 "--"
18578 ("Documentation"
18579 ["Show Version" org-version t]
18580 ["Info Documentation" org-info t])
18581 ("Customize"
18582 ["Browse Org Group" org-customize t]
18583 "--"
18584 ["Expand This Menu" org-create-customize-menu
18585 (fboundp 'customize-menu-create)])
18586 ["Send bug report" org-submit-bug-report t]
18587 "--"
18588 ("Refresh/Reload"
18589 ["Refresh setup current buffer" org-mode-restart t]
18590 ["Reload Org (after update)" org-reload t]
18591 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18592 ))
18594 (defun org-info (&optional node)
18595 "Read documentation for Org-mode in the info system.
18596 With optional NODE, go directly to that node."
18597 (interactive)
18598 (info (format "(org)%s" (or node ""))))
18600 ;;;###autoload
18601 (defun org-submit-bug-report ()
18602 "Submit a bug report on Org-mode via mail.
18604 Don't hesitate to report any problems or inaccurate documentation.
18606 If you don't have setup sending mail from (X)Emacs, please copy the
18607 output buffer into your mail program, as it gives us important
18608 information about your Org-mode version and configuration."
18609 (interactive)
18610 (require 'reporter)
18611 (org-load-modules-maybe)
18612 (org-require-autoloaded-modules)
18613 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18614 (reporter-submit-bug-report
18615 "emacs-orgmode@gnu.org"
18616 (org-version)
18617 (let (list)
18618 (save-window-excursion
18619 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18620 (delete-other-windows)
18621 (erase-buffer)
18622 (insert "You are about to submit a bug report to the Org-mode mailing list.
18624 We would like to add your full Org-mode and Outline configuration to the
18625 bug report. This greatly simplifies the work of the maintainer and
18626 other experts on the mailing list.
18628 HOWEVER, some variables you have customized may contain private
18629 information. The names of customers, colleagues, or friends, might
18630 appear in the form of file names, tags, todo states, or search strings.
18631 If you answer yes to the prompt, you might want to check and remove
18632 such private information before sending the email.")
18633 (add-text-properties (point-min) (point-max) '(face org-warning))
18634 (when (yes-or-no-p "Include your Org-mode configuration ")
18635 (mapatoms
18636 (lambda (v)
18637 (and (boundp v)
18639 (or (and (symbol-value v)
18641 (and
18642 (get v 'custom-type) (get v 'standard-value)
18643 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18644 (push v list)))))
18645 (kill-buffer (get-buffer "*Warn about privacy*"))
18646 list))
18647 nil nil
18648 "Remember to cover the basics, that is, what you expected to happen and
18649 what in fact did happen. You don't know how to make a good report? See
18651 http://orgmode.org/manual/Feedback.html#Feedback
18653 Your bug report will be posted to the Org-mode mailing list.
18654 ------------------------------------------------------------------------")
18655 (save-excursion
18660 (defun org-install-agenda-files-menu ()
18661 (let ((bl (buffer-list)))
18662 (save-excursion
18663 (while bl
18664 (set-buffer (pop bl))
18665 (if (org-mode-p) (setq bl nil)))
18666 (when (org-mode-p)
18667 (easy-menu-change
18668 '("Org") "File List for Agenda"
18669 (append
18670 (list
18671 ["Edit File List" (org-edit-agenda-file-list) t]
18672 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18673 ["Remove Current File from List" org-remove-file t]
18674 ["Cycle through agenda files" org-cycle-agenda-files t]
18675 ["Occur in all agenda files" org-occur-in-agenda-files t]
18676 "--")
18677 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18679 ;;;; Documentation
18681 ;;;###autoload
18682 (defun org-require-autoloaded-modules ()
18683 (interactive)
18684 (mapc 'require
18685 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18686 org-docbook org-exp org-html org-icalendar
18687 org-id org-latex
18688 org-publish org-remember org-table
18689 org-timer org-xoxo)))
18691 ;;;###autoload
18692 (defun org-reload (&optional uncompiled)
18693 "Reload all org lisp files.
18694 With prefix arg UNCOMPILED, load the uncompiled versions."
18695 (interactive "P")
18696 (require 'find-func)
18698 (dir-org (file-name-directory (org-find-library-name "org")))
18699 (dir-org-contrib (ignore-errors
18700 (file-name-directory
18701 (org-find-library-name "org-contribdir"))))
18702 (babel-files
18703 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18704 (append (list nil "comint" "eval" "exp" "keys"
18705 "lob" "ref" "table" "tangle")
18706 (delq nil
18707 (mapcar
18708 (lambda (lang)
18709 (when (cdr lang) (symbol-name (car lang))))
18710 org-babel-load-languages)))))
18711 (files
18712 (append (directory-files dir-org t file-re)
18713 babel-files
18714 (and dir-org-contrib
18715 (directory-files dir-org-contrib t file-re))))
18716 (remove-re (concat (if (featurep 'xemacs)
18717 "org-colview" "org-colview-xemacs")
18719 (setq files (mapcar 'file-name-sans-extension files))
18720 (setq files (mapcar
18721 (lambda (x) (if (string-match remove-re x) nil x))
18722 files))
18723 (setq files (delq nil files))
18724 (mapc
18725 (lambda (f)
18726 (when (featurep (intern (file-name-nondirectory f)))
18727 (if (and (not uncompiled)
18728 (file-exists-p (concat f ".elc")))
18729 (load (concat f ".elc") nil nil t)
18730 (load (concat f ".el") nil nil t))))
18731 files))
18732 (org-version))
18734 ;;;###autoload
18735 (defun org-customize ()
18736 "Call the customize function with org as argument."
18737 (interactive)
18738 (org-load-modules-maybe)
18739 (org-require-autoloaded-modules)
18740 (customize-browse 'org))
18742 (defun org-create-customize-menu ()
18743 "Create a full customization menu for Org-mode, insert it into the menu."
18744 (interactive)
18745 (org-load-modules-maybe)
18746 (org-require-autoloaded-modules)
18747 (if (fboundp 'customize-menu-create)
18748 (progn
18749 (easy-menu-change
18750 '("Org") "Customize"
18751 `(["Browse Org group" org-customize t]
18752 "--"
18753 ,(customize-menu-create 'org)
18754 ["Set" Custom-set t]
18755 ["Save" Custom-save t]
18756 ["Reset to Current" Custom-reset-current t]
18757 ["Reset to Saved" Custom-reset-saved t]
18758 ["Reset to Standard Settings" Custom-reset-standard t]))
18760 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18762 ;;;; Miscellaneous stuff
18764 ;;; Generally useful functions
18766 (defun org-get-at-bol (property)
18767 "Get text property PROPERTY at beginning of line."
18768 (get-text-property (point-at-bol) property))
18770 (defun org-find-text-property-in-string (prop s)
18771 "Return the first non-nil value of property PROP in string S."
18772 (or (get-text-property 0 prop s)
18773 (get-text-property (or (next-single-property-change 0 prop s) 0)
18774 prop s)))
18776 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18777 "Display the given MESSAGE as a warning."
18778 (if (fboundp 'display-warning)
18779 (display-warning 'org message
18780 (if (featurep 'xemacs) 'warning :warning))
18781 (let ((buf (get-buffer-create "*Org warnings*")))
18782 (with-current-buffer buf
18783 (goto-char (point-max))
18784 (insert "Warning (Org): " message)
18785 (unless (bolp)
18786 (newline)))
18787 (display-buffer buf)
18788 (sit-for 0))))
18790 (defun org-eval (form)
18791 "Eval FORM and return result."
18792 (condition-case error
18793 (eval form)
18794 (error (format "%%![Error: %s]" error))))
18796 (defun org-in-commented-line ()
18797 "Is point in a line starting with `#'?"
18798 (equal (char-after (point-at-bol)) ?#))
18800 (defun org-in-indented-comment-line ()
18801 "Is point in a line starting with `#' after some white space?"
18802 (save-excursion
18803 (save-match-data
18804 (goto-char (point-at-bol))
18807 (defun org-in-verbatim-emphasis ()
18808 (save-match-data
18809 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18811 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18812 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18813 (if (and marker (marker-buffer marker)
18814 (buffer-live-p (marker-buffer marker)))
18815 (progn
18816 (org-pop-to-buffer-same-window (marker-buffer marker))
18817 (if (or (> marker (point-max)) (< marker (point-min)))
18818 (widen))
18819 (goto-char marker)
18820 (org-show-context 'org-goto))
18821 (if bookmark
18822 (bookmark-jump bookmark)
18823 (error "Cannot find location"))))
18825 (defun org-quote-csv-field (s)
18826 "Quote field for inclusion in CSV material."
18829 s))
18831 (defun org-force-self-insert (N)
18832 "Needed to enforce self-insert under remapping."
18833 (interactive "p")
18834 (self-insert-command N))
18836 (defun org-string-width (s)
18837 "Compute width of string, ignoring invisible characters.
18838 This ignores character with invisibility property `org-link', and also
18839 characters with property `org-cwidth', because these will become invisible
18840 upon the next fontification round."
18841 (let (b l)
18842 (when (or (eq t buffer-invisibility-spec)
18843 (assq 'org-link buffer-invisibility-spec))
18844 (while (setq b (text-property-any 0 (length s)
18845 'invisible 'org-link s))
18846 (setq s (concat (substring s 0 b)
18847 (substring s (or (next-single-property-change
18848 b 'invisible s) (length s)))))))
18849 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18850 (setq s (concat (substring s 0 b)
18851 (substring s (or (next-single-property-change
18852 b 'org-cwidth s) (length s))))))
18853 (setq l (string-width s) b -1)
18854 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18855 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18856 l))
18858 (defun org-shorten-string (s maxlength)
18859 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18860 If the string is shorter or has length MAXLENGTH, just return the
18861 original string. If it is longer, the functions finds a space in the
18862 string, breaks this string off at that locations and adds three dots
18863 as ellipsis. Including the ellipsis, the string will not be longer
18864 than MAXLENGTH. If finding a good breaking point in the string does
18865 not work, the string is just chopped off in the middle of a word
18866 if necessary."
18867 (if (<= (length s) maxlength)
18868 s
18869 (let* ((n (max (- maxlength 4) 1))
18871 (if (string-match re s)
18872 (concat (match-string 1 s) "...")
18873 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18875 (defun org-get-indentation (&optional line)
18876 "Get the indentation of the current line, interpreting tabs.
18877 When LINE is given, assume it represents a line and compute its indentation."
18878 (if line
18879 (if (string-match "^ *" (org-remove-tabs line))
18880 (match-end 0))
18881 (save-excursion
18882 (beginning-of-line 1)
18884 (current-column))))
18886 (defun org-get-string-indentation (s)
18887 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18888 (let ((n -1) (i 0) (w tab-width) c)
18889 (catch 'exit
18890 (while (< (setq n (1+ n)) (length s))
18891 (setq c (aref s n))
18892 (cond ((= c ?\ ) (setq i (1+ i)))
18894 (t (throw 'exit t)))))
18895 i))
18897 (defun org-remove-tabs (s &optional width)
18898 "Replace tabulators in S with spaces.
18899 Assumes that s is a single line, starting in column 0."
18900 (setq width (or width tab-width))
18902 (setq s (replace-match
18903 (make-string
18904 (- (* width (/ (+ (match-beginning 0) width) width))
18905 (match-beginning 0)) ?\ )
18906 t t s)))
18907 s)
18909 (defun org-fix-indentation (line ind)
18910 "Fix indentation in LINE.
18911 IND is a cons cell with target and minimum indentation.
18912 If the current indentation in LINE is smaller than the minimum,
18913 leave it alone. If it is larger than ind, set it to the target."
18914 (let* ((l (org-remove-tabs line))
18915 (i (org-get-indentation l))
18916 (i1 (car ind)) (i2 (cdr ind)))
18917 (if (>= i i2) (setq l (substring line i2)))
18918 (if (> i1 0)
18919 (concat (make-string i1 ?\ ) l)
18920 l)))
18922 (defun org-remove-indentation (code &optional n)
18923 "Remove the maximum common indentation from the lines in CODE.
18924 N may optionally be the number of spaces to remove."
18925 (with-temp-buffer
18926 (insert code)
18927 (org-do-remove-indentation n)
18928 (buffer-string)))
18930 (defun org-do-remove-indentation (&optional n)
18931 "Remove the maximum common indentation from the buffer."
18932 (untabify (point-min) (point-max))
18933 (let ((min 10000) re)
18934 (if n
18935 (setq min n)
18936 (goto-char (point-min))
18938 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18939 (unless (or (= min 0) (= min 10000))
18941 (goto-char (point-min))
18942 (while (re-search-forward re nil t)
18943 (replace-match "")
18944 (end-of-line 1))
18945 min)))
18947 (defun org-fill-template (template alist)
18948 "Find each %key of ALIST in TEMPLATE and replace it."
18949 (let ((case-fold-search nil)
18950 entry key value)
18951 (setq alist (sort (copy-sequence alist)
18952 (lambda (a b) (< (length (car a)) (length (car b))))))
18953 (while (setq entry (pop alist))
18954 (setq template
18955 (replace-regexp-in-string
18956 (concat "%" (regexp-quote (car entry)))
18957 (cdr entry) template t t)))
18958 template))
18960 (defun org-base-buffer (buffer)
18961 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18962 (if (not buffer)
18963 buffer
18964 (or (buffer-base-buffer buffer)
18965 buffer)))
18967 (defun org-trim (s)
18968 "Remove whitespace at beginning and end of string."
18971 s)
18973 (defun org-wrap (string &optional width lines)
18974 "Wrap string to either a number of lines, or a width in characters.
18975 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18976 that costs. If there is a word longer than WIDTH, the text is actually
18977 wrapped to the length of that word.
18978 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18979 many lines, whatever width that takes.
18980 The return value is a list of lines, without newlines at the end."
18982 (maxword (apply 'max (mapcar 'org-string-width words)))
18983 w ll)
18984 (cond (width
18985 (org-do-wrap words (max maxword width)))
18986 (lines
18987 (setq w maxword)
18988 (setq ll (org-do-wrap words maxword))
18989 (if (<= (length ll) lines)
18990 ll
18991 (setq ll words)
18992 (while (> (length ll) lines)
18993 (setq w (1+ w))
18994 (setq ll (org-do-wrap words w)))
18995 ll))
18996 (t (error "Cannot wrap this")))))
18998 (defun org-do-wrap (words width)
18999 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19000 (let (lines line)
19001 (while words
19002 (setq line (pop words))
19003 (while (and words (< (+ (length line) (length (car words))) width))
19004 (setq line (concat line " " (pop words))))
19005 (setq lines (push line lines)))
19006 (nreverse lines)))
19008 (defun org-split-string (string &optional separators)
19009 "Splits STRING into substrings at SEPARATORS.
19010 No empty strings are returned if there are matches at the beginning
19011 and end of string."
19013 (start 0)
19014 notfirst
19015 (list nil))
19016 (while (and (string-match rexp string
19017 (if (and notfirst
19018 (= start (match-beginning 0))
19019 (< start (length string)))
19020 (1+ start) start))
19021 (< (match-beginning 0) (length string)))
19022 (setq notfirst t)
19023 (or (eq (match-beginning 0) 0)
19024 (and (eq (match-beginning 0) (match-end 0))
19025 (eq (match-beginning 0) start))
19026 (setq list
19027 (cons (substring string start (match-beginning 0))
19028 list)))
19029 (setq start (match-end 0)))
19030 (or (eq start (length string))
19031 (setq list
19032 (cons (substring string start)
19033 list)))
19034 (nreverse list)))
19036 (defun org-quote-vert (s)
19038 (while (string-match "|" s)
19040 s)
19042 (defun org-uuidgen-p (s)
19043 "Is S an ID created by UUIDGEN?"
19044 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19046 (defun org-context ()
19047 "Return a list of contexts of the current cursor position.
19048 If several contexts apply, all are returned.
19049 Each context entry is a list with a symbol naming the context, and
19050 two positions indicating start and end of the context. Possible
19051 contexts are:
19053 :headline anywhere in a headline
19054 :headline-stars on the leading stars in a headline
19055 :todo-keyword on a TODO keyword (including DONE) in a headline
19056 :tags on the TAGS in a headline
19057 :priority on the priority cookie in a headline
19058 :item on the first line of a plain list item
19059 :item-bullet on the bullet/number of a plain list item
19060 :checkbox on the checkbox in a plain list item
19061 :table in an org-mode table
19062 :table-special on a special filed in a table
19063 :table-table in a table.el table
19064 :link on a hyperlink
19065 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19066 :target on a <<target>>
19067 :radio-target on a <<<radio-target>>>
19068 :latex-fragment on a LaTeX fragment
19069 :latex-preview on a LaTeX fragment with overlayed preview image
19071 This function expects the position to be visible because it uses font-lock
19072 faces as a help to recognize the following contexts: :table-special, :link,
19073 and :keyword."
19074 (let* ((f (get-text-property (point) 'face))
19075 (faces (if (listp f) f (list f)))
19076 (p (point)) clist o)
19077 ;; First the large context
19078 (cond
19079 ((org-on-heading-p t)
19080 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19081 (when (progn
19082 (beginning-of-line 1)
19083 (looking-at org-todo-line-tags-regexp))
19084 (push (org-point-in-group p 1 :headline-stars) clist)
19085 (push (org-point-in-group p 2 :todo-keyword) clist)
19086 (push (org-point-in-group p 4 :tags) clist))
19087 (goto-char p)
19090 (push (org-point-in-group p 0 :priority) clist)))
19092 ((org-at-item-p)
19093 (push (org-point-in-group p 2 :item-bullet) clist)
19094 (push (list :item (point-at-bol)
19095 (save-excursion (org-end-of-item) (point)))
19096 clist)
19097 (and (org-at-item-checkbox-p)
19098 (push (org-point-in-group p 0 :checkbox) clist)))
19100 ((org-at-table-p)
19101 (push (list :table (org-table-begin) (org-table-end)) clist)
19102 (if (memq 'org-formula faces)
19103 (push (list :table-special
19104 (previous-single-property-change p 'face)
19105 (next-single-property-change p 'face)) clist)))
19106 ((org-at-table-p 'any)
19107 (push (list :table-table) clist)))
19108 (goto-char p)
19110 ;; Now the small context
19111 (cond
19112 ((org-at-timestamp-p)
19113 (push (org-point-in-group p 0 :timestamp) clist))
19114 ((memq 'org-link faces)
19115 (push (list :link
19116 (previous-single-property-change p 'face)
19117 (next-single-property-change p 'face)) clist))
19118 ((memq 'org-special-keyword faces)
19119 (push (list :keyword
19120 (previous-single-property-change p 'face)
19121 (next-single-property-change p 'face)) clist))
19122 ((org-on-target-p)
19123 (push (org-point-in-group p 0 :target) clist)
19124 (goto-char (1- (match-beginning 0)))
19125 (if (looking-at org-radio-target-regexp)
19126 (push (org-point-in-group p 0 :radio-target) clist))
19127 (goto-char p))
19128 ((setq o (car (delq nil
19129 (mapcar
19130 (lambda (x)
19131 (if (memq x org-latex-fragment-image-overlays) x))
19132 (overlays-at (point))))))
19133 (push (list :latex-fragment
19134 (overlay-start o) (overlay-end o)) clist)
19135 (push (list :latex-preview
19136 (overlay-start o) (overlay-end o)) clist))
19137 ((org-inside-LaTeX-fragment-p)
19138 ;; FIXME: positions wrong.
19139 (push (list :latex-fragment (point) (point)) clist)))
19141 (setq clist (nreverse (delq nil clist)))
19142 clist))
19144 ;; FIXME: Compare with at-regexp-p Do we need both?
19145 (defun org-in-regexp (re &optional nlines visually)
19146 "Check if point is inside a match of regexp.
19147 Normally only the current line is checked, but you can include NLINES extra
19148 lines both before and after point into the search.
19149 If VISUALLY is set, require that the cursor is not after the match but
19150 really on, so that the block visually is on the match."
19151 (catch 'exit
19152 (let ((pos (point))
19153 (eol (point-at-eol (+ 1 (or nlines 0))))
19154 (inc (if visually 1 0)))
19155 (save-excursion
19156 (beginning-of-line (- 1 (or nlines 0)))
19157 (while (re-search-forward re eol t)
19158 (if (and (<= (match-beginning 0) pos)
19159 (>= (+ inc (match-end 0)) pos))
19160 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19162 (defun org-at-regexp-p (regexp)
19163 "Is point inside a match of REGEXP in the current line?"
19164 (catch 'exit
19165 (save-excursion
19166 (let ((pos (point)) (end (point-at-eol)))
19167 (beginning-of-line 1)
19168 (while (re-search-forward regexp end t)
19169 (if (and (<= (match-beginning 0) pos)
19170 (>= (match-end 0) pos))
19171 (throw 'exit t)))
19172 nil))))
19174 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19175 "Non-nil when point is between matches of START-RE and END-RE.
19177 Also return a non-nil value when point is on one of the matches.
19179 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19180 buffer positions. Default values are the positions of headlines
19181 surrounding the point.
19183 The functions returns a cons cell whose car (resp. cdr) is the
19184 position before START-RE (resp. after END-RE)."
19185 (save-match-data
19186 (let ((pos (point))
19187 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19188 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19189 beg end)
19190 (save-excursion
19191 ;; Point is on a block when on START-RE or if START-RE can be
19192 ;; found before it...
19193 (and (or (org-at-regexp-p start-re)
19194 (re-search-backward start-re limit-up t))
19195 (setq beg (match-beginning 0))
19196 ;; ... and END-RE after it...
19197 (goto-char (match-end 0))
19198 (re-search-forward end-re limit-down t)
19199 (> (setq end (match-end 0)) pos)
19200 ;; ... without another START-RE in-between.
19201 (goto-char (match-beginning 0))
19202 (not (re-search-backward start-re (1+ beg) t))
19203 ;; Return value.
19204 (cons beg end))))))
19206 (defun org-in-block-p (names)
19207 "Is point inside any block whose name belongs to NAMES?
19209 NAMES is a list of strings containing names of blocks."
19210 (save-match-data
19211 (catch 'exit
19212 (let ((case-fold-search t)
19213 (lim-up (save-excursion (outline-previous-heading)))
19214 (lim-down (save-excursion (outline-next-heading))))
19215 (mapc (lambda (name)
19216 (let ((n (regexp-quote name)))
19217 (when (org-between-regexps-p
19220 lim-up lim-down)
19221 (throw 'exit t))))
19222 names))
19223 nil)))
19225 (defun org-occur-in-agenda-files (regexp &optional nlines)
19226 "Call `multi-occur' with buffers for all agenda files."
19228 (let* ((files (org-agenda-files))
19229 (tnames (mapcar 'file-truename files))
19230 (extra org-agenda-text-search-extra-files)
19231 f)
19232 (when (eq (car extra) 'agenda-archives)
19233 (setq extra (cdr extra))
19234 (setq files (org-add-archive-files files)))
19235 (while (setq f (pop extra))
19236 (unless (member (file-truename f) tnames)
19237 (add-to-list 'files f 'append)
19238 (add-to-list 'tnames (file-truename f) 'append)))
19239 (multi-occur
19240 (mapcar (lambda (x)
19241 (with-current-buffer
19242 (or (get-file-buffer x) (find-file-noselect x))
19243 (widen)
19244 (current-buffer)))
19245 files)
19246 regexp)))
19248 (if (boundp 'occur-mode-find-occurrence-hook)
19249 ;; Emacs 23
19250 (add-hook 'occur-mode-find-occurrence-hook
19251 (lambda ()
19252 (when (org-mode-p)
19253 (org-reveal))))
19254 ;; Emacs 22
19255 (defadvice occur-mode-goto-occurrence
19256 (after org-occur-reveal activate)
19257 (and (org-mode-p) (org-reveal)))
19258 (defadvice occur-mode-goto-occurrence-other-window
19259 (after org-occur-reveal activate)
19260 (and (org-mode-p) (org-reveal)))
19261 (defadvice occur-mode-display-occurrence
19262 (after org-occur-reveal activate)
19263 (when (org-mode-p)
19264 (let ((pos (occur-mode-find-occurrence)))
19265 (with-current-buffer (marker-buffer pos)
19266 (save-excursion
19267 (goto-char pos)
19268 (org-reveal)))))))
19270 (defun org-occur-link-in-agenda-files ()
19271 "Create a link and search for it in the agendas.
19272 The link is not stored in `org-stored-links', it is just created
19273 for the search purpose."
19274 (interactive)
19275 (let ((link (condition-case nil
19276 (org-store-link nil)
19277 (error "Unable to create a link to here"))))
19278 (org-occur-in-agenda-files (regexp-quote link))))
19280 (defun org-uniquify (list)
19281 "Remove duplicate elements from LIST."
19282 (let (res)
19283 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19284 res))
19286 (defun org-delete-all (elts list)
19287 "Remove all elements in ELTS from LIST."
19288 (while elts
19289 (setq list (delete (pop elts) list)))
19290 list)
19292 (defun org-count (cl-item cl-seq)
19293 "Count the number of occurrences of ITEM in SEQ.
19294 Taken from `count' in cl-seq.el with all keyword arguments removed."
19295 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19296 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19297 (while (< cl-start cl-end)
19298 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19299 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19300 (setq cl-start (1+ cl-start)))
19301 cl-count))
19303 (defun org-remove-if (predicate seq)
19304 "Remove everything from SEQ that fulfills PREDICATE."
19305 (let (res e)
19306 (while seq
19307 (setq e (pop seq))
19308 (if (not (funcall predicate e)) (push e res)))
19309 (nreverse res)))
19311 (defun org-remove-if-not (predicate seq)
19312 "Remove everything from SEQ that does not fulfill PREDICATE."
19313 (let (res e)
19314 (while seq
19315 (setq e (pop seq))
19316 (if (funcall predicate e) (push e res)))
19317 (nreverse res)))
19319 (defun org-back-over-empty-lines ()
19320 "Move backwards over whitespace, to the beginning of the first empty line.
19321 Returns the number of empty lines passed."
19322 (let ((pos (point)))
19323 (if (cdr (assoc 'heading org-blank-before-new-entry))
19325 (unless (eobp)
19326 (forward-line -1)))
19327 (beginning-of-line 2)
19328 (goto-char (min (point) pos))
19329 (count-lines (point) pos)))
19331 (defun org-skip-whitespace ()
19334 (defun org-point-in-group (point group &optional context)
19335 "Check if POINT is in match-group GROUP.
19336 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19337 match. If the match group does not exist or point is not inside it,
19338 return nil."
19339 (and (match-beginning group)
19340 (>= point (match-beginning group))
19341 (<= point (match-end group))
19342 (if context
19343 (list context (match-beginning group) (match-end group))
19344 t)))
19346 (defun org-switch-to-buffer-other-window (&rest args)
19347 "Switch to buffer in a second window on the current frame.
19348 In particular, do not allow pop-up frames.
19349 Returns the newly created buffer."
19350 (let (pop-up-frames special-display-buffer-names special-display-regexps
19351 special-display-function)
19352 (apply 'switch-to-buffer-other-window args)))
19354 (defun org-combine-plists (&rest plists)
19355 "Create a single property list from all plists in PLISTS.
19356 The process starts by copying the first list, and then setting properties
19357 from the other lists. Settings in the last list are the most significant
19358 ones and overrule settings in the other lists."
19359 (let ((rtn (copy-sequence (pop plists)))
19360 p v ls)
19361 (while plists
19362 (setq ls (pop plists))
19363 (while ls
19364 (setq p (pop ls) v (pop ls))
19365 (setq rtn (plist-put rtn p v))))
19366 rtn))
19368 (defun org-move-line-down (arg)
19369 "Move the current line down. With prefix argument, move it past ARG lines."
19370 (interactive "p")
19371 (let ((col (current-column))
19372 beg end pos)
19373 (beginning-of-line 1) (setq beg (point))
19374 (beginning-of-line 2) (setq end (point))
19375 (beginning-of-line (+ 1 arg))
19376 (setq pos (move-marker (make-marker) (point)))
19377 (insert (delete-and-extract-region beg end))
19378 (goto-char pos)
19379 (org-move-to-column col)))
19381 (defun org-move-line-up (arg)
19382 "Move the current line up. With prefix argument, move it past ARG lines."
19383 (interactive "p")
19384 (let ((col (current-column))
19385 beg end pos)
19386 (beginning-of-line 1) (setq beg (point))
19387 (beginning-of-line 2) (setq end (point))
19388 (beginning-of-line (- arg))
19389 (setq pos (move-marker (make-marker) (point)))
19390 (insert (delete-and-extract-region beg end))
19391 (goto-char pos)
19392 (org-move-to-column col)))
19394 (defun org-replace-escapes (string table)
19395 "Replace %-escapes in STRING with values in TABLE.
19397 The sequences in STRING may contain normal field width and padding information,
19399 so values can contain further %-escapes if they are define later in TABLE."
19400 (let ((tbl (copy-alist table))
19401 (case-fold-search nil)
19402 (pchg 0)
19403 e re rpl)
19404 (while (setq e (pop tbl))
19405 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19406 (when (and (cdr e) (string-match re (cdr e)))
19407 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19408 (safe "SREF"))
19409 (add-text-properties 0 3 (list 'sref sref) safe)
19410 (setcdr e (replace-match safe t t (cdr e)))))
19411 (while (string-match re string)
19412 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19413 (cdr e)))
19414 (setq string (replace-match rpl t t string))))
19415 (while (setq pchg (next-property-change pchg string))
19416 (let ((sref (get-text-property pchg 'sref string)))
19417 (when (and sref (string-match "SREF" string pchg))
19418 (setq string (replace-match sref t t string)))))
19419 string))
19421 (defun org-sublist (list start end)
19422 "Return a section of LIST, from START to END.
19423 Counting starts at 1."
19424 (let (rtn (c start))
19425 (setq list (nthcdr (1- start) list))
19426 (while (and list (<= c end))
19427 (push (pop list) rtn)
19428 (setq c (1+ c)))
19429 (nreverse rtn)))
19431 (defun org-find-base-buffer-visiting (file)
19432 "Like `find-buffer-visiting' but always return the base buffer and
19433 not an indirect buffer."
19434 (let ((buf (or (get-file-buffer file)
19435 (find-buffer-visiting file))))
19436 (if buf
19437 (or (buffer-base-buffer buf) buf)
19438 nil)))
19440 (defun org-image-file-name-regexp (&optional extensions)
19441 "Return regexp matching the file names of images.
19442 If EXTENSIONS is given, only match these."
19443 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19444 (image-file-name-regexp)
19445 (let ((image-file-name-extensions
19446 (or extensions
19447 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19448 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19450 (regexp-opt (nconc (mapcar 'upcase
19451 image-file-name-extensions)
19452 image-file-name-extensions)
19453 t)
19456 (defun org-file-image-p (file &optional extensions)
19457 "Return non-nil if FILE is an image."
19458 (save-match-data
19459 (string-match (org-image-file-name-regexp extensions) file)))
19461 (defun org-get-cursor-date ()
19462 "Return the date at cursor in as a time.
19463 This works in the calendar and in the agenda, anywhere else it just
19464 returns the current time."
19465 (let (date day defd)
19466 (cond
19467 ((eq major-mode 'calendar-mode)
19468 (setq date (calendar-cursor-to-date)
19469 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19470 ((eq major-mode 'org-agenda-mode)
19471 (setq day (get-text-property (point) 'day))
19472 (if day
19473 (setq date (calendar-gregorian-from-absolute day)
19474 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19475 (nth 2 date))))))
19476 (or defd (current-time))))
19478 (defvar org-agenda-action-marker (make-marker)
19479 "Marker pointing to the entry for the next agenda action.")
19481 (defun org-mark-entry-for-agenda-action ()
19482 "Mark the current entry as target of an agenda action.
19483 Agenda actions are actions executed from the agenda with the key `k',
19484 which make use of the date at the cursor."
19485 (interactive)
19486 (move-marker org-agenda-action-marker
19487 (save-excursion (org-back-to-heading t) (point))
19488 (current-buffer))
19489 (message
19490 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19492 (defun org-mark-subtree ()
19493 "Mark the current subtree.
19494 This puts point at the start of the current subtree, and mark at the end.
19496 If point is in an inline task, mark that task instead."
19497 (interactive)
19498 (let ((inline-task-p
19499 (and (featurep 'org-inlinetask)
19500 (org-inlinetask-in-task-p)))
19501 (beg))
19502 ;; Get beginning of subtree
19503 (cond
19504 (inline-task-p (org-inlinetask-goto-beginning))
19505 ((org-at-heading-p) (beginning-of-line))
19506 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19507 (setq beg (point))
19508 ;; Get end of it
19509 (if inline-task-p
19510 (org-inlinetask-goto-end)
19511 (org-end-of-subtree))
19512 ;; Mark zone
19513 (push-mark (point) nil t)
19514 (goto-char beg)))
19516 ;;; Paragraph filling stuff.
19517 ;; We want this to be just right, so use the full arsenal.
19519 (defun org-indent-line-function ()
19520 "Indent line depending on context."
19521 (interactive)
19522 (let* ((pos (point))
19523 (itemp (org-at-item-p))
19524 (case-fold-search t)
19526 (inline-task-p (and (featurep 'org-inlinetask)
19527 (org-inlinetask-in-task-p)))
19528 (inline-re (and inline-task-p
19529 (org-inlinetask-outline-regexp)))
19530 column)
19531 (beginning-of-line 1)
19532 (cond
19533 ;; Comments
19534 ((looking-at "# ") (setq column 0))
19535 ;; Headings
19536 ((looking-at org-outline-regexp) (setq column 0))
19537 ;; Included files
19539 ;; Footnote definition
19540 ((looking-at org-footnote-definition-re) (setq column 0))
19541 ;; Literal examples
19543 (setq column (org-get-indentation))) ; do nothing
19544 ;; Lists
19545 ((ignore-errors (goto-char (org-in-item-p)))
19546 (setq column (if itemp
19547 (org-get-indentation)
19548 (org-list-item-body-column (point))))
19549 (goto-char pos))
19550 ;; Drawers
19552 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19553 (save-excursion
19554 (goto-char (1- (match-beginning 1)))
19555 (setq column (current-column))))
19556 ;; Special blocks
19558 (save-excursion
19559 (re-search-backward
19561 (setq column (org-get-indentation (match-string 0))))
19564 (save-excursion
19566 (setq column
19567 (cond ((equal (downcase (match-string 1)) "src")
19568 ;; src blocks: let `org-edit-src-exit' handle them
19569 (org-get-indentation))
19570 ((equal (downcase (match-string 1)) "example")
19571 (max (org-get-indentation)
19572 (org-get-indentation (match-string 0))))
19573 (t
19574 (org-get-indentation (match-string 0))))))
19575 ;; This line has nothing special, look at the previous relevant
19576 ;; line to compute indentation
19577 (t
19578 (beginning-of-line 0)
19579 (while (and (not (bobp))
19580 (not (looking-at org-drawer-regexp))
19581 ;; When point started in an inline task, do not move
19582 ;; above task starting line.
19583 (not (and inline-task-p (looking-at inline-re)))
19584 ;; Skip drawers, blocks, empty lines, verbatim,
19585 ;; comments, tables, footnotes definitions, lists,
19586 ;; inline tasks.
19588 (re-search-backward org-drawer-regexp nil t))
19592 (looking-at org-footnote-definition-re)
19593 (and (ignore-errors (goto-char (org-in-item-p)))
19594 (goto-char
19595 (org-list-get-top-point (org-list-struct))))
19596 (and (not inline-task-p)
19597 (featurep 'org-inlinetask)
19598 (org-inlinetask-in-task-p)
19599 (or (org-inlinetask-goto-beginning) t))))
19600 (beginning-of-line 0))
19601 (cond
19602 ;; There was an heading above.
19604 (if (not org-adapt-indentation)
19605 (setq column 0)
19606 (goto-char (match-end 0))
19607 (setq column (current-column))))
19608 ;; A drawer had started and is unfinished
19609 ((looking-at org-drawer-regexp)
19610 (goto-char (1- (match-beginning 1)))
19611 (setq column (current-column)))
19612 ;; Else, nothing noticeable found: get indentation and go on.
19613 (t (setq column (org-get-indentation))))))
19614 ;; Now apply indentation and move cursor accordingly
19615 (goto-char pos)
19616 (if (<= (current-column) (current-indentation))
19617 (org-indent-line-to column)
19618 (save-excursion (org-indent-line-to column)))
19619 ;; Special polishing for properties, see `org-property-format'
19620 (setq column (current-column))
19621 (beginning-of-line 1)
19622 (if (looking-at
19624 (replace-match (concat (match-string 1)
19625 (format org-property-format
19626 (match-string 2) (match-string 3)))
19627 t t))
19628 (org-move-to-column column)))
19630 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19631 "Variable to store copy of `adaptive-fill-regexp'.
19632 Since `adaptive-fill-regexp' is set to never match, we need to
19633 store a backup of its value before entering `org-mode' so that
19634 the functionality can be provided as a fall-back.")
19636 (defun org-set-autofill-regexps ()
19637 (interactive)
19638 ;; In the paragraph separator we include headlines, because filling
19639 ;; text in a line directly attached to a headline would otherwise
19640 ;; fill the headline as well.
19643 ;; The paragraph starter includes hand-formatted lists.
19644 (org-set-local
19645 'paragraph-start
19646 (concat
19655 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19656 ;; But only if the user has not turned off tables or fixed-width regions
19657 (org-set-local
19658 'auto-fill-inhibit-regexp
19659 (concat org-outline-regexp
19662 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19663 (concat
19665 (if org-enable-table-editor "|" "")
19666 (if org-enable-fixed-width-editor ":" "")
19667 "]"))))
19668 ;; We use our own fill-paragraph function, to make sure that tables
19669 ;; and fixed-width regions are not wrapped. That function will pass
19670 ;; through to `fill-paragraph' when appropriate.
19671 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19672 ;; Prevent auto-fill from inserting unwanted new items.
19673 (org-set-local 'fill-nobreak-predicate
19674 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19675 fill-nobreak-predicate
19676 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19677 ;; Adaptive filling: To get full control, first make sure that
19678 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19679 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19680 (org-set-local 'org-adaptive-fill-regexp-backup
19681 adaptive-fill-regexp))
19683 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19684 (org-set-local 'adaptive-fill-function
19685 'org-adaptive-fill-function)
19686 (org-set-local
19687 'align-mode-rules-list
19688 '((org-in-buffer-settings
19690 (modes . '(org-mode))))))
19692 (defun org-fill-item-nobreak-p ()
19693 "Non-nil when a line break at point would insert a new item."
19694 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19696 (defun org-fill-paragraph (&optional justify)
19697 "Re-align a table, pass through to fill-paragraph if no table."
19698 (let ((table-p (org-at-table-p))
19699 (table.el-p (org-at-table.el-p))
19700 (itemp (org-in-item-p)))
19701 (cond ((and (equal (char-after (point-at-bol)) ?*)
19702 (save-excursion (goto-char (point-at-bol))
19703 (looking-at org-outline-regexp)))
19704 t) ; skip headlines
19705 (table.el-p t) ; skip table.el tables
19706 (table-p (org-table-align) t) ; align Org tables
19707 (itemp ; align text in items
19708 (let* ((struct (save-excursion (goto-char itemp)
19709 (org-list-struct)))
19710 (parents (org-list-parents-alist struct))
19711 (children (org-list-get-children itemp struct parents))
19712 beg end prev next prefix)
19713 ;; Determine in which part of item point is: before
19714 ;; first child, after last child, between two
19715 ;; sub-lists, or simply in item if there's no child.
19716 (cond
19717 ((not children)
19718 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19719 beg itemp
19720 end (org-list-get-item-end itemp struct)))
19721 ((< (point) (setq next (car children)))
19722 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19723 beg itemp
19724 end next))
19725 ((> (point) (setq prev (car (last children))))
19726 (setq beg (org-list-get-item-end prev struct)
19727 end (org-list-get-item-end itemp struct)
19728 prefix (save-excursion
19729 (goto-char beg)
19731 (make-string (current-column) ?\ ))))
19732 (t (catch 'exit
19733 (while (setq next (pop children))
19734 (if (> (point) next)
19735 (setq prev next)
19736 (setq beg (org-list-get-item-end prev struct)
19737 end next
19738 prefix (save-excursion
19739 (goto-char beg)
19741 (make-string (current-column) ?\ )))
19742 (throw 'exit nil))))))
19743 ;; Use `fill-paragraph' with buffer narrowed to item
19744 ;; without any child, and with our computed PREFIX.
19745 (flet ((fill-context-prefix (from to &optional flr) prefix))
19746 (save-restriction
19747 (narrow-to-region beg end)
19748 (save-excursion (fill-paragraph justify)))) t))
19749 ;; Special case where point is not in a list but is on
19750 ;; a paragraph adjacent to a list: make sure this paragraph
19751 ;; doesn't get merged with the end of the list by narrowing
19752 ;; buffer first.
19753 ((save-excursion (forward-paragraph -1)
19754 (setq itemp (org-in-item-p)))
19755 (let ((struct (save-excursion (goto-char itemp)
19756 (org-list-struct))))
19757 (save-restriction
19758 (narrow-to-region (org-list-get-bottom-point struct)
19759 (save-excursion (forward-paragraph 1)
19760 (point)))
19761 (fill-paragraph justify) t)))
19762 ;; Else simply call `fill-paragraph'.
19763 (t nil))))
19765 ;; For reference, this is the default value of adaptive-fill-regexp
19768 (defun org-adaptive-fill-function ()
19769 "Return a fill prefix for org-mode files."
19770 (let (itemp)
19771 (save-excursion
19772 (cond
19773 ;; Comment line
19775 (match-string-no-properties 0))
19776 ;; Plain list item
19777 ((org-at-item-p)
19778 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19779 ;; Point is in a list after `backward-paragraph': original
19780 ;; point wasn't in the list, or filling would have been taken
19781 ;; care of by `org-auto-fill-function', but the list and the
19782 ;; real paragraph are not separated by a blank line. Thus, move
19783 ;; point after the list to go back to real paragraph and
19784 ;; determine fill-prefix.
19785 ((setq itemp (org-in-item-p))
19786 (goto-char itemp)
19787 (let* ((struct (org-list-struct))
19788 (bottom (org-list-get-bottom-point struct)))
19789 (goto-char bottom)
19790 (make-string (org-get-indentation) ?\ )))
19791 ;; Other text
19792 ((looking-at org-adaptive-fill-regexp-backup)
19793 (match-string-no-properties 0))))))
19795 (defun org-auto-fill-function ()
19796 "Auto-fill function."
19797 (let (itemp prefix)
19798 ;; When in a list, compute an appropriate fill-prefix and make
19799 ;; sure it will be used by `do-auto-fill'.
19800 (if (setq itemp (org-in-item-p))
19801 (progn
19802 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19803 (flet ((fill-context-prefix (from to &optional flr) prefix))
19804 (do-auto-fill)))
19805 ;; Else just use `do-auto-fill'.
19806 (do-auto-fill))))
19808 ;;; Other stuff.
19810 (defun org-toggle-fixed-width-section (arg)
19811 "Toggle the fixed-width export.
19812 If there is no active region, the QUOTE keyword at the current headline is
19813 inserted or removed. When present, it causes the text between this headline
19814 and the next to be exported as fixed-width text, and unmodified.
19815 If there is an active region, this command adds or removes a colon as the
19816 first character of this line. If the first character of a line is a colon,
19817 this line is also exported in fixed-width font."
19818 (interactive "P")
19819 (let* ((cc 0)
19820 (regionp (org-region-active-p))
19821 (beg (if regionp (region-beginning) (point)))
19822 (end (if regionp (region-end)))
19823 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19824 (case-fold-search nil)
19826 off)
19827 (if regionp
19828 (save-excursion
19829 (goto-char beg)
19830 (setq cc (current-column))
19831 (beginning-of-line 1)
19832 (setq off (looking-at re))
19833 (while (> nlines 0)
19834 (setq nlines (1- nlines))
19835 (beginning-of-line 1)
19836 (cond
19837 (arg
19838 (org-move-to-column cc t)
19840 (forward-line -1))
19841 ((and off (looking-at re))
19842 (replace-match "" t t nil 1))
19843 ((not off) (org-move-to-column cc t) (insert ": ")))
19844 (forward-line 1)))
19845 (save-excursion
19846 (org-back-to-heading)
19847 (if (looking-at (concat org-outline-regexp
19849 (replace-match "" t t nil 1)
19850 (if (looking-at org-outline-regexp)
19851 (progn
19852 (goto-char (match-end 0))
19853 (insert org-quote-string " "))))))))
19855 (defun org-reftex-citation ()
19856 "Use reftex-citation to insert a citation into the buffer.
19857 This looks for a line like
19859 #+BIBLIOGRAPHY: foo plain option:-d
19861 and derives from it that foo.bib is the bibliography file relevant
19862 for this document. It then installs the necessary environment for RefTeX
19863 to work in this buffer and calls `reftex-citation' to insert a citation
19864 into the buffer.
19866 Export of such citations to both LaTeX and HTML is handled by the contributed
19867 package org-exp-bibtex by Taru Karttunen."
19868 (interactive)
19869 (let ((reftex-docstruct-symbol 'rds)
19871 rds bib)
19872 (save-excursion
19873 (save-restriction
19874 (widen)
19875 (let ((case-fold-search t)
19877 (if (not (save-excursion
19878 (or (re-search-forward re nil t)
19879 (re-search-backward re nil t))))
19880 (error "No bibliography defined in file")
19881 (setq bib (concat (match-string 1) ".bib")
19882 rds (list (list 'bib bib)))))))
19883 (call-interactively 'reftex-citation)))
19885 ;;;; Functions extending outline functionality
19887 (defun org-beginning-of-line (&optional arg)
19888 "Go to the beginning of the current line. If that is invisible, continue
19889 to a visible line beginning. This makes the function of C-a more intuitive.
19890 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19891 first attempt, and only move to after the tags when the cursor is already
19892 beyond the end of the headline."
19893 (interactive "P")
19894 (let ((pos (point))
19895 (special (if (consp org-special-ctrl-a/e)
19896 (car org-special-ctrl-a/e)
19897 org-special-ctrl-a/e))
19898 refpos)
19899 (if (org-bound-and-true-p line-move-visual)
19900 (beginning-of-visual-line 1)
19901 (beginning-of-line 1))
19902 (if (and arg (fboundp 'move-beginning-of-line))
19903 (call-interactively 'move-beginning-of-line)
19904 (if (bobp)
19905 nil
19906 (backward-char 1)
19907 (if (org-truely-invisible-p)
19908 (while (and (not (bobp)) (org-truely-invisible-p))
19909 (backward-char 1)
19910 (beginning-of-line 1))
19911 (forward-char 1))))
19912 (when special
19913 (cond
19914 ((and (looking-at org-complex-heading-regexp)
19915 (= (char-after (match-end 1)) ?\ ))
19916 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19917 (point-at-eol)))
19918 (goto-char
19919 (if (eq special t)
19920 (cond ((> pos refpos) refpos)
19921 ((= pos (point)) refpos)
19922 (t (point)))
19923 (cond ((> pos (point)) (point))
19924 ((not (eq last-command this-command)) (point))
19925 (t refpos)))))
19926 ((org-at-item-p)
19927 (goto-char
19928 (if (eq special t)
19929 (cond ((> pos (match-end 0)) (match-end 0))
19930 ((= pos (point)) (match-end 0))
19931 (t (point)))
19932 (cond ((> pos (point)) (point))
19933 ((not (eq last-command this-command)) (point))
19934 (t (match-end 0))))))))
19935 (org-no-warnings
19936 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19938 (defun org-end-of-line (&optional arg)
19939 "Go to the end of the line.
19940 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19941 first attempt, and only move to after the tags when the cursor is already
19942 beyond the end of the headline."
19943 (interactive "P")
19944 (let ((special (if (consp org-special-ctrl-a/e)
19945 (cdr org-special-ctrl-a/e)
19946 org-special-ctrl-a/e)))
19947 (cond
19948 ((or (not special) arg
19949 (not (or (org-on-heading-p) (org-at-item-p))))
19950 (call-interactively
19951 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19952 ((fboundp 'move-end-of-line) 'move-end-of-line)
19953 (t 'end-of-line))))
19954 ((org-on-heading-p)
19955 (let ((pos (point)))
19956 (beginning-of-line 1)
19958 (if (eq special t)
19959 (if (or (< pos (match-beginning 1))
19960 (= pos (match-end 0)))
19961 (goto-char (match-beginning 1))
19962 (goto-char (match-end 0)))
19963 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19964 (goto-char (match-end 0))
19965 (goto-char (match-beginning 1))))
19966 (call-interactively (if (fboundp 'move-end-of-line)
19967 'move-end-of-line
19968 'end-of-line)))))
19969 ;; At an item: Move before any hidden text.
19970 (t (call-interactively 'end-of-line)))
19971 (org-no-warnings
19972 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19974 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19975 (define-key org-mode-map "\C-e" 'org-end-of-line)
19977 (defun org-backward-sentence (&optional arg)
19978 "Go to beginning of sentence, or beginning of table field.
19979 This will call `backward-sentence' or `org-table-beginning-of-field',
19980 depending on context."
19981 (interactive "P")
19982 (cond
19983 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19984 (t (call-interactively 'backward-sentence))))
19986 (defun org-forward-sentence (&optional arg)
19987 "Go to end of sentence, or end of table field.
19988 This will call `forward-sentence' or `org-table-end-of-field',
19989 depending on context."
19990 (interactive "P")
19991 (cond
19992 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19993 (t (call-interactively 'forward-sentence))))
19995 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19996 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19998 (defun org-kill-line (&optional arg)
19999 "Kill line, to tags or end of line."
20000 (interactive "P")
20001 (cond
20002 ((or (not org-special-ctrl-k)
20003 (bolp)
20004 (not (org-on-heading-p)))
20005 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20006 org-ctrl-k-protect-subtree)
20007 (if (or (eq org-ctrl-k-protect-subtree 'error)
20008 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20009 (error "C-k aborted - would kill hidden subtree")))
20010 (call-interactively 'kill-line))
20012 (kill-region (point) (match-beginning 1))
20013 (org-set-tags nil t))
20014 (t (kill-region (point) (point-at-eol)))))
20016 (define-key org-mode-map "\C-k" 'org-kill-line)
20018 (defun org-yank (&optional arg)
20019 "Yank. If the kill is a subtree, treat it specially.
20020 This command will look at the current kill and check if is a single
20021 subtree, or a series of subtrees[1]. If it passes the test, and if the
20022 cursor is at the beginning of a line or after the stars of a currently
20023 empty headline, then the yank is handled specially. How exactly depends
20024 on the value of the following variables, both set by default.
20026 org-yank-folded-subtrees
20027 When set, the subtree(s) will be folded after insertion, but only
20028 if doing so would now swallow text after the yanked text.
20030 org-yank-adjusted-subtrees
20031 When set, the subtree will be promoted or demoted in order to
20032 fit into the local outline tree structure, which means that the level
20033 will be adjusted so that it becomes the smaller one of the two
20034 *visible* surrounding headings.
20036 Any prefix to this command will cause `yank' to be called directly with
20038 will just
20039 plainly yank the text as it is.
20041 \[1] The test checks if the first non-white line is a heading
20042 and if there are no other headings with fewer stars."
20043 (interactive "P")
20044 (org-yank-generic 'yank arg))
20046 (defun org-yank-generic (command arg)
20047 "Perform some yank-like command.
20049 This function implements the behavior described in the `org-yank'
20050 documentation. However, it has been generalized to work for any
20051 interactive command with similar behavior."
20053 ;; pretend to be command COMMAND
20054 (setq this-command command)
20056 (if arg
20057 (call-interactively command)
20059 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20060 (and (org-kill-is-subtree-p)
20061 (or (bolp)
20063 (string-match
20065 (buffer-substring (point-at-bol) (point)))))))
20066 swallowp)
20067 (cond
20068 ((and subtreep org-yank-folded-subtrees)
20069 (let ((beg (point))
20070 end)
20071 (if (and subtreep org-yank-adjusted-subtrees)
20072 (org-paste-subtree nil nil 'for-yank)
20073 (call-interactively command))
20075 (setq end (point))
20076 (goto-char beg)
20077 (when (and (bolp) subtreep
20078 (not (setq swallowp
20079 (org-yank-folding-would-swallow-text beg end))))
20080 (org-with-limited-levels
20081 (or (looking-at org-outline-regexp)
20082 (re-search-forward org-outline-regexp-bol end t))
20083 (while (and (< (point) end) (looking-at org-outline-regexp))
20084 (hide-subtree)
20085 (org-cycle-show-empty-lines 'folded)
20086 (condition-case nil
20087 (outline-forward-same-level 1)
20088 (error (goto-char end))))))
20089 (when swallowp
20090 (message
20091 "Inserted text not folded because that would swallow text"))
20093 (goto-char end)
20095 (beginning-of-line 1)
20096 (push-mark beg 'nomsg)))
20097 ((and subtreep org-yank-adjusted-subtrees)
20098 (let ((beg (point-at-bol)))
20099 (org-paste-subtree nil nil 'for-yank)
20100 (push-mark beg 'nomsg)))
20101 (t
20102 (call-interactively command))))))
20104 (defun org-yank-folding-would-swallow-text (beg end)
20105 "Would hide-subtree at BEG swallow any text after END?"
20106 (let (level)
20107 (org-with-limited-levels
20108 (save-excursion
20109 (goto-char beg)
20110 (when (or (looking-at org-outline-regexp)
20111 (re-search-forward org-outline-regexp-bol end t))
20112 (setq level (org-outline-level)))
20113 (goto-char end)
20115 (if (or (eobp)
20116 (and (bolp) (looking-at org-outline-regexp)
20117 (<= (org-outline-level) level)))
20118 nil ; Nothing would be swallowed
20119 t))))) ; something would swallow
20121 (define-key org-mode-map "\C-y" 'org-yank)
20123 (defun org-truely-invisible-p ()
20124 "Check if point is at a character currently not visible.
20125 This version does not only check the character property, but also
20126 `visible-mode'."
20127 ;; Early versions of noutline don't have `outline-invisible-p'.
20128 (if (org-bound-and-true-p visible-mode)
20129 nil
20130 (outline-invisible-p)))
20132 (defun org-invisible-p2 ()
20133 "Check if point is at a character currently not visible."
20134 (save-excursion
20135 (if (and (eolp) (not (bobp))) (backward-char 1))
20136 ;; Early versions of noutline don't have `outline-invisible-p'.
20137 (outline-invisible-p)))
20139 (defun org-back-to-heading (&optional invisible-ok)
20140 "Call `outline-back-to-heading', but provide a better error message."
20141 (condition-case nil
20142 (outline-back-to-heading invisible-ok)
20143 (error (error "Before first headline at position %d in buffer %s"
20144 (point) (current-buffer)))))
20146 (defun org-beginning-of-defun ()
20147 "Go to the beginning of the subtree, i.e. back to the heading."
20148 (org-back-to-heading))
20149 (defun org-end-of-defun ()
20150 "Go to the end of the subtree."
20151 (org-end-of-subtree nil t))
20153 (defun org-before-first-heading-p ()
20154 "Before first heading?"
20155 (save-excursion
20156 (end-of-line)
20157 (null (re-search-backward org-outline-regexp-bol nil t))))
20159 (defun org-on-heading-p (&optional ignored)
20160 (outline-on-heading-p t))
20161 (defun org-at-heading-p (&optional ignored)
20162 (outline-on-heading-p t))
20164 (defun org-point-at-end-of-empty-headline ()
20165 "If point is at the end of an empty headline, return t, else nil.
20166 If the heading only contains a TODO keyword, it is still still considered
20167 empty."
20169 (save-excursion
20170 (beginning-of-line 1)
20171 (let ((case-fold-search nil))
20174 (defun org-at-heading-or-item-p ()
20175 (or (org-on-heading-p) (org-at-item-p)))
20177 (defun org-on-target-p ()
20178 (or (org-in-regexp org-radio-target-regexp)
20179 (org-in-regexp org-target-regexp)))
20181 (defun org-up-heading-all (arg)
20182 "Move to the heading line of which the present line is a subheading.
20183 This function considers both visible and invisible heading lines.
20184 With argument, move up ARG levels."
20185 (if (fboundp 'outline-up-heading-all)
20186 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20187 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20189 (defun org-up-heading-safe ()
20190 "Move to the heading line of which the present line is a subheading.
20191 This version will not throw an error. It will return the level of the
20192 headline found, or nil if no higher level is found.
20194 Also, this function will be a lot faster than `outline-up-heading',
20195 because it relies on stars being the outline starters. This can really
20196 make a significant difference in outlines with very many siblings."
20197 (let (start-level re)
20198 (org-back-to-heading t)
20199 (setq start-level (funcall outline-level))
20200 (if (equal start-level 1)
20201 nil
20203 (if (re-search-backward re nil t)
20204 (funcall outline-level)))))
20206 (defun org-first-sibling-p ()
20207 "Is this heading the first child of its parents?"
20208 (interactive)
20209 (let ((re org-outline-regexp-bol)
20210 level l)
20211 (unless (org-at-heading-p t)
20212 (error "Not at a heading"))
20213 (setq level (funcall outline-level))
20214 (save-excursion
20215 (if (not (re-search-backward re nil t))
20216 t
20217 (setq l (funcall outline-level))
20218 (< l level)))))
20220 (defun org-goto-sibling (&optional previous)
20221 "Goto the next sibling, even if it is invisible.
20222 When PREVIOUS is set, go to the previous sibling instead. Returns t
20223 when a sibling was found. When none is found, return nil and don't
20224 move point."
20225 (let ((fun (if previous 're-search-backward 're-search-forward))
20226 (pos (point))
20227 (re org-outline-regexp-bol)
20228 level l)
20229 (when (condition-case nil (org-back-to-heading t) (error nil))
20230 (setq level (funcall outline-level))
20231 (catch 'exit
20232 (or previous (forward-char 1))
20233 (while (funcall fun re nil t)
20234 (setq l (funcall outline-level))
20235 (when (< l level) (goto-char pos) (throw 'exit nil))
20236 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20237 (goto-char pos)
20238 nil))))
20240 (defun org-show-siblings ()
20241 "Show all siblings of the current headline."
20242 (save-excursion
20243 (while (org-goto-sibling) (org-flag-heading nil)))
20244 (save-excursion
20245 (while (org-goto-sibling 'previous)
20246 (org-flag-heading nil))))
20248 (defun org-goto-first-child ()
20249 "Goto the first child, even if it is invisible.
20250 Return t when a child was found. Otherwise don't move point and
20251 return nil."
20252 (let (level (pos (point)) (re org-outline-regexp-bol))
20253 (when (condition-case nil (org-back-to-heading t) (error nil))
20254 (setq level (outline-level))
20255 (forward-char 1)
20256 (if (and (re-search-forward re nil t) (> (outline-level) level))
20257 (progn (goto-char (match-beginning 0)) t)
20258 (goto-char pos) nil))))
20260 (defun org-show-hidden-entry ()
20261 "Show an entry where even the heading is hidden."
20262 (save-excursion
20263 (org-show-entry)))
20265 (defun org-flag-heading (flag &optional entry)
20266 "Flag the current heading. FLAG non-nil means make invisible.
20267 When ENTRY is non-nil, show the entire entry."
20268 (save-excursion
20269 (org-back-to-heading t)
20270 ;; Check if we should show the entire entry
20271 (if entry
20272 (progn
20273 (org-show-entry)
20274 (save-excursion
20275 (and (outline-next-heading)
20276 (org-flag-heading nil))))
20277 (outline-flag-region (max (point-min) (1- (point)))
20278 (save-excursion (outline-end-of-heading) (point))
20279 flag))))
20281 (defun org-get-next-sibling ()
20282 "Move to next heading of the same level, and return point.
20283 If there is no such heading, return nil.
20284 This is like outline-next-sibling, but invisible headings are ok."
20285 (let ((level (funcall outline-level)))
20286 (outline-next-heading)
20287 (while (and (not (eobp)) (> (funcall outline-level) level))
20288 (outline-next-heading))
20289 (if (or (eobp) (< (funcall outline-level) level))
20290 nil
20291 (point))))
20293 (defun org-get-last-sibling ()
20294 "Move to previous heading of the same level, and return point.
20295 If there is no such heading, return nil."
20296 (let ((opoint (point))
20297 (level (funcall outline-level)))
20298 (outline-previous-heading)
20299 (when (and (/= (point) opoint) (outline-on-heading-p t))
20300 (while (and (> (funcall outline-level) level)
20301 (not (bobp)))
20302 (outline-previous-heading))
20303 (if (< (funcall outline-level) level)
20304 nil
20305 (point)))))
20307 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20308 ;; This contains an exact copy of the original function, but it uses
20309 ;; `org-back-to-heading', to make it work also in invisible
20310 ;; trees. And is uses an invisible-OK argument.
20311 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20312 ;; Furthermore, when used inside Org, finding the end of a large subtree
20313 ;; with many children and grandchildren etc, this can be much faster
20314 ;; than the outline version.
20315 (org-back-to-heading invisible-OK)
20316 (let ((first t)
20317 (level (funcall outline-level)))
20318 (if (and (org-mode-p) (< level 1000))
20319 ;; A true heading (not a plain list item), in Org-mode
20320 ;; This means we can easily find the end by looking
20321 ;; only for the right number of stars. Using a regexp to do
20322 ;; this is so much faster than using a Lisp loop.
20324 (forward-char 1)
20325 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20326 ;; something else, do it the slow way
20327 (while (and (not (eobp))
20328 (or first (> (funcall outline-level) level)))
20329 (setq first nil)
20330 (outline-next-heading)))
20331 (unless to-heading
20333 (progn
20334 ;; Go to end of line before heading
20335 (forward-char -1)
20337 ;; leave blank line before heading
20338 (forward-char -1))))))
20339 (point))
20341 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20342 "Use Org version in org-mode, for dramatic speed-up."
20343 (if (org-mode-p)
20344 (progn
20345 (org-end-of-subtree nil t)
20346 (unless (eobp) (backward-char 1)))
20347 ad-do-it))
20349 (defun org-end-of-meta-data-and-drawers ()
20350 "Jump to the first text after meta data and drawers in the current entry.
20351 This will move over empty lines, lines with planning time stamps,
20352 clocking lines, and drawers."
20353 (org-back-to-heading t)
20354 (let ((end (save-excursion (outline-next-heading) (point)))
20357 (forward-line 1)
20358 (while (re-search-forward re end t)
20359 (if (not (match-end 1))
20360 ;; empty or planning line
20361 (forward-line 1)
20362 ;; a drawer, find the end
20364 (forward-line 1)))
20366 (point)))
20368 (defun org-forward-same-level (arg &optional invisible-ok)
20369 "Move forward to the arg'th subheading at same level as this one.
20370 Stop at the first and last subheadings of a superior heading.
20371 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20372 it wil also look at invisible ones."
20373 (interactive "p")
20374 (org-back-to-heading invisible-ok)
20375 (org-on-heading-p)
20376 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20378 l)
20379 (forward-char 1)
20380 (while (> arg 0)
20381 (while (and (re-search-forward re nil 'move)
20382 (setq l (- (match-end 0) (match-beginning 0) 1))
20383 (= l level)
20384 (not invisible-ok)
20385 (progn (backward-char 1) (outline-invisible-p)))
20386 (if (< l level) (setq arg 1)))
20387 (setq arg (1- arg)))
20388 (beginning-of-line 1)))
20390 (defun org-backward-same-level (arg &optional invisible-ok)
20391 "Move backward to the arg'th subheading at same level as this one.
20392 Stop at the first and last subheadings of a superior heading."
20393 (interactive "p")
20394 (org-back-to-heading)
20395 (org-on-heading-p)
20396 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20398 l)
20399 (while (> arg 0)
20400 (while (and (re-search-backward re nil 'move)
20401 (setq l (- (match-end 0) (match-beginning 0) 1))
20402 (= l level)
20403 (not invisible-ok)
20404 (outline-invisible-p))
20405 (if (< l level) (setq arg 1)))
20406 (setq arg (1- arg)))))
20408 (defun org-show-subtree ()
20409 "Show everything after this heading at deeper levels."
20410 (outline-flag-region
20411 (point)
20412 (save-excursion
20413 (org-end-of-subtree t t))
20414 nil))
20416 (defun org-show-entry ()
20417 "Show the body directly following this heading.
20418 Show the heading too, if it is currently invisible."
20419 (interactive)
20420 (save-excursion
20421 (condition-case nil
20422 (progn
20423 (org-back-to-heading t)
20424 (outline-flag-region
20425 (max (point-min) (1- (point)))
20426 (save-excursion
20427 (if (re-search-forward
20429 (match-beginning 1)
20430 (point-max)))
20431 nil)
20432 (org-cycle-hide-drawers 'children))
20433 (error nil))))
20435 (defun org-make-options-regexp (kwds &optional extra)
20436 "Make a regular expression for keyword lines."
20437 (concat
20438 "^"
20445 ;; Make isearch reveal the necessary context
20446 (defun org-isearch-end ()
20447 "Reveal context after isearch exits."
20448 (when isearch-success ; only if search was successful
20449 (if (featurep 'xemacs)
20450 ;; Under XEmacs, the hook is run in the correct place,
20451 ;; we directly show the context.
20452 (org-show-context 'isearch)
20453 ;; In Emacs the hook runs *before* restoring the overlays.
20454 ;; So we have to use a one-time post-command-hook to do this.
20455 ;; (Emacs 22 has a special variable, see function `org-mode')
20456 (unless (and (boundp 'isearch-mode-end-hook-quit)
20457 isearch-mode-end-hook-quit)
20458 ;; Only when the isearch was not quitted.
20459 (org-add-hook 'post-command-hook 'org-isearch-post-command
20460 'append 'local)))))
20462 (defun org-isearch-post-command ()
20463 "Remove self from hook, and show context."
20464 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20465 (org-show-context 'isearch))
20468 ;;;; Integration with and fixes for other packages
20470 ;;; Imenu support
20472 (defvar org-imenu-markers nil
20473 "All markers currently used by Imenu.")
20474 (make-variable-buffer-local 'org-imenu-markers)
20476 (defun org-imenu-new-marker (&optional pos)
20477 "Return a new marker for use by Imenu, and remember the marker."
20478 (let ((m (make-marker)))
20479 (move-marker m (or pos (point)))
20480 (push m org-imenu-markers)
20481 m))
20483 (defun org-imenu-get-tree ()
20484 "Produce the index for Imenu."
20485 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20486 (setq org-imenu-markers nil)
20487 (let* ((n org-imenu-depth)
20488 (re (concat "^" (org-get-limited-outline-regexp)))
20489 (subs (make-vector (1+ n) nil))
20490 (last-level 0)
20491 m level head)
20492 (save-excursion
20493 (save-restriction
20494 (widen)
20495 (goto-char (point-max))
20496 (while (re-search-backward re nil t)
20497 (setq level (org-reduced-level (funcall outline-level)))
20498 (when (<= level n)
20499 (looking-at org-complex-heading-regexp)
20500 (setq head (org-link-display-format
20501 (org-match-string-no-properties 4))
20502 m (org-imenu-new-marker))
20503 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20504 (if (>= level last-level)
20505 (push (cons head m) (aref subs level))
20506 (push (cons head (aref subs (1+ level))) (aref subs level))
20507 (loop for i from (1+ level) to n do (aset subs i nil)))
20508 (setq last-level level)))))
20509 (aref subs 1)))
20511 (eval-after-load "imenu"
20512 '(progn
20513 (add-hook 'imenu-after-jump-hook
20514 (lambda ()
20515 (if (org-mode-p)
20516 (org-show-context 'org-goto))))))
20518 (defun org-link-display-format (link)
20519 "Replace a link with either the description, or the link target
20520 if no description is present"
20521 (save-match-data
20522 (if (string-match org-bracket-link-analytic-regexp link)
20523 (replace-match (if (match-end 5)
20524 (match-string 5 link)
20525 (concat (match-string 1 link)
20526 (match-string 3 link)))
20527 nil t link)
20528 link)))
20530 (defun org-toggle-link-display ()
20531 "Toggle the literal or descriptive display of links."
20532 (interactive)
20533 (if org-descriptive-links
20534 (progn (org-remove-from-invisibility-spec '(org-link))
20535 (org-restart-font-lock)
20536 (setq org-descriptive-links nil))
20537 (progn (add-to-invisibility-spec '(org-link))
20538 (org-restart-font-lock)
20539 (setq org-descriptive-links t))))
20541 ;; Speedbar support
20543 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20544 "Overlay marking the agenda restriction line in speedbar.")
20545 (overlay-put org-speedbar-restriction-lock-overlay
20546 'face 'org-agenda-restriction-lock)
20547 (overlay-put org-speedbar-restriction-lock-overlay
20548 'help-echo "Agendas are currently limited to this item.")
20549 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20551 (defun org-speedbar-set-agenda-restriction ()
20552 "Restrict future agenda commands to the location at point in speedbar.
20554 (interactive)
20555 (require 'org-agenda)
20556 (let (p m tp np dir txt)
20557 (cond
20558 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20559 'org-imenu t))
20560 (setq m (get-text-property p 'org-imenu-marker))
20561 (with-current-buffer (marker-buffer m)
20562 (goto-char m)
20563 (org-agenda-set-restriction-lock 'subtree)))
20564 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20565 'speedbar-function 'speedbar-find-file))
20566 (setq tp (previous-single-property-change
20567 (1+ p) 'speedbar-function)
20568 np (next-single-property-change
20569 tp 'speedbar-function)
20570 dir (speedbar-line-directory)
20571 txt (buffer-substring-no-properties (or tp (point-min))
20572 (or np (point-max))))
20573 (with-current-buffer (find-file-noselect
20574 (let ((default-directory dir))
20575 (expand-file-name txt)))
20576 (unless (org-mode-p)
20577 (error "Cannot restrict to non-Org-mode file"))
20578 (org-agenda-set-restriction-lock 'file)))
20579 (t (error "Don't know how to restrict Org-mode's agenda")))
20580 (move-overlay org-speedbar-restriction-lock-overlay
20581 (point-at-bol) (point-at-eol))
20582 (setq current-prefix-arg nil)
20583 (org-agenda-maybe-redo)))
20585 (eval-after-load "speedbar"
20586 '(progn
20587 (speedbar-add-supported-extension ".org")
20588 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20589 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20590 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20591 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20592 (add-hook 'speedbar-visiting-tag-hook
20593 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20595 ;;; Fixes and Hacks for problems with other packages
20597 ;; Make flyspell not check words in links, to not mess up our keymap
20598 (defun org-mode-flyspell-verify ()
20599 "Don't let flyspell put overlays at active buttons, or on
20600 {todo,all-time,additional-option-like}-keywords."
20601 (let ((pos (max (1- (point)) (point-min)))
20602 (word (thing-at-point 'word)))
20603 (and (not (get-text-property pos 'keymap))
20604 (not (get-text-property pos 'org-no-flyspell))
20605 (not (member word org-todo-keywords-1))
20606 (not (member word org-all-time-keywords))
20607 (not (member word org-additional-option-like-keywords)))))
20609 (defun org-remove-flyspell-overlays-in (beg end)
20610 "Remove flyspell overlays in region."
20611 (and (org-bound-and-true-p flyspell-mode)
20612 (fboundp 'flyspell-delete-region-overlays)
20613 (flyspell-delete-region-overlays beg end))
20614 (add-text-properties beg end '(org-no-flyspell t)))
20616 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20617 (eval-after-load "bookmark"
20618 '(if (boundp 'bookmark-after-jump-hook)
20619 ;; We can use the hook
20620 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20621 ;; Hook not available, use advice
20622 (defadvice bookmark-jump (after org-make-visible activate)
20623 "Make the position visible."
20624 (org-bookmark-jump-unhide))))
20626 ;; Make sure saveplace shows the location if it was hidden
20627 (eval-after-load "saveplace"
20628 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20629 "Make the position visible."
20630 (org-bookmark-jump-unhide)))
20632 ;; Make sure ecb shows the location if it was hidden
20633 (eval-after-load "ecb"
20634 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20635 "Make hierarchy visible when jumping into location from ECB tree buffer."
20636 (if (org-mode-p)
20637 (org-show-context))))
20639 (defun org-bookmark-jump-unhide ()
20640 "Unhide the current position, to show the bookmark location."
20641 (and (org-mode-p)
20642 (or (outline-invisible-p)
20643 (save-excursion (goto-char (max (point-min) (1- (point))))
20644 (outline-invisible-p)))
20645 (org-show-context 'bookmark-jump)))
20647 ;; Make session.el ignore our circular variable
20648 (eval-after-load "session"
20649 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20651 ;;;; Experimental code
20653 (defun org-closed-in-range ()
20654 "Sparse tree of items closed in a certain time range.
20655 Still experimental, may disappear in the future."
20656 (interactive)
20657 ;; Get the time interval from the user.
20658 (let* ((time1 (org-float-time
20659 (org-read-date nil 'to-time nil "Starting date: ")))
20660 (time2 (org-float-time
20661 (org-read-date nil 'to-time nil "End date:")))
20662 ;; callback function
20663 (callback (lambda ()
20664 (let ((time
20665 (org-float-time
20666 (apply 'encode-time
20667 (org-parse-time-string
20668 (match-string 1))))))
20669 ;; check if time in interval
20670 (and (>= time time1) (<= time time2))))))
20671 ;; make tree, check each match with the callback
20674 ;;;; Finish up
20676 (provide 'org)
20678 (run-hooks 'org-load-hook)
20680 ;;; org.el ends here