| blob | d82ae0ce33a505d9090d942109ccc26cd25b9ebd |
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 %d will be replaced by a short-format time stamp.
2379 %D will be replaced by an active short-format time stamp.
2380 %s will be replaced by the new TODO state, in double quotes.
2381 %S will be replaced by the old TODO state, in double quotes.
2382 %u will be replaced by the user name.
2383 %U will be replaced by the full user name.
2385 In fact, it is not a good idea to change the `state' entry, because
2386 agenda log mode depends on the format of these entries."
2392 "Heading when changing todo state (todo sequence only)"
2406 "Non-nil means insert state change notes and time stamps into a drawer.
2407 When nil, state changes notes will be inserted after the headline and
2408 any scheduling and clock lines, but not inside a drawer.
2410 The value of this variable should be the name of the drawer to use.
2411 LOGBOOK is proposed as the default drawer for this purpose, you can
2412 also set this to a string to define the drawer of your choice.
2416 If this variable is set, `org-log-state-notes-insert-after-drawers'
2417 will be ignored.
2419 You can set the property LOG_INTO_DRAWER to overrule this setting for
2420 a subtree."
2432 "Return the value of `org-log-into-drawer', but let properties overrule.
2433 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2434 used instead of the default value."
2442 "Non-nil means insert state change notes after any drawers in entry.
2443 Only the drawers that *immediately* follow the headline and the
2444 deadline/scheduled line are skipped.
2445 When nil, insert notes right after the heading and perhaps the line
2446 with deadline/scheduling if present.
2448 This variable will have no effect if `org-log-into-drawer' is
2449 set."
2455 "Non-nil means the latest state note will be directly after heading.
2456 When nil, the state change notes will be ordered according to time."
2462 "The TODO state to which a repeater should return the repeating task.
2463 By default this is the first task in a TODO sequence, or the previous state
2464 in a TODO_TYP set. But you can specify another task here.
2465 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2471 "Non-nil means record moving through the DONE state when triggering repeat.
2472 An auto-repeating task is immediately switched back to TODO when
2475 record a closing note, there will be no record of the task moving
2476 through DONE. This variable forces taking a note anyway.
2478 nil Don't force a record
2479 time Record a time stamp
2480 note Record a note
2482 This option can also be set with on a per-file-basis with
2484 #+STARTUP: logrepeat
2485 #+STARTUP: lognoterepeat
2486 #+STARTUP: nologrepeat
2488 You can have local logging settings for a subtree by setting the LOGGING
2489 property to one or more of these keywords."
2499 "Priorities in Org-mode."
2504 "Non-nil means priority commands are active.
2505 When nil, these commands will be disabled, so that you never accidentally
2506 set a priority."
2511 "The highest priority of TODO items. A character like ?A, ?B etc.
2512 Must have a smaller ASCII number than `org-lowest-priority'."
2517 "The lowest priority of TODO items. A character like ?A, ?B etc.
2518 Must have a larger ASCII number than `org-highest-priority'."
2523 "The default priority of TODO items.
2524 This is the priority an item gets if no explicit priority is given.
2525 When starting to cycle on an empty priority the first step in the cycle
2526 depends on `org-priority-start-cycle-with-default'. The resulting first
2527 step priority must not exceed the range from `org-highest-priority' to
2528 `org-lowest-priority' which means that `org-default-priority' has to be
2529 in this range exclusive or inclusive the range boundaries. Else the
2530 first step refuses to set the default and the second will fall back
2531 to (depending on the command used) the highest or lowest priority."
2536 "Non-nil means start with default priority when starting to cycle.
2537 When this is nil, the first step in the cycle will be (depending on the
2538 command used) one higher or lower than the default priority.
2539 See also `org-default-priority'."
2544 "Function to extract the priority from a string.
2545 The string is normally the headline. If this is nil Org computes the
2546 priority from the priority cookie like [#A] in the headline. It returns
2547 an integer, increasing by 1000 for each priority level.
2548 The user can set a different function here, which should take a string
2549 as an argument and return the numeric priority."
2554 "Options concerning time stamps and deadlines in Org-mode."
2559 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2560 When nil, these labeled time stamps are forces into the second line of an
2561 entry, just after the headline. When scheduling from the global TODO list,
2562 the time stamp will always be forced into the second line."
2567 "Formats for `format-time-string' which are used for time stamps.
2571 "Number of minutes to round time stamps to.
2572 These are two values, the first applies when first creating a time stamp.
2573 The second applies when changing it with the commands `S-up' and `S-down'.
2574 When changing the time stamp, this means that it will change in steps
2575 of N minutes, as given by the second value.
2577 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2578 numbers should be factors of 60, so for example 5, 10, 15.
2580 When this is larger than 1, you can still force an exact time stamp by using
2581 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2582 and by using a prefix arg to `S-up/down' to specify the exact number
2583 of minutes to shift."
2593 ;; Normalize old customizations of this variable.
2597 org-time-stamp-rounding-minutes)))
2600 "Non-nil means overlay custom formats over all time stamps.
2601 The formats are defined through the variable `org-time-stamp-custom-formats'.
2602 To turn this on on a per-file basis, insert anywhere in the file:
2603 #+STARTUP: customtime"
2611 "Custom formats for time stamps. See `format-time-string' for the syntax.
2612 These are overlayed over the default ISO format if the variable
2613 `org-display-custom-times' is set. Time like %H:%M should be at the
2614 end of the second format. The custom formats are also honored by export
2615 commands, if custom time display is turned on at the time of export."
2620 "Get the right format for a time string."
2625 f)))
2628 "The format string used when creating CLOCKSUM lines.
2629 This is also used when org-mode generates a time duration."
2635 org-mode generates a time duration."
2640 "The format string used when creating CLOCKSUM lines, or when
2641 org-mode generates a time duration."
2646 "No. of days before expiration during which a deadline becomes active.
2647 This variable governs the display in sparse trees and in the agenda.
2648 When 0 or negative, it means use this number (the absolute value of it)
2649 even if a deadline has a different individual lead time specified.
2651 Custom commands can set this variable in the options section."
2657 "Non-nil means assume future for incomplete date input from user.
2658 This affects the following situations:
2659 1. The user gives a month but not a year.
2662 2. The user gives a day, but no month.
2665 it will be considered as *this* month.
2667 If you set this variable to the symbol `time', then also the following
2668 will work:
2670 3. If the user gives a time, but no day. If the time is before now,
2671 to will be interpreted as tomorrow.
2673 Currently none of this works for ISO week specifications.
2675 When this option is nil, the current day, month and year will always be
2676 used as defaults.
2678 See also `org-agenda-jump-prefer-future'."
2686 "Should the agenda jump command prefer the future for incomplete dates?
2687 The default is to do the same as configured in `org-read-date-prefer-future'.
2688 But you can also set a deviating value here.
2689 This may t or nil, or the symbol `org-read-date-prefer-future'."
2694 org-read-date-prefer-future)
2699 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2701 Depending on the system Emacs is running on, certain dates cannot
2702 be represented with the type used internally to represent time.
2703 Dates between 1970-1-1 and 2038-1-1 can always be represented
2704 correctly. Some systems allow for earlier dates, some for later,
2705 some for both. One way to find out it to insert any date into an
2706 Org buffer, putting the cursor on the year and hitting S-up and
2707 S-down to test the range.
2709 When this variable is set to t, the date/time prompt will not let
2710 you specify dates outside the 1970-2037 range, so it is certain that
2711 these dates will work in whatever version of Emacs you are
2712 running, and also that you can move a file from one Emacs implementation
2713 to another. WHenever Org is forcing the year for you, it will display
2714 a message and beep.
2716 When this variable is nil, Org will check if the date is
2717 representable in the specific Emacs implementation you are using.
2718 If not, it will force a year, usually the current year, and beep
2719 to remind you. Currently this setting is not recommended because
2720 the likelihood that you will open your Org files in an Emacs that
2721 has limited date range is not negligible.
2723 A workaround for this problem is to use diary sexp dates for time
2724 stamps outside of this range."
2729 "Non-nil means display current interpretation of date prompt live.
2730 This display will be in an overlay, in the minibuffer."
2735 "Non-nil means pop up a calendar when prompting for a date.
2736 In the calendar, the date can be selected with mouse-1. However, the
2737 minibuffer will also be active, and you can simply enter the date as well.
2738 When nil, only the minibuffer will be available."
2746 "Hook to be used to set up keys for the date/time interface.
2747 Add key definitions to `minibuffer-local-map', which will be a temporary
2748 copy."
2753 "The hour when your day really ends. Must be an integer.
2754 This has influence for the following applications:
2756 the time given here, the day recognized as TODAY is actually yesterday.
2757 - When a date is read from the user and it is still before the time given
2758 here, the current date and time will be assumed to be yesterday, 23:59.
2759 Also, timestamps inserted in remember templates follow this rule.
2761 IMPORTANT: This is a feature whose implementation is and likely will
2762 remain incomplete. Really, it is only here because past midnight seems to
2763 be the favorite working time of John Wiegley :-)"
2768 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2769 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2771 23:59 of the previous day."
2776 "Non-nil means S-down will increase the time in a time stamp.
2777 When nil, S-up will increase."
2782 "Non-nil means make the calendar window follow timestamp changes.
2783 When a timestamp is modified and the calendar window is visible, it will be
2784 moved to the new date."
2789 "Options concerning tags in Org-mode."
2794 "List of tags allowed in Org-mode files.
2795 When this list is nil, Org-mode will base TAG input on what is already in the
2796 buffer.
2797 The value of this variable is an alist, the car of each entry must be a
2798 keyword as a string, the cdr may be a character that is used to select
2799 that tag through the fast-tag-selection interface.
2800 See the manual for details."
2815 "List of tags that will always appear in all Org-mode files.
2816 This is in addition to any in buffer settings or customizations
2817 of `org-tag-alist'.
2818 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2819 The value of this variable is an alist, the car of each entry must be a
2820 keyword as a string, the cdr may be a character that is used to select
2821 that tag through the fast-tag-selection interface.
2822 See the manual for details.
2823 To disable these tags on a per-file basis, insert anywhere in the file:
2824 #+STARTUP: noptag"
2835 "If non-nil, always offer completion for all tags of all agenda files.
2836 Instead of customizing this variable directly, you might want to
2837 set it locally for capture buffers, because there no list of
2838 tags in that file can be created dynamically (there are none).
2840 (add-hook 'org-capture-mode-hook
2841 (lambda ()
2842 (set (make-local-variable
2843 'org-complete-tags-always-offer-all-agenda-tags)
2844 t)))"
2849 "List of tags that can be inherited by all entries in the file.
2850 The tags will be inherited if the variable `org-use-tag-inheritance'
2851 says they should be.
2855 "Non-nil means use fast tag selection scheme.
2856 This is a special interface to select and deselect tags with single keys.
2857 When nil, fast selection is never used.
2858 When the symbol `auto', fast selection is used if and only if selection
2859 characters for tags have been configured, either through the variable
2860 `org-tag-alist' or through a #+TAGS line in the buffer.
2861 When t, fast selection is always used and selection keys are assigned
2862 automatically if necessary."
2870 "Non-nil means fast tag selection exits after first change.
2871 When nil, you have to press RET to exit it.
2872 During fast tag selection, you can toggle this flag with `C-c'.
2873 This variable can also have the value `expert'. In this case, the window
2874 displaying the tags menu is not even shown, until you press C-c again."
2882 "Non-nil means fast tags selection interface will also offer TODO states.
2886 "The column to which tags should be indented in a headline.
2887 If this number is positive, it specifies the column. If it is negative,
2888 it means that the tags should be flushright to that column. For example,
2889 -80 works well for a normal 80 character screen.
2890 When 0, place tags directly after headline text, with only one space in
2891 between."
2896 "Non-nil keeps tags aligned when modifying headlines.
2897 Some operations (i.e. demoting) change the length of a headline and
2898 therefore shift the tags around. With this option turned on, after
2899 each such operation the tags are again aligned to `org-tags-column'."
2904 "Non-nil means tags in levels apply also for sublevels.
2905 When nil, only the tags directly given in a specific line apply there.
2906 This may also be a list of tags that should be inherited, or a regexp that
2907 matches tags that should be inherited. Additional control is possible
2908 with the variable `org-tags-exclude-from-inheritance' which gives an
2909 explicit list of tags to be excluded from inheritance., even if the value of
2910 `org-use-tag-inheritance' would select it for inheritance.
2912 If this option is t, a match early-on in a tree can lead to a large
2913 number of matches in the subtree when constructing the agenda or creating
2914 a sparse tree. If you only want to see the first match in a tree during
2915 a search, check out the variable `org-tags-match-list-sublevels'."
2924 "List of tags that should never be inherited.
2925 This is a way to exclude a few tags from inheritance. For way to do
2926 the opposite, to actively allow inheritance for selected tags,
2927 see the variable `org-use-tag-inheritance'."
2932 "Check if TAG is one that should be inherited."
2944 "Non-nil means list also sublevels of headlines matching a search.
2945 This variable applies to tags/property searches, and also to stuck
2946 projects because this search is based on a tags match as well.
2948 When set to the symbol `indented', sublevels are indented with
2949 leading dots.
2951 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2952 the sublevels of a headline matching a tag search often also match
2953 the same search. Listing all of them can create very long lists.
2954 Setting this variable to nil causes subtrees of a match to be skipped.
2956 This variable is semi-obsolete and probably should always be true. It
2957 is better to limit inheritance to certain tags using the variables
2958 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2966 "When set, tags are sorted using this function as a comparator."
2982 "Options concerning properties in Org-mode."
2987 "How property key/value pairs should be formatted by `indent-line'.
2988 When `indent-line' hits a property definition, it will format the line
2989 according to this format, mainly to make sure that the values are
2990 lined-up with respect to each other."
2995 "Alist of properties and functions to adjust inserted values.
2996 Elements of this alist must be of the form
2998 ([string] [function])
3000 where [string] must be a property name and [function] must be a
3001 lambda expression: this lambda expression must take one argument,
3002 the value to adjust, and return the new value as a string.
3006 and the clock summary:
3009 (let ((clocksum (org-clock-sum-current-item))
3010 (effort (org-duration-string-to-minutes
3012 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3017 "Non-nil means properties apply also for sublevels.
3019 This setting is chiefly used during property searches. Turning it on can
3020 cause significant overhead when doing a search, which is why it is not
3021 on by default.
3023 When nil, only the properties directly given in the current entry count.
3024 When t, every property is inherited. The value may also be a list of
3025 properties that should have inheritance, or a regular expression matching
3026 properties that should be inherited.
3028 However, note that some special properties use inheritance under special
3029 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3031 for valid values of a property.
3033 Note for programmers:
3034 When querying an entry with `org-entry-get', you can control if inheritance
3035 should be used. By default, `org-entry-get' looks only at the local
3036 properties. You can request inheritance by setting the inherit argument
3037 to t (to force inheritance) or to `selective' (to respect the setting
3038 in this variable)."
3047 "Check if PROPERTY is one that should be inherited."
3058 "The default column format, if no other format has been defined.
3059 This variable can be set on the per-file basis by inserting a line
3061 #+COLUMNS: %25ITEM ....."
3066 "The ellipses to be used when a field in column view is truncated.
3067 When this is the empty string, as many characters as possible are shown,
3068 but then there will be no visual indication that the field has been truncated.
3069 When this is a string of length N, the last N characters of a truncated
3070 field are replaced by this string. If the column is narrower than the
3071 ellipses string, only part of the ellipses string will be shown."
3076 "Function that modifies values for display in column view.
3077 For example, it can be used to cut out a certain part from a time stamp.
3078 The function must take 2 arguments:
3080 column-title The title of the column (*not* the property name)
3081 value The value that should be modified.
3083 The function should return the value that should be displayed,
3084 or nil if the normal value should be used."
3089 "The property that is being used to keep track of effort estimates.
3090 Effort estimates given in this property need to have the format H:MM."
3098 "List of property/value pairs that can be inherited by any entry.
3100 These are fixed values, for the preset properties. The user variable
3101 that can be used to add to this list is `org-global-properties'.
3103 The entries in this list are cons cells where the car is a property
3104 name and cdr is a string with the value. If the value represents
3109 "List of property/value pairs that can be inherited by any entry.
3111 This list will be combined with the constant `org-global-properties-fixed'.
3113 The entries in this list are cons cells where the car is a property
3114 name and cdr is a string with the value.
3116 You can set buffer-local values for the same purpose in the variable
3117 `org-file-properties' this by adding lines like
3119 #+PROPERTY: NAME VALUE"
3126 "List of property/value pairs that can be inherited by any entry.
3127 Valid for the current buffer.
3132 "Options concerning agenda views in Org-mode."
3137 "Variable used by org files to set a category for agenda display.
3138 Such files should use a file variable to set it, for example
3142 or contain a special line
3144 #+CATEGORY: ELisp
3146 If the file does not specify a category, then file's base name
3152 "The files to be used for agenda display.
3156 If an entry is a directory, all files in that directory that are matched by
3157 `org-agenda-file-regexp' will be part of the file list.
3159 If the value of the variable is not a list but a single file name, then
3160 the list of agenda files is actually stored and maintained in that file, one
3161 agenda file per line. In this file paths can be given relative to
3162 `org-directory'. Tilde expansion and environment variable substitution
3163 are also made."
3170 "Regular expression to match files for `org-agenda-files'.
3171 If any element in the list in that variable contains a directory instead
3172 of a normal file, all files in that directory that are matched by this
3173 regular expression will be included."
3178 "List of extra files to be searched by text search commands.
3179 These files will be search in addition to the agenda files by the
3180 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3181 Note that these files will only be searched for text search commands,
3182 not for the other agenda views like todo lists, tag searches or the weekly
3183 agenda. This variable is intended to list notes and possibly archive files
3184 that should also be searched by these two commands.
3185 In fact, if the first element in the list is the symbol `agenda-archives',
3186 than all archive files of all agenda files will be added to the search
3187 scope."
3198 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3199 A nil value means to remove them, after a query, from the list."
3204 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3205 The command `org-calendar-goto-agenda' will be bound to this key. The
3206 default is the character `c' because then `c' can be used to switch back and
3207 forth between agenda and calendar."
3212 "The key to be installed in `calendar-mode-map' for agenda-action.
3213 The command `org-agenda-action' will be bound to this key. The
3214 default is the character `k' because we use the same key in the agenda."
3219 "The key to be installed in `calendar-mode-map' for adding diary entries.
3220 This option is irrelevant until `org-agenda-diary-file' has been configured
3221 to point to an Org-mode file. When that is the case, the command
3222 `org-agenda-diary-entry' will be bound to the key given here, by default
3223 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3224 if you want to continue doing this, you need to change this to a different
3225 key."
3230 "File to which to add new entries with the `i' key in agenda and calendar.
3231 When this is the symbol `diary-file', the functionality in the Emacs
3232 calendar will be used to add entries to the `diary-file'. But when this
3233 points to a file, `org-agenda-diary-entry' will be used instead."
3249 org-calendar-insert-diary-entry-key
3253 "Options for embedding LaTeX code into Org-mode."
3261 "Options for creating images from LaTeX fragments.
3262 This is a property list with the following properties:
3264 `default' means use the foreground of the default face.
3266 `default' means use the background of the default face.
3267 :scale a scaling factor for the size of the images, to get more pixels
3268 :html-foreground, :html-background, :html-scale
3269 the same numbers for HTML export.
3270 :matchers a list indicating which matchers should be used to
3271 find LaTeX fragments. Valid members of this list are:
3282 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3283 When nil, just push out a message."
3288 Use this to specify additional executable file say a jar file.
3290 When using MathToWeb as the converter, specify the full-path to
3291 your mathtoweb.jar file."
3298 "Command to convert LaTeX fragments to MathML.
3299 Replace format-specifiers in the command as noted below and use
3300 `shell-command' to convert LaTeX to MathML.
3301 %j: Executable file in fully expanded form as specified by
3302 `org-latex-to-mathml-jar-file'.
3303 %I: Input LaTeX file in fully expanded form
3304 %o: Output MathML file
3305 This command is used by `org-create-math-formula'.
3307 When using MathToWeb as the converter, set this to
3315 "Return t if `org-latex-to-mathml-convert-command' is usable."
3318 org-latex-to-mathml-convert-command)
3320 org-latex-to-mathml-convert-command))))
3325 t))))))
3332 \[PACKAGES]
3333 \[DEFAULT-PACKAGES]
3334 % The settings below are copied from fullpage.sty
3347 "The document header used for processing LaTeX fragments.
3348 It is imperative that this header make sure that no page number
3349 appears on the page. The package defined in the variables
3350 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3352 will be appended."
3359 "Set the packages alist and make sure it has 3 elements per entry."
3363 x))
3364 val)))
3368 "Get the packages alist and make sure it has 3 elements per entry."
3372 x))
3375 ;; The following variables are defined here because is it also used
3376 ;; when formatting latex fragments. Originally it was part of the
3377 ;; LaTeX exporter, which is why the name includes "export".
3394 )
3395 "Alist of default packages to be inserted in the header.
3396 Change this only if one of the packages here causes an incompatibility
3397 with another package you are using.
3398 The packages in this list are needed by one part or another of Org-mode
3399 to function properly.
3401 - inputenc, fontenc: for basic font and character selection
3402 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3403 for interpreting the entities in `org-entities'. You can skip some of these
3404 packages if you don't use any of the symbols in it.
3405 - graphicx: for including images
3406 - float, wrapfig: for figure placement
3407 - longtable: for long tables
3408 - hyperref: for cross references
3410 Therefore you should not modify this variable unless you know what you
3411 are doing. The one reason to change it anyway is that you might be loading
3412 some other package that conflicts with one of the default packages.
3414 If SNIPPET-FLAG is t, the package also needs to be included when
3415 compiling LaTeX snippets into images for inclusion into HTML."
3428 "Alist of packages to be inserted in every LaTeX header.
3429 These will be inserted after `org-export-latex-default-packages-alist'.
3431 SNIPPET-FLAG, when t, indicates that this package is also needed when
3432 turning LaTeX snippets into images for inclusion into HTML.
3433 Make sure that you only list packages here which:
3434 - you want in every file
3435 - do not conflict with the default packages in
3436 `org-export-latex-default-packages-alist'
3437 - do not conflict with the setup in `org-format-latex-header'."
3451 "Settings for Org-mode appearance."
3456 "Non-nil means fontify only the stars in each headline.
3457 When nil, the entire headline is fontified.
3458 Changing it requires restart of `font-lock-mode' to become effective
3459 also in regions already fontified."
3464 "Non-nil means hide the first N-1 stars in a headline.
3465 This works by using the face `org-hide' for these stars. This
3466 face is white for a light background, and black for a dark
3467 background. You may have to customize the face `org-hide' to
3468 make this work.
3469 Changing it requires restart of `font-lock-mode' to become effective
3470 also in regions already fontified.
3471 You may also set this on a per-file basis by adding one of the following
3472 lines to the buffer:
3474 #+STARTUP: hidestars
3475 #+STARTUP: showstars"
3480 "List of symbols corresponding to keywords to be hidden the org buffer.
3481 For example, a value '(title) for this list will make the document's title
3482 appear in the buffer without the initial #+TITLE: keyword."
3490 "Non-nil means change the face of a headline if it is marked DONE.
3491 Normally, only the TODO/DONE keyword indicates the state of a headline.
3492 When this is non-nil, the headline after the keyword is set to the
3493 `org-headline-done' as an additional indication."
3498 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3499 Changing this variable requires a restart of Emacs to take effect."
3504 "Non-nil means fontify the whole line for headings.
3505 This is useful when setting a background color for the
3506 org-level-* faces."
3511 "Non-nil means fontify what is treated specially by the exporters."
3516 "Non-nil mean font-lock should hide the emphasis marker characters."
3521 "Non-nil means show entities as UTF8 characters.
3527 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3532 "Regular expression for matching emphasis.
3533 After a match, the match groups contain these elements:
3534 0 The match of the full regular expression, including the characters
3535 before and after the proper match
3536 1 The character before the proper match, or empty at beginning of line
3537 2 The proper match, including the leading and trailing markers
3538 3 The leading marker like * or /, indicating the type of highlighting
3539 4 The text between the emphasis markers, not including the markers
3546 "Set variable and compute the emphasis regular expression."
3550 org-emphasis-alist org-emphasis-regexp-components)
3562 ;; make sure special characters appear at the right position in the class
3574 ;; Make the regexp
3582 body1
3594 body1
3602 "Components used to build the regular expression for emphasis.
3603 This is a list with five entries. Terminology: In an emphasis string
3607 specify what is allowed/forbidden in each part:
3609 pre Chars allowed as prematch. Beginning of line will be allowed too.
3610 post Chars allowed as postmatch. End of line will be allowed too.
3611 border The chars *forbidden* as border characters.
3613 non-shy groups here, and don't allow newline here.
3614 newline The maximum number of newlines allowed in an emphasis exp.
3616 Use customize to modify this, or restart Emacs after changing it."
3635 )
3636 "Special syntax for emphasized text.
3637 Text starting and ending with a special character will be emphasized, for
3638 example *bold*, _underlined_ and /italic/. This variable sets the marker
3639 characters, the face to be used by font-lock for highlighting in Org-mode
3640 Emacs buffers, and the HTML tags to be used for this.
3641 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3642 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3643 Use customize to modify this, or restart Emacs after changing it."
3658 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3661 ;;; Miscellaneous options
3664 "Completion in Org-mode."
3669 "Non-nil means use ido completion wherever possible.
3670 Note that `ido-mode' must be active for this variable to be relevant.
3671 If you decide to turn this variable on, you might well want to turn off
3672 `org-outline-path-complete-in-steps'.
3673 See also `org-completion-use-iswitchb'."
3678 "Non-nil means use iswitchb completion wherever possible.
3679 Note that `iswitchb-mode' must be active for this variable to be relevant.
3680 If you decide to turn this variable on, you might well want to turn off
3681 `org-outline-path-complete-in-steps'.
3682 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3688 Normal means, no org-mode-specific context."
3692 ;;; Functions and variables from their packages
3693 ;; Declared here to avoid compiler warnings
3695 ;; XEmacs only
3701 ;; Emacs only
3704 ;; Various packages
3723 org-agenda-format-item "org-agenda"
3754 ;;; Autoload and prepare some org modules
3756 ;; Some table stuff that needs to be defined here, because it is used
3757 ;; by the functions setting up org-mode or checking for table context.
3770 "Detect the first line outside a table when searching from within it.
3773 ;; Autoload the functions in org-table.el that are needed by functions here.
3778 org-table-convert org-table-convert-region org-table-copy-down
3779 org-table-copy-region org-table-create
3780 org-table-create-or-convert-from-region
3781 org-table-create-with-table.el org-table-current-dline
3782 org-table-cut-region org-table-delete-column org-table-edit-field
3783 org-table-edit-formulas org-table-end org-table-eval-formula
3784 org-table-export org-table-field-info
3785 org-table-get-stored-formulas org-table-goto-column
3786 org-table-hline-and-move org-table-import org-table-insert-column
3787 org-table-insert-hline org-table-insert-row org-table-iterate
3788 org-table-justify-field-maybe org-table-kill-row
3789 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3790 org-table-move-column org-table-move-column-left
3791 org-table-move-column-right org-table-move-row
3792 org-table-move-row-down org-table-move-row-up
3793 org-table-next-field org-table-next-row org-table-paste-rectangle
3794 org-table-previous-field org-table-recalculate
3795 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3796 org-table-toggle-coordinate-overlays
3797 org-table-toggle-formula-debugger org-table-wrap-region
3798 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3799 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3800 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3803 "Return t if the cursor is inside an org-type table.
3804 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3809 org-table-line-regexp)))
3810 nil))
3814 "Return t if and only if we are at a table.el table."
3820 "If there is a table.el table nearby, recognize it and move into it."
3826 nil
3836 t
3841 t)
3842 nil)
3843 nil))
3846 "Return t if the cursor is inside a hline in a table."
3851 nil))
3856 "Apply FUNCTION to the start of all tables in the buffer."
3872 ;; Declare and autoload functions from org-exp.el & Co
3880 org-insert-export-options-template
3881 org-table-clean-before-export))
3884 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3885 org-export-region-as-ascii))
3888 org-replace-region-by-latex org-export-region-as-latex
3889 org-export-as-latex org-export-as-pdf
3890 org-export-as-pdf-and-open))
3893 org-export-as-html-batch org-export-as-html-to-buffer
3894 org-replace-region-by-html org-export-region-as-html
3895 org-export-as-html))
3898 org-replace-region-by-docbook org-export-region-as-docbook
3899 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3900 org-export-as-docbook))
3903 org-export-icalendar-all-agenda-files
3904 org-export-icalendar-combine-agenda-files))
3908 ;; Declare and autoload functions from org-agenda.el
3913 org-todo-list org-tags-view org-agenda-list-stuck-projects
3914 org-diary org-agenda-to-appt
3915 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3917 ;; Autoload org-remember
3922 org-remember-apply-template org-remember org-remember-handler)))
3927 org-capture-import-remember-templates)))
3929 ;; Autoload org-clock.el
3944 "Return non-nil if clock is currently running.
3945 The return value is actually the clock marker."
3950 "org-clock"
3952 org-clock-goto org-clock-sum org-clock-display
3953 org-clock-remove-overlays org-clock-report
3954 org-clocktable-shift org-dblock-write:clocktable
3955 org-get-clocktable org-resolve-clocks)))
3958 "If this is a CLOCK line, update it and return t.
3959 Otherwise, return nil."
3968 ts te h m s neg)
3971 nil)
3976 ;; The clock is running here
3997 t))))))
4000 "Check if the current buffer contains the running clock.
4001 If yes, offer to stop it and to save the buffer with the changes."
4010 "Check if this line starts a clock table, if yes, shift the time block."
4014 ;; Autoload org-timer.el
4018 "org-timer"
4020 org-timer-change-times-in-region
4021 org-timer-set-timer
4022 org-timer-reset-timers
4023 org-timer-show-remaining-time)))
4025 ;; Autoload org-feed.el
4029 "org-feed"
4033 ;; Autoload org-indent.el
4035 ;; Define the variable already here, to make sure we have it.
4037 "Non-nil if Org-Indent mode is enabled.
4042 "org-indent"
4045 ;; Autoload org-mobile.el
4049 "org-mobile"
4052 ;; Autoload archiving code
4053 ;; The stuff that is needed for cycling and tags has to be defined here.
4056 "Options concerning archiving in Org-mode."
4061 "The location where subtrees should be archived.
4063 The value of this variable is a string, consisting of two parts,
4064 separated by a double-colon. The first part is a filename and
4065 the second part is a headline.
4067 When the filename is omitted, archiving happens in the same file.
4068 %s in the filename will be replaced by the current file
4069 name (without the directory part). Archiving to a different file
4070 is useful to keep archived entries from contributing to the
4071 Org-mode Agenda.
4073 The archived entries will be filed as subtrees of the specified
4074 headline. When the headline is omitted, the subtrees are simply
4075 filed away at the end of the file, as top-level entries. Also in
4076 the heading you can use %s to represent the file name, this can be
4077 useful when using the same archive for a number of different files.
4079 Here are a few examples:
4081 If the current file is Projects.org, archive in file
4082 Projects.org_archive, as top-level trees. This is the default.
4085 Archive in the current file, under the top-level headline
4089 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4092 Archive in file ~/org/archive.org (absolute path), under headlines
4096 Archive in file ./basement (relative path), as level 3 trees
4099 You may set this option on a per-file basis by adding to the buffer a
4100 line like
4102 #+ARCHIVE: basement::** Finished Tasks
4104 You may also define it locally for a subtree by setting an ARCHIVE property
4105 in the entry. If such a property is found in an entry, or anywhere up
4106 the hierarchy, it will be used."
4111 "The tag that marks a subtree as archived.
4112 An archived subtree does not open during visibility cycling, and does
4113 not contribute to the agenda listings.
4114 After changing this, font-lock must be restarted in the relevant buffers to
4115 get the proper fontification."
4121 "Non-nil means the agenda will skip any items located in archived trees.
4122 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4123 variable is no longer recommended, you should leave it at the value t.
4124 Instead, use the key `v' to cycle the archives-mode in the agenda."
4130 "Non-nil means ignore archived trees when creating column view."
4136 "Non-nil means `org-cycle' will open archived trees.
4137 An archived tree is a tree marked with the tag ARCHIVE.
4138 When nil, archived trees will stay folded. You can still open them with
4139 normal outline commands like `show-all', but not with the cycling commands."
4145 "Non-nil means sparse tree construction shows matches in archived trees.
4146 When nil, matches in these trees are highlighted, but the trees are kept in
4147 collapsed state."
4153 "Re-hide all archived subtrees after a visibility state change."
4164 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4167 "Cycle subtree even if it is archived."
4174 "Re-hide all archived subtrees after a visibility state change."
4189 flag)))
4196 org-archive-to-archive-sibling org-toggle-archive-tag
4197 org-archive-subtree-default
4198 org-archive-subtree-default-with-confirmation)))
4200 ;; Autoload Column View Code
4208 org-columns-compute org-agenda-columns org-columns-remove-overlays
4211 ;; Autoload ID code
4219 org-id-get-with-outline-path-completion
4220 org-id-get-with-outline-drilling org-id-store-link
4221 org-id-goto org-id-find org-id-store-link))
4223 ;; Autoload Plotting Code
4228 ;;; Variables for pre-computed regular expressions, all buffer local
4246 "Matches a headline and puts everything into groups:
4247 group 1: the stars
4248 group 2: The todo keyword, maybe
4249 group 3: Priority cookie
4250 group 4: True headline
4254 "Printf format to make regexp to match an exact headline.
4255 This regexp will match the headline of any node which hase the exact
4256 headline text that is put into the format, but may have any TODO state,
4260 "Matches a headline and puts TODO state into group 2 if present.
4315 "Regular expression to match a plain time or time range.
4316 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4317 groups carry important information:
4318 0 the full match
4319 1 the first time, range or not
4327 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4328 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4329 groups carry important information:
4330 0 the full match
4331 7 hours of duration
4340 "Regular expression to match a timestamp time or time range.
4341 After a match, the following groups carry important information:
4342 0 the full match
4343 1 date plus weekday, for back referencing to make sure both times are on the same day
4344 2 the first time, range or not
4399 "Variable associated with STARTUP options for org-mode.
4400 Each element is a list of three items: The startup options as written
4401 in the #+STARTUP line, the corresponding variable, and the value to
4402 set this variable to if the option is found. An optional forth element PUSH
4406 "Precompute regular expressions for current buffer."
4426 kwds kws0 kwsa key log value cat arch tags const links hw dws
4427 tail sep kws1 prio props ftags drawers beamer-p
4449 ;; general TODO-like setup
4461 links)))
4467 props)))
4472 ftags
4482 l var val)
4512 ))))
4529 ;; Process the TODO keywords
4531 ;; Use the global values as if they had been given locally.
4543 kws)))
4546 kwsa nil
4549 ;; 1 2
4557 kw)
4559 kws0)
4576 ;; Process the constants
4584 ;; Process the tags.
4595 tgs))
4603 ;; Compute the regular expressions and other local variables
4611 org-drawer-regexp
4615 org-not-done-keywords
4617 org-todo-regexp
4620 org-not-done-regexp
4624 org-not-done-heading-regexp
4628 org-todo-line-regexp
4632 org-complex-heading-regexp
4639 org-complex-heading-regexp-format
4648 org-nl-done-regexp
4652 org-todo-line-tags-regexp
4657 org-looking-at-done-regexp
4662 org-deadline-time-regexp
4664 org-deadline-line-regexp
4666 org-scheduled-regexp
4668 org-scheduled-time-regexp
4670 org-closed-time-regexp
4672 org-keyword-time-regexp
4678 org-keyword-time-not-clock-regexp
4684 org-maybe-keyword-time-regexp
4690 org-planning-or-clock-line-re
4695 org-all-time-keywords
4698 org-clock-string org-closed-string))
4699 )
4704 "Return the contents of FILE, as a string."
4718 "Extract the log state setting from a TODO keyword string.
4732 "Remove a pair of parenthesis at the end of each string in LIST."
4736 x))
4737 list))
4740 "Assign fast keys to a keyword-key alist.
4741 Respect keys that are already there."
4759 ;;; Some variables used in various places
4766 "Function to be called when `C-c C-c' is used.
4770 ;; FIXME: Occasionally check by commenting these, to make sure
4771 ;; no other functions uses these, forgetting to let-bind them.
4776 ;; Defined somewhere in this file, but used before definition.
4782 ;;;; Define the Org-mode
4785 (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"))
4788 ;; We use a before-change function to check if a table might need
4789 ;; an update.
4791 "Indicates that a table might need an update.
4792 This variable is set by `org-before-change-function'.
4795 "Every change indicates that a table might need an update."
4805 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4806 ;; some places -- e.g. see the macro org-with-limited-levels.
4807 ;;
4808 ;; In Org buffers, the value of `outline-regexp' is that of
4809 ;; `org-outline-regexp'. The only function still directly relying on
4810 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4811 ;; job when `orgstruct-mode' is active.
4815 "Regexp to match Org headlines.
4816 This is similar to `org-outline-regexp' but additionally makes
4819 ;;;###autoload
4821 "Outline-based notes management and organizer, alias
4824 Org-mode develops organizational tasks around a NOTES file which
4825 contains information about projects as plain text. Org-mode is
4826 implemented on top of outline-mode, which is ideal to keep the content
4827 of large files well structured. It supports ToDo items, deadlines and
4828 time stamps, which magically appear in the diary listing of the Emacs
4829 calendar. Tables are easily created with a built-in table editor.
4830 Plain text URL-like links connect to websites, emails (VM), Usenet
4831 messages (Gnus), BBDB entries, and any files related to the project.
4832 For printing and sharing of notes, an Org-mode file (or a part of it)
4833 can be exported as a structured ASCII or HTML file.
4835 The following commands are available:
4839 ;; Get rid of Outline menus, they are not needed
4840 ;; Need to do this here because define-derived-mode sets up
4841 ;; the keymap so late. Still, it is a waste to call this each time
4842 ;; we switch another buffer into org-mode.
4845 ;; Assume this is Greg's port, it uses easymenu
4871 org-display-table 4
4874 org-ellipsis)))
4879 ;; tag faces set outside customize.... force initialization.
4881 ;; Calc embedded
4887 ;; Activate before-change-function
4891 ;; Check for running clock before killing a buffer
4893 ;; Paragraphs and auto-filling
4897 ;; Beginning/end of defun
4900 ;; Next error for sparse trees
4902 ;; Make sure dependence stuff works reliably, even for users who set it
4903 ;; too late :-(
4915 ;; Comment characters
4919 ;; Align options lines
4921 'align-mode-rules-list
4926 ;; Imenu
4930 ;; Make isearch reveal context
4933 ;; Emacs 21 and XEmacs make use of the hook
4935 ;; Emacs 22 deals with this through a special variable
4939 ;; Turn on org-beamer-mode?
4942 ;; Setup the pcomplete hooks
4955 ;; If empty file that did not turn on org-mode automatically, make it to.
4980 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4990 "Return today date, considering `org-extend-today-until'."
4995 ;;;; Font-Lock stuff, including the activators
5026 "Regular expression used to analyze links.
5027 Here is what the match groups contain after a match:
5028 1: http:
5029 2: http
5030 3: path
5031 4: [desc]
5039 "Number of stacked braces for sub/superscript matching.
5040 This has to be set before loading org.el to be effective."
5045 "Create a regular expression which will match a balanced sexp.
5046 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5047 as single character strings.
5048 The regexp returned will match the entire expression including the
5049 delimiters. It will also define a single group which contains the
5050 match except for the outermost delimiters. The maximum depth of
5051 stacked delimiters is N. Escaping delimiters is not possible."
5080 "Update the link regular expressions.
5081 This should be called after the variable `org-link-types' has changed."
5085 org-link-re-with-space
5091 org-link-re-with-space2
5097 org-link-re-with-space3
5102 org-angle-link-re
5108 org-plain-link-re
5112 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5113 org-bracket-link-regexp
5115 org-bracket-link-analytic-regexp
5123 org-bracket-link-analytic-regexp++
5131 org-any-link-re
5140 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5142 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5143 "Regular expression matching time strings for analysis.
5144 This one does not require the space after the date, so it can be used
5146 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5162 "Regular expression matching a time stamp or time stamp range.
5168 "Run through the buffer and add overlays to emphasised strings."
5177 'face
5190 rtn))
5193 "Insert or change an emphasis, i.e. a font like bold or italic.
5194 If there is an active region, change that region to a new emphasis.
5195 If there is no region, just insert the marker characters and position
5196 the cursor between them.
5197 CHAR should be either the marker character, or the first character of the
5198 HTML tag associated with that emphasis. If CHAR is a space, the means
5199 to remove the emphasis of the selected region.
5200 If char is not given (for example in an interactive call) it
5201 will be prompted for."
5252 "Run through the buffer and add overlays to links."
5261 nil
5267 t)))))
5275 t)))
5278 "When non-nil, fontify code in code blocks."
5289 "Fontify #+ lines and blocks, in the correct ways."
5292 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5293 limit t)
5301 end end1 quoting block-type ovl)
5304 ;; a single line of backend-specific content
5312 ; for backend-specific code
5313 t)
5315 ;; Truly a block
5327 beg end
5335 ;; remove old background overlays
5340 ;; add a background overlay
5354 t))
5367 ;; just any other in-buffer setting, but not indented
5371 t)
5380 t)
5388 "Run through the buffer and add overlays to links."
5396 t)))
5399 "Run through the buffer and add overlays to footnotes."
5406 'keymap org-mouse-map
5407 'help-echo
5409 "Footnote definition"
5411 'font-lock-fontified t
5412 'font-lock-multiline t
5416 "Run through the buffer and add overlays to bracketed links."
5420 ;; FIXME: above we should remove the escapes.
5421 ;; but that requires another match, protecting match data,
5422 ;; a lot of overhead for font-lock.
5429 ;; We need to remove the invisible property here. Table narrowing
5430 ;; may have made some of this invisible.
5448 t)))
5451 "Run through the buffer and add overlays to dates."
5463 t)))
5472 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5476 "Run through the buffer and add overlays to target matches."
5484 'keymap org-mouse-map
5488 t)))))
5491 "Find all radio targets in this file and update the regular expression."
5506 t)))
5513 ;; This should be with the exporter code, but we also use if for font-locking
5523 "Compute regular expression for stuff treated specially by exporters."
5530 org-latex-regexps)))
5558 org-entities)))
5562 org-latex-entities)
5563 nil))
5565 ))
5566 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5569 org-export-html-special-string-regexps)))
5574 ))))
5576 'org-latex-and-specials-regexp
5581 "Run through the buffer and add overlays to links."
5585 limit t))
5599 rtn)))
5602 "Restart `font-lock-mode', to force refontification."
5608 "Return a list of all targets in this file.
5609 With optional argument RADIO, only find radio targets."
5611 rtn)
5616 rtn)))
5619 "Make regular expression matching all strings in TARGETS.
5620 The regular expression finds the targets also if there is a line break
5621 between words."
5630 x)
5631 targets
5643 t)))
5646 "Compute the outline level of the heading at point.
5647 This function assumes that the cursor is at the beginning of a line matched
5648 by `outline-regexp'. Otherwise it returns garbage.
5649 If this is called at a normal headline, the level is the number of stars.
5650 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5657 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5664 "Functions that can manipulate `org-font-lock-extra-keywords'.
5665 This is calles after `org-font-lock-extra-keywords' is defined, but before
5666 it is installed to be used by font lock. This can be useful if something
5677 ;; Call the hook
5679 ;; Headlines
5686 ;; Table lines
5689 ;; Table internals
5694 ;; Drawers
5697 ;; Properties
5701 ;; Links
5711 ;; TODO lines
5714 ;; DONE
5720 nil)
5721 ;; Priorities
5723 ;; Tags
5725 ;; Special keywords
5730 ;; Emphasis
5735 ;; Checkboxes
5736 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5741 ;; Description list items
5744 ;; ARCHIVEd headings
5746 org-outline-regexp-bol
5749 ;; Specials
5753 ;; Code
5755 ;; COMMENT
5760 ;; Blocks and meta lines
5762 )))
5765 ;; Now set the full font-lock-keywords
5772 "Toggle the composition display of entities as UTF8 characters."
5784 "Find an entity to fontify."
5790 limit t)
5802 nil))))
5805 "Fontify string S like in Org-mode."
5817 "Get the right face for match N in font-lock matching of headlines."
5830 "Get the right face for a TODO keyword KWD.
5831 If KWD is a number, get the corresponding match group."
5839 "Create a face list that inherits INHERIT, but sets the foreground color.
5840 When FACE-OR-COLOR is not a string, just return it."
5844 face-or-color)
5845 face-or-color))
5848 "Add the special tag faces."
5857 "Add the special priority faces."
5864 org-priority-faces)))
5869 "Get the right face for a TODO keyword KWD.
5870 If KWD is a number, get the corresponding match group."
5877 "Remove fontification and activation overlays from links."
5882 deactivate-mark buffer-file-name buffer-file-truename)
5886 invisible t intangible t
5887 org-no-flyspell t org-emphasis t))
5897 "Remove specific display properties that have been added by font lock.
5898 The will remove the raise properties that are used to show superscripts
5899 and subscripts."
5909 "Add raise properties to sub/superscripts."
5913 org-match-substring-regexp
5914 org-match-substring-with-braces-regexp)
5915 limit t)
5925 ;; FIXME: Should we go back one character here, for a_b^c
5926 ;; (goto-char (1- pos)) ;????????????????????
5928 t
5930 'display
5946 t)))))
5948 ;;;; Visibility cycling, including org-goto and indirect buffer
5950 ;;; Cycling
5957 ;;;###autoload
5962 "TAB-action and visibility cycling for Org-mode.
5964 This is the command invoked in Org-mode by the TAB key. Its main purpose
5965 is outline visibility cycling, but it also invokes other actions
5966 in special contexts.
5968 - When this function is called with a prefix argument, rotate the entire
5969 buffer through 3 states (global cycling)
5970 1. OVERVIEW: Show only top-level headlines.
5971 2. CONTENTS: Show all headlines of all levels, but no body text.
5972 3. SHOW ALL: Show everything.
5973 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5974 determined by the variable `org-startup-folded', and by any VISIBILITY
5975 properties in the buffer.
5976 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5977 including any drawers.
5979 - When inside a table, re-align the table and move to the next field.
5981 - When point is at the beginning of a headline, rotate the subtree started
5982 by this line through 3 different states (local cycling)
5983 1. FOLDED: Only the main headline is shown.
5984 2. CHILDREN: The main headline and the direct children are shown.
5985 From this state, you can move to one of the children
5986 and zoom in further.
5987 3. SUBTREE: Show the entire subtree, including body text.
5988 If there is no subtree, switch directly from CHILDREN to FOLDED.
5990 - When point is at the beginning of an empty headline and the variable
5991 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5992 of the headline by demoting and promoting it to likely levels. This
5993 speeds up creation document structure by pressing TAB once or several
5994 times right after creating a new headline.
5996 - When there is a numeric prefix, go up to a heading with level ARG, do
5997 a `show-subtree' and return to the previous cursor position. If ARG
5998 is negative, go up that many levels.
6000 - When point is not at the beginning of a headline, execute the global
6001 binding for TAB, which is re-indenting the line. See the option
6002 `org-cycle-emulate-tab' for details.
6004 - Special case: if point is at the beginning of the buffer and there is
6005 no headline in line 1, this function will act as if called with prefix arg
6006 (C-u TAB, same as S-TAB) also when called without prefix arg.
6007 But only if also the variable `org-cycle-global-at-bob' is t."
6017 org-inlinetask-min-level
6022 limit-level)))
6025 outline-regexp
6033 org-cycle-hook))
6037 ;; special case: use global cycling
6051 ;; Table: enter it or move to the next field.
6062 ;; Global cycling: delegate to `org-cycle-internal-global'.
6065 ;; Drawers: delegate to `org-flag-drawer'.
6073 ;; Show-subtree, ARG levels up from here.
6081 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6087 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6094 ;; From there: TAB emulation and template completion.
6118 t
6127 "Do the global cycling action."
6131 ;; We just created the overview - now do table of contents
6132 ;; This can be slow in very large buffers, so indicate action
6142 ;; We just showed the table of contents - now show everything
6150 ;; Default action: go to overview
6158 "Do the local cycling action."
6160 ;; First, determine end of headline (EOH), end of subtree or item
6161 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6185 ;; Determine end invisible part of buffer (EOL)
6187 ;; XEmacs doesn't have `next-single-char-property-change'
6197 ;; Find out what to do next and set `this-command'
6200 ;; Nothing is hidden behind this heading
6212 org-cycle-skip-children-state-if-no-children))))
6213 ;; Entire subtree is hidden in one line: children view
6219 ;; Fold every list in subtree to top-level items.
6241 ;; We just showed the children, or no children are there,
6242 ;; now show everything.
6249 ;; Default action: hide the subtree.
6256 ;;;###autoload
6258 "Cycle the global visibility. For details see `org-cycle'.
6260 With a numeric prefix, show all headlines up to that level."
6276 "Set the visibility required by startup options and properties."
6291 "Switch subtree visibilities according to :VISIBILITY: property."
6298 nil t)
6322 ;; This function uses outline-regexp instead of the more fundamental
6323 ;; org-outline-regexp so that org-cycle-global works outside of Org
6324 ;; buffers, where outline-regexp is needed.
6326 "Switch to overview mode, showing only top-level headlines.
6327 Really, this shows all headlines with level equal or greater than the level
6328 of the first headline in the buffer. This is important, because if the
6329 first headline is not level one, then (hide-sublevels 1) gives confusing
6330 results."
6341 "Show all headlines in the buffer, like a table of contents.
6342 With numerical argument N, show content up to level N."
6345 ;; Visit all headings and show their offspring
6352 t)
6361 "Adjust the window after a change in outline visibility.
6362 This function is the default value of the hook `org-cycle-hook'."
6372 "Remove outline overlays that do not contain non-white stuff."
6382 "Fix visibility issues after moving a subtree."
6383 ;; First, find a reasonable region to look at:
6384 ;; Start two siblings above, end three below
6402 ;; Properly fold already folded siblings
6413 "Show empty lines above all visible headlines.
6414 The region to be covered depends on STATE when called through
6415 `org-cycle-hook'. Lisp program can use t for STATE to get the
6416 entire buffer covered. Note that an empty line is only shown if there
6417 are at least `org-cycle-separator-lines' empty lines before the headline."
6427 beg end b e)
6451 ;; Never hide empty lines at the end of the file.
6461 "Move to the parent and re-show empty lines before visible headlines."
6467 "Return `org-agenda-files' list, plus all open org-mode files.
6468 This is useful for operations that need to scan all of a user's
6469 open and agenda-wise Org files."
6477 files))
6480 "Return the beginning position of the current entry."
6484 "Return the end position of the current entry."
6488 "Re-hide all drawers after a visibility state change."
6514 "Is the end of the current subtree visible?"
6519 "Move cursor to the first headline and recenter the headline.
6520 Optional argument N means put the headline into the Nth line of the window."
6526 ;;; Saving and restoring visibility
6529 "Return a list of the locations of all outline overlays.
6530 These are overlays with the `invisible' property value `outline'.
6531 The return value is a list of cons cells, with start and stop
6532 positions for each overlay.
6533 If USE-MARKERS is set, return the positions as markers."
6551 "Create visibility overlays for all positions in DATA.
6552 DATA should have been made by `org-outline-overlay-data'."
6561 data)))))
6563 ;;; Folding of blocks
6574 "Call FUNCTION at the head of all source blocks in the current buffer.
6575 Optional arguments START and END can be used to limit the range."
6587 "Toggle the visibility of all blocks in the current buffer."
6591 "Fold all blocks in the current buffer."
6597 "Unfold all blocks in the current buffer."
6603 "Toggle visibility of block at point."
6614 "Toggle the visibility of the current block."
6621 ov)
6637 ;; make the block accessible to isearch
6639 ov 'isearch-open-invisible
6650 ;; org-tab-after-check-for-cycling-hook
6652 ;; Remove overlays when changing major mode
6657 ;;; Org-goto
6663 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6679 nil)
6680 (org-defkey map "q" 'org-goto-quit)
6681 (org-defkey map "n" 'outline-next-visible-heading)
6682 (org-defkey map "p" 'outline-previous-visible-heading)
6683 (org-defkey map "f" 'outline-forward-same-level)
6684 (org-defkey map "b" 'outline-backward-same-level)
6685 (org-defkey map "u" 'outline-up-heading))
6686 (org-defkey map "/" 'org-occur)
6687 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6688 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6689 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6690 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6691 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6692 map))
6694 (defconst org-goto-help
6695 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6696 RET=jump to location [Q]uit and return to previous location
6697 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6699 (defvar org-goto-start-pos) ; dynamically scoped parameter
6701 ;; FIXME: Docstring does not mention both interfaces
6702 (defun org-goto (&optional alternative-interface)
6703 "Look up a different location in the current file, keeping current visibility.
6705 When you want look-up or go to a different location in a document, the
6706 fastest way is often to fold the entire buffer and then dive into the tree.
6707 This method has the disadvantage, that the previous location will be folded,
6708 which may not be what you want.
6710 This command works around this by showing a copy of the current buffer
6711 in an indirect buffer, in overview mode. You can dive into the tree in
6712 that copy, use org-occur and incremental search to find a location.
6713 When pressing RET or `Q', the command returns to the original buffer in
6714 which the visibility is still unchanged. After RET is will also jump to
6715 the location selected in the indirect buffer and expose the headline
6716 hierarchy above."
6717 (interactive "P")
6718 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6719 (org-refile-use-outline-path t)
6720 (org-refile-target-verify-function nil)
6721 (interface
6722 (if (not alternative-interface)
6723 org-goto-interface
6724 (if (eq org-goto-interface 'outline)
6725 'outline-path-completion
6726 'outline)))
6727 (org-goto-start-pos (point))
6728 (selected-point
6729 (if (eq interface 'outline)
6730 (car (org-get-location (current-buffer) org-goto-help))
6731 (let ((pa (org-refile-get-location "Goto")))
6732 (org-refile-check-position pa)
6733 (nth 3 pa)))))
6734 (if selected-point
6735 (progn
6736 (org-mark-ring-push org-goto-start-pos)
6737 (goto-char selected-point)
6738 (if (or (outline-invisible-p) (org-invisible-p2))
6739 (org-show-context 'org-goto)))
6740 (message "Quit"))))
6742 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6743 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6744 (defvar org-goto-local-auto-isearch-map) ; defined below
6746 (defun org-get-location (buf help)
6747 "Let the user select a location in the Org-mode buffer BUF.
6748 This function uses a recursive edit. It returns the selected position
6749 or nil."
6750 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6751 (isearch-hide-immediately nil)
6752 (isearch-search-fun-function
6753 (lambda () 'org-goto-local-search-headings))
6754 (org-goto-selected-point org-goto-exit-command)
6755 (pop-up-frames nil)
6756 (special-display-buffer-names nil)
6757 (special-display-regexps nil)
6758 (special-display-function nil))
6759 (save-excursion
6760 (save-window-excursion
6761 (delete-other-windows)
6762 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6763 (org-pop-to-buffer-same-window
6764 (condition-case nil
6765 (make-indirect-buffer (current-buffer) "*org-goto*")
6766 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6767 (with-output-to-temp-buffer "*Help*"
6768 (princ help))
6769 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6770 (setq buffer-read-only nil)
6771 (let ((org-startup-truncated t)
6772 (org-startup-folded nil)
6773 (org-startup-align-all-tables nil))
6774 (org-mode)
6775 (org-overview))
6776 (setq buffer-read-only t)
6777 (if (and (boundp 'org-goto-start-pos)
6778 (integer-or-marker-p org-goto-start-pos))
6779 (let ((org-show-hierarchy-above t)
6780 (org-show-siblings t)
6781 (org-show-following-heading t))
6782 (goto-char org-goto-start-pos)
6783 (and (outline-invisible-p) (org-show-context)))
6784 (goto-char (point-min)))
6785 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6786 (message "Select location and press RET")
6787 (use-local-map org-goto-map)
6788 (recursive-edit)
6789 ))
6790 (kill-buffer "*org-goto*")
6791 (cons org-goto-selected-point org-goto-exit-command)))
6793 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6794 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6795 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6796 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6798 (defun org-goto-local-search-headings (string bound noerror)
6799 "Search and make sure that any matches are in headlines."
6800 (catch 'return
6801 (while (if isearch-forward
6802 (search-forward string bound noerror)
6803 (search-backward string bound noerror))
6804 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6805 (and (member :headline context)
6806 (not (member :tags context))))
6807 (throw 'return (point))))))
6809 (defun org-goto-local-auto-isearch ()
6810 "Start isearch."
6811 (interactive)
6812 (goto-char (point-min))
6813 (let ((keys (this-command-keys)))
6814 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6815 (isearch-mode t)
6816 (isearch-process-search-char (string-to-char keys)))))
6818 (defun org-goto-ret (&optional arg)
6819 "Finish `org-goto' by going to the new location."
6820 (interactive "P")
6821 (setq org-goto-selected-point (point)
6822 org-goto-exit-command 'return)
6823 (throw 'exit nil))
6825 (defun org-goto-left ()
6826 "Finish `org-goto' by going to the new location."
6827 (interactive)
6828 (if (org-on-heading-p)
6829 (progn
6830 (beginning-of-line 1)
6831 (setq org-goto-selected-point (point)
6832 org-goto-exit-command 'left)
6833 (throw 'exit nil))
6834 (error "Not on a heading")))
6836 (defun org-goto-right ()
6837 "Finish `org-goto' by going to the new location."
6838 (interactive)
6839 (if (org-on-heading-p)
6840 (progn
6841 (setq org-goto-selected-point (point)
6842 org-goto-exit-command 'right)
6843 (throw 'exit nil))
6844 (error "Not on a heading")))
6846 (defun org-goto-quit ()
6847 "Finish `org-goto' without cursor motion."
6848 (interactive)
6849 (setq org-goto-selected-point nil)
6850 (setq org-goto-exit-command 'quit)
6851 (throw 'exit nil))
6853 ;;; Indirect buffer display of subtrees
6855 (defvar org-indirect-dedicated-frame nil
6856 "This is the frame being used for indirect tree display.")
6857 (defvar org-last-indirect-buffer nil)
6859 (defun org-tree-to-indirect-buffer (&optional arg)
6860 "Create indirect buffer and narrow it to current subtree.
6861 With numerical prefix ARG, go up to this level and then take that tree.
6862 If ARG is negative, go up that many levels.
6863 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6864 indirect buffer previously made with this command, to avoid proliferation of
6865 indirect buffers. However, when you call the command with a \
6867 when `org-indirect-buffer-display' is `new-frame', the last buffer
6868 is kept so that you can work with several indirect buffers at the same time.
6869 If `org-indirect-buffer-display' is `dedicated-frame', the \
6871 requests that a new frame be made for the new buffer, so that the dedicated
6872 frame is not changed."
6873 (interactive "P")
6874 (let ((cbuf (current-buffer))
6875 (cwin (selected-window))
6876 (pos (point))
6877 beg end level heading ibuf)
6878 (save-excursion
6879 (org-back-to-heading t)
6880 (when (numberp arg)
6881 (setq level (org-outline-level))
6882 (if (< arg 0) (setq arg (+ level arg)))
6883 (while (> (setq level (org-outline-level)) arg)
6884 (outline-up-heading 1 t)))
6885 (setq beg (point)
6886 heading (org-get-heading))
6887 (org-end-of-subtree t t)
6888 (if (org-on-heading-p) (backward-char 1))
6889 (setq end (point)))
6890 (if (and (buffer-live-p org-last-indirect-buffer)
6891 (not (eq org-indirect-buffer-display 'new-frame))
6892 (not arg))
6893 (kill-buffer org-last-indirect-buffer))
6894 (setq ibuf (org-get-indirect-buffer cbuf)
6895 org-last-indirect-buffer ibuf)
6896 (cond
6897 ((or (eq org-indirect-buffer-display 'new-frame)
6898 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6899 (select-frame (make-frame))
6900 (delete-other-windows)
6901 (org-pop-to-buffer-same-window ibuf)
6902 (org-set-frame-title heading))
6903 ((eq org-indirect-buffer-display 'dedicated-frame)
6904 (raise-frame
6905 (select-frame (or (and org-indirect-dedicated-frame
6906 (frame-live-p org-indirect-dedicated-frame)
6907 org-indirect-dedicated-frame)
6908 (setq org-indirect-dedicated-frame (make-frame)))))
6909 (delete-other-windows)
6910 (org-pop-to-buffer-same-window ibuf)
6911 (org-set-frame-title (concat "Indirect: " heading)))
6912 ((eq org-indirect-buffer-display 'current-window)
6913 (org-pop-to-buffer-same-window ibuf))
6914 ((eq org-indirect-buffer-display 'other-window)
6915 (pop-to-buffer ibuf))
6916 (t (error "Invalid value")))
6917 (if (featurep 'xemacs)
6918 (save-excursion (org-mode) (turn-on-font-lock)))
6919 (narrow-to-region beg end)
6920 (show-all)
6921 (goto-char pos)
6922 (run-hook-with-args 'org-cycle-hook 'all)
6923 (and (window-live-p cwin) (select-window cwin))))
6925 (defun org-get-indirect-buffer (&optional buffer)
6926 (setq buffer (or buffer (current-buffer)))
6927 (let ((n 1) (base (buffer-name buffer)) bname)
6928 (while (buffer-live-p
6929 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6930 (setq n (1+ n)))
6931 (condition-case nil
6932 (make-indirect-buffer buffer bname 'clone)
6933 (error (make-indirect-buffer buffer bname)))))
6935 (defun org-set-frame-title (title)
6936 "Set the title of the current frame to the string TITLE."
6937 ;; FIXME: how to name a single frame in XEmacs???
6938 (unless (featurep 'xemacs)
6939 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6941 ;;;; Structure editing
6943 ;;; Inserting headlines
6945 (defun org-previous-line-empty-p ()
6946 (save-excursion
6947 (and (not (bobp))
6948 (or (beginning-of-line 0) t)
6949 (save-match-data
6952 (defun org-insert-heading (&optional force-heading invisible-ok)
6953 "Insert a new heading or item with same depth at point.
6954 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6955 If point is at the beginning of a headline, insert a sibling before the
6956 current headline. If point is not at the beginning, split the line,
6957 create the new headline with the text in the current line after point
6958 \(but see also the variable `org-M-RET-may-split-line').
6960 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6961 This is important for non-interactive uses of the command."
6962 (interactive "P")
6963 (if (or (= (buffer-size) 0)
6964 (and (not (save-excursion
6965 (and (ignore-errors (org-back-to-heading invisible-ok))
6966 (org-on-heading-p))))
6967 (or force-heading (not (org-in-item-p)))))
6968 (progn
6970 (run-hooks 'org-insert-heading-hook))
6971 (when (or force-heading (not (org-insert-item)))
6972 (let* ((empty-line-p nil)
6973 (level nil)
6974 (on-heading (org-on-heading-p))
6975 (head (save-excursion
6976 (condition-case nil
6977 (progn
6978 (org-back-to-heading invisible-ok)
6979 (when (and (not on-heading)
6980 (featurep 'org-inlinetask)
6981 (integerp org-inlinetask-min-level)
6982 (>= (length (match-string 0))
6983 org-inlinetask-min-level))
6984 ;; Find a heading level before the inline task
6985 (while (and (setq level (org-up-heading-safe))
6986 (>= level org-inlinetask-min-level)))
6987 (if (org-on-heading-p)
6988 (org-back-to-heading invisible-ok)
6989 (error "This should not happen")))
6990 (setq empty-line-p (org-previous-line-empty-p))
6991 (match-string 0))
6992 (error "*"))))
6993 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6994 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6995 pos hide-previous previous-pos)
6996 (cond
6997 ((and (org-on-heading-p) (bolp)
6998 (or (bobp)
6999 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7000 ;; insert before the current line
7001 (open-line (if blank 2 1)))
7002 ((and (bolp)
7003 (not org-insert-heading-respect-content)
7004 (or (bobp)
7005 (save-excursion
7006 (backward-char 1) (not (outline-invisible-p)))))
7007 ;; insert right here
7008 nil)
7009 (t
7010 ;; somewhere in the line
7011 (save-excursion
7012 (setq previous-pos (point-at-bol))
7013 (end-of-line)
7014 (setq hide-previous (outline-invisible-p)))
7015 (and org-insert-heading-respect-content (org-show-subtree))
7016 (let ((split
7017 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7018 (save-excursion
7019 (let ((p (point)))
7020 (goto-char (point-at-bol))
7021 (and (looking-at org-complex-heading-regexp)
7022 (> p (match-beginning 4)))))))
7023 tags pos)
7024 (cond
7025 (org-insert-heading-respect-content
7026 (org-end-of-subtree nil t)
7027 (when (featurep 'org-inlinetask)
7028 (while (and (not (eobp))
7030 (>= (length (match-string 1))
7031 org-inlinetask-min-level))
7032 (org-end-of-subtree nil t)))
7033 (or (bolp) (newline))
7034 (or (org-previous-line-empty-p)
7035 (and blank (newline)))
7036 (open-line 1))
7037 ((org-on-heading-p)
7038 (when hide-previous
7039 (show-children)
7040 (org-show-entry))
7042 (setq tags (and (match-end 2) (match-string 2)))
7043 (and (match-end 1)
7044 (delete-region (match-beginning 1) (match-end 1)))
7045 (setq pos (point-at-bol))
7046 (or split (end-of-line 1))
7047 (delete-horizontal-space)
7049 (buffer-substring (point-at-bol) (point)))
7050 (insert " "))
7051 (newline (if blank 2 1))
7052 (when tags
7053 (save-excursion
7054 (goto-char pos)
7055 (end-of-line 1)
7056 (insert " " tags)
7057 (org-set-tags nil 'align))))
7058 (t
7059 (or split (end-of-line 1))
7060 (newline (if blank 2 1)))))))
7061 (insert head) (just-one-space)
7062 (setq pos (point))
7063 (end-of-line 1)
7064 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7065 (when (and org-insert-heading-respect-content hide-previous)
7066 (save-excursion
7067 (goto-char previous-pos)
7068 (hide-subtree)))
7069 (run-hooks 'org-insert-heading-hook)))))
7071 (defun org-get-heading (&optional no-tags no-todo)
7072 "Return the heading of the current entry, without the stars.
7073 When NO-TAGS is non-nil, don't include tags.
7074 When NO-TODO is non-nil, don't include TODO keywords."
7075 (save-excursion
7076 (org-back-to-heading t)
7077 (cond
7078 ((and no-tags no-todo)
7079 (looking-at org-complex-heading-regexp)
7080 (match-string 4))
7081 (no-tags
7083 (match-string 1))
7084 (no-todo
7087 (match-string 2))
7089 (match-string 1)))))
7091 (defun org-heading-components ()
7092 "Return the components of the current heading.
7093 This is a list with the following elements:
7094 - the level as an integer
7095 - the reduced level, different if `org-odd-levels-only' is set.
7096 - the TODO keyword, or nil
7097 - the priority character, like ?A, or nil if no priority is given
7098 - the headline text itself, or the tags string if no headline text
7099 - the tags string, or nil."
7100 (save-excursion
7101 (org-back-to-heading t)
7102 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7103 (list (length (match-string 1))
7104 (org-reduced-level (length (match-string 1)))
7105 (org-match-string-no-properties 2)
7106 (and (match-end 3) (aref (match-string 3) 2))
7107 (org-match-string-no-properties 4)
7108 (org-match-string-no-properties 5)))))
7110 (defun org-get-entry ()
7111 "Get the entry text, after heading, entire subtree."
7112 (save-excursion
7113 (org-back-to-heading t)
7114 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7116 (defun org-insert-heading-after-current ()
7117 "Insert a new heading with same level as current, after current subtree."
7118 (interactive)
7119 (org-back-to-heading)
7120 (org-insert-heading)
7121 (org-move-subtree-down)
7122 (end-of-line 1))
7124 (defun org-insert-heading-respect-content ()
7125 (interactive)
7126 (let ((org-insert-heading-respect-content t))
7127 (org-insert-heading t)))
7129 (defun org-insert-todo-heading-respect-content (&optional force-state)
7130 (interactive "P")
7131 (let ((org-insert-heading-respect-content t))
7132 (org-insert-todo-heading force-state t)))
7134 (defun org-insert-todo-heading (arg &optional force-heading)
7135 "Insert a new heading with the same level and TODO state as current heading.
7136 If the heading has no TODO state, or if the state is DONE, use the first
7137 state (TODO by default). Also with prefix arg, force first state."
7138 (interactive "P")
7139 (when (or force-heading (not (org-insert-item 'checkbox)))
7140 (org-insert-heading force-heading)
7141 (save-excursion
7142 (org-back-to-heading)
7143 (outline-previous-heading)
7144 (looking-at org-todo-line-regexp))
7145 (let*
7146 ((new-mark-x
7147 (if (or arg
7148 (not (match-beginning 2))
7149 (member (match-string 2) org-done-keywords))
7150 (car org-todo-keywords-1)
7151 (match-string 2)))
7152 (new-mark
7153 (or
7154 (run-hook-with-args-until-success
7155 'org-todo-get-default-hook new-mark-x nil)
7156 new-mark-x)))
7157 (beginning-of-line 1)
7158 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7159 (if org-treat-insert-todo-heading-as-state-change
7160 (org-todo new-mark)
7161 (insert new-mark " "))))
7162 (when org-provide-todo-statistics
7163 (org-update-parent-todo-statistics))))
7165 (defun org-insert-subheading (arg)
7166 "Insert a new subheading and demote it.
7167 Works for outline headings and for plain lists alike."
7168 (interactive "P")
7169 (org-insert-heading arg)
7170 (cond
7171 ((org-on-heading-p) (org-do-demote))
7172 ((org-at-item-p) (org-indent-item))))
7174 (defun org-insert-todo-subheading (arg)
7175 "Insert a new subheading with TODO keyword or checkbox and demote it.
7176 Works for outline headings and for plain lists alike."
7177 (interactive "P")
7178 (org-insert-todo-heading arg)
7179 (cond
7180 ((org-on-heading-p) (org-do-demote))
7181 ((org-at-item-p) (org-indent-item))))
7183 ;;; Promotion and Demotion
7185 (defvar org-after-demote-entry-hook nil
7186 "Hook run after an entry has been demoted.
7187 The cursor will be at the beginning of the entry.
7188 When a subtree is being demoted, the hook will be called for each node.")
7190 (defvar org-after-promote-entry-hook nil
7191 "Hook run after an entry has been promoted.
7192 The cursor will be at the beginning of the entry.
7193 When a subtree is being promoted, the hook will be called for each node.")
7195 (defun org-promote-subtree ()
7196 "Promote the entire subtree.
7197 See also `org-promote'."
7198 (interactive)
7199 (save-excursion
7200 (org-with-limited-levels (org-map-tree 'org-promote)))
7201 (org-fix-position-after-promote))
7203 (defun org-demote-subtree ()
7204 "Demote the entire subtree. See `org-demote'.
7205 See also `org-promote'."
7206 (interactive)
7207 (save-excursion
7208 (org-with-limited-levels (org-map-tree 'org-demote)))
7209 (org-fix-position-after-promote))
7212 (defun org-do-promote ()
7213 "Promote the current heading higher up the tree.
7214 If the region is active in `transient-mark-mode', promote all headings
7215 in the region."
7216 (interactive)
7217 (save-excursion
7218 (if (org-region-active-p)
7219 (org-map-region 'org-promote (region-beginning) (region-end))
7220 (org-promote)))
7221 (org-fix-position-after-promote))
7223 (defun org-do-demote ()
7224 "Demote the current heading lower down the tree.
7225 If the region is active in `transient-mark-mode', demote all headings
7226 in the region."
7227 (interactive)
7228 (save-excursion
7229 (if (org-region-active-p)
7230 (org-map-region 'org-demote (region-beginning) (region-end))
7231 (org-demote)))
7232 (org-fix-position-after-promote))
7234 (defun org-fix-position-after-promote ()
7235 "Make sure that after pro/demotion cursor position is right."
7236 (let ((pos (point)))
7237 (when (save-excursion
7238 (beginning-of-line 1)
7239 (looking-at org-todo-line-regexp)
7240 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7241 (cond ((eobp) (insert " "))
7242 ((eolp) (insert " "))
7243 ((equal (char-after) ?\ ) (forward-char 1))))))
7245 (defun org-current-level ()
7246 "Return the level of the current entry, or nil if before the first headline.
7247 The level is the number of stars at the beginning of the headline."
7248 (save-excursion
7249 (org-with-limited-levels
7250 (ignore-errors
7251 (org-back-to-heading t)
7252 (funcall outline-level)))))
7254 (defun org-get-previous-line-level ()
7255 "Return the outline depth of the last headline before the current line.
7256 Returns 0 for the first headline in the buffer, and nil if before the
7257 first headline."
7258 (let ((current-level (org-current-level))
7259 (prev-level (when (> (line-number-at-pos) 1)
7260 (save-excursion
7261 (beginning-of-line 0)
7262 (org-current-level)))))
7263 (cond ((null current-level) nil) ; Before first headline
7264 ((null prev-level) 0) ; At first headline
7265 (prev-level))))
7267 (defun org-reduced-level (l)
7268 "Compute the effective level of a heading.
7269 This takes into account the setting of `org-odd-levels-only'."
7270 (cond
7271 ((zerop l) 0)
7272 (org-odd-levels-only (1+ (floor (/ l 2))))
7273 (t l)))
7275 (defun org-level-increment ()
7276 "Return the number of stars that will be added or removed at a
7277 time to headlines when structure editing, based on the value of
7278 `org-odd-levels-only'."
7279 (if org-odd-levels-only 2 1))
7281 (defun org-get-valid-level (level &optional change)
7282 "Rectify a level change under the influence of `org-odd-levels-only'
7283 LEVEL is a current level, CHANGE is by how much the level should be
7284 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7285 even level numbers will become the next higher odd number."
7286 (if org-odd-levels-only
7287 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7288 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7289 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7290 (max 1 (+ level (or change 0)))))
7292 (if (boundp 'define-obsolete-function-alias)
7293 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7294 (define-obsolete-function-alias 'org-get-legal-level
7295 'org-get-valid-level)
7296 (define-obsolete-function-alias 'org-get-legal-level
7297 'org-get-valid-level "23.1")))
7299 (defun org-promote ()
7300 "Promote the current heading higher up the tree.
7301 If the region is active in `transient-mark-mode', promote all headings
7302 in the region."
7303 (org-back-to-heading t)
7304 (let* ((level (save-match-data (funcall outline-level)))
7305 (after-change-functions (remove 'flyspell-after-change-function
7306 after-change-functions))
7307 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7308 (diff (abs (- level (length up-head) -1))))
7309 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7310 (replace-match up-head nil t)
7311 ;; Fixup tag positioning
7312 (and org-auto-align-tags (org-set-tags nil t))
7313 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7314 (run-hooks 'org-after-promote-entry-hook)))
7316 (defun org-demote ()
7317 "Demote the current heading lower down the tree.
7318 If the region is active in `transient-mark-mode', demote all headings
7319 in the region."
7320 (org-back-to-heading t)
7321 (let* ((level (save-match-data (funcall outline-level)))
7322 (after-change-functions (remove 'flyspell-after-change-function
7323 after-change-functions))
7324 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7325 (diff (abs (- level (length down-head) -1))))
7326 (replace-match down-head nil t)
7327 ;; Fixup tag positioning
7328 (and org-auto-align-tags (org-set-tags nil t))
7329 (if org-adapt-indentation (org-fixup-indentation diff))
7330 (run-hooks 'org-after-demote-entry-hook)))
7332 (defun org-cycle-level ()
7333 "Cycle the level of an empty headline through possible states.
7334 This goes first to child, then to parent, level, then up the hierarchy.
7335 After top level, it switches back to sibling level."
7336 (interactive)
7337 (let ((org-adapt-indentation nil))
7338 (when (org-point-at-end-of-empty-headline)
7339 (setq this-command 'org-cycle-level) ; Only needed for caching
7340 (let ((cur-level (org-current-level))
7341 (prev-level (org-get-previous-line-level)))
7342 (cond
7343 ;; If first headline in file, promote to top-level.
7344 ((= prev-level 0)
7345 (loop repeat (/ (- cur-level 1) (org-level-increment))
7346 do (org-do-promote)))
7347 ;; If same level as prev, demote one.
7348 ((= prev-level cur-level)
7349 (org-do-demote))
7350 ;; If parent is top-level, promote to top level if not already.
7351 ((= prev-level 1)
7352 (loop repeat (/ (- cur-level 1) (org-level-increment))
7353 do (org-do-promote)))
7354 ;; If top-level, return to prev-level.
7355 ((= cur-level 1)
7356 (loop repeat (/ (- prev-level 1) (org-level-increment))
7357 do (org-do-demote)))
7358 ;; If less than prev-level, promote one.
7359 ((< cur-level prev-level)
7360 (org-do-promote))
7361 ;; If deeper than prev-level, promote until higher than
7362 ;; prev-level.
7363 ((> cur-level prev-level)
7364 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7365 do (org-do-promote))))
7366 t))))
7368 (defun org-map-tree (fun)
7369 "Call FUN for every heading underneath the current one."
7370 (org-back-to-heading)
7371 (let ((level (funcall outline-level)))
7372 (save-excursion
7373 (funcall fun)
7374 (while (and (progn
7375 (outline-next-heading)
7376 (> (funcall outline-level) level))
7377 (not (eobp)))
7378 (funcall fun)))))
7380 (defun org-map-region (fun beg end)
7381 "Call FUN for every heading between BEG and END."
7382 (let ((org-ignore-region t))
7383 (save-excursion
7384 (setq end (copy-marker end))
7385 (goto-char beg)
7386 (if (and (re-search-forward org-outline-regexp-bol nil t)
7387 (< (point) end))
7388 (funcall fun))
7389 (while (and (progn
7390 (outline-next-heading)
7391 (< (point) end))
7392 (not (eobp)))
7393 (funcall fun)))))
7395 (defvar org-property-end-re) ; silence byte-compiler
7396 (defun org-fixup-indentation (diff)
7397 "Change the indentation in the current entry by DIFF.
7398 However, if any line in the current entry has no indentation, or if it
7399 would end up with no indentation after the change, nothing at all is done."
7400 (save-excursion
7401 (let ((end (save-excursion (outline-next-heading)
7402 (point-marker)))
7403 (prohibit (if (> diff 0)
7406 col)
7407 (unless (save-excursion (end-of-line 1)
7408 (re-search-forward prohibit end t))
7409 (while (and (< (point) end)
7411 (goto-char (match-end 0))
7412 (setq col (current-column))
7413 (if (< diff 0) (replace-match ""))
7414 (org-indent-to-column (+ diff col))))
7415 (move-marker end nil))))
7417 (defun org-convert-to-odd-levels ()
7418 "Convert an org-mode file with all levels allowed to one with odd levels.
7419 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7420 level 5 etc."
7421 (interactive)
7422 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7423 (let ((outline-level 'org-outline-level)
7424 (org-odd-levels-only nil) n)
7425 (save-excursion
7426 (goto-char (point-min))
7428 (setq n (- (length (match-string 0)) 2))
7429 (while (>= (setq n (1- n)) 0)
7430 (org-demote))
7431 (end-of-line 1))))))
7433 (defun org-convert-to-oddeven-levels ()
7434 "Convert an org-mode file with only odd levels to one with odd/even levels.
7435 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7436 file contains a section with an even level, conversion would
7437 destroy the structure of the file. An error is signaled in this
7438 case."
7439 (interactive)
7440 (goto-char (point-min))
7441 ;; First check if there are no even levels
7443 (org-show-context t)
7444 (error "Not all levels are odd in this file. Conversion not possible"))
7445 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7446 (let ((outline-regexp org-outline-regexp)
7447 (outline-level 'org-outline-level)
7448 (org-odd-levels-only nil) n)
7449 (save-excursion
7450 (goto-char (point-min))
7452 (setq n (/ (1- (length (match-string 0))) 2))
7453 (while (>= (setq n (1- n)) 0)
7454 (org-promote))
7455 (end-of-line 1))))))
7457 (defun org-tr-level (n)
7458 "Make N odd if required."
7459 (if org-odd-levels-only (1+ (/ n 2)) n))
7461 ;;; Vertical tree motion, cutting and pasting of subtrees
7463 (defun org-move-subtree-up (&optional arg)
7464 "Move the current subtree up past ARG headlines of the same level."
7465 (interactive "p")
7466 (org-move-subtree-down (- (prefix-numeric-value arg))))
7468 (defun org-move-subtree-down (&optional arg)
7469 "Move the current subtree down past ARG headlines of the same level."
7470 (interactive "p")
7471 (setq arg (prefix-numeric-value arg))
7472 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7473 'org-get-last-sibling))
7474 (ins-point (make-marker))
7475 (cnt (abs arg))
7476 (col (current-column))
7477 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7478 ;; Select the tree
7479 (org-back-to-heading)
7480 (setq beg0 (point))
7481 (save-excursion
7482 (setq ne-beg (org-back-over-empty-lines))
7483 (setq beg (point)))
7484 (save-match-data
7485 (save-excursion (outline-end-of-heading)
7486 (setq folded (outline-invisible-p)))
7487 (outline-end-of-subtree))
7488 (outline-next-heading)
7489 (setq ne-end (org-back-over-empty-lines))
7490 (setq end (point))
7491 (goto-char beg0)
7492 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7493 ;; include less whitespace
7494 (save-excursion
7495 (goto-char beg)
7496 (forward-line (- ne-beg ne-end))
7497 (setq beg (point))))
7498 ;; Find insertion point, with error handling
7499 (while (> cnt 0)
7500 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7501 (progn (goto-char beg0)
7502 (error "Cannot move past superior level or buffer limit")))
7503 (setq cnt (1- cnt)))
7504 (if (> arg 0)
7505 ;; Moving forward - still need to move over subtree
7506 (progn (org-end-of-subtree t t)
7507 (save-excursion
7508 (org-back-over-empty-lines)
7509 (or (bolp) (newline)))))
7510 (setq ne-ins (org-back-over-empty-lines))
7511 (move-marker ins-point (point))
7512 (setq txt (buffer-substring beg end))
7513 (org-save-markers-in-region beg end)
7514 (delete-region beg end)
7515 (org-remove-empty-overlays-at beg)
7516 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7517 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7519 (let ((bbb (point)))
7520 (insert-before-markers txt)
7521 (org-reinstall-markers-in-region bbb)
7522 (move-marker ins-point bbb))
7524 (setq ins-end (point))
7525 (goto-char ins-point)
7526 (org-skip-whitespace)
7527 (when (and (< arg 0)
7528 (org-first-sibling-p)
7529 (> ne-ins ne-beg))
7530 ;; Move whitespace back to beginning
7531 (save-excursion
7532 (goto-char ins-end)
7533 (let ((kill-whole-line t))
7534 (kill-line (- ne-ins ne-beg)) (point)))
7536 (move-marker ins-point nil)
7537 (if folded
7538 (hide-subtree)
7539 (org-show-entry)
7540 (show-children)
7541 (org-cycle-hide-drawers 'children))
7542 (org-clean-visibility-after-subtree-move)
7543 ;; move back to the initial column we were at
7544 (move-to-column col)))
7546 (defvar org-subtree-clip ""
7547 "Clipboard for cut and paste of subtrees.
7548 This is actually only a copy of the kill, because we use the normal kill
7549 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7551 (defvar org-subtree-clip-folded nil
7552 "Was the last copied subtree folded?
7553 This is used to fold the tree back after pasting.")
7555 (defun org-cut-subtree (&optional n)
7556 "Cut the current subtree into the clipboard.
7557 With prefix arg N, cut this many sequential subtrees.
7558 This is a short-hand for marking the subtree and then cutting it."
7559 (interactive "p")
7560 (org-copy-subtree n 'cut))
7562 (defun org-copy-subtree (&optional n cut force-store-markers)
7563 "Cut the current subtree into the clipboard.
7564 With prefix arg N, cut this many sequential subtrees.
7565 This is a short-hand for marking the subtree and then copying it.
7566 If CUT is non-nil, actually cut the subtree.
7567 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7568 of some markers in the region, even if CUT is non-nil. This is
7569 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7570 (interactive "p")
7571 (let (beg end folded (beg0 (point)))
7572 (if (org-called-interactively-p 'any)
7573 (org-back-to-heading nil) ; take what looks like a subtree
7574 (org-back-to-heading t)) ; take what is really there
7575 (org-back-over-empty-lines)
7576 (setq beg (point))
7578 (save-match-data
7579 (save-excursion (outline-end-of-heading)
7580 (setq folded (outline-invisible-p)))
7581 (condition-case nil
7582 (org-forward-same-level (1- n) t)
7583 (error nil))
7584 (org-end-of-subtree t t))
7585 (org-back-over-empty-lines)
7586 (setq end (point))
7587 (goto-char beg0)
7588 (when (> end beg)
7589 (setq org-subtree-clip-folded folded)
7590 (when (or cut force-store-markers)
7591 (org-save-markers-in-region beg end))
7592 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7593 (setq org-subtree-clip (current-kill 0))
7594 (message "%s: Subtree(s) with %d characters"
7595 (if cut "Cut" "Copied")
7596 (length org-subtree-clip)))))
7598 (defun org-paste-subtree (&optional level tree for-yank)
7599 "Paste the clipboard as a subtree, with modification of headline level.
7600 The entire subtree is promoted or demoted in order to match a new headline
7601 level.
7603 If the cursor is at the beginning of a headline, the same level as
7604 that headline is used to paste the tree
7606 If not, the new level is derived from the *visible* headings
7607 before and after the insertion point, and taken to be the inferior headline
7608 level of the two. So if the previous visible heading is level 3 and the
7609 next is level 4 (or vice versa), level 4 will be used for insertion.
7610 This makes sure that the subtree remains an independent subtree and does
7611 not swallow low level entries.
7613 You can also force a different level, either by using a numeric prefix
7614 argument, or by inserting the heading marker by hand. For example, if the
7617 If optional TREE is given, use this text instead of the kill ring.
7619 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7620 move back over whitespace before inserting, and move point to the end of
7621 the inserted text when done."
7622 (interactive "P")
7623 (setq tree (or tree (and kill-ring (current-kill 0))))
7624 (unless (org-kill-is-subtree-p tree)
7625 (error "%s"
7626 (substitute-command-keys
7628 (org-with-limited-levels
7629 (let* ((visp (not (outline-invisible-p)))
7630 (txt tree)
7632 (old-level (if (string-match org-outline-regexp-bol txt)
7633 (- (match-end 0) (match-beginning 0) 1)
7634 -1))
7635 (force-level (cond (level (prefix-numeric-value level))
7637 (string-match
7639 (point-at-bol) (point))))
7640 (- (match-end 1) (match-beginning 1)))
7641 ((and (bolp)
7642 (looking-at org-outline-regexp))
7643 (- (match-end 0) (point) 1))
7644 (t nil)))
7645 (previous-level (save-excursion
7646 (condition-case nil
7647 (progn
7648 (outline-previous-visible-heading 1)
7649 (if (looking-at ^re_)
7650 (- (match-end 0) (match-beginning 0) 1)
7651 1))
7652 (error 1))))
7653 (next-level (save-excursion
7654 (condition-case nil
7655 (progn
7656 (or (looking-at org-outline-regexp)
7657 (outline-next-visible-heading 1))
7658 (if (looking-at ^re_)
7659 (- (match-end 0) (match-beginning 0) 1)
7660 1))
7661 (error 1))))
7662 (new-level (or force-level (max previous-level next-level)))
7663 (shift (if (or (= old-level -1)
7664 (= new-level -1)
7665 (= old-level new-level))
7666 0
7667 (- new-level old-level)))
7668 (delta (if (> shift 0) -1 1))
7669 (func (if (> shift 0) 'org-demote 'org-promote))
7670 (org-odd-levels-only nil)
7671 beg end newend)
7672 ;; Remove the forced level indicator
7673 (if force-level
7674 (delete-region (point-at-bol) (point)))
7675 ;; Paste
7676 (beginning-of-line (if (bolp) 1 2))
7677 (unless for-yank (org-back-over-empty-lines))
7678 (setq beg (point))
7679 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7680 (insert-before-markers txt)
7682 (setq newend (point))
7683 (org-reinstall-markers-in-region beg)
7684 (setq end (point))
7685 (goto-char beg)
7687 (setq beg (point))
7688 (if (and (outline-invisible-p) visp)
7689 (save-excursion (outline-show-heading)))
7690 ;; Shift if necessary
7691 (unless (= shift 0)
7692 (save-restriction
7693 (narrow-to-region beg end)
7694 (while (not (= shift 0))
7695 (org-map-region func (point-min) (point-max))
7696 (setq shift (+ delta shift)))
7697 (goto-char (point-min))
7698 (setq newend (point-max))))
7699 (when (or (org-called-interactively-p 'interactive) for-yank)
7700 (message "Clipboard pasted as level %d subtree" new-level))
7701 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7702 kill-ring
7703 (eq org-subtree-clip (current-kill 0))
7704 org-subtree-clip-folded)
7705 ;; The tree was folded before it was killed/copied
7706 (hide-subtree))
7707 (and for-yank (goto-char newend)))))
7709 (defun org-kill-is-subtree-p (&optional txt)
7710 "Check if the current kill is an outline subtree, or a set of trees.
7711 Returns nil if kill does not start with a headline, or if the first
7712 headline level is not the largest headline level in the tree.
7713 So this will actually accept several entries of equal levels as well,
7714 which is OK for `org-paste-subtree'.
7715 If optional TXT is given, check this string instead of the current kill."
7716 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7717 (re (org-get-limited-outline-regexp))
7718 (^re (concat "^" re))
7719 (start-level (and kill
7720 (string-match
7722 kill)
7723 (- (match-end 2) (match-beginning 2) 1)))
7724 (start (1+ (or (match-beginning 2) -1))))
7725 (if (not start-level)
7726 (progn
7727 nil) ;; does not even start with a heading
7728 (catch 'exit
7729 (while (setq start (string-match ^re kill (1+ start)))
7730 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7731 (throw 'exit nil)))
7732 t))))
7734 (defvar org-markers-to-move nil
7735 "Markers that should be moved with a cut-and-paste operation.
7736 Those markers are stored together with their positions relative to
7737 the start of the region.")
7739 (defun org-save-markers-in-region (beg end)
7740 "Check markers in region.
7741 If these markers are between BEG and END, record their position relative
7742 to BEG, so that after moving the block of text, we can put the markers back
7743 into place.
7744 This function gets called just before an entry or tree gets cut from the
7745 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7746 called immediately, to move the markers with the entries."
7747 (setq org-markers-to-move nil)
7748 (when (featurep 'org-clock)
7749 (org-clock-save-markers-for-cut-and-paste beg end))
7750 (when (featurep 'org-agenda)
7751 (org-agenda-save-markers-for-cut-and-paste beg end)))
7753 (defun org-check-and-save-marker (marker beg end)
7754 "Check if MARKER is between BEG and END.
7755 If yes, remember the marker and the distance to BEG."
7756 (when (and (marker-buffer marker)
7757 (equal (marker-buffer marker) (current-buffer)))
7758 (if (and (>= marker beg) (< marker end))
7759 (push (cons marker (- marker beg)) org-markers-to-move))))
7761 (defun org-reinstall-markers-in-region (beg)
7762 "Move all remembered markers to their position relative to BEG."
7763 (mapc (lambda (x)
7764 (move-marker (car x) (+ beg (cdr x))))
7765 org-markers-to-move)
7766 (setq org-markers-to-move nil))
7768 (defun org-narrow-to-subtree ()
7769 "Narrow buffer to the current subtree."
7770 (interactive)
7771 (save-excursion
7772 (save-match-data
7773 (org-with-limited-levels
7774 (narrow-to-region
7775 (progn (org-back-to-heading t) (point))
7776 (progn (org-end-of-subtree t t)
7777 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7778 (point)))))))
7780 (defun org-narrow-to-block ()
7781 "Narrow buffer to the current block."
7782 (interactive)
7783 (let* ((case-fold-search t)
7786 (if blockp
7787 (narrow-to-region (car blockp) (cdr blockp))
7788 (error "Not in a block"))))
7790 (eval-when-compile
7791 (defvar org-property-drawer-re))
7793 (defvar org-property-start-re) ;; defined below
7794 (defun org-clone-subtree-with-time-shift (n &optional shift)
7795 "Clone the task (subtree) at point N times.
7796 The clones will be inserted as siblings.
7798 In interactive use, the user will be prompted for the number of
7799 clones to be produced, and for a time SHIFT, which may be a
7800 repeater as used in time stamps, for example `+3d'.
7802 When a valid repeater is given and the entry contains any time
7803 stamps, the clones will become a sequence in time, with time
7804 stamps in the subtree shifted for each clone produced. If SHIFT
7805 is nil or the empty string, time stamps will be left alone. The
7806 ID property of the original subtree is removed.
7808 If the original subtree did contain time stamps with a repeater,
7809 the following will happen:
7810 - the repeater will be removed in each clone
7811 - an additional clone will be produced, with the current, unshifted
7812 date(s) in the entry.
7813 - the original entry will be placed *after* all the clones, with
7814 repeater intact.
7815 - the start days in the repeater in the original entry will be shifted
7816 to past the last clone.
7817 I this way you can spell out a number of instances of a repeating task,
7818 and still retain the repeater to cover future instances of the task."
7819 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7820 (let (beg end template task idprop
7821 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7822 (if (not (and (integerp n) (> n 0)))
7823 (error "Invalid number of replications %s" n))
7826 shift)))
7827 (error "Invalid shift specification %s" shift))
7828 (when doshift
7829 (setq shift-n (string-to-number (match-string 1 shift))
7830 shift-what (cdr (assoc (match-string 2 shift)
7831 '(("d" . day) ("w" . week)
7832 ("m" . month) ("y" . year))))))
7833 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7834 (setq nmin 1 nmax n)
7835 (org-back-to-heading t)
7836 (setq beg (point))
7837 (setq idprop (org-entry-get nil "ID"))
7838 (org-end-of-subtree t t)
7840 (setq end (point))
7841 (setq template (buffer-substring beg end))
7842 ;; Remove clocks and empty drawers
7843 (with-temp-buffer
7844 (insert template)
7845 (goto-char (point-min))
7846 (while (re-search-forward
7848 (replace-match "")
7849 (kill-whole-line))
7850 (goto-char (point-min))
7851 (while (re-search-forward
7853 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7854 (setq template (buffer-substring (point-min) (point-max))))
7855 (when (and doshift
7857 (delete-region beg end)
7858 (setq end beg)
7859 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7860 (goto-char end)
7861 (loop for n from nmin to nmax do
7862 ;; prepare clone
7863 (with-temp-buffer
7864 (insert template)
7865 (org-mode)
7866 (goto-char (point-min))
7867 (and idprop (if org-clone-delete-id
7868 (org-entry-delete nil "ID")
7869 (org-id-get-create t)))
7870 (while (re-search-forward org-property-start-re nil t)
7871 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7872 (goto-char (point-min))
7873 (when doshift
7874 (while (re-search-forward org-ts-regexp-both nil t)
7875 (org-timestamp-change (* n shift-n) shift-what))
7876 (unless (= n n-no-remove)
7877 (goto-char (point-min))
7878 (while (re-search-forward org-ts-regexp nil t)
7879 (save-excursion
7880 (goto-char (match-beginning 0))
7882 (delete-region (match-beginning 1) (match-end 1)))))))
7883 (setq task (buffer-string)))
7884 (insert task))
7885 (goto-char beg)))
7887 ;;; Outline Sorting
7889 (defun org-sort (with-case)
7890 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7891 Optional argument WITH-CASE means sort case-sensitively.
7892 With a double prefix argument, also remove duplicate entries."
7893 (interactive "P")
7894 (cond
7895 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7896 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7897 (t
7898 (org-call-with-arg 'org-sort-entries with-case))))
7900 (defun org-sort-remove-invisible (s)
7901 (remove-text-properties 0 (length s) org-rm-props s)
7902 (while (string-match org-bracket-link-regexp s)
7903 (setq s (replace-match (if (match-end 2)
7904 (match-string 3 s)
7905 (match-string 1 s)) t t s)))
7906 s)
7908 (defvar org-priority-regexp) ; defined later in the file
7910 (defvar org-after-sorting-entries-or-items-hook nil
7911 "Hook that is run after a bunch of entries or items have been sorted.
7912 When children are sorted, the cursor is in the parent line when this
7913 hook gets called. When a region or a plain list is sorted, the cursor
7914 will be in the first entry of the sorted region/list.")
7916 (defun org-sort-entries
7917 (&optional with-case sorting-type getkey-func compare-func property)
7918 "Sort entries on a certain level of an outline tree.
7919 If there is an active region, the entries in the region are sorted.
7920 Else, if the cursor is before the first entry, sort the top-level items.
7921 Else, the children of the entry at point are sorted.
7923 Sorting can be alphabetically, numerically, by date/time as given by
7924 a time stamp, by a property or by priority.
7926 The command prompts for the sorting type unless it has been given to the
7927 function through the SORTING-TYPE argument, which needs to be a character,
7928 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7929 precise meaning of each character:
7931 n Numerically, by converting the beginning of the entry/item to a number.
7932 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7933 t By date/time, either the first active time stamp in the entry, or, if
7934 none exist, by the first inactive one.
7935 s By the scheduled date/time.
7936 d By deadline date/time.
7937 c By creation time, which is assumed to be the first inactive time stamp
7938 at the beginning of a line.
7939 p By priority according to the cookie.
7940 r By the value of a property.
7942 Capital letters will reverse the sort order.
7944 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7945 called with point at the beginning of the record. It must return either
7946 a string or a number that should serve as the sorting key for that record.
7948 Comparing entries ignores case by default. However, with an optional argument
7949 WITH-CASE, the sorting considers case as well."
7950 (interactive "P")
7951 (let ((case-func (if with-case 'identity 'downcase))
7952 start beg end stars re re2
7953 txt what tmp)
7954 ;; Find beginning and end of region to sort
7955 (cond
7956 ((org-region-active-p)
7957 ;; we will sort the region
7958 (setq end (region-end)
7959 what "region")
7960 (goto-char (region-beginning))
7961 (if (not (org-on-heading-p)) (outline-next-heading))
7962 (setq start (point)))
7963 ((or (org-on-heading-p)
7964 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7965 ;; we will sort the children of the current headline
7966 (org-back-to-heading)
7967 (setq start (point)
7968 end (progn (org-end-of-subtree t t)
7970 (org-back-over-empty-lines)
7971 (point))
7972 what "children")
7973 (goto-char start)
7974 (show-subtree)
7975 (outline-next-heading))
7976 (t
7977 ;; we will sort the top-level entries in this file
7978 (goto-char (point-min))
7979 (or (org-on-heading-p) (outline-next-heading))
7980 (setq start (point))
7981 (goto-char (point-max))
7982 (beginning-of-line 1)
7984 ;; File ends in a non-white line
7985 (end-of-line 1)
7987 (setq end (point-max))
7988 (setq what "top-level")
7989 (goto-char start)
7990 (show-all)))
7992 (setq beg (point))
7993 (if (>= beg end) (error "Nothing to sort"))
7996 (setq stars (match-string 1)
7997 re (concat "^" (regexp-quote stars) " +")
7999 txt (buffer-substring beg end))
8001 (if (and (not (equal stars "*")) (string-match re2 txt))
8002 (error "Region to sort contains a level above the first entry"))
8004 (unless sorting-type
8005 (message
8006 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8008 A/N/T/S/D/C/P/O/F means reversed:"
8009 what)
8010 (setq sorting-type (read-char-exclusive))
8012 (and (= (downcase sorting-type) ?f)
8013 (setq getkey-func
8014 (org-icompleting-read "Sort using function: "
8015 obarray 'fboundp t nil nil))
8016 (setq getkey-func (intern getkey-func)))
8018 (and (= (downcase sorting-type) ?r)
8019 (setq property
8020 (org-icompleting-read "Property: "
8021 (mapcar 'list (org-buffer-property-keys t))
8022 nil t))))
8024 (message "Sorting entries...")
8026 (save-restriction
8027 (narrow-to-region start end)
8028 (let ((dcst (downcase sorting-type))
8029 (case-fold-search nil)
8030 (now (current-time)))
8031 (sort-subr
8032 (/= dcst sorting-type)
8033 ;; This function moves to the beginning character of the "record" to
8034 ;; be sorted.
8035 (lambda nil
8036 (if (re-search-forward re nil t)
8037 (goto-char (match-beginning 0))
8038 (goto-char (point-max))))
8039 ;; This function moves to the last character of the "record" being
8040 ;; sorted.
8041 (lambda nil
8042 (save-match-data
8043 (condition-case nil
8044 (outline-forward-same-level 1)
8045 (error
8046 (goto-char (point-max))))))
8047 ;; This function returns the value that gets sorted against.
8048 (lambda nil
8049 (cond
8050 ((= dcst ?n)
8051 (if (looking-at org-complex-heading-regexp)
8052 (string-to-number (match-string 4))
8053 nil))
8054 ((= dcst ?a)
8055 (if (looking-at org-complex-heading-regexp)
8056 (funcall case-func (match-string 4))
8057 nil))
8058 ((= dcst ?t)
8059 (let ((end (save-excursion (outline-next-heading) (point))))
8060 (if (or (re-search-forward org-ts-regexp end t)
8061 (re-search-forward org-ts-regexp-both end t))
8062 (org-time-string-to-seconds (match-string 0))
8063 (org-float-time now))))
8064 ((= dcst ?c)
8065 (let ((end (save-excursion (outline-next-heading) (point))))
8066 (if (re-search-forward
8068 end t)
8069 (org-time-string-to-seconds (match-string 0))
8070 (org-float-time now))))
8071 ((= dcst ?s)
8072 (let ((end (save-excursion (outline-next-heading) (point))))
8073 (if (re-search-forward org-scheduled-time-regexp end t)
8074 (org-time-string-to-seconds (match-string 1))
8075 (org-float-time now))))
8076 ((= dcst ?d)
8077 (let ((end (save-excursion (outline-next-heading) (point))))
8078 (if (re-search-forward org-deadline-time-regexp end t)
8079 (org-time-string-to-seconds (match-string 1))
8080 (org-float-time now))))
8081 ((= dcst ?p)
8082 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8083 (string-to-char (match-string 2))
8084 org-default-priority))
8085 ((= dcst ?r)
8086 (or (org-entry-get nil property) ""))
8087 ((= dcst ?o)
8088 (if (looking-at org-complex-heading-regexp)
8089 (- 9999 (length (member (match-string 2)
8090 org-todo-keywords-1)))))
8091 ((= dcst ?f)
8092 (if getkey-func
8093 (progn
8094 (setq tmp (funcall getkey-func))
8095 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8096 tmp)
8097 (error "Invalid key function `%s'" getkey-func)))
8098 (t (error "Invalid sorting type `%c'" sorting-type))))
8099 nil
8100 (cond
8101 ((= dcst ?a) 'string<)
8102 ((= dcst ?f) compare-func)
8103 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8104 (t nil)))))
8105 (run-hooks 'org-after-sorting-entries-or-items-hook)
8106 (message "Sorting entries...done")))
8108 (defun org-do-sort (table what &optional with-case sorting-type)
8109 "Sort TABLE of WHAT according to SORTING-TYPE.
8110 The user will be prompted for the SORTING-TYPE if the call to this
8111 function does not specify it. WHAT is only for the prompt, to indicate
8112 what is being sorted. The sorting key will be extracted from
8113 the car of the elements of the table.
8114 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8115 (unless sorting-type
8116 (message
8117 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8118 what)
8119 (setq sorting-type (read-char-exclusive)))
8120 (let ((dcst (downcase sorting-type))
8121 extractfun comparefun)
8122 ;; Define the appropriate functions
8123 (cond
8124 ((= dcst ?n)
8125 (setq extractfun 'string-to-number
8126 comparefun (if (= dcst sorting-type) '< '>)))
8127 ((= dcst ?a)
8128 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8129 (lambda(x) (downcase (org-sort-remove-invisible x))))
8130 comparefun (if (= dcst sorting-type)
8131 'string<
8132 (lambda (a b) (and (not (string< a b))
8133 (not (string= a b)))))))
8134 ((= dcst ?t)
8135 (setq extractfun
8136 (lambda (x)
8137 (if (or (string-match org-ts-regexp x)
8138 (string-match org-ts-regexp-both x))
8139 (org-float-time
8140 (org-time-string-to-time (match-string 0 x)))
8141 0))
8142 comparefun (if (= dcst sorting-type) '< '>)))
8143 (t (error "Invalid sorting type `%c'" sorting-type)))
8145 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8146 table)
8147 (lambda (a b) (funcall comparefun (car a) (car b))))))
8150 ;;; The orgstruct minor mode
8152 ;; Define a minor mode which can be used in other modes in order to
8153 ;; integrate the org-mode structure editing commands.
8155 ;; This is really a hack, because the org-mode structure commands use
8156 ;; keys which normally belong to the major mode. Here is how it
8157 ;; works: The minor mode defines all the keys necessary to operate the
8158 ;; structure commands, but wraps the commands into a function which
8159 ;; tests if the cursor is currently at a headline or a plain list
8160 ;; item. If that is the case, the structure command is used,
8161 ;; temporarily setting many Org-mode variables like regular
8162 ;; expressions for filling etc. However, when any of those keys is
8163 ;; used at a different location, function uses `key-binding' to look
8164 ;; up if the key has an associated command in another currently active
8165 ;; keymap (minor modes, major mode, global), and executes that
8166 ;; command. There might be problems if any of the keys is otherwise
8167 ;; used as a prefix key.
8169 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8170 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8171 ;; addresses this by checking explicitly for both bindings.
8173 (defvar orgstruct-mode-map (make-sparse-keymap)
8174 "Keymap for the minor `orgstruct-mode'.")
8176 (defvar org-local-vars nil
8177 "List of local variables, for use by `orgstruct-mode'.")
8179 ;;;###autoload
8180 (define-minor-mode orgstruct-mode
8181 "Toggle the minor mode `orgstruct-mode'.
8182 This mode is for using Org-mode structure commands in other
8183 modes. The following keys behave as if Org-mode were active, if
8184 the cursor is on a headline, or on a plain list item (both as
8185 defined by Org-mode).
8187 M-up Move entry/item up
8188 M-down Move entry/item down
8189 M-left Promote
8190 M-right Demote
8191 M-S-up Move entry/item up
8192 M-S-down Move entry/item down
8193 M-S-left Promote subtree
8194 M-S-right Demote subtree
8195 M-q Fill paragraph and items like in Org-mode
8196 C-c ^ Sort entries
8197 C-c - Cycle list bullet
8198 TAB Cycle item visibility
8199 M-RET Insert new heading/item
8200 S-M-RET Insert new TODO heading / Checkbox item
8201 C-c C-c Set tags / toggle checkbox"
8202 nil " OrgStruct" nil
8203 (org-load-modules-maybe)
8204 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8206 ;;;###autoload
8207 (defun turn-on-orgstruct ()
8208 "Unconditionally turn on `orgstruct-mode'."
8209 (orgstruct-mode 1))
8211 (defun orgstruct++-mode (&optional arg)
8212 "Toggle `orgstruct-mode', the enhanced version of it.
8213 In addition to setting orgstruct-mode, this also exports all indentation
8214 and autofilling variables from org-mode into the buffer. It will also
8215 recognize item context in multiline items.
8216 Note that turning off orgstruct-mode will *not* remove the
8217 indentation/paragraph settings. This can only be done by refreshing the
8219 (interactive "P")
8220 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8221 (if (< arg 1)
8222 (orgstruct-mode -1)
8223 (orgstruct-mode 1)
8224 (let (var val)
8225 (mapc
8226 (lambda (x)
8227 (when (string-match
8229 (symbol-name (car x)))
8230 (setq var (car x) val (nth 1 x))
8231 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8232 org-local-vars)
8233 (org-set-local 'orgstruct-is-++ t))))
8235 (defvar orgstruct-is-++ nil
8236 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8237 (make-variable-buffer-local 'orgstruct-is-++)
8239 ;;;###autoload
8240 (defun turn-on-orgstruct++ ()
8241 "Unconditionally turn on `orgstruct++-mode'."
8242 (orgstruct++-mode 1))
8244 (defun orgstruct-error ()
8245 "Error when there is no default binding for a structure key."
8246 (interactive)
8247 (error "This key has no function outside structure elements"))
8249 (defun orgstruct-setup ()
8250 "Setup orgstruct keymaps."
8251 (let ((nfunc 0)
8252 (bindings
8253 (list
8254 '([(meta up)] org-metaup)
8255 '([(meta down)] org-metadown)
8256 '([(meta left)] org-metaleft)
8257 '([(meta right)] org-metaright)
8258 '([(meta shift up)] org-shiftmetaup)
8259 '([(meta shift down)] org-shiftmetadown)
8260 '([(meta shift left)] org-shiftmetaleft)
8261 '([(meta shift right)] org-shiftmetaright)
8262 '([?\e (up)] org-metaup)
8263 '([?\e (down)] org-metadown)
8264 '([?\e (left)] org-metaleft)
8265 '([?\e (right)] org-metaright)
8266 '([?\e (shift up)] org-shiftmetaup)
8267 '([?\e (shift down)] org-shiftmetadown)
8268 '([?\e (shift left)] org-shiftmetaleft)
8269 '([?\e (shift right)] org-shiftmetaright)
8270 '([(shift up)] org-shiftup)
8271 '([(shift down)] org-shiftdown)
8272 '([(shift left)] org-shiftleft)
8273 '([(shift right)] org-shiftright)
8274 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8275 '("\M-q" fill-paragraph)
8276 '("\C-c^" org-sort)
8277 '("\C-c-" org-cycle-list-bullet)))
8278 elt key fun cmd)
8279 (while (setq elt (pop bindings))
8280 (setq nfunc (1+ nfunc))
8281 (setq key (org-key (car elt))
8282 fun (nth 1 elt)
8283 cmd (orgstruct-make-binding fun nfunc key))
8284 (org-defkey orgstruct-mode-map key cmd))
8286 ;; Special treatment needed for TAB and RET
8287 (org-defkey orgstruct-mode-map [(tab)]
8288 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8289 (org-defkey orgstruct-mode-map "\C-i"
8290 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8292 (org-defkey orgstruct-mode-map "\M-\C-m"
8293 (orgstruct-make-binding 'org-insert-heading 105
8294 "\M-\C-m" [(meta return)]))
8295 (org-defkey orgstruct-mode-map [(meta return)]
8296 (orgstruct-make-binding 'org-insert-heading 106
8297 [(meta return)] "\M-\C-m"))
8299 (org-defkey orgstruct-mode-map [(shift meta return)]
8300 (orgstruct-make-binding 'org-insert-todo-heading 107
8301 [(meta return)] "\M-\C-m"))
8303 (org-defkey orgstruct-mode-map "\e\C-m"
8304 (orgstruct-make-binding 'org-insert-heading 108
8305 "\e\C-m" [?\e (return)]))
8306 (org-defkey orgstruct-mode-map [?\e (return)]
8307 (orgstruct-make-binding 'org-insert-heading 109
8308 [?\e (return)] "\e\C-m"))
8309 (org-defkey orgstruct-mode-map [?\e (shift return)]
8310 (orgstruct-make-binding 'org-insert-todo-heading 110
8311 [?\e (return)] "\e\C-m"))
8313 (unless org-local-vars
8314 (setq org-local-vars (org-get-local-variables)))
8316 t))
8318 (defun orgstruct-make-binding (fun n &rest keys)
8319 "Create a function for binding in the structure minor mode.
8320 FUN is the command to call inside a table. N is used to create a unique
8321 command name. KEYS are keys that should be checked in for a command
8322 to execute outside of tables."
8323 (eval
8324 (list 'defun
8325 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8326 '(arg)
8328 "Outside of structure, run the binding of `"
8329 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8330 "'.")
8331 '(interactive "p")
8332 (list 'if
8333 `(org-context-p 'headline 'item
8334 (and orgstruct-is-++
8335 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8336 'item-body))
8337 (list 'org-run-like-in-org-mode (list 'quote fun))
8338 (list 'let '(orgstruct-mode)
8339 (list 'call-interactively
8340 (append '(or)
8341 (mapcar (lambda (k)
8342 (list 'key-binding k))
8343 keys)
8344 '('orgstruct-error))))))))
8346 (defun org-context-p (&rest contexts)
8347 "Check if local context is any of CONTEXTS.
8348 Possible values in the list of contexts are `table', `headline', and `item'."
8349 (let ((pos (point)))
8350 (goto-char (point-at-bol))
8351 (prog1 (or (and (memq 'table contexts)
8353 (and (memq 'headline contexts)
8354 (looking-at org-outline-regexp))
8355 (and (memq 'item contexts)
8357 (and (memq 'item-body contexts)
8358 (org-in-item-p)))
8359 (goto-char pos))))
8361 (defun org-get-local-variables ()
8362 "Return a list of all local variables in an org-mode buffer."
8363 (let (varlist)
8364 (with-current-buffer (get-buffer-create "*Org tmp*")
8365 (erase-buffer)
8366 (org-mode)
8367 (setq varlist (buffer-local-variables)))
8368 (kill-buffer "*Org tmp*")
8369 (delq nil
8370 (mapcar
8371 (lambda (x)
8372 (setq x
8373 (if (symbolp x)
8374 (list x)
8375 (list (car x) (list 'quote (cdr x)))))
8376 (if (string-match
8377 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8378 (symbol-name (car x)))
8379 x nil))
8380 varlist))))
8382 (defun org-clone-local-variables (from-buffer &optional regexp)
8383 "Clone local variables from FROM-BUFFER.
8384 Optional argument REGEXP selects variables to clone."
8385 (mapc
8386 (lambda (pair)
8387 (and (symbolp (car pair))
8388 (or (null regexp)
8389 (string-match regexp (symbol-name (car pair))))
8390 (set (make-local-variable (car pair))
8391 (cdr pair))))
8392 (buffer-local-variables from-buffer)))
8394 ;;;###autoload
8395 (defun org-run-like-in-org-mode (cmd)
8396 "Run a command, pretending that the current buffer is in Org-mode.
8397 This will temporarily bind local variables that are typically bound in
8398 Org-mode to the values they have in Org-mode, and then interactively
8399 call CMD."
8400 (org-load-modules-maybe)
8401 (unless org-local-vars
8402 (setq org-local-vars (org-get-local-variables)))
8403 (eval (list 'let org-local-vars
8404 (list 'call-interactively (list 'quote cmd)))))
8406 ;;;; Archiving
8408 (defun org-get-category (&optional pos force-refresh)
8409 "Get the category applying to position POS."
8410 (if force-refresh (org-refresh-category-properties))
8411 (let ((pos (or pos (point))))
8412 (or (get-text-property pos 'org-category)
8413 (progn (org-refresh-category-properties)
8414 (get-text-property pos 'org-category)))))
8416 (defun org-refresh-category-properties ()
8417 "Refresh category text properties in the buffer."
8418 (let ((def-cat (cond
8419 ((null org-category)
8420 (if buffer-file-name
8421 (file-name-sans-extension
8422 (file-name-nondirectory buffer-file-name))
8423 "???"))
8424 ((symbolp org-category) (symbol-name org-category))
8425 (t org-category)))
8426 beg end cat pos optionp)
8427 (org-unmodified
8428 (save-excursion
8429 (save-restriction
8430 (widen)
8431 (goto-char (point-min))
8432 (put-text-property (point) (point-max) 'org-category def-cat)
8433 (while (re-search-forward
8435 (setq pos (match-end 0)
8436 optionp (equal (char-after (match-beginning 0)) ?#)
8437 cat (org-trim (match-string 2)))
8438 (if optionp
8439 (setq beg (point-at-bol) end (point-max))
8440 (org-back-to-heading t)
8441 (setq beg (point) end (org-end-of-subtree t t)))
8442 (put-text-property beg end 'org-category cat)
8443 (put-text-property beg end 'org-category-position beg)
8444 (goto-char pos)))))))
8447 ;;;; Link Stuff
8449 ;;; Link abbreviations
8451 (defun org-link-expand-abbrev (link)
8452 "Apply replacements as defined in `org-link-abbrev-alist."
8454 (let* ((key (match-string 1 link))
8455 (as (or (assoc key org-link-abbrev-alist-local)
8456 (assoc key org-link-abbrev-alist)))
8457 (tag (and (match-end 2) (match-string 3 link)))
8458 rpl)
8459 (if (not as)
8460 link
8461 (setq rpl (cdr as))
8462 (cond
8463 ((symbolp rpl) (funcall rpl tag))
8464 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8465 ((string-match "%h" rpl)
8466 (replace-match (url-hexify-string (or tag "")) t t rpl))
8467 (t (concat rpl tag)))))
8468 link))
8470 ;;; Storing and inserting links
8472 (defvar org-insert-link-history nil
8473 "Minibuffer history for links inserted with `org-insert-link'.")
8475 (defvar org-stored-links nil
8476 "Contains the links stored with `org-store-link'.")
8478 (defvar org-store-link-plist nil
8479 "Plist with info about the most recently link created with `org-store-link'.")
8481 (defvar org-link-protocols nil
8482 "Link protocols added to Org-mode using `org-add-link-type'.")
8484 (defvar org-store-link-functions nil
8485 "List of functions that are called to create and store a link.
8486 Each function will be called in turn until one returns a non-nil
8487 value. Each function should check if it is responsible for creating
8488 this link (for example by looking at the major mode).
8489 If not, it must exit and return nil.
8490 If yes, it should return a non-nil value after a calling
8491 `org-store-link-props' with a list of properties and values.
8492 Special properties are:
8496 This is obligatory as well.
8497 :description Optional default description for the second pair
8498 of brackets in an Org-mode link. The user can still change
8499 this when inserting this link into an Org-mode buffer.
8501 In addition to these, any additional properties can be specified
8502 and then used in remember templates.")
8504 (defun org-add-link-type (type &optional follow export)
8505 "Add TYPE to the list of `org-link-types'.
8506 Re-compute all regular expressions depending on `org-link-types'
8508 FOLLOW and EXPORT are two functions.
8510 FOLLOW should take the link path as the single argument and do whatever
8511 is necessary to follow the link, for example find a file or display
8512 a mail message.
8514 EXPORT should format the link path for export to one of the export formats.
8515 It should be a function accepting three arguments:
8518 desc the description of the link, if any, or a description added by
8519 org-export-normalize-links if there is none
8520 format the export format, a symbol like `html' or `latex' or `ascii'..
8522 The function may use the FORMAT information to return different values
8523 depending on the format. The return value will be put literally into
8524 the exported file. If the return value is nil, this means Org should
8525 do what it normally does with links which do not have EXPORT defined.
8527 Org-mode has a built-in default for exporting links. If you are happy with
8528 this default, there is no need to define an export function for the link
8529 type. For a simple example of an export function, see `org-bbdb.el'."
8530 (add-to-list 'org-link-types type t)
8531 (org-make-link-regexps)
8532 (if (assoc type org-link-protocols)
8533 (setcdr (assoc type org-link-protocols) (list follow export))
8534 (push (list type follow export) org-link-protocols)))
8536 (defvar org-agenda-buffer-name)
8538 ;;;###autoload
8539 (defun org-store-link (arg)
8541 This link is added to `org-stored-links' and can later be inserted
8544 For some link types, a prefix arg is interpreted:
8545 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8546 For file links, arg negates `org-context-in-file-links'."
8547 (interactive "P")
8548 (org-load-modules-maybe)
8549 (setq org-store-link-plist nil) ; reset
8550 (org-with-limited-levels
8551 (let (link cpltxt desc description search txt custom-id agenda-link)
8552 (cond
8554 ((run-hook-with-args-until-success 'org-store-link-functions)
8555 (setq link (plist-get org-store-link-plist :link)
8556 desc (or (plist-get org-store-link-plist :description) link)))
8558 ((equal (buffer-name) "*Org Edit Src Example*")
8559 (let (label gc)
8560 (while (or (not label)
8561 (save-excursion
8562 (save-restriction
8563 (widen)
8564 (goto-char (point-min))
8565 (re-search-forward
8566 (regexp-quote (format org-coderef-label-format label))
8567 nil t))))
8568 (when label (message "Label exists already") (sit-for 2))
8569 (setq label (read-string "Code line label: " label)))
8570 (end-of-line 1)
8571 (setq link (format org-coderef-label-format label))
8572 (setq gc (- 79 (length link)))
8573 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8574 (insert link)
8575 (setq link (concat "(" label ")") desc nil)))
8577 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8578 ;; We are in the agenda, link to referenced location
8579 (let ((m (or (get-text-property (point) 'org-hd-marker)
8580 (get-text-property (point) 'org-marker))))
8581 (when m
8582 (org-with-point-at m
8583 (setq agenda-link
8584 (if (org-called-interactively-p 'any)
8585 (call-interactively 'org-store-link)
8586 (org-store-link nil)))))))
8588 ((eq major-mode 'calendar-mode)
8589 (let ((cd (calendar-cursor-to-date)))
8590 (setq link
8591 (format-time-string
8592 (car org-time-stamp-formats)
8593 (apply 'encode-time
8594 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8595 nil nil nil))))
8596 (org-store-link-props :type "calendar" :date cd)))
8598 ((eq major-mode 'w3-mode)
8599 (setq cpltxt (if (and (buffer-name)
8600 (not (string-match "Untitled" (buffer-name))))
8601 (buffer-name)
8602 (url-view-url t))
8603 link (org-make-link (url-view-url t)))
8604 (org-store-link-props :type "w3" :url (url-view-url t)))
8606 ((eq major-mode 'w3m-mode)
8607 (setq cpltxt (or w3m-current-title w3m-current-url)
8608 link (org-make-link w3m-current-url))
8609 (org-store-link-props :type "w3m" :url (url-view-url t)))
8611 ((setq search (run-hook-with-args-until-success
8612 'org-create-file-search-functions))
8613 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8614 "::" search))
8615 (setq cpltxt (or description link)))
8617 ((eq major-mode 'image-mode)
8618 (setq cpltxt (concat "file:"
8619 (abbreviate-file-name buffer-file-name))
8620 link (org-make-link cpltxt))
8621 (org-store-link-props :type "image" :file buffer-file-name))
8623 ((eq major-mode 'dired-mode)
8624 ;; link to the file in the current line
8625 (let ((file (dired-get-filename nil t)))
8626 (setq file (if file
8627 (abbreviate-file-name
8628 (expand-file-name (dired-get-filename nil t)))
8629 ;; otherwise, no file so use current directory.
8630 default-directory))
8631 (setq cpltxt (concat "file:" file)
8632 link (org-make-link cpltxt))))
8634 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8635 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8636 (cond
8638 (setq cpltxt
8639 (concat "file:"
8640 (abbreviate-file-name
8641 (buffer-file-name (buffer-base-buffer)))
8642 "::" (match-string 1))
8643 link (org-make-link cpltxt)))
8644 ((and (featurep 'org-id)
8645 (or (eq org-link-to-org-use-id t)
8646 (and (eq org-link-to-org-use-id 'create-if-interactive)
8647 (org-called-interactively-p 'any))
8648 (and (eq org-link-to-org-use-id
8649 'create-if-interactive-and-no-custom-id)
8650 (org-called-interactively-p 'any)
8651 (not custom-id))
8652 (and org-link-to-org-use-id
8653 (org-entry-get nil "ID"))))
8654 ;; We can make a link using the ID.
8655 (setq link (condition-case nil
8656 (prog1 (org-id-store-link)
8657 (setq desc (plist-get org-store-link-plist
8658 :description)))
8659 (error
8660 ;; probably before first headline, link to file only
8661 (concat "file:"
8662 (abbreviate-file-name
8663 (buffer-file-name (buffer-base-buffer))))))))
8664 (t
8665 ;; Just link to current headline
8666 (setq cpltxt (concat "file:"
8667 (abbreviate-file-name
8668 (buffer-file-name (buffer-base-buffer)))))
8669 ;; Add a context search string
8670 (when (org-xor org-context-in-file-links arg)
8671 (setq txt (cond
8672 ((org-on-heading-p) nil)
8673 ((org-region-active-p)
8674 (buffer-substring (region-beginning) (region-end)))
8675 (t nil)))
8677 (setq cpltxt
8678 (concat cpltxt "::"
8679 (condition-case nil
8680 (org-make-org-heading-search-string txt)
8681 (error "")))
8682 desc (or (nth 4 (ignore-errors
8683 (org-heading-components))) "NONE"))))
8685 (setq cpltxt (substring cpltxt 0 -2)))
8686 (setq link (org-make-link cpltxt)))))
8688 ((buffer-file-name (buffer-base-buffer))
8689 ;; Just link to this file here.
8690 (setq cpltxt (concat "file:"
8691 (abbreviate-file-name
8692 (buffer-file-name (buffer-base-buffer)))))
8693 ;; Add a context string
8694 (when (org-xor org-context-in-file-links arg)
8695 (setq txt (if (org-region-active-p)
8696 (buffer-substring (region-beginning) (region-end))
8697 (buffer-substring (point-at-bol) (point-at-eol))))
8698 ;; Only use search option if there is some text.
8700 (setq cpltxt
8701 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8702 desc "NONE")))
8703 (setq link (org-make-link cpltxt)))
8705 ((org-called-interactively-p 'interactive)
8706 (error "Cannot link to a buffer which is not visiting a file"))
8708 (t (setq link nil)))
8710 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8711 (setq link (or link cpltxt)
8712 desc (or desc cpltxt))
8713 (if (equal desc "NONE") (setq desc nil))
8715 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8716 (progn
8717 (setq org-stored-links
8718 (cons (list link desc) org-stored-links))
8719 (message "Stored: %s" (or desc link))
8720 (when custom-id
8721 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8722 "::#" custom-id))
8723 (setq org-stored-links
8724 (cons (list link desc) org-stored-links))))
8725 (or agenda-link (and link (org-make-link-string link desc)))))))
8727 (defun org-store-link-props (&rest plist)
8728 "Store link properties, extract names and addresses."
8729 (let (x adr)
8730 (when (setq x (plist-get plist :from))
8731 (setq adr (mail-extract-address-components x))
8732 (setq plist (plist-put plist :fromname (car adr)))
8733 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8734 (when (setq x (plist-get plist :to))
8735 (setq adr (mail-extract-address-components x))
8736 (setq plist (plist-put plist :toname (car adr)))
8737 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8738 (let ((from (plist-get plist :from))
8739 (to (plist-get plist :to)))
8740 (when (and from to org-from-is-user-regexp)
8741 (setq plist
8742 (plist-put plist :fromto
8743 (if (string-match org-from-is-user-regexp from)
8744 (concat "to %t")
8745 (concat "from %f"))))))
8746 (setq org-store-link-plist plist))
8748 (defun org-add-link-props (&rest plist)
8749 "Add these properties to the link property list."
8750 (let (key value)
8751 (while plist
8752 (setq key (pop plist) value (pop plist))
8753 (setq org-store-link-plist
8754 (plist-put org-store-link-plist key value)))))
8756 (defun org-email-link-description (&optional fmt)
8757 "Return the description part of an email link.
8758 This takes information from `org-store-link-plist' and formats it
8759 according to FMT (default from `org-email-link-description-format')."
8760 (setq fmt (or fmt org-email-link-description-format))
8761 (let* ((p org-store-link-plist)
8762 (to (plist-get p :toaddress))
8763 (from (plist-get p :fromaddress))
8764 (table
8765 (list
8766 (cons "%c" (plist-get p :fromto))
8767 (cons "%F" (plist-get p :from))
8768 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8769 (cons "%T" (plist-get p :to))
8770 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8771 (cons "%s" (plist-get p :subject))
8772 (cons "%d" (plist-get p :date))
8773 (cons "%m" (plist-get p :message-id)))))
8774 (when (string-match "%c" fmt)
8775 ;; Check if the user wrote this message
8776 (if (and org-from-is-user-regexp from to
8777 (save-match-data (string-match org-from-is-user-regexp from)))
8778 (setq fmt (replace-match "to %t" t t fmt))
8779 (setq fmt (replace-match "from %f" t t fmt))))
8780 (org-replace-escapes fmt table)))
8782 (defun org-make-org-heading-search-string (&optional string heading)
8783 "Make search string for STRING or current headline."
8784 (interactive)
8785 (let ((s (or string (org-get-heading)))
8786 (lines org-context-in-file-links))
8787 (unless (and string (not heading))
8788 ;; We are using a headline, clean up garbage in there.
8789 (if (string-match org-todo-regexp s)
8790 (setq s (replace-match "" t t s)))
8792 (setq s (replace-match "" t t s)))
8793 (setq s (org-trim s))
8796 (setq s (replace-match "" t t s)))
8797 (while (string-match org-ts-regexp s)
8798 (setq s (replace-match "" t t s))))
8799 (or string (setq s (concat "*" s))) ; Add * for headlines
8800 (when (and string (integerp lines) (> lines 0))
8802 (when (< lines (length slines))
8803 (setq s (mapconcat
8804 'identity
8805 (reverse (nthcdr (- (length slines) lines)
8809 (defun org-make-link (&rest strings)
8810 "Concatenate STRINGS."
8811 (apply 'concat strings))
8813 (defun org-make-link-string (link &optional description)
8814 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8816 (error "Empty link"))
8817 (when (and description
8818 (stringp description)
8820 (setq description nil))
8821 (when (stringp description)
8822 ;; Remove brackets from the description, they are fatal.
8824 (setq description (replace-match "{" t t description)))
8826 (setq description (replace-match "}" t t description))))
8827 (when (equal link description)
8828 ;; No description needed, it is identical
8829 (setq description nil))
8830 (when (and (not description)
8831 (not (string-match (org-image-file-name-regexp) link))
8832 (not (equal link (org-link-escape link))))
8833 (setq description (org-extract-attributes link)))
8834 (setq link
8835 (cond ((string-match (org-image-file-name-regexp) link) link)
8836 ((string-match org-link-types-re link)
8837 (concat (match-string 1 link)
8838 (org-link-escape (substring link (match-end 1)))))
8839 (t (org-link-escape link))))
8840 (concat "[[" link "]"
8841 (if description (concat "[" description "]") "")
8842 "]"))
8844 (defconst org-link-escape-chars
8845 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8846 "List of characters that should be escaped in link.
8847 This is the list that is used for internal purposes.")
8849 (defvar org-url-encoding-use-url-hexify nil)
8851 (defconst org-link-escape-chars-browser
8852 '(?\ )
8853 "List of escapes for characters that are problematic in links.
8854 This is the list that is used before handing over to the browser.")
8856 (defun org-link-escape (text &optional table merge)
8857 "Return percent escaped representation of TEXT.
8858 TEXT is a string with the text to escape.
8859 Optional argument TABLE is a list with characters that should be
8860 escaped. When nil, `org-link-escape-chars' is used.
8861 If optional argument MERGE is set, merge TABLE into
8862 `org-link-escape-chars'."
8863 (if (and org-url-encoding-use-url-hexify (not table))
8864 (url-hexify-string text)
8865 (cond
8866 ((and table merge)
8867 (mapc (lambda (defchr)
8868 (unless (member defchr table)
8869 (setq table (cons defchr table)))) org-link-escape-chars))
8870 ((null table)
8871 (setq table org-link-escape-chars)))
8872 (mapconcat
8873 (lambda (char)
8874 (if (or (member char table)
8875 (< char 32) (= char 37) (> char 126))
8876 (mapconcat (lambda (sequence-element)
8877 (format "%%%.2X" sequence-element))
8878 (or (encode-coding-char char 'utf-8)
8879 (error "Unable to percent escape character: %s"
8880 (char-to-string char))) "")
8881 (char-to-string char))) text "")))
8883 (defun org-link-unescape (str)
8884 "Unhex hexified unicode strings as returned from the JavaScript function
8885 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8886 (unless (and (null str) (string= "" str))
8887 (let ((pos 0) (case-fold-search t) unhexed)
8889 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8890 (setq str (replace-match unhexed t t str))
8891 (setq pos (+ pos (length unhexed))))))
8892 str)
8894 (defun org-link-unescape-compound (hex)
8895 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8896 Note: this function also decodes single byte encodings like
8898 (save-match-data
8899 (let* ((bytes (cdr (split-string hex "%")))
8900 (ret "")
8901 (eat 0)
8902 (sum 0))
8903 (while bytes
8904 (let* ((val (string-to-number (pop bytes) 16))
8905 (shift-xor
8906 (if (= 0 eat)
8907 (cond
8908 ((>= val 252) (cons 6 252))
8909 ((>= val 248) (cons 5 248))
8910 ((>= val 240) (cons 4 240))
8911 ((>= val 224) (cons 3 224))
8912 ((>= val 192) (cons 2 192))
8913 (t (cons 0 0)))
8914 (cons 6 128))))
8915 (if (>= val 192) (setq eat (car shift-xor)))
8916 (setq val (logxor val (cdr shift-xor)))
8917 (setq sum (+ (lsh sum (car shift-xor)) val))
8918 (if (> eat 0) (setq eat (- eat 1)))
8919 (cond
8920 ((= 0 eat) ;multi byte
8921 (setq ret (concat ret (org-char-to-string sum)))
8922 (setq sum 0))
8923 ((not bytes) ; single byte(s)
8924 (setq ret (org-link-unescape-single-byte-sequence hex))))
8925 )) ;; end (while bytes
8926 ret )))
8928 (defun org-link-unescape-single-byte-sequence (hex)
8929 "Unhexify hex-encoded single byte character sequences."
8930 (mapconcat (lambda (byte)
8931 (char-to-string (string-to-number byte 16)))
8932 (cdr (split-string hex "%")) ""))
8934 (defun org-xor (a b)
8935 "Exclusive or."
8936 (if a (not b) b))
8938 (defun org-fixup-message-id-for-http (s)
8939 "Replace special characters in a message id, so it can be used in an http query."
8940 (when (string-match "%" s)
8941 (setq s (mapconcat (lambda (c)
8942 (if (eq c ?%)
8943 "%25"
8944 (char-to-string c)))
8945 s "")))
8946 (while (string-match "<" s)
8947 (setq s (replace-match "%3C" t t s)))
8948 (while (string-match ">" s)
8949 (setq s (replace-match "%3E" t t s)))
8950 (while (string-match "@" s)
8951 (setq s (replace-match "%40" t t s)))
8952 s)
8954 ;;;###autoload
8955 (defun org-insert-link-global ()
8956 "Insert a link like Org-mode does.
8957 This command can be called in any mode to insert a link in Org-mode syntax."
8958 (interactive)
8959 (org-load-modules-maybe)
8960 (org-run-like-in-org-mode 'org-insert-link))
8962 (defun org-insert-link (&optional complete-file link-location)
8963 "Insert a link. At the prompt, enter the link.
8965 Completion can be used to insert any of the link protocol prefixes like
8966 http or ftp in use.
8968 The history can be used to select a link previously stored with
8969 `org-store-link'. When the empty string is entered (i.e. if you just
8970 press RET at the prompt), the link defaults to the most recently
8971 stored link. As SPC triggers completion in the minibuffer, you need to
8972 use M-SPC or C-q SPC to force the insertion of a space character.
8974 You will also be prompted for a description, and if one is given, it will
8975 be displayed in the buffer instead of the link.
8977 If there is already a link at point, this command will allow you to edit link
8978 and description parts.
8981 be selected using completion. The path to the file will be relative to the
8982 current directory if the file is in the current directory or a subdirectory.
8983 Otherwise, the link will be the absolute path as completed in the minibuffer
8984 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8985 option `org-link-file-path-type'.
8988 the current directory or below.
8991 `org-keep-stored-link-after-insertion'.
8993 If `org-make-link-description-function' is non-nil, this function will be
8994 called with the link target, and the result will be the default
8995 link description.
8997 If the LINK-LOCATION parameter is non-nil, this value will be
8998 used as the link location instead of reading one interactively."
8999 (interactive "P")
9000 (let* ((wcf (current-window-configuration))
9001 (region (if (org-region-active-p)
9002 (buffer-substring (region-beginning) (region-end))))
9003 (remove (and region (list (region-beginning) (region-end))))
9004 (desc region)
9005 tmphist ; byte-compile incorrectly complains about this
9006 (link link-location)
9007 entry file all-prefixes)
9008 (cond
9009 (link-location) ; specified by arg, just use it.
9010 ((org-in-regexp org-bracket-link-regexp 1)
9011 ;; We do have a link at point, and we are going to edit it.
9012 (setq remove (list (match-beginning 0) (match-end 0)))
9013 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9014 (setq link (read-string "Link: "
9015 (org-link-unescape
9016 (org-match-string-no-properties 1)))))
9017 ((or (org-in-regexp org-angle-link-re)
9018 (org-in-regexp org-plain-link-re))
9019 ;; Convert to bracket link
9020 (setq remove (list (match-beginning 0) (match-end 0))
9021 link (read-string "Link: "
9022 (org-remove-angle-brackets (match-string 0)))))
9023 ((member complete-file '((4) (16)))
9024 ;; Completing read for file names.
9025 (setq link (org-file-complete-link complete-file)))
9026 (t
9027 ;; Read link, with completion for stored links.
9028 (with-output-to-temp-buffer "*Org Links*"
9029 (princ "Insert a link.
9031 (when org-stored-links
9033 (princ (mapconcat
9034 (lambda (x)
9035 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9037 (let ((cw (selected-window)))
9038 (select-window (get-buffer-window "*Org Links*" 'visible))
9039 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9040 (unless (pos-visible-in-window-p (point-max))
9041 (org-fit-window-to-buffer))
9042 (and (window-live-p cw) (select-window cw)))
9043 ;; Fake a link history, containing the stored links.
9044 (setq tmphist (append (mapcar 'car org-stored-links)
9045 org-insert-link-history))
9046 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9047 (mapcar 'car org-link-abbrev-alist)
9048 org-link-types))
9049 (unwind-protect
9050 (progn
9051 (setq link
9052 (let ((org-completion-use-ido nil)
9053 (org-completion-use-iswitchb nil))
9054 (org-completing-read
9055 "Link: "
9056 (append
9057 (mapcar (lambda (x) (list (concat x ":")))
9058 all-prefixes)
9059 (mapcar 'car org-stored-links))
9060 nil nil nil
9061 'tmphist
9062 (car (car org-stored-links)))))
9064 (error "No link selected"))
9065 (if (or (member link all-prefixes)
9066 (and (equal ":" (substring link -1))
9067 (member (substring link 0 -1) all-prefixes)
9068 (setq link (substring link 0 -1))))
9069 (setq link (org-link-try-special-completion link))))
9070 (set-window-configuration wcf)
9071 (kill-buffer "*Org Links*"))
9072 (setq entry (assoc link org-stored-links))
9073 (or entry (push link org-insert-link-history))
9074 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9075 (not org-keep-stored-link-after-insertion))
9076 (setq org-stored-links (delq (assoc link org-stored-links)
9077 org-stored-links)))
9078 (setq desc (or desc (nth 1 entry)))))
9080 (if (string-match org-plain-link-re link)
9081 ;; URL-like link, normalize the use of angular brackets.
9082 (setq link (org-make-link (org-remove-angle-brackets link))))
9084 ;; Check if we are linking to the current file with a search option
9085 ;; If yes, simplify the link by using only the search option.
9086 (when (and buffer-file-name
9088 (let* ((path (match-string 1 link))
9089 (case-fold-search nil)
9090 (search (match-string 2 link)))
9091 (save-match-data
9092 (if (equal (file-truename buffer-file-name) (file-truename path))
9093 ;; We are linking to this same file, with a search option
9094 (setq link search)))))
9096 ;; Check if we can/should use a relative path. If yes, simplify the link
9098 (let* ((type (match-string 1 link))
9099 (path (match-string 2 link))
9100 (origpath path)
9101 (case-fold-search nil))
9102 (cond
9103 ((or (eq org-link-file-path-type 'absolute)
9104 (equal complete-file '(16)))
9105 (setq path (abbreviate-file-name (expand-file-name path))))
9106 ((eq org-link-file-path-type 'noabbrev)
9107 (setq path (expand-file-name path)))
9108 ((eq org-link-file-path-type 'relative)
9109 (setq path (file-relative-name path)))
9110 (t
9111 (save-match-data
9112 (if (string-match (concat "^" (regexp-quote
9113 (expand-file-name
9114 (file-name-as-directory
9115 default-directory))))
9116 (expand-file-name path))
9117 ;; We are linking a file with relative path name.
9118 (setq path (substring (expand-file-name path)
9119 (match-end 0)))
9120 (setq path (abbreviate-file-name (expand-file-name path)))))))
9121 (setq link (concat type path))
9122 (if (equal desc origpath)
9123 (setq desc path))))
9125 (if org-make-link-description-function
9126 (setq desc (funcall org-make-link-description-function link desc)))
9128 (setq desc (read-string "Description: " desc))
9130 (if remove (apply 'delete-region remove))
9131 (insert (org-make-link-string link desc))))
9133 (defun org-link-try-special-completion (type)
9134 "If there is completion support for link type TYPE, offer it."
9135 (let ((fun (intern (concat "org-" type "-complete-link"))))
9136 (if (functionp fun)
9137 (funcall fun)
9138 (read-string "Link (no completion support): " (concat type ":")))))
9140 (defun org-file-complete-link (&optional arg)
9141 "Create a file link using completion."
9142 (let (file link)
9143 (setq file (read-file-name "File: "))
9144 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9145 (pwd1 (file-name-as-directory (abbreviate-file-name
9146 (expand-file-name ".")))))
9147 (cond
9148 ((equal arg '(16))
9149 (setq link (org-make-link
9150 "file:"
9151 (abbreviate-file-name (expand-file-name file)))))
9153 (setq link (org-make-link "file:" (match-string 1 file))))
9155 (expand-file-name file))
9156 (setq link (org-make-link
9157 "file:" (match-string 1 (expand-file-name file)))))
9158 (t (setq link (org-make-link "file:" file)))))
9159 link))
9161 (defun org-completing-read (&rest args)
9162 "Completing-read with SPACE being a normal character."
9163 (let ((enable-recursive-minibuffers t)
9164 (minibuffer-local-completion-map
9165 (copy-keymap minibuffer-local-completion-map)))
9166 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9167 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9168 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9169 (apply 'org-icompleting-read args)))
9171 (defun org-completing-read-no-i (&rest args)
9172 (let (org-completion-use-ido org-completion-use-iswitchb)
9173 (apply 'org-completing-read args)))
9175 (defun org-iswitchb-completing-read (prompt choices &rest args)
9176 "Use iswitch as a completing-read replacement to choose from choices.
9177 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9178 from."
9179 (let* ((iswitchb-use-virtual-buffers nil)
9180 (iswitchb-make-buflist-hook
9181 (lambda ()
9182 (setq iswitchb-temp-buflist choices))))
9183 (iswitchb-read-buffer prompt)))
9185 (defun org-icompleting-read (&rest args)
9186 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9187 (org-without-partial-completion
9188 (if (and org-completion-use-ido
9189 (fboundp 'ido-completing-read)
9190 (boundp 'ido-mode) ido-mode
9191 (listp (second args)))
9192 (let ((ido-enter-matching-directory nil))
9193 (apply 'ido-completing-read (concat (car args))
9194 (if (consp (car (nth 1 args)))
9195 (mapcar 'car (nth 1 args))
9196 (nth 1 args))
9197 (cddr args)))
9198 (if (and org-completion-use-iswitchb
9199 (boundp 'iswitchb-mode) iswitchb-mode
9200 (listp (second args)))
9201 (apply 'org-iswitchb-completing-read (concat (car args))
9202 (if (consp (car (nth 1 args)))
9203 (mapcar 'car (nth 1 args))
9204 (nth 1 args))
9205 (cddr args))
9206 (apply 'completing-read args)))))
9208 (defun org-extract-attributes (s)
9209 "Extract the attributes cookie from a string and set as text property."
9210 (let (a attr (start 0) key value)
9211 (save-match-data
9213 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9215 (setq key (match-string 1 a) value (match-string 2 a)
9216 start (match-end 0)
9217 attr (plist-put attr (intern key) value))))
9218 (org-add-props s nil 'org-attr attr))
9219 s))
9221 (defun org-extract-attributes-from-string (tag)
9222 (let (key value attr)
9224 (setq key (match-string 1 tag) value (match-string 2 tag)
9225 tag (replace-match "" t t tag)
9226 attr (plist-put attr (intern key) value)))
9227 (cons tag attr)))
9229 (defun org-attributes-to-string (plist)
9230 "Format a property list into an HTML attribute list."
9231 (let ((s "") key value)
9232 (while plist
9233 (setq key (pop plist) value (pop plist))
9234 (and value
9236 s))
9238 ;;; Opening/following a link
9240 (defvar org-link-search-failed nil)
9242 (defvar org-open-link-functions nil
9243 "Hook for functions finding a plain text link.
9244 These functions must take a single argument, the link content.
9245 They will be called for links that look like [[link text][description]]
9249 These functions will be called *before* Org attempts to resolve the
9250 link by doing text searches in the current buffer - so if you want a
9252 handle this as a special case.
9254 When the function does handle the link, it must return a non-nil value.
9255 If it decides that it is not responsible for this link, it must return
9256 nil to indicate that that Org-mode can continue with other options
9257 like exact and fuzzy text search.")
9259 (defun org-next-link ()
9260 "Move forward to the next link.
9261 If the link is in hidden text, expose it."
9262 (interactive)
9263 (when (and org-link-search-failed (eq this-command last-command))
9264 (goto-char (point-min))
9265 (message "Link search wrapped back to beginning of buffer"))
9266 (setq org-link-search-failed nil)
9267 (let* ((pos (point))
9268 (ct (org-context))
9269 (a (assoc :link ct)))
9270 (if a (goto-char (nth 2 a)))
9271 (if (re-search-forward org-any-link-re nil t)
9272 (progn
9273 (goto-char (match-beginning 0))
9274 (if (outline-invisible-p) (org-show-context)))
9275 (goto-char pos)
9276 (setq org-link-search-failed t)
9277 (error "No further link found"))))
9279 (defun org-previous-link ()
9280 "Move backward to the previous link.
9281 If the link is in hidden text, expose it."
9282 (interactive)
9283 (when (and org-link-search-failed (eq this-command last-command))
9284 (goto-char (point-max))
9285 (message "Link search wrapped back to end of buffer"))
9286 (setq org-link-search-failed nil)
9287 (let* ((pos (point))
9288 (ct (org-context))
9289 (a (assoc :link ct)))
9290 (if a (goto-char (nth 1 a)))
9291 (if (re-search-backward org-any-link-re nil t)
9292 (progn
9293 (goto-char (match-beginning 0))
9294 (if (outline-invisible-p) (org-show-context)))
9295 (goto-char pos)
9296 (setq org-link-search-failed t)
9297 (error "No further link found"))))
9299 (defun org-translate-link (s)
9300 "Translate a link string if a translation function has been defined."
9301 (if (and org-link-translation-function
9302 (fboundp org-link-translation-function)
9304 (progn
9305 (setq s (funcall org-link-translation-function
9306 (match-string 1) (match-string 2)))
9307 (concat (car s) ":" (cdr s)))
9308 s))
9310 (defun org-translate-link-from-planner (type path)
9311 "Translate a link from Emacs Planner syntax so that Org can follow it.
9312 This is still an experimental function, your mileage may vary."
9313 (cond
9314 ((member type '("http" "https" "news" "ftp"))
9315 ;; standard Internet links are the same.
9316 nil)
9317 ((and (equal type "irc") (string-match "^//" path))
9318 ;; Planner has two / at the beginning of an irc link, we have 1.
9319 ;; We should have zero, actually....
9320 (setq path (substring path 1)))
9321 ((and (equal type "lisp") (string-match "^/" path))
9322 ;; Planner has a slash, we do not.
9323 (setq type "elisp" path (substring path 1)))
9325 ;; A typical message link. Planner has the id after the final slash,
9326 ;; we separate it with a hash mark
9327 (setq path (concat (match-string 1 path) "#"
9328 (org-remove-angle-brackets (match-string 2 path)))))
9329 )
9330 (cons type path))
9332 (defun org-find-file-at-mouse (ev)
9333 "Open file link or URL at mouse."
9334 (interactive "e")
9335 (mouse-set-point ev)
9336 (org-open-at-point 'in-emacs))
9338 (defun org-open-at-mouse (ev)
9339 "Open file link or URL at mouse.
9340 See the docstring of `org-open-file' for details."
9341 (interactive "e")
9342 (mouse-set-point ev)
9343 (if (eq major-mode 'org-agenda-mode)
9344 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9345 (org-open-at-point))
9347 (defvar org-window-config-before-follow-link nil
9348 "The window configuration before following a link.
9349 This is saved in case the need arises to restore it.")
9351 (defvar org-open-link-marker (make-marker)
9352 "Marker pointing to the location where `org-open-at-point; was called.")
9354 ;;;###autoload
9355 (defun org-open-at-point-global ()
9356 "Follow a link like Org-mode does.
9357 This command can be called in any mode to follow a link that has
9358 Org-mode syntax."
9359 (interactive)
9360 (org-run-like-in-org-mode 'org-open-at-point))
9362 ;;;###autoload
9363 (defun org-open-link-from-string (s &optional arg reference-buffer)
9364 "Open a link in the string S, as if it was in Org-mode."
9366 (let ((reference-buffer (or reference-buffer (current-buffer))))
9367 (with-temp-buffer
9368 (let ((org-inhibit-startup t))
9369 (org-mode)
9370 (insert s)
9371 (goto-char (point-min))
9372 (when reference-buffer
9373 (setq org-link-abbrev-alist-local
9374 (with-current-buffer reference-buffer
9375 org-link-abbrev-alist-local)))
9376 (org-open-at-point arg reference-buffer)))))
9378 (defvar org-open-at-point-functions nil
9379 "Hook that is run when following a link at point.
9381 Functions in this hook must return t if they identify and follow
9382 a link at point. If they don't find anything interesting at point,
9383 they must return nil.")
9385 (defun org-open-at-point (&optional arg reference-buffer)
9386 "Open link at or after point.
9387 If there is no link at point, this function will search forward up to
9388 the end of the current line.
9389 Normally, files will be opened by an appropriate application. If the
9390 optional prefix argument ARG is non-nil, Emacs will visit the file.
9391 With a double prefix argument, try to open outside of Emacs, in the
9392 application the system uses for this file type."
9393 (interactive "P")
9394 ;; if in a code block, then open the block's results
9395 (unless (call-interactively #'org-babel-open-src-block-result)
9396 (org-load-modules-maybe)
9397 (move-marker org-open-link-marker (point))
9398 (setq org-window-config-before-follow-link (current-window-configuration))
9399 (org-remove-occur-highlights nil nil t)
9400 (cond
9401 ((and (org-on-heading-p)
9402 (not (org-in-regexp
9407 (not (get-text-property (point) 'org-linked-text)))
9408 (or (org-offer-links-in-entry arg)
9409 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9410 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9411 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9412 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9413 (not (org-in-regexp org-bracket-link-regexp)))
9414 (org-footnote-action))
9415 (t
9416 (let (type path link line search (pos (point)))
9417 (catch 'match
9418 (save-excursion
9420 (when (org-in-regexp org-bracket-link-regexp 1)
9421 (setq link (org-extract-attributes
9422 (org-link-unescape (org-match-string-no-properties 1))))
9424 (setq link (replace-match " " t t link)))
9425 (setq link (org-link-expand-abbrev link))
9426 (cond
9427 ((or (file-name-absolute-p link)
9429 (setq type "file" path link))
9430 ((string-match org-link-re-with-space3 link)
9431 (setq type (match-string 1 link) path (match-string 2 link)))
9432 (t (setq type "thisfile" path link)))
9433 (throw 'match t)))
9435 (when (get-text-property (point) 'org-linked-text)
9436 (setq type "thisfile"
9437 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9438 (1+ (point)) (point))
9439 path (buffer-substring
9440 (or (previous-single-property-change pos 'org-linked-text)
9441 (point-min))
9442 (or (next-single-property-change pos 'org-linked-text)
9443 (point-max))))
9444 (throw 'match t))
9446 (save-excursion
9447 (when (or (org-in-regexp org-angle-link-re)
9448 (org-in-regexp org-plain-link-re))
9449 (setq type (match-string 1)
9450 path (org-link-unescape (match-string 2)))
9451 (throw 'match t)))
9452 (save-excursion
9454 (setq type "tags"
9455 path (match-string 1))
9456 (while (string-match ":" path)
9457 (setq path (replace-match "+" t t path)))
9458 (throw 'match t)))
9460 (setq type "tree-match"
9461 path (match-string 1))
9462 (throw 'match t)))
9463 (unless path
9464 (error "No link found"))
9466 ;; switch back to reference buffer
9467 ;; needed when if called in a temporary buffer through
9468 ;; org-open-link-from-string
9469 (with-current-buffer (or reference-buffer (current-buffer))
9471 ;; Remove any trailing spaces in path
9473 (setq path (replace-match "" t t path)))
9474 (if (and org-link-translation-function
9475 (fboundp org-link-translation-function))
9476 ;; Check if we need to translate the link
9477 (let ((tmp (funcall org-link-translation-function type path)))
9478 (setq type (car tmp) path (cdr tmp))))
9480 (cond
9482 ((assoc type org-link-protocols)
9483 (funcall (nth 1 (assoc type org-link-protocols)) path))
9485 ((equal type "mailto")
9486 (let ((cmd (car org-link-mailto-program))
9487 (args (cdr org-link-mailto-program)) args1
9488 (address path) (subject "") a)
9490 (setq address (match-string 1 path)
9491 subject (org-link-escape (match-string 2 path))))
9492 (while args
9493 (cond
9494 ((not (stringp (car args))) (push (pop args) args1))
9495 (t (setq a (pop args))
9496 (if (string-match "%a" a)
9497 (setq a (replace-match address t t a)))
9498 (if (string-match "%s" a)
9499 (setq a (replace-match subject t t a)))
9500 (push a args1))))
9501 (apply cmd (nreverse args1))))
9503 ((member type '("http" "https" "ftp" "news"))
9504 (browse-url (concat type ":" (org-link-escape
9505 path org-link-escape-chars-browser))))
9507 ((string= type "doi")
9508 (browse-url (concat "http://dx.doi.org/"
9509 (org-link-escape
9510 path org-link-escape-chars-browser))))
9512 ((member type '("message"))
9513 (browse-url (concat type ":" path)))
9515 ((string= type "tags")
9516 (org-tags-view arg path))
9518 ((string= type "tree-match")
9521 ((string= type "file")
9523 (setq line (string-to-number (match-string 1 path))
9524 path (substring path 0 (match-beginning 0)))
9526 (setq search (match-string 1 path)
9527 path (substring path 0 (match-beginning 0)))))
9528 (if (string-match "[*?{]" (file-name-nondirectory path))
9529 (dired path)
9530 (org-open-file path arg line search)))
9532 ((string= type "shell")
9533 (let ((cmd path))
9534 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9535 (string-match org-confirm-shell-link-not-regexp cmd))
9536 (not org-confirm-shell-link-function)
9537 (funcall org-confirm-shell-link-function
9539 (org-add-props cmd nil
9540 'face 'org-warning))))
9541 (progn
9542 (message "Executing %s" cmd)
9543 (shell-command cmd))
9544 (error "Abort"))))
9546 ((string= type "elisp")
9547 (let ((cmd path))
9548 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9549 (string-match org-confirm-elisp-link-not-regexp cmd))
9550 (not org-confirm-elisp-link-function)
9551 (funcall org-confirm-elisp-link-function
9553 (org-add-props cmd nil
9554 'face 'org-warning))))
9555 (message "%s => %s" cmd
9556 (if (equal (string-to-char cmd) ?\()
9557 (eval (read cmd))
9558 (call-interactively (read cmd))))
9559 (error "Abort"))))
9561 ((and (string= type "thisfile")
9562 (run-hook-with-args-until-success
9563 'org-open-link-functions path)))
9565 ((string= type "thisfile")
9566 (if arg
9567 (switch-to-buffer-other-window
9568 (org-get-buffer-for-internal-link (current-buffer)))
9569 (org-mark-ring-push))
9570 (let ((cmd `(org-link-search
9571 ,path
9572 ,(cond ((equal arg '(4)) ''occur)
9573 ((equal arg '(16)) ''org-occur)
9574 (t nil))
9575 ,pos)))
9576 (condition-case nil (let ((org-link-search-inhibit-query t))
9577 (eval cmd))
9578 (error (progn (widen) (eval cmd))))))
9580 (t
9581 (browse-url-at-point)))))))
9582 (move-marker org-open-link-marker nil)
9583 (run-hook-with-args 'org-follow-link-hook)))
9585 (defun org-offer-links-in-entry (&optional nth zero)
9586 "Offer links in the current entry and follow the selected link.
9587 If there is only one link, follow it immediately as well.
9588 If NTH is an integer, immediately pick the NTH link found.
9589 If ZERO is a string, check also this string for a link, and if
9590 there is one, offer it as link number zero."
9594 (cnt ?0)
9595 (in-emacs (if (integerp nth) nil nth))
9596 have-zero end links link c)
9597 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9598 (push (match-string 0 zero) links)
9599 (setq cnt (1- cnt) have-zero t))
9600 (save-excursion
9601 (org-back-to-heading t)
9602 (setq end (save-excursion (outline-next-heading) (point)))
9603 (while (re-search-forward re end t)
9604 (push (match-string 0) links))
9605 (setq links (org-uniquify (reverse links))))
9607 (cond
9608 ((null links)
9609 (message "No links"))
9610 ((equal (length links) 1)
9611 (setq link (list (car links))))
9612 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9613 (setq link (nth (if have-zero nth (1- nth)) links)))
9614 (t ; we have to select a link
9615 (save-excursion
9616 (save-window-excursion
9617 (delete-other-windows)
9618 (with-output-to-temp-buffer "*Select Link*"
9619 (mapc (lambda (l)
9620 (if (not (string-match org-bracket-link-regexp l))
9622 (org-remove-angle-brackets l)))
9623 (if (match-end 3)
9625 (match-string 3 l) (match-string 1 l)))
9627 (match-string 1 l))))))
9628 links))
9629 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9630 (message "Select link to open, RET to open all:")
9631 (setq c (read-char-exclusive))
9632 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9633 (when (equal c ?q) (error "Abort"))
9634 (if (equal c ?\C-m)
9635 (setq link links)
9636 (setq nth (- c ?0))
9637 (if have-zero (setq nth (1+ nth)))
9638 (unless (and (integerp nth) (>= (length links) nth))
9639 (error "Invalid link selection"))
9640 (setq link (list (nth (1- nth) links))))))
9641 (if link
9642 (let ((buf (current-buffer)))
9643 (dolist (l link)
9644 (org-open-link-from-string l in-emacs buf))
9645 t)
9646 nil)))
9648 ;; Add special file links that specify the way of opening
9650 (org-add-link-type "file+sys" 'org-open-file-with-system)
9651 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9652 (defun org-open-file-with-system (path)
9653 "Open file at PATH using the system way of opening it."
9654 (org-open-file path 'system))
9655 (defun org-open-file-with-emacs (path)
9656 "Open file at PATH in Emacs."
9657 (org-open-file path 'emacs))
9658 (defun org-remove-file-link-modifiers ()
9659 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9660 (goto-char (point-min))
9662 (org-if-unprotected
9663 (replace-match "file:" t t))))
9664 (eval-after-load "org-exp"
9665 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9666 'org-remove-file-link-modifiers))
9668 ;;;; Time estimates
9670 (defun org-get-effort (&optional pom)
9671 "Get the effort estimate for the current entry."
9672 (org-entry-get pom org-effort-property))
9674 ;;; File search
9676 (defvar org-create-file-search-functions nil
9677 "List of functions to construct the right search string for a file link.
9678 These functions are called in turn with point at the location to
9679 which the link should point.
9681 A function in the hook should first test if it would like to
9682 handle this file type, for example by checking the `major-mode'
9683 or the file extension. If it decides not to handle this file, it
9684 should just return nil to give other functions a chance. If it
9685 does handle the file, it must return the search string to be used
9686 when following the link. The search string will be part of the
9687 file link, given after a double colon, and `org-open-at-point'
9688 will automatically search for it. If special measures must be
9689 taken to make the search successful, another function should be
9690 added to the companion hook `org-execute-file-search-functions',
9691 which see.
9693 A function in this hook may also use `setq' to set the variable
9694 `description' to provide a suggestion for the descriptive text to
9695 be used for this link when it gets inserted into an Org-mode
9698 (defvar org-execute-file-search-functions nil
9699 "List of functions to execute a file search triggered by a link.
9701 Functions added to this hook must accept a single argument, the
9702 search string that was part of the file link, the part after the
9703 double colon. The function must first check if it would like to
9704 handle this search, for example by checking the `major-mode' or
9705 the file extension. If it decides not to handle this search, it
9706 should just return nil to give other functions a chance. If it
9707 does handle the search, it must return a non-nil value to keep
9708 other functions from trying.
9710 Each function can access the current prefix argument through the
9711 variable `current-prefix-argument'. Note that a single prefix is
9712 used to force opening a link in Emacs, so it may be good to only
9713 use a numeric or double prefix to guide the search function.
9715 In case this is needed, a function in this hook can also restore
9716 the window configuration before `org-open-at-point' was called using:
9718 (set-window-configuration org-window-config-before-follow-link)")
9720 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9721 (defun org-link-search (s &optional type avoid-pos)
9722 "Search for a link search option.
9723 If S is surrounded by forward slashes, it is interpreted as a
9724 regular expression. In org-mode files, this will create an `org-occur'
9725 sparse tree. In ordinary files, `occur' will be used to list matches.
9726 If the current buffer is in `dired-mode', grep will be used to search
9727 in all files. If AVOID-POS is given, ignore matches near that position."
9728 (let ((case-fold-search t)
9732 org-emphasis-alist)
9734 (pos (point))
9735 (pre nil) (post nil)
9736 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9737 (cond
9738 ;; First check if there are any special search functions
9739 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9740 ;; Now try the builtin stuff
9741 ((and (equal (string-to-char s0) ?#)
9742 (> (length s0) 1)
9743 (save-excursion
9744 (goto-char (point-min))
9745 (and
9746 (re-search-forward
9748 (setq type 'dedicated
9749 pos (match-beginning 0))))
9750 ;; There is an exact target for this
9751 (goto-char pos)
9752 (org-back-to-heading t)))
9753 ((save-excursion
9754 (goto-char (point-min))
9755 (and
9756 (re-search-forward
9757 (concat "<<" (regexp-quote s0) ">>") nil t)
9758 (setq type 'dedicated
9759 pos (match-beginning 0))))
9760 ;; There is an exact target for this
9761 (goto-char pos))
9763 (save-excursion
9764 (goto-char (point-min))
9765 (and
9766 (re-search-forward
9767 (concat "[^[]" (regexp-quote
9768 (format org-coderef-label-format
9769 (match-string 1 s0))))
9770 nil t)
9771 (setq type 'dedicated
9772 pos (1+ (match-beginning 0))))))
9773 ;; There is a coderef target for this
9774 (goto-char pos))
9776 ;; A regular expression
9777 (cond
9778 ((eq major-mode 'org-mode)
9779 (org-occur (match-string 1 s)))
9780 ;;((eq major-mode 'dired-mode)
9781 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9782 (t (org-do-occur (match-string 1 s)))))
9783 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9784 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9785 (goto-char (point-min))
9786 (cond
9787 ((let (case-fold-search)
9788 (re-search-forward (format org-complex-heading-regexp-format
9789 (regexp-quote s))
9790 nil t))
9791 ;; OK, found a match
9792 (setq type 'dedicated)
9793 (goto-char (match-beginning 0)))
9794 ((and (not org-link-search-inhibit-query)
9795 (eq org-link-search-must-match-exact-headline 'query-to-create)
9796 (y-or-n-p "No match - create this as a new heading? "))
9797 (goto-char (point-max))
9798 (or (bolp) (newline))
9800 (beginning-of-line 0))
9801 (t
9802 (goto-char pos)
9803 (error "No match"))))
9804 (t
9805 ;; A normal search string
9806 (when (equal (string-to-char s) ?*)
9807 ;; Anchor on headlines, post may include tags.
9810 s (substring s 1)))
9811 (remove-text-properties
9812 0 (length s)
9813 '(face nil mouse-face nil keymap nil fontified nil) s)
9814 ;; Make a series of regular expressions to find a match
9823 re4 (concat "[^a-zA-Z_]" re4_)
9825 re1 (concat pre re2 post)
9826 re3 (concat pre (if pre re4_ re4) post)
9827 re5 (concat pre ".*" re4)
9828 re2 (concat pre re2)
9829 re2a (concat pre (if pre re2a_ re2a))
9830 re4 (concat pre (if pre re4_ re4))
9834 ))
9835 (cond
9836 ((eq type 'org-occur) (org-occur reall))
9837 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9838 (t (goto-char (point-min))
9839 (setq type 'fuzzy)
9840 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9841 (org-search-not-self 1 re1 nil t)
9842 (org-search-not-self 1 re2 nil t)
9843 (org-search-not-self 1 re2a nil t)
9844 (org-search-not-self 1 re3 nil t)
9845 (org-search-not-self 1 re4 nil t)
9846 (org-search-not-self 1 re5 nil t)
9847 )
9848 (goto-char (match-beginning 1))
9849 (goto-char pos)
9850 (error "No match"))))))
9851 (and (eq major-mode 'org-mode) (org-show-context 'link-search))
9852 type))
9854 (defun org-search-not-self (group &rest args)
9855 "Execute `re-search-forward', but only accept matches that do not
9856 enclose the position of `org-open-link-marker'."
9857 (let ((m org-open-link-marker))
9858 (catch 'exit
9859 (while (apply 're-search-forward args)
9860 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9861 (goto-char (match-end group))
9862 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9863 (> (match-beginning 0) (marker-position m))
9864 (< (match-end 0) (marker-position m)))
9865 (save-match-data
9866 (or (not (org-in-regexp
9867 org-bracket-link-analytic-regexp 1))
9868 (not (match-end 4)) ; no description
9869 (and (<= (match-beginning 4) (point))
9870 (>= (match-end 4) (point))))))
9871 (throw 'exit (point))))))))
9873 (defun org-get-buffer-for-internal-link (buffer)
9874 "Return a buffer to be used for displaying the link target of internal links."
9875 (cond
9876 ((not org-display-internal-link-with-indirect-buffer)
9877 buffer)
9878 ((string-match "(Clone)$" (buffer-name buffer))
9879 (message "Buffer is already a clone, not making another one")
9880 ;; we also do not modify visibility in this case
9881 buffer)
9882 (t ; make a new indirect buffer for displaying the link
9883 (let* ((bn (buffer-name buffer))
9884 (ibn (concat bn "(Clone)"))
9885 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9886 (with-current-buffer ib (org-overview))
9887 ib))))
9889 (defun org-do-occur (regexp &optional cleanup)
9890 "Call the Emacs command `occur'.
9891 If CLEANUP is non-nil, remove the printout of the regular expression
9892 in the *Occur* buffer. This is useful if the regex is long and not useful
9893 to read."
9894 (occur regexp)
9895 (when cleanup
9896 (let ((cwin (selected-window)) win beg end)
9897 (when (setq win (get-buffer-window "*Occur*"))
9898 (select-window win))
9899 (goto-char (point-min))
9900 (when (re-search-forward "match[a-z]+" nil t)
9901 (setq beg (match-end 0))
9903 (setq end (1- (match-beginning 0)))))
9904 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9905 (goto-char (point-min))
9906 (select-window cwin))))
9908 ;;; The mark ring for links jumps
9910 (defvar org-mark-ring nil
9911 "Mark ring for positions before jumps in Org-mode.")
9912 (defvar org-mark-ring-last-goto nil
9913 "Last position in the mark ring used to go back.")
9914 ;; Fill and close the ring
9915 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9916 (loop for i from 1 to org-mark-ring-length do
9917 (push (make-marker) org-mark-ring))
9918 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9919 org-mark-ring)
9921 (defun org-mark-ring-push (&optional pos buffer)
9922 "Put the current position or POS into the mark ring and rotate it."
9923 (interactive)
9924 (setq pos (or pos (point)))
9925 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9926 (move-marker (car org-mark-ring)
9927 (or pos (point))
9928 (or buffer (current-buffer)))
9929 (message "%s"
9930 (substitute-command-keys
9933 (defun org-mark-ring-goto (&optional n)
9934 "Jump to the previous position in the mark ring.
9935 With prefix arg N, jump back that many stored positions. When
9936 called several times in succession, walk through the entire ring.
9937 Org-mode commands jumping to a different position in the current file,
9938 or to another Org-mode file, automatically push the old position
9939 onto the ring."
9940 (interactive "p")
9941 (let (p m)
9942 (if (eq last-command this-command)
9943 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9944 (setq p org-mark-ring))
9945 (setq org-mark-ring-last-goto p)
9946 (setq m (car p))
9947 (org-pop-to-buffer-same-window (marker-buffer m))
9948 (goto-char m)
9949 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9951 (defun org-remove-angle-brackets (s)
9952 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9953 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9954 s)
9955 (defun org-add-angle-brackets (s)
9956 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9957 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9958 s)
9959 (defun org-remove-double-quotes (s)
9962 s)
9964 ;;; Following specific links
9966 (defun org-follow-timestamp-link ()
9967 (cond
9968 ((org-at-date-range-p t)
9969 (let ((org-agenda-start-on-weekday)
9970 (t1 (match-string 1))
9971 (t2 (match-string 2)))
9972 (setq t1 (time-to-days (org-time-string-to-time t1))
9973 t2 (time-to-days (org-time-string-to-time t2)))
9974 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9975 ((org-at-timestamp-p t)
9976 (org-agenda-list nil (time-to-days (org-time-string-to-time
9977 (substring (match-string 1) 0 10)))
9978 1))
9979 (t (error "This should not happen"))))
9982 ;;; Following file links
9983 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9984 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9985 (declare-function mailcap-mime-info
9986 "mailcap" (string &optional request no-decode))
9987 (defvar org-wait nil)
9988 (defun org-open-file (path &optional in-emacs line search)
9989 "Open the file at PATH.
9990 First, this expands any special file name abbreviations. Then the
9991 configuration variable `org-file-apps' is checked if it contains an
9992 entry for this file type, and if yes, the corresponding command is launched.
9994 If no application is found, Emacs simply visits the file.
9996 With optional prefix argument IN-EMACS, Emacs will visit the file.
9998 prefix arg, Org tries to avoid opening in Emacs
9999 and to use an external application to visit the file.
10001 Optional LINE specifies a line to go to, optional SEARCH a string
10002 to search for. If LINE or SEARCH is given, the file will be
10003 opened in Emacs, unless an entry from org-file-apps that makes
10004 use of groups in a regexp matches.
10006 If you want to change the way frames are used when following a
10007 link, please customize `org-link-frame-setup'.
10009 If the file does not exist, an error is thrown."
10010 (let* ((file (if (equal path "")
10011 buffer-file-name
10012 (substitute-in-file-name (expand-file-name path))))
10013 (file-apps (append org-file-apps (org-default-apps)))
10014 (apps (org-remove-if
10015 'org-file-apps-entry-match-against-dlink-p file-apps))
10016 (apps-dlink (org-remove-if-not
10017 'org-file-apps-entry-match-against-dlink-p file-apps))
10018 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10019 (dirp (if remp nil (file-directory-p file)))
10020 (file (if (and dirp org-open-directory-means-index-dot-org)
10021 (concat (file-name-as-directory file) "index.org")
10022 file))
10023 (a-m-a-p (assq 'auto-mode apps))
10024 (dfile (downcase file))
10025 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10026 (link (cond ((and (eq line nil)
10027 (eq search nil))
10028 file)
10029 (line
10030 (concat file "::" (number-to-string line)))
10031 (search
10032 (concat file "::" search))))
10033 (dlink (downcase link))
10034 (old-buffer (current-buffer))
10035 (old-pos (point))
10036 (old-mode major-mode)
10037 ext cmd link-match-data)
10039 (setq ext (match-string 1 dfile))
10041 (setq ext (match-string 1 dfile))))
10042 (cond
10043 ((member in-emacs '((16) system))
10044 (setq cmd (cdr (assoc 'system apps))))
10045 (in-emacs (setq cmd 'emacs))
10046 (t
10047 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10048 (and dirp (cdr (assoc 'directory apps)))
10049 ; first, try matching against apps-dlink
10050 ; if we get a match here, store the match data for later
10051 (let ((match (assoc-default dlink apps-dlink
10052 'string-match)))
10053 (if match
10054 (progn (setq link-match-data (match-data))
10055 match)
10056 (progn (setq in-emacs (or in-emacs line search))
10057 nil))) ; if we have no match in apps-dlink,
10058 ; always open the file in emacs if line or search
10059 ; is given (for backwards compatibility)
10060 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10061 'string-match)
10062 (cdr (assoc ext apps))
10063 (cdr (assoc t apps))))))
10064 (when (eq cmd 'system)
10065 (setq cmd (cdr (assoc 'system apps))))
10066 (when (eq cmd 'default)
10067 (setq cmd (cdr (assoc t apps))))
10068 (when (eq cmd 'mailcap)
10069 (require 'mailcap)
10070 (mailcap-parse-mailcaps)
10071 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10072 (command (mailcap-mime-info mime-type)))
10073 (if (stringp command)
10074 (setq cmd command)
10075 (setq cmd 'emacs))))
10076 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10077 (not (file-exists-p file))
10078 (not org-open-non-existing-files))
10079 (error "No such file: %s" file))
10080 (cond
10082 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10084 (setq cmd (replace-match "%s" t t cmd)))
10085 (while (string-match "%s" cmd)
10086 (setq cmd (replace-match
10087 (save-match-data
10088 (shell-quote-argument
10089 (convert-standard-filename file)))
10090 t t cmd)))
10092 ;; Replace "%1", "%2" etc. in command with group matches from regex
10093 (save-match-data
10094 (let ((match-index 1)
10095 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10096 (set-match-data link-match-data)
10097 (while (<= match-index number-of-groups)
10098 (let ((regex (concat "%" (number-to-string match-index)))
10099 (replace-with (match-string match-index dlink)))
10100 (while (string-match regex cmd)
10101 (setq cmd (replace-match replace-with t t cmd))))
10102 (setq match-index (+ match-index 1)))))
10104 (save-window-excursion
10105 (start-process-shell-command cmd nil cmd)
10106 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10107 ))
10108 ((or (stringp cmd)
10109 (eq cmd 'emacs))
10110 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10111 (widen)
10112 (if line (org-goto-line line)
10113 (if search (org-link-search search))))
10114 ((consp cmd)
10115 (let ((file (convert-standard-filename file)))
10116 (save-match-data
10117 (set-match-data link-match-data)
10118 (eval cmd))))
10119 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10120 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10121 (or (not (equal old-buffer (current-buffer)))
10122 (not (equal old-pos (point))))
10123 (org-mark-ring-push old-pos old-buffer))))
10125 (defun org-file-apps-entry-match-against-dlink-p (entry)
10126 "This function returns non-nil if `entry' uses a regular
10127 expression which should be matched against the whole link by
10128 org-open-file.
10130 It assumes that is the case when the entry uses a regular
10131 expression which has at least one grouping construct and the
10132 action is either a lisp form or a command string containing
10133 '%1', i.e. using at least one subexpression match as a
10134 parameter."
10135 (let ((selector (car entry))
10136 (action (cdr entry)))
10137 (if (stringp selector)
10138 (and (> (regexp-opt-depth selector) 0)
10139 (or (and (stringp action)
10140 (string-match "%[0-9]" action))
10141 (consp action)))
10142 nil)))
10144 (defun org-default-apps ()
10145 "Return the default applications for this operating system."
10146 (cond
10147 ((eq system-type 'darwin)
10148 org-file-apps-defaults-macosx)
10149 ((eq system-type 'windows-nt)
10150 org-file-apps-defaults-windowsnt)
10151 (t org-file-apps-defaults-gnu)))
10153 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10154 "Convert extensions to regular expressions in the cars of LIST.
10155 Also, weed out any non-string entries, because the return value is used
10156 only for regexp matching.
10157 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10158 point to the symbol `emacs', indicating that the file should
10159 be opened in Emacs."
10160 (append
10161 (delq nil
10162 (mapcar (lambda (x)
10163 (if (not (stringp (car x)))
10164 nil
10166 x
10168 list))
10169 (if add-auto-mode
10170 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10172 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10173 (defun org-file-remote-p (file)
10174 "Test whether FILE specifies a location on a remote system.
10175 Return non-nil if the location is indeed remote.
10179 (cond ((fboundp 'file-remote-p)
10180 (file-remote-p file))
10181 ((fboundp 'tramp-handle-file-remote-p)
10182 (tramp-handle-file-remote-p file))
10183 ((and (boundp 'ange-ftp-name-format)
10184 (string-match (car ange-ftp-name-format) file))
10185 t)
10186 (t nil)))
10189 ;;;; Refiling
10191 (defun org-get-org-file ()
10192 "Read a filename, with default directory `org-directory'."
10193 (let ((default (or org-default-notes-file remember-data-file)))
10194 (read-file-name (format "File name [%s]: " default)
10195 (file-name-as-directory org-directory)
10196 default)))
10198 (defun org-notes-order-reversed-p ()
10199 "Check if the current file should receive notes in reversed order."
10200 (cond
10201 ((not org-reverse-note-order) nil)
10202 ((eq t org-reverse-note-order) t)
10203 ((not (listp org-reverse-note-order)) nil)
10204 (t (catch 'exit
10205 (let ((all org-reverse-note-order)
10206 entry)
10207 (while (setq entry (pop all))
10208 (if (string-match (car entry) buffer-file-name)
10209 (throw 'exit (cdr entry))))
10210 nil)))))
10212 (defvar org-refile-target-table nil
10213 "The list of refile targets, created by `org-refile'.")
10215 (defvar org-agenda-new-buffers nil
10216 "Buffers created to visit agenda files.")
10218 (defvar org-refile-cache nil
10219 "Cache for refile targets.")
10221 (defvar org-refile-markers nil
10222 "All the markers used for caching refile locations.")
10224 (defun org-refile-marker (pos)
10225 "Get a new refile marker, but only if caching is in use."
10226 (if (not org-refile-use-cache)
10227 pos
10228 (let ((m (make-marker)))
10229 (move-marker m pos)
10230 (push m org-refile-markers)
10231 m)))
10233 (defun org-refile-cache-clear ()
10234 "Clear the refile cache and disable all the markers."
10235 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10236 (setq org-refile-markers nil)
10237 (setq org-refile-cache nil)
10238 (message "Refile cache has been cleared"))
10240 (defun org-refile-cache-check-set (set)
10241 "Check if all the markers in the cache still have live buffers."
10242 (let (marker)
10243 (catch 'exit
10244 (while (and set (setq marker (nth 3 (pop set))))
10245 ;; if org-refile-use-outline-path is 'file, marker may be nil
10246 (when (and marker (null (marker-buffer marker)))
10247 (message "not found") (sit-for 3)
10248 (throw 'exit nil)))
10249 t)))
10251 (defun org-refile-cache-put (set &rest identifiers)
10252 "Push the refile targets SET into the cache, under IDENTIFIERS."
10253 (let* ((key (sha1 (prin1-to-string identifiers)))
10254 (entry (assoc key org-refile-cache)))
10255 (if entry
10256 (setcdr entry set)
10257 (push (cons key set) org-refile-cache))))
10259 (defun org-refile-cache-get (&rest identifiers)
10260 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10261 (cond
10262 ((not org-refile-cache) nil)
10263 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10264 (t
10265 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10266 org-refile-cache))))
10267 (and set (org-refile-cache-check-set set) set)))))
10269 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10270 "Produce a table with refile targets."
10271 (let ((case-fold-search nil)
10272 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10273 (entries (or org-refile-targets '((nil . (:level . 1)))))
10274 targets tgs txt re files f desc descre fast-path-p level pos0)
10275 (message "Getting targets...")
10276 (with-current-buffer (or default-buffer (current-buffer))
10277 (while (setq entry (pop entries))
10278 (setq files (car entry) desc (cdr entry))
10279 (setq fast-path-p nil)
10280 (cond
10281 ((null files) (setq files (list (current-buffer))))
10282 ((eq files 'org-agenda-files)
10283 (setq files (org-agenda-files 'unrestricted)))
10284 ((and (symbolp files) (fboundp files))
10285 (setq files (funcall files)))
10286 ((and (symbolp files) (boundp files))
10287 (setq files (symbol-value files))))
10288 (if (stringp files) (setq files (list files)))
10289 (cond
10290 ((eq (car desc) :tag)
10292 ((eq (car desc) :todo)
10294 ((eq (car desc) :regexp)
10295 (setq descre (cdr desc)))
10296 ((eq (car desc) :level)
10298 (if org-odd-levels-only
10299 (1- (* 2 (cdr desc)))
10300 (cdr desc)))
10302 ((eq (car desc) :maxlevel)
10303 (setq fast-path-p t)
10305 (if org-odd-levels-only
10306 (1- (* 2 (cdr desc)))
10307 (cdr desc)))
10309 (t (error "Bad refiling target description %s" desc)))
10310 (while (setq f (pop files))
10311 (with-current-buffer
10312 (if (bufferp f) f (org-get-agenda-file-buffer f))
10313 (or
10314 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10315 (progn
10316 (if (bufferp f) (setq f (buffer-file-name
10317 (buffer-base-buffer f))))
10318 (setq f (and f (expand-file-name f)))
10319 (if (eq org-refile-use-outline-path 'file)
10320 (push (list (file-name-nondirectory f) f nil nil) tgs))
10321 (save-excursion
10322 (save-restriction
10323 (widen)
10324 (goto-char (point-min))
10325 (while (re-search-forward descre nil t)
10326 (goto-char (setq pos0 (point-at-bol)))
10327 (catch 'next
10328 (when org-refile-target-verify-function
10329 (save-match-data
10330 (or (funcall org-refile-target-verify-function)
10331 (throw 'next t))))
10332 (when (and (looking-at org-complex-heading-regexp)
10333 (not (member (match-string 4) excluded-entries)))
10334 (setq level (org-reduced-level
10335 (- (match-end 1) (match-beginning 1)))
10336 txt (org-link-display-format (match-string 4))
10338 re (format org-complex-heading-regexp-format
10339 (regexp-quote (match-string 4))))
10340 (when org-refile-use-outline-path
10341 (setq txt (mapconcat
10342 'org-protect-slash
10343 (append
10344 (if (eq org-refile-use-outline-path
10345 'file)
10346 (list (file-name-nondirectory
10347 (buffer-file-name
10348 (buffer-base-buffer))))
10349 (if (eq org-refile-use-outline-path
10350 'full-file-path)
10351 (list (buffer-file-name
10352 (buffer-base-buffer)))))
10353 (org-get-outline-path fast-path-p
10354 level txt)
10355 (list txt))
10356 "/")))
10357 (push (list txt f re (org-refile-marker (point)))
10358 tgs)))
10359 (when (= (point) pos0)
10360 ;; verification function has not moved point
10361 (goto-char (point-at-eol))))))))
10362 (when org-refile-use-cache
10363 (org-refile-cache-put tgs (buffer-file-name) descre))
10364 (setq targets (append tgs targets))
10365 ))))
10366 (message "Getting targets...done")
10367 (nreverse targets)))
10369 (defun org-protect-slash (s)
10370 (while (string-match "/" s)
10372 s)
10374 (defvar org-olpa (make-vector 20 nil))
10376 (defun org-get-outline-path (&optional fastp level heading)
10377 "Return the outline path to the current entry, as a list.
10379 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10380 routine which makes outline path derivations for an entire file,
10381 avoiding backtracing. Refile target collection makes use of that."
10382 (if fastp
10383 (progn
10384 (if (> level 19)
10385 (error "Outline path failure, more than 19 levels"))
10386 (loop for i from level upto 19 do
10387 (aset org-olpa i nil))
10388 (prog1
10389 (delq nil (append org-olpa nil))
10390 (aset org-olpa level heading)))
10391 (let (rtn case-fold-search)
10392 (save-excursion
10393 (save-restriction
10394 (widen)
10395 (while (org-up-heading-safe)
10396 (when (looking-at org-complex-heading-regexp)
10397 (push (org-match-string-no-properties 4) rtn)))
10398 rtn)))))
10400 (defun org-format-outline-path (path &optional width prefix)
10401 "Format the outline path PATH for display.
10402 Width is the maximum number of characters that is available.
10403 Prefix is a prefix to be included in the returned string,
10404 such as the file name."
10405 (setq width (or width 79))
10406 (if prefix (setq width (- width (length prefix))))
10407 (if (not path)
10408 (or prefix "")
10409 (let* ((nsteps (length path))
10410 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10411 (maxwidth (if (<= total-width width)
10412 10000 ;; everything fits
10413 ;; we need to shorten the level headings
10414 (/ (- width nsteps) nsteps)))
10415 (org-odd-levels-only nil)
10416 (n 0)
10417 (total (1+ (length prefix))))
10418 (setq maxwidth (max maxwidth 10))
10419 (concat prefix
10420 (mapconcat
10421 (lambda (h)
10422 (setq n (1+ n))
10423 (if (and (= n nsteps) (< maxwidth 10000))
10424 (setq maxwidth (- total-width total)))
10425 (if (< (length h) maxwidth)
10426 (progn (setq total (+ total (length h) 1)) h)
10427 (setq h (substring h 0 (- maxwidth 2))
10428 total (+ total maxwidth 1))
10430 (setq h (substring h 0 (match-beginning 0))))
10431 (setq h (concat h "..")))
10432 (org-add-props h nil 'face
10433 (nth (% (1- n) org-n-level-faces)
10434 org-level-faces))
10435 h)
10436 path "/")))))
10438 (defun org-display-outline-path (&optional file current)
10439 "Display the current outline path in the echo area."
10440 (interactive "P")
10441 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10442 (case-fold-search nil)
10443 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10444 (if current (setq path (append path
10445 (save-excursion
10446 (org-back-to-heading t)
10447 (if (looking-at org-complex-heading-regexp)
10448 (list (match-string 4)))))))
10449 (message "%s"
10450 (org-format-outline-path
10451 path
10452 (1- (frame-width))
10453 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10455 (defvar org-refile-history nil
10456 "History for refiling operations.")
10458 (defvar org-after-refile-insert-hook nil
10459 "Hook run after `org-refile' has inserted its stuff at the new location.
10460 Note that this is still *before* the stuff will be removed from
10461 the *old* location.")
10463 (defvar org-capture-last-stored-marker)
10464 (defun org-refile (&optional goto default-buffer rfloc)
10465 "Move the entry or entries at point to another heading.
10466 The list of target headings is compiled using the information in
10467 `org-refile-targets', which see.
10469 At the target location, the entry is filed as a subitem of the target
10470 heading. Depending on `org-reverse-note-order', the new subitem will
10471 either be the first or the last subitem.
10473 If there is an active region, all entries in that region will be moved.
10474 However, the region must fulfill the requirement that the first heading
10475 is the first one sets the top-level of the moved text - at most siblings
10476 below it are allowed.
10478 With prefix arg GOTO, the command will only visit the target location
10479 and not actually move anything.
10482 go to the location where the last refiling operation has put the subtree.
10483 With a prefix argument of `2', refile to the running clock.
10485 RFLOC can be a refile location obtained in a different way.
10487 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10489 If you are using target caching (see `org-refile-use-cache'),
10490 You have to clear the target cache in order to find new targets.
10491 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10492 prefix argument (`C-u C-u C-u C-c C-w')."
10494 (interactive "P")
10495 (if (member goto '(0 (64)))
10496 (org-refile-cache-clear)
10497 (let* ((cbuf (current-buffer))
10498 (regionp (org-region-active-p))
10499 (region-start (and regionp (region-beginning)))
10500 (region-end (and regionp (region-end)))
10501 (region-length (and regionp (- region-end region-start)))
10502 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10503 pos it nbuf file re level reversed)
10504 (setq last-command nil)
10505 (when regionp
10506 (goto-char region-start)
10507 (or (bolp) (goto-char (point-at-bol)))
10508 (setq region-start (point))
10509 (unless (or (org-kill-is-subtree-p
10510 (buffer-substring region-start region-end))
10511 (prog1 org-refile-active-region-within-subtree
10512 (org-toggle-heading)))
10513 (error "The region is not a (sequence of) subtree(s)")))
10514 (if (equal goto '(16))
10515 (org-refile-goto-last-stored)
10516 (when (or
10517 (and (equal goto 2)
10518 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10519 (prog1
10520 (setq it (list (or org-clock-heading "running clock")
10521 (buffer-file-name
10522 (marker-buffer org-clock-hd-marker))
10523 ""
10524 (marker-position org-clock-hd-marker)))
10525 (setq goto nil)))
10526 (setq it (or rfloc
10527 (let (heading-text)
10528 (save-excursion
10529 (unless goto
10530 (org-back-to-heading t)
10531 (setq heading-text
10532 (nth 4 (org-heading-components))))
10533 (org-refile-get-location
10534 (cond (goto "Goto")
10535 (regionp "Refile region to")
10538 default-buffer
10539 org-refile-allow-creating-parent-nodes
10540 goto))))))
10541 (setq file (nth 1 it)
10542 re (nth 2 it)
10543 pos (nth 3 it))
10544 (if (and (not goto)
10545 pos
10546 (equal (buffer-file-name) file)
10547 (if regionp
10548 (and (>= pos region-start)
10549 (<= pos region-end))
10550 (and (>= pos (point))
10551 (< pos (save-excursion
10552 (org-end-of-subtree t t))))))
10553 (error "Cannot refile to position inside the tree or region"))
10555 (setq nbuf (or (find-buffer-visiting file)
10556 (find-file-noselect file)))
10557 (if goto
10558 (progn
10559 (org-pop-to-buffer-same-window nbuf)
10560 (goto-char pos)
10561 (org-show-context 'org-goto))
10562 (if regionp
10563 (progn
10564 (org-kill-new (buffer-substring region-start region-end))
10565 (org-save-markers-in-region region-start region-end))
10566 (org-copy-subtree 1 nil t))
10567 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10568 (find-file-noselect file)))
10569 (setq reversed (org-notes-order-reversed-p))
10570 (save-excursion
10571 (save-restriction
10572 (widen)
10573 (if pos
10574 (progn
10575 (goto-char pos)
10576 (looking-at org-outline-regexp)
10577 (setq level (org-get-valid-level (funcall outline-level) 1))
10578 (goto-char
10579 (if reversed
10580 (or (outline-next-heading) (point-max))
10581 (or (save-excursion (org-get-next-sibling))
10582 (org-end-of-subtree t t)
10583 (point-max)))))
10584 (setq level 1)
10585 (if (not reversed)
10586 (goto-char (point-max))
10587 (goto-char (point-min))
10588 (or (outline-next-heading) (goto-char (point-max)))))
10589 (if (not (bolp)) (newline))
10590 (org-paste-subtree level)
10591 (when org-log-refile
10592 (org-add-log-setup 'refile nil nil 'findpos
10593 org-log-refile)
10594 (unless (eq org-log-refile 'note)
10595 (save-excursion (org-add-log-note))))
10596 (and org-auto-align-tags (org-set-tags nil t))
10597 (bookmark-set "org-refile-last-stored")
10598 ;; If we are refiling for capture, make sure that the
10599 ;; last-capture pointers point here
10600 (when (org-bound-and-true-p org-refile-for-capture)
10601 (bookmark-set "org-capture-last-stored-marker")
10602 (move-marker org-capture-last-stored-marker (point)))
10603 (if (fboundp 'deactivate-mark) (deactivate-mark))
10604 (run-hooks 'org-after-refile-insert-hook))))
10605 (if regionp
10606 (delete-region (point) (+ (point) region-length))
10607 (org-cut-subtree))
10608 (when (featurep 'org-inlinetask)
10609 (org-inlinetask-remove-END-maybe))
10610 (setq org-markers-to-move nil)
10613 (defun org-refile-goto-last-stored ()
10614 "Go to the location where the last refile was stored."
10615 (interactive)
10616 (bookmark-jump "org-refile-last-stored")
10617 (message "This is the location of the last refile"))
10619 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10620 no-exclude)
10621 "Prompt the user for a refile location, using PROMPT.
10622 PROMPT should not be suffixed with a colon and a space, because
10623 this function appends the default value from
10624 `org-refile-history' automatically, if that is not empty.
10625 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10626 this is used for the GOTO interface."
10627 (let ((org-refile-targets org-refile-targets)
10628 (org-refile-use-outline-path org-refile-use-outline-path)
10629 excluded-entries)
10630 (when (and (eq major-mode 'org-mode)
10631 (not org-refile-use-cache)
10632 (not no-exclude))
10633 (org-map-tree
10634 (lambda()
10635 (setq excluded-entries
10636 (append excluded-entries (list (org-get-heading t t)))))))
10637 (setq org-refile-target-table
10638 (org-refile-get-targets default-buffer excluded-entries)))
10639 (unless org-refile-target-table
10640 (error "No refile targets"))
10641 (let* ((prompt (concat prompt
10642 (and (car org-refile-history)
10643 (concat " (default " (car org-refile-history) ")"))
10644 ": "))
10645 (cbuf (current-buffer))
10646 (partial-completion-mode nil)
10647 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10648 (cfunc (if (and org-refile-use-outline-path
10649 org-outline-path-complete-in-steps)
10650 'org-olpath-completing-read
10651 'org-icompleting-read))
10652 (extra (if org-refile-use-outline-path "/" ""))
10653 (filename (and cfn (expand-file-name cfn)))
10654 (tbl (mapcar
10655 (lambda (x)
10656 (if (and (not (member org-refile-use-outline-path
10657 '(file full-file-path)))
10658 (not (equal filename (nth 1 x))))
10659 (cons (concat (car x) extra " ("
10660 (file-name-nondirectory (nth 1 x)) ")")
10661 (cdr x))
10662 (cons (concat (car x) extra) (cdr x))))
10663 org-refile-target-table))
10664 (completion-ignore-case t)
10665 pa answ parent-target child parent old-hist)
10666 (setq old-hist org-refile-history)
10667 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10668 nil 'org-refile-history (car org-refile-history)))
10669 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10670 (org-refile-check-position pa)
10671 (if pa
10672 (progn
10673 (when (or (not org-refile-history)
10674 (not (eq old-hist org-refile-history))
10675 (not (equal (car pa) (car org-refile-history))))
10676 (setq org-refile-history
10677 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10678 org-refile-history
10679 (cdr org-refile-history))))
10680 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10681 (pop org-refile-history)))
10682 pa)
10684 (progn
10685 (setq parent (match-string 1 answ)
10686 child (match-string 2 answ))
10687 (setq parent-target (or (assoc parent tbl)
10688 (assoc (concat parent "/") tbl)))
10689 (when (and parent-target
10690 (or (eq new-nodes t)
10691 (and (eq new-nodes 'confirm)
10693 child)))))
10694 (org-refile-new-child parent-target child)))
10695 (error "Invalid target location")))))
10697 (defun org-refile-check-position (refile-pointer)
10698 "Check if the refile pointer matches the readline to which it points."
10699 (let* ((file (nth 1 refile-pointer))
10700 (re (nth 2 refile-pointer))
10701 (pos (nth 3 refile-pointer))
10702 buffer)
10703 (when (org-string-nw-p re)
10704 (setq buffer (if (markerp pos)
10705 (marker-buffer pos)
10706 (or (find-buffer-visiting file)
10707 (find-file-noselect file))))
10708 (with-current-buffer buffer
10709 (save-excursion
10710 (save-restriction
10711 (widen)
10712 (goto-char pos)
10713 (beginning-of-line 1)
10714 (unless (org-looking-at-p re)
10715 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10717 (defun org-refile-new-child (parent-target child)
10718 "Use refile target PARENT-TARGET to add new CHILD below it."
10719 (unless parent-target
10720 (error "Cannot find parent for new node"))
10721 (let ((file (nth 1 parent-target))
10722 (pos (nth 3 parent-target))
10723 level)
10724 (with-current-buffer (or (find-buffer-visiting file)
10725 (find-file-noselect file))
10726 (save-excursion
10727 (save-restriction
10728 (widen)
10729 (if pos
10730 (goto-char pos)
10731 (goto-char (point-max))
10732 (if (not (bolp)) (newline)))
10733 (when (looking-at org-outline-regexp)
10734 (setq level (funcall outline-level))
10735 (org-end-of-subtree t t))
10736 (org-back-over-empty-lines)
10738 (if pos (org-get-valid-level level 1) 1) ?*)
10740 (beginning-of-line 0)
10741 (list (concat (car parent-target) "/" child) file "" (point)))))))
10743 (defun org-olpath-completing-read (prompt collection &rest args)
10744 "Read an outline path like a file name."
10745 (let ((thetable collection)
10746 (org-completion-use-ido nil) ; does not work with ido.
10747 (org-completion-use-iswitchb nil)) ; or iswitchb
10748 (apply
10749 'org-icompleting-read prompt
10750 (lambda (string predicate &optional flag)
10751 (let (rtn r f (l (length string)))
10752 (cond
10753 ((eq flag nil)
10754 ;; try completion
10755 (try-completion string thetable))
10756 ((eq flag t)
10757 ;; all-completions
10758 (setq rtn (all-completions string thetable predicate))
10759 (mapcar
10760 (lambda (x)
10761 (setq r (substring x l))
10762 (if (string-match " ([^)]*)$" x)
10763 (setq f (match-string 0 x))
10764 (setq f ""))
10765 (if (string-match "/" r)
10766 (concat string (substring r 0 (match-end 0)) f)
10767 x))
10768 rtn))
10769 ((eq flag 'lambda)
10770 ;; exact match?
10771 (assoc string thetable)))
10772 ))
10773 args)))
10775 ;;;; Dynamic blocks
10777 (defun org-find-dblock (name)
10778 "Find the first dynamic block with name NAME in the buffer.
10779 If not found, stay at current position and return nil."
10780 (let (pos)
10781 (save-excursion
10782 (goto-char (point-min))
10784 nil t)
10785 (match-beginning 0))))
10786 (if pos (goto-char pos))
10787 pos))
10789 (defconst org-dblock-start-re
10791 "Matches the start line of a dynamic block, with parameters.")
10794 "Matches the end of a dynamic block.")
10796 (defun org-create-dblock (plist)
10797 "Create a dynamic block section, with parameters taken from PLIST.
10798 PLIST must contain a :name entry which is used as name of the block."
10800 (end-of-line 1)
10801 (newline))
10802 (let ((col (current-column))
10803 (name (plist-get plist :name)))
10804 (insert "#+BEGIN: " name)
10805 (while plist
10806 (if (eq (car plist) :name)
10807 (setq plist (cddr plist))
10808 (insert " " (prin1-to-string (pop plist)))))
10810 (beginning-of-line -2)))
10812 (defun org-prepare-dblock ()
10813 "Prepare dynamic block for refresh.
10814 This empties the block, puts the cursor at the insert position and returns
10815 the property list including an extra property :name with the block name."
10816 (unless (looking-at org-dblock-start-re)
10817 (error "Not at a dynamic block"))
10818 (let* ((begdel (1+ (match-end 0)))
10819 (name (org-no-properties (match-string 1)))
10820 (params (append (list :name name)
10821 (read (concat "(" (match-string 3) ")")))))
10822 (save-excursion
10823 (beginning-of-line 1)
10825 (setq params (plist-put params :indentation-column (current-column))))
10826 (unless (re-search-forward org-dblock-end-re nil t)
10827 (error "Dynamic block not terminated"))
10828 (setq params
10829 (append params
10830 (list :content (buffer-substring
10831 begdel (match-beginning 0)))))
10832 (delete-region begdel (match-beginning 0))
10833 (goto-char begdel)
10834 (open-line 1)
10835 params))
10837 (defun org-map-dblocks (&optional command)
10838 "Apply COMMAND to all dynamic blocks in the current buffer.
10839 If COMMAND is not given, use `org-update-dblock'."
10840 (let ((cmd (or command 'org-update-dblock)))
10841 (save-excursion
10842 (goto-char (point-min))
10843 (while (re-search-forward org-dblock-start-re nil t)
10844 (goto-char (match-beginning 0))
10845 (save-excursion
10846 (condition-case nil
10847 (funcall cmd)
10848 (error (message "Error during update of dynamic block"))))
10849 (unless (re-search-forward org-dblock-end-re nil t)
10850 (error "Dynamic block not terminated"))))))
10852 (defun org-dblock-update (&optional arg)
10853 "User command for updating dynamic blocks.
10854 Update the dynamic block at point. With prefix ARG, update all dynamic
10855 blocks in the buffer."
10856 (interactive "P")
10857 (if arg
10858 (org-update-all-dblocks)
10859 (or (looking-at org-dblock-start-re)
10860 (org-beginning-of-dblock))
10861 (org-update-dblock)))
10863 (defun org-update-dblock ()
10864 "Update the dynamic block at point.
10865 This means to empty the block, parse for parameters and then call
10866 the correct writing function."
10867 (interactive)
10868 (save-window-excursion
10869 (let* ((pos (point))
10870 (line (org-current-line))
10871 (params (org-prepare-dblock))
10872 (name (plist-get params :name))
10873 (indent (plist-get params :indentation-column))
10874 (cmd (intern (concat "org-dblock-write:" name))))
10875 (message "Updating dynamic block `%s' at line %d..." name line)
10876 (funcall cmd params)
10877 (message "Updating dynamic block `%s' at line %d...done" name line)
10878 (goto-char pos)
10879 (when (and indent (> indent 0))
10880 (setq indent (make-string indent ?\ ))
10881 (save-excursion
10882 (org-beginning-of-dblock)
10883 (forward-line 1)
10884 (while (not (looking-at org-dblock-end-re))
10885 (insert indent)
10886 (beginning-of-line 2))
10887 (when (looking-at org-dblock-end-re)
10889 (replace-match ""))
10890 (insert indent)))))))
10892 (defun org-beginning-of-dblock ()
10893 "Find the beginning of the dynamic block at point.
10894 Error if there is no such block at point."
10895 (let ((pos (point))
10896 beg)
10897 (end-of-line 1)
10898 (if (and (re-search-backward org-dblock-start-re nil t)
10899 (setq beg (match-beginning 0))
10900 (re-search-forward org-dblock-end-re nil t)
10901 (> (match-end 0) pos))
10902 (goto-char beg)
10903 (goto-char pos)
10904 (error "Not in a dynamic block"))))
10906 (defun org-update-all-dblocks ()
10907 "Update all dynamic blocks in the buffer.
10908 This function can be used in a hook."
10909 (interactive)
10910 (when (eq major-mode 'org-mode)
10911 (org-map-dblocks 'org-update-dblock)))
10914 ;;;; Completion
10916 (defconst org-additional-option-like-keywords
10917 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10918 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10919 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10920 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10921 "BEGIN:" "END:"
10922 "ORGTBL" "TBLFM:" "TBLNAME:"
10923 "BEGIN_EXAMPLE" "END_EXAMPLE"
10924 "BEGIN_QUOTE" "END_QUOTE"
10925 "BEGIN_VERSE" "END_VERSE"
10926 "BEGIN_CENTER" "END_CENTER"
10927 "BEGIN_SRC" "END_SRC"
10928 "BEGIN_RESULT" "END_RESULT"
10929 "SOURCE:" "SRCNAME:" "FUNCTION:"
10930 "RESULTS:" "DATA:"
10931 "HEADER:" "HEADERS:"
10932 "BABEL:"
10933 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10934 "CAPTION:" "LABEL:"
10935 "SETUPFILE:"
10936 "INCLUDE:"
10937 "BIND:"
10938 "MACRO:"))
10940 (defcustom org-structure-template-alist
10941 '(
10954 ("L" "#+latex: "
10958 ("H" "#+html: "
10961 ("A" "#+ascii: ")
10962 ("i" "#+index: ?"
10963 "#+index: ?")
10964 ("I" "#+include %file ?"
10966 )
10967 "Structure completion elements.
10968 This is a list of abbreviation keys and values. The value gets inserted
10969 if you type `<' followed by the key and then press the completion key,
10970 usually `M-TAB'. %file will be replaced by a file name after prompting
10971 for the file using completion. The cursor will be placed at the position
10972 of the `?` in the template.
10973 There are two templates for each key, the first uses the original Org syntax,
10974 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10975 the default when the /org-mtags.el/ module has been loaded. See also the
10976 variable `org-mtags-prefer-muse-templates'.
10977 This is an experimental feature, it is undecided if it is going to stay in."
10978 :group 'org-completion
10979 :type '(repeat
10980 (string :tag "Key")
10981 (string :tag "Template")
10982 (string :tag "Muse Template")))
10984 (defun org-try-structure-completion ()
10985 "Try to complete a structure template before point.
10987 expands them."
10988 (let ((l (buffer-substring (point-at-bol) (point)))
10989 a)
10992 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10993 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10994 (match-beginning 1)) a)
10995 t)))
10997 (defun org-complete-expand-structure-template (start cell)
10998 "Expand a structure template."
10999 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11000 (rpl (nth (if musep 2 1) cell))
11001 (ind ""))
11002 (delete-region start (point))
11004 (cond
11005 ((bolp))
11007 (setq ind (buffer-substring (point-at-bol) (point))))
11008 (t (newline))))
11009 (setq start (point))
11010 (if (string-match "%file" rpl)
11011 (setq rpl (replace-match
11012 (concat
11014 (save-match-data
11015 (abbreviate-file-name (read-file-name "Include file: ")))
11017 t t rpl)))
11020 (insert rpl)
11023 ;;;; TODO, DEADLINE, Comments
11025 (defun org-toggle-comment ()
11026 "Change the COMMENT state of an entry."
11027 (interactive)
11028 (save-excursion
11029 (org-back-to-heading)
11030 (let (case-fold-search)
11031 (if (looking-at (concat org-outline-regexp
11033 (replace-match "" t t nil 1)
11034 (if (looking-at org-outline-regexp)
11035 (progn
11036 (goto-char (match-end 0))
11037 (insert org-comment-string " ")))))))
11039 (defvar org-last-todo-state-is-todo nil
11040 "This is non-nil when the last TODO state change led to a TODO state.
11041 If the last change removed the TODO tag or switched to DONE, then
11042 this is nil.")
11044 (defvar org-setting-tags nil) ; dynamically skipped
11046 (defvar org-todo-setup-filter-hook nil
11047 "Hook for functions that pre-filter todo specs.
11048 Each function takes a todo spec and returns either nil or the spec
11049 transformed into canonical form." )
11051 (defvar org-todo-get-default-hook nil
11052 "Hook for functions that get a default item for todo.
11053 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11054 nil or a string to be used for the todo mark." )
11056 (defvar org-agenda-headline-snapshot-before-repeat)
11058 (defun org-current-effective-time ()
11059 "Return current time adjusted for `org-extend-today-until' variable"
11060 (let* ((ct (org-current-time))
11061 (dct (decode-time ct))
11062 (ct1
11063 (if (and org-use-effective-time
11064 (< (nth 2 dct) org-extend-today-until))
11065 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11066 ct)))
11067 ct1))
11069 (defun org-todo-yesterday (&optional arg)
11070 "Like `org-todo' but the time of change will be 23:59 of yesterday"
11071 (interactive "P")
11072 (let* ((hour (third (decode-time
11073 (org-current-time))))
11074 (org-extend-today-until (1+ hour)))
11075 (org-todo arg)))
11077 (defun org-todo (&optional arg)
11078 "Change the TODO state of an item.
11079 The state of an item is given by a keyword at the start of the heading,
11080 like
11081 *** TODO Write paper
11082 *** DONE Call mom
11084 The different keywords are specified in the variable `org-todo-keywords'.
11086 So for this example: when the item starts with TODO, it is changed to DONE.
11087 When it starts with DONE, the DONE is removed. And when neither TODO nor
11088 DONE are present, add TODO at the beginning of the heading.
11091 state.
11092 With numeric prefix arg, switch to that state.
11094 keywords (nextset).
11097 For calling through lisp, arg is also interpreted in the following way:
11098 'none -> empty state
11100 'done -> switch to DONE
11101 'nextset -> switch to the next set of keywords
11102 'previousset -> switch to the previous set of keywords
11104 really is a member of `org-todo-keywords'."
11105 (interactive "P")
11106 (if (equal arg '(16)) (setq arg 'nextset))
11107 (let ((org-blocker-hook org-blocker-hook)
11108 (case-fold-search nil))
11109 (when (equal arg '(64))
11110 (setq arg nil org-blocker-hook nil))
11111 (when (and org-blocker-hook
11112 (or org-inhibit-blocking
11113 (org-entry-get nil "NOBLOCKING")))
11114 (setq org-blocker-hook nil))
11115 (save-excursion
11116 (catch 'exit
11117 (org-back-to-heading t)
11118 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11120 (looking-at " *"))
11121 (let* ((match-data (match-data))
11122 (startpos (point-at-bol))
11123 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11124 (org-log-done org-log-done)
11125 (org-log-repeat org-log-repeat)
11126 (org-todo-log-states org-todo-log-states)
11127 (this (match-string 1))
11128 (hl-pos (match-beginning 0))
11129 (head (org-get-todo-sequence-head this))
11130 (ass (assoc head org-todo-kwd-alist))
11131 (interpret (nth 1 ass))
11132 (done-word (nth 3 ass))
11133 (final-done-word (nth 4 ass))
11134 (last-state (or this ""))
11135 (completion-ignore-case t)
11136 (member (member this org-todo-keywords-1))
11137 (tail (cdr member))
11138 (state (cond
11139 ((and org-todo-key-trigger
11140 (or (and (equal arg '(4))
11141 (eq org-use-fast-todo-selection 'prefix))
11142 (and (not arg) org-use-fast-todo-selection
11143 (not (eq org-use-fast-todo-selection
11144 'prefix)))))
11145 ;; Use fast selection
11146 (org-fast-todo-selection))
11147 ((and (equal arg '(4))
11148 (or (not org-use-fast-todo-selection)
11149 (not org-todo-key-trigger)))
11150 ;; Read a state with completion
11151 (org-icompleting-read
11152 "State: " (mapcar (lambda(x) (list x))
11153 org-todo-keywords-1)
11154 nil t))
11155 ((eq arg 'right)
11156 (if this
11157 (if tail (car tail) nil)
11158 (car org-todo-keywords-1)))
11159 ((eq arg 'left)
11160 (if (equal member org-todo-keywords-1)
11161 nil
11162 (if this
11163 (nth (- (length org-todo-keywords-1)
11164 (length tail) 2)
11165 org-todo-keywords-1)
11166 (org-last org-todo-keywords-1))))
11167 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11168 (setq arg nil))) ; hack to fall back to cycling
11169 (arg
11170 ;; user or caller requests a specific state
11171 (cond
11172 ((equal arg "") nil)
11173 ((eq arg 'none) nil)
11174 ((eq arg 'done) (or done-word (car org-done-keywords)))
11175 ((eq arg 'nextset)
11176 (or (car (cdr (member head org-todo-heads)))
11177 (car org-todo-heads)))
11178 ((eq arg 'previousset)
11179 (let ((org-todo-heads (reverse org-todo-heads)))
11180 (or (car (cdr (member head org-todo-heads)))
11181 (car org-todo-heads))))
11182 ((car (member arg org-todo-keywords-1)))
11183 ((stringp arg)
11184 (error "State `%s' not valid in this file" arg))
11185 ((nth (1- (prefix-numeric-value arg))
11186 org-todo-keywords-1))))
11187 ((null member) (or head (car org-todo-keywords-1)))
11188 ((equal this final-done-word) nil) ;; -> make empty
11189 ((null tail) nil) ;; -> first entry
11190 ((memq interpret '(type priority))
11191 (if (eq this-command last-command)
11192 (car tail)
11193 (if (> (length tail) 0)
11194 (or done-word (car org-done-keywords))
11195 nil)))
11196 (t
11197 (car tail))))
11198 (state (or
11199 (run-hook-with-args-until-success
11200 'org-todo-get-default-hook state last-state)
11201 state))
11202 (next (if state (concat " " state " ") " "))
11203 (change-plist (list :type 'todo-state-change :from this :to state
11204 :position startpos))
11205 dolog now-done-p)
11206 (when org-blocker-hook
11207 (setq org-last-todo-state-is-todo
11208 (not (member this org-done-keywords)))
11209 (unless (save-excursion
11210 (save-match-data
11211 (org-with-wide-buffer
11212 (run-hook-with-args-until-failure
11213 'org-blocker-hook change-plist))))
11214 (if (org-called-interactively-p 'interactive)
11215 (error "TODO state change from %s to %s blocked" this state)
11216 ;; fail silently
11217 (message "TODO state change from %s to %s blocked" this state)
11218 (throw 'exit nil))))
11219 (store-match-data match-data)
11220 (replace-match next t t)
11221 (unless (pos-visible-in-window-p hl-pos)
11222 (message "TODO state changed to %s" (org-trim next)))
11223 (unless head
11224 (setq head (org-get-todo-sequence-head state)
11225 ass (assoc head org-todo-kwd-alist)
11226 interpret (nth 1 ass)
11227 done-word (nth 3 ass)
11228 final-done-word (nth 4 ass)))
11229 (when (memq arg '(nextset previousset))
11230 (message "Keyword-Set %d/%d: %s"
11231 (- (length org-todo-sets) -1
11232 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11233 (length org-todo-sets)
11234 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11235 (setq org-last-todo-state-is-todo
11236 (not (member state org-done-keywords)))
11237 (setq now-done-p (and (member state org-done-keywords)
11238 (not (member this org-done-keywords))))
11239 (and logging (org-local-logging logging))
11240 (when (and (or org-todo-log-states org-log-done)
11241 (not (eq org-inhibit-logging t))
11242 (not (memq arg '(nextset previousset))))
11243 ;; we need to look at recording a time and note
11244 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11245 (nth 2 (assoc this org-todo-log-states))))
11246 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11247 (setq dolog 'time))
11248 (when (and state
11249 (member state org-not-done-keywords)
11250 (not (member this org-not-done-keywords)))
11251 ;; This is now a todo state and was not one before
11252 ;; If there was a CLOSED time stamp, get rid of it.
11253 (org-add-planning-info nil nil 'closed))
11254 (when (and now-done-p org-log-done)
11255 ;; It is now done, and it was not done before
11256 (org-add-planning-info 'closed (org-current-effective-time))
11257 (if (and (not dolog) (eq 'note org-log-done))
11258 (org-add-log-setup 'done state this 'findpos 'note)))
11259 (when (and state dolog)
11260 ;; This is a non-nil state, and we need to log it
11261 (org-add-log-setup 'state state this 'findpos dolog)))
11262 ;; Fixup tag positioning
11263 (org-todo-trigger-tag-changes state)
11264 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11265 (when org-provide-todo-statistics
11266 (org-update-parent-todo-statistics))
11267 (run-hooks 'org-after-todo-state-change-hook)
11268 (if (and arg (not (member state org-done-keywords)))
11269 (setq head (org-get-todo-sequence-head state)))
11270 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11271 ;; Do we need to trigger a repeat?
11272 (when now-done-p
11273 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11274 ;; This is for the agenda, take a snapshot of the headline.
11275 (save-match-data
11276 (setq org-agenda-headline-snapshot-before-repeat
11277 (org-get-heading))))
11278 (org-auto-repeat-maybe state))
11279 ;; Fixup cursor location if close to the keyword
11280 (if (and (outline-on-heading-p)
11281 (not (bolp))
11282 (save-excursion (beginning-of-line 1)
11283 (looking-at org-todo-line-regexp))
11284 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11285 (progn
11286 (goto-char (or (match-end 2) (match-end 1)))
11287 (and (looking-at " ") (just-one-space))))
11288 (when org-trigger-hook
11289 (save-excursion
11290 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11292 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11293 "Block turning an entry into a TODO, using the hierarchy.
11294 This checks whether the current task should be blocked from state
11295 changes. Such blocking occurs when:
11297 1. The task has children which are not all in a completed state.
11299 2. A task has a parent with the property :ORDERED:, and there
11300 are siblings prior to the current task with incomplete
11301 status.
11303 3. The parent of the task is blocked because it has siblings that should
11304 be done first, or is child of a block grandparent TODO entry."
11306 (if (not org-enforce-todo-dependencies)
11307 t ; if locally turned off don't block
11308 (catch 'dont-block
11309 ;; If this is not a todo state change, or if this entry is already DONE,
11310 ;; do not block
11311 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11312 (member (plist-get change-plist :from)
11313 (cons 'done org-done-keywords))
11314 (member (plist-get change-plist :to)
11315 (cons 'todo org-not-done-keywords))
11316 (not (plist-get change-plist :to)))
11317 (throw 'dont-block t))
11318 ;; If this task has children, and any are undone, it's blocked
11319 (save-excursion
11320 (org-back-to-heading t)
11321 (let ((this-level (funcall outline-level)))
11322 (outline-next-heading)
11323 (let ((child-level (funcall outline-level)))
11324 (while (and (not (eobp))
11325 (> child-level this-level))
11326 ;; this todo has children, check whether they are all
11327 ;; completed
11328 (if (and (not (org-entry-is-done-p))
11329 (org-entry-is-todo-p))
11330 (throw 'dont-block nil))
11331 (outline-next-heading)
11332 (setq child-level (funcall outline-level))))))
11333 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11334 ;; any previous siblings are undone, it's blocked
11335 (save-excursion
11336 (org-back-to-heading t)
11337 (let* ((pos (point))
11338 (parent-pos (and (org-up-heading-safe) (point))))
11339 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11340 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11341 (forward-line 1)
11342 (re-search-forward org-not-done-heading-regexp pos t))
11343 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11344 ;; Search further up the hierarchy, to see if an anchestor is blocked
11345 (while t
11346 (goto-char parent-pos)
11347 (if (not (looking-at org-not-done-heading-regexp))
11348 (throw 'dont-block t)) ; do not block, parent is not a TODO
11349 (setq pos (point))
11350 (setq parent-pos (and (org-up-heading-safe) (point)))
11351 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11352 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11353 (forward-line 1)
11354 (re-search-forward org-not-done-heading-regexp pos t))
11355 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11357 (defcustom org-track-ordered-property-with-tag nil
11358 "Should the ORDERED property also be shown as a tag?
11359 The ORDERED property decides if an entry should require subtasks to be
11360 completed in sequence. Since a property is not very visible, setting
11361 this option means that toggling the ORDERED property with the command
11362 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11363 not relevant for the behavior, but it makes things more visible.
11365 Note that toggling the tag with tags commands will not change the property
11366 and therefore not influence behavior!
11368 This can be t, meaning the tag ORDERED should be used, It can also be a
11369 string to select a different tag for this task."
11370 :group 'org-todo
11371 :type '(choice
11372 (const :tag "No tracking" nil)
11373 (const :tag "Track with ORDERED tag" t)
11374 (string :tag "Use other tag")))
11376 (defun org-toggle-ordered-property ()
11377 "Toggle the ORDERED property of the current entry.
11378 For better visibility, you can track the value of this property with a tag.
11379 See variable `org-track-ordered-property-with-tag'."
11380 (interactive)
11381 (let* ((t1 org-track-ordered-property-with-tag)
11382 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11383 (save-excursion
11384 (org-back-to-heading)
11385 (if (org-entry-get nil "ORDERED")
11386 (progn
11387 (org-delete-property "ORDERED")
11388 (and tag (org-toggle-tag tag 'off))
11389 (message "Subtasks can be completed in arbitrary order"))
11390 (org-entry-put nil "ORDERED" "t")
11391 (and tag (org-toggle-tag tag 'on))
11392 (message "Subtasks must be completed in sequence")))))
11394 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11395 (defun org-block-todo-from-checkboxes (change-plist)
11396 "Block turning an entry into a TODO, using checkboxes.
11397 This checks whether the current task should be blocked from state
11398 changes because there are unchecked boxes in this entry."
11399 (if (not org-enforce-todo-checkbox-dependencies)
11400 t ; if locally turned off don't block
11401 (catch 'dont-block
11402 ;; If this is not a todo state change, or if this entry is already DONE,
11403 ;; do not block
11404 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11405 (member (plist-get change-plist :from)
11406 (cons 'done org-done-keywords))
11407 (member (plist-get change-plist :to)
11408 (cons 'todo org-not-done-keywords))
11409 (not (plist-get change-plist :to)))
11410 (throw 'dont-block t))
11411 ;; If this task has checkboxes that are not checked, it's blocked
11412 (save-excursion
11413 (org-back-to-heading t)
11414 (let ((beg (point)) end)
11415 (outline-next-heading)
11416 (setq end (point))
11417 (goto-char beg)
11418 (if (org-list-search-forward
11419 (concat (org-item-beginning-re)
11422 end t)
11423 (progn
11424 (if (boundp 'org-blocked-by-checkboxes)
11425 (setq org-blocked-by-checkboxes t))
11426 (throw 'dont-block nil)))))
11427 t))) ; do not block
11429 (defun org-entry-blocked-p ()
11430 "Is the current entry blocked?"
11431 (if (org-entry-get nil "NOBLOCKING")
11432 nil ;; Never block this entry
11433 (not
11434 (run-hook-with-args-until-failure
11435 'org-blocker-hook
11436 (list :type 'todo-state-change
11437 :position (point)
11438 :from 'todo
11439 :to 'done)))))
11441 (defun org-update-statistics-cookies (all)
11442 "Update the statistics cookie, either from TODO or from checkboxes.
11443 This should be called with the cursor in a line with a statistics cookie."
11444 (interactive "P")
11445 (if all
11446 (progn
11447 (org-update-checkbox-count 'all)
11448 (org-map-entries 'org-update-parent-todo-statistics))
11449 (if (not (org-on-heading-p))
11450 (org-update-checkbox-count)
11451 (let ((pos (move-marker (make-marker) (point)))
11452 end l1 l2)
11453 (ignore-errors (org-back-to-heading t))
11454 (if (not (org-on-heading-p))
11455 (org-update-checkbox-count)
11456 (setq l1 (org-outline-level))
11457 (setq end (save-excursion
11458 (outline-next-heading)
11459 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11460 (point)))
11461 (if (and (save-excursion
11462 (re-search-forward
11464 (not (save-excursion (re-search-forward
11466 (org-update-checkbox-count)
11467 (if (and l2 (> l2 l1))
11468 (progn
11469 (goto-char end)
11470 (org-update-parent-todo-statistics))
11471 (goto-char pos)
11472 (beginning-of-line 1)
11473 (while (re-search-forward
11475 (point-at-eol) t)
11476 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11477 (goto-char pos)
11478 (move-marker pos nil)))))
11480 (defvar org-entry-property-inherited-from) ;; defined below
11481 (defun org-update-parent-todo-statistics ()
11482 "Update any statistics cookie in the parent of the current headline.
11483 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11484 the entire subtree and this will travel up the hierarchy and update
11485 statistics everywhere."
11486 (let* ((prop (save-excursion (org-up-heading-safe)
11487 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11488 (recursive (or (not org-hierarchical-todo-statistics)
11490 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11491 0))
11492 (first t)
11494 level ltoggle l1 new ndel
11495 (cnt-all 0) (cnt-done 0) is-percent kwd
11496 checkbox-beg ov ovs ove cookie-present)
11497 (catch 'exit
11498 (save-excursion
11499 (beginning-of-line 1)
11500 (setq ltoggle (funcall outline-level))
11501 ;; Three situations are to consider:
11503 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11504 ;; to the top-level ancestor on the headline;
11506 ;; 2. If parent has "recursive" property, repeat up to the
11507 ;; headline setting that property, taking inheritance into
11508 ;; account;
11510 ;; 3. Else, move up to direct parent and proceed only once.
11511 (while (and (setq level (org-up-heading-safe))
11512 (or recursive first)
11513 (>= (point) lim))
11514 (setq first nil cookie-present nil)
11515 (unless (and level
11516 (not (string-match
11518 (downcase (or (org-entry-get nil "COOKIE_DATA")
11519 "")))))
11520 (throw 'exit nil))
11521 (while (re-search-forward box-re (point-at-eol) t)
11522 (setq cnt-all 0 cnt-done 0 cookie-present t)
11523 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11524 (save-match-data
11525 (unless (outline-next-heading) (throw 'exit nil))
11526 (while (and (looking-at org-complex-heading-regexp)
11527 (> (setq l1 (length (match-string 1))) level))
11528 (setq kwd (and (or recursive (= l1 ltoggle))
11529 (match-string 2)))
11530 (if (or (eq org-provide-todo-statistics 'all-headlines)
11531 (and (listp org-provide-todo-statistics)
11532 (or (member kwd org-provide-todo-statistics)
11533 (member kwd org-done-keywords))))
11534 (setq cnt-all (1+ cnt-all))
11535 (if (eq org-provide-todo-statistics t)
11536 (and kwd (setq cnt-all (1+ cnt-all)))))
11537 (and (member kwd org-done-keywords)
11538 (setq cnt-done (1+ cnt-done)))
11539 (outline-next-heading)))
11540 (setq new
11541 (if is-percent
11542 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11543 (format "[%d/%d]" cnt-done cnt-all))
11544 ndel (- (match-end 0) checkbox-beg))
11545 ;; handle overlays when updating cookie from column view
11546 (when (setq ov (car (overlays-at checkbox-beg)))
11547 (setq ovs (overlay-start ov) ove (overlay-end ov))
11548 (delete-overlay ov))
11549 (goto-char checkbox-beg)
11550 (insert new)
11551 (delete-region (point) (+ (point) ndel))
11552 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11553 (when ov (move-overlay ov ovs ove)))
11554 (when cookie-present
11555 (run-hook-with-args 'org-after-todo-statistics-hook
11556 cnt-done (- cnt-all cnt-done))))))
11557 (run-hooks 'org-todo-statistics-hook)))
11559 (defvar org-after-todo-statistics-hook nil
11560 "Hook that is called after a TODO statistics cookie has been updated.
11561 Each function is called with two arguments: the number of not-done entries
11562 and the number of done entries.
11564 For example, the following function, when added to this hook, will switch
11565 an entry to DONE when all children are done, and back to TODO when new
11566 entries are set to a TODO status. Note that this hook is only called
11567 when there is a statistics cookie in the headline!
11569 (defun org-summary-todo (n-done n-not-done)
11571 (let (org-log-done org-log-states) ; turn off logging
11573 ")
11575 (defvar org-todo-statistics-hook nil
11576 "Hook that is run whenever Org thinks TODO statistics should be updated.
11577 This hook runs even if there is no statistics cookie present, in which case
11578 `org-after-todo-statistics-hook' would not run.")
11580 (defun org-todo-trigger-tag-changes (state)
11581 "Apply the changes defined in `org-todo-state-tags-triggers'."
11582 (let ((l org-todo-state-tags-triggers)
11583 changes)
11584 (when (or (not state) (equal state ""))
11585 (setq changes (append changes (cdr (assoc "" l)))))
11586 (when (and (stringp state) (> (length state) 0))
11587 (setq changes (append changes (cdr (assoc state l)))))
11588 (when (member state org-not-done-keywords)
11589 (setq changes (append changes (cdr (assoc 'todo l)))))
11590 (when (member state org-done-keywords)
11591 (setq changes (append changes (cdr (assoc 'done l)))))
11592 (dolist (c changes)
11593 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11595 (defun org-local-logging (value)
11596 "Get logging settings from a property VALUE."
11597 (let* (words w a)
11598 ;; directly set the variables, they are already local.
11599 (setq org-log-done nil
11600 org-log-repeat nil
11601 org-todo-log-states nil)
11602 (setq words (org-split-string value))
11603 (while (setq w (pop words))
11604 (cond
11605 ((setq a (assoc w org-startup-options))
11606 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11607 (set (nth 1 a) (nth 2 a))))
11608 ((setq a (org-extract-log-state-settings w))
11609 (and (member (car a) org-todo-keywords-1)
11610 (push a org-todo-log-states)))))))
11612 (defun org-get-todo-sequence-head (kwd)
11613 "Return the head of the TODO sequence to which KWD belongs.
11614 If KWD is not set, check if there is a text property remembering the
11615 right sequence."
11616 (let (p)
11617 (cond
11618 ((not kwd)
11619 (or (get-text-property (point-at-bol) 'org-todo-head)
11620 (progn
11621 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11622 nil (point-at-eol)))
11623 (get-text-property p 'org-todo-head))))
11624 ((not (member kwd org-todo-keywords-1))
11625 (car org-todo-keywords-1))
11626 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11628 (defun org-fast-todo-selection ()
11629 "Fast TODO keyword selection with single keys.
11630 Returns the new TODO keyword, or nil if no state change should occur."
11631 (let* ((fulltable org-todo-key-alist)
11632 (done-keywords org-done-keywords) ;; needed for the faces.
11633 (maxlen (apply 'max (mapcar
11634 (lambda (x)
11635 (if (stringp (car x)) (string-width (car x)) 0))
11636 fulltable)))
11637 (expert nil)
11638 (fwidth (+ maxlen 3 1 3))
11639 (ncol (/ (- (window-width) 4) fwidth))
11640 tg cnt e c tbl
11641 groups ingroup)
11642 (save-excursion
11643 (save-window-excursion
11644 (if expert
11645 (set-buffer (get-buffer-create " *Org todo*"))
11646 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11647 (erase-buffer)
11648 (org-set-local 'org-done-keywords done-keywords)
11649 (setq tbl fulltable cnt 0)
11650 (while (setq e (pop tbl))
11651 (cond
11652 ((equal e '(:startgroup))
11653 (push '() groups) (setq ingroup t)
11654 (when (not (= cnt 0))
11655 (setq cnt 0)
11657 (insert "{ "))
11658 ((equal e '(:endgroup))
11659 (setq ingroup nil cnt 0)
11661 ((equal e '(:newline))
11662 (when (not (= cnt 0))
11663 (setq cnt 0)
11665 (setq e (car tbl))
11666 (while (equal (car tbl) '(:newline))
11668 (setq tbl (cdr tbl)))))
11669 (t
11670 (setq tg (car e) c (cdr e))
11671 (if ingroup (push tg (car groups)))
11672 (setq tg (org-add-props tg nil 'face
11673 (org-get-todo-face tg)))
11674 (if (and (= cnt 0) (not ingroup)) (insert " "))
11675 (insert "[" c "] " tg (make-string
11676 (- fwidth 4 (length tg)) ?\ ))
11677 (when (= (setq cnt (1+ cnt)) ncol)
11679 (if ingroup (insert " "))
11680 (setq cnt 0)))))
11682 (goto-char (point-min))
11683 (if (not expert) (org-fit-window-to-buffer))
11684 (message "[a-z..]:Set [SPC]:clear")
11685 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11686 (cond
11687 ((or (= c ?\C-g)
11688 (and (= c ?q) (not (rassoc c fulltable))))
11689 (setq quit-flag t))
11690 ((= c ?\ ) nil)
11691 ((setq e (rassoc c fulltable) tg (car e))
11692 tg)
11693 (t (setq quit-flag t)))))))
11695 (defun org-entry-is-todo-p ()
11696 (member (org-get-todo-state) org-not-done-keywords))
11698 (defun org-entry-is-done-p ()
11699 (member (org-get-todo-state) org-done-keywords))
11701 (defun org-get-todo-state ()
11702 (save-excursion
11703 (org-back-to-heading t)
11704 (and (looking-at org-todo-line-regexp)
11705 (match-end 2)
11706 (match-string 2))))
11708 (defun org-at-date-range-p (&optional inactive-ok)
11709 "Is the cursor inside a date range?"
11710 (interactive)
11711 (save-excursion
11712 (catch 'exit
11713 (let ((pos (point)))
11715 (skip-chars-backward "<[")
11716 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11717 (>= (match-end 0) pos)
11718 (throw 'exit t))
11720 (skip-chars-backward "<[")
11721 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11722 (>= (match-end 0) pos)
11723 (throw 'exit t)))
11724 nil)))
11726 (defun org-get-repeat (&optional tagline)
11727 "Check if there is a deadline/schedule with repeater in this entry."
11728 (save-match-data
11729 (save-excursion
11730 (org-back-to-heading t)
11731 (and (re-search-forward (if tagline
11733 org-repeat-re)
11734 (org-entry-end-position) t)
11735 (match-string-no-properties 1)))))
11737 (defvar org-last-changed-timestamp)
11738 (defvar org-last-inserted-timestamp)
11739 (defvar org-log-post-message)
11740 (defvar org-log-note-purpose)
11741 (defvar org-log-note-how)
11742 (defvar org-log-note-extra)
11743 (defun org-auto-repeat-maybe (done-word)
11744 "Check if the current headline contains a repeated deadline/schedule.
11745 If yes, set TODO state back to what it was and change the base date
11746 of repeating deadline/scheduled time stamps to new date.
11747 This function is run automatically after each state change to a DONE state."
11748 ;; last-state is dynamically scoped into this function
11749 (let* ((repeat (org-get-repeat))
11750 (aa (assoc last-state org-todo-kwd-alist))
11751 (interpret (nth 1 aa))
11752 (head (nth 2 aa))
11753 (whata '(("d" . day) ("m" . month) ("y" . year)))
11754 (msg "Entry repeats: ")
11755 (org-log-done nil)
11756 (org-todo-log-states nil)
11757 re type n what ts time to-state)
11758 (when repeat
11759 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11760 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11761 org-todo-repeat-to-state))
11762 (unless (and to-state (member to-state org-todo-keywords-1))
11763 (setq to-state (if (eq interpret 'type) last-state head)))
11764 (org-todo to-state)
11765 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11766 (org-entry-put nil "LAST_REPEAT" (format-time-string
11767 (org-time-stamp-format t t))))
11768 (when org-log-repeat
11769 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11770 (memq 'org-add-log-note post-command-hook))
11771 ;; OK, we are already setup for some record
11772 (if (eq org-log-repeat 'note)
11773 ;; make sure we take a note, not only a time stamp
11774 (setq org-log-note-how 'note))
11775 ;; Set up for taking a record
11776 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11777 last-state
11778 'findpos org-log-repeat)))
11779 (org-back-to-heading t)
11780 (org-add-planning-info nil nil 'closed)
11784 (while (re-search-forward
11785 re (save-excursion (outline-next-heading) (point)) t)
11786 (setq type (if (match-end 1) org-scheduled-string
11787 (if (match-end 3) org-deadline-string "Plain:"))
11788 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11790 (setq n (string-to-number (match-string 2 ts))
11791 what (match-string 3 ts))
11792 (if (equal what "w") (setq n (* n 7) what "d"))
11793 ;; Preparation, see if we need to modify the start date for the change
11794 (when (match-end 1)
11795 (setq time (save-match-data (org-time-string-to-time ts)))
11796 (cond
11797 ((equal (match-string 1 ts) ".")
11798 ;; Shift starting date to today
11799 (org-timestamp-change
11800 (- (org-today) (time-to-days time))
11801 'day))
11802 ((equal (match-string 1 ts) "+")
11803 (let ((nshiftmax 10) (nshift 0))
11804 (while (or (= nshift 0)
11805 (<= (time-to-days time)
11806 (time-to-days (current-time))))
11807 (when (= (incf nshift) nshiftmax)
11808 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11809 (error "Abort")))
11810 (org-timestamp-change n (cdr (assoc what whata)))
11811 (org-at-timestamp-p t)
11812 (setq ts (match-string 1))
11813 (setq time (save-match-data (org-time-string-to-time ts)))))
11814 (org-timestamp-change (- n) (cdr (assoc what whata)))
11815 ;; rematch, so that we have everything in place for the real shift
11816 (org-at-timestamp-p t)
11817 (setq ts (match-string 1))
11819 (org-timestamp-change n (cdr (assoc what whata)))
11820 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11821 (setq org-log-post-message msg)
11822 (message "%s" msg))))
11824 (defun org-show-todo-tree (arg)
11825 "Make a compact tree which shows all headlines marked with TODO.
11826 The tree will show the lines where the regexp matches, and all higher
11827 headlines above the match.
11829 With a numeric prefix N, construct a sparse tree for the Nth element
11830 of `org-todo-keywords-1'."
11831 (interactive "P")
11832 (let ((case-fold-search nil)
11833 (kwd-re
11834 (cond ((null arg) org-not-done-regexp)
11835 ((equal arg '(4))
11836 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11837 (mapcar 'list org-todo-keywords-1))))
11841 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11842 (regexp-quote (nth (1- (prefix-numeric-value arg))
11843 org-todo-keywords-1)))
11844 (t (error "Invalid prefix argument: %s" arg)))))
11845 (message "%d TODO entries found"
11846 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11848 (defun org-deadline (&optional remove time)
11850 With argument REMOVE, remove any deadline from the item.
11851 With argument TIME, set the deadline at the corresponding date. TIME
11853 (interactive "P")
11854 (let* ((old-date (org-entry-get nil "DEADLINE"))
11855 (repeater (and old-date
11856 (string-match
11858 old-date)
11859 (match-string 1 old-date))))
11860 (if remove
11861 (progn
11862 (when (and old-date org-log-redeadline)
11863 (org-add-log-setup 'deldeadline nil old-date 'findpos
11864 org-log-redeadline))
11865 (org-remove-timestamp-with-keyword org-deadline-string)
11866 (message "Item no longer has a deadline."))
11867 (org-add-planning-info 'deadline time 'closed)
11868 (when (and old-date org-log-redeadline
11869 (not (equal old-date
11870 (substring org-last-inserted-timestamp 1 -1))))
11871 (org-add-log-setup 'redeadline nil old-date 'findpos
11872 org-log-redeadline))
11873 (when repeater
11874 (save-excursion
11875 (org-back-to-heading t)
11876 (when (re-search-forward (concat org-deadline-string " "
11877 org-last-inserted-timestamp)
11878 (save-excursion
11879 (outline-next-heading) (point)) t)
11880 (goto-char (1- (match-end 0)))
11881 (insert " " repeater)
11882 (setq org-last-inserted-timestamp
11883 (concat (substring org-last-inserted-timestamp 0 -1)
11884 " " repeater
11885 (substring org-last-inserted-timestamp -1))))))
11886 (message "Deadline on %s" org-last-inserted-timestamp))))
11888 (defun org-schedule (&optional remove time)
11889 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11890 With argument REMOVE, remove any scheduling date from the item.
11891 With argument TIME, scheduled at the corresponding date. TIME can
11893 (interactive "P")
11894 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11895 (repeater (and old-date
11896 (string-match
11898 old-date)
11899 (match-string 1 old-date))))
11900 (if remove
11901 (progn
11902 (when (and old-date org-log-reschedule)
11903 (org-add-log-setup 'delschedule nil old-date 'findpos
11904 org-log-reschedule))
11905 (org-remove-timestamp-with-keyword org-scheduled-string)
11906 (message "Item is no longer scheduled."))
11907 (org-add-planning-info 'scheduled time 'closed)
11908 (when (and old-date org-log-reschedule
11909 (not (equal old-date
11910 (substring org-last-inserted-timestamp 1 -1))))
11911 (org-add-log-setup 'reschedule nil old-date 'findpos
11912 org-log-reschedule))
11913 (when repeater
11914 (save-excursion
11915 (org-back-to-heading t)
11916 (when (re-search-forward (concat org-scheduled-string " "
11917 org-last-inserted-timestamp)
11918 (save-excursion
11919 (outline-next-heading) (point)) t)
11920 (goto-char (1- (match-end 0)))
11921 (insert " " repeater)
11922 (setq org-last-inserted-timestamp
11923 (concat (substring org-last-inserted-timestamp 0 -1)
11924 " " repeater
11925 (substring org-last-inserted-timestamp -1))))))
11926 (message "Scheduled to %s" org-last-inserted-timestamp))))
11928 (defun org-get-scheduled-time (pom &optional inherit)
11929 "Get the scheduled time as a time tuple, of a format suitable
11930 for calling org-schedule with, or if there is no scheduling,
11931 returns nil."
11932 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11933 (when time
11934 (apply 'encode-time (org-parse-time-string time)))))
11936 (defun org-get-deadline-time (pom &optional inherit)
11937 "Get the deadline as a time tuple, of a format suitable for
11938 calling org-deadline with, or if there is no scheduling, returns
11939 nil."
11940 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11941 (when time
11942 (apply 'encode-time (org-parse-time-string time)))))
11944 (defun org-remove-timestamp-with-keyword (keyword)
11945 "Remove all time stamps with KEYWORD in the current entry."
11947 beg)
11948 (save-excursion
11949 (org-back-to-heading t)
11950 (setq beg (point))
11951 (outline-next-heading)
11952 (while (re-search-backward re beg t)
11953 (replace-match "")
11955 (equal (char-before) ?\ ))
11956 (backward-delete-char 1)
11958 (point-at-bol) (point-at-eol)))
11959 (delete-region (point-at-bol)
11960 (min (point-max) (1+ (point-at-eol))))))))))
11962 (defun org-add-planning-info (what &optional time &rest remove)
11963 "Insert new timestamp with keyword in the line directly after the headline.
11964 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11965 If non is given, the user is prompted for a date.
11966 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11967 be removed."
11968 (interactive)
11969 (let (org-time-was-given org-end-time-was-given ts
11970 end default-time default-input)
11972 (catch 'exit
11973 (when (and (memq what '(scheduled deadline))
11974 (or (not time)
11975 (and (stringp time)
11976 (string-match "^[-+]+[0-9]" time))))
11977 ;; Try to get a default date/time from existing timestamp
11978 (save-excursion
11979 (org-back-to-heading t)
11980 (setq end (save-excursion (outline-next-heading) (point)))
11981 (when (re-search-forward (if (eq what 'scheduled)
11982 org-scheduled-time-regexp
11983 org-deadline-time-regexp)
11984 end t)
11985 (setq ts (match-string 1)
11986 default-time
11987 (apply 'encode-time (org-parse-time-string ts))
11988 default-input (and ts (org-get-compact-tod ts))))))
11989 (when what
11990 (setq time
11991 (if (and (stringp time)
11992 (string-match "^[-+]+[0-9]" time))
11993 ;; This is a relative time, set the proper date
11994 (apply 'encode-time
11995 (org-read-date-analyze
11996 time default-time (decode-time default-time)))
11997 ;; If necessary, get the time from the user
11998 (or time (org-read-date nil 'to-time nil nil
11999 default-time default-input)))))
12001 (when (and org-insert-labeled-timestamps-at-point
12002 (member what '(scheduled deadline)))
12003 (insert
12004 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12005 (org-insert-time-stamp time org-time-was-given
12006 nil nil nil (list org-end-time-was-given))
12007 (setq what nil))
12008 (save-excursion
12009 (save-restriction
12010 (let (col list elt ts buffer-invisibility-spec)
12011 (org-back-to-heading t)
12013 (goto-char (match-end 1))
12014 (setq col (current-column))
12015 (goto-char (match-end 0))
12017 (when (and (not what)
12018 (not (looking-at
12020 org-keyword-time-not-clock-regexp))))
12021 ;; Nothing to add, nothing to remove...... :-)
12022 (throw 'exit nil))
12023 (if (and (not (looking-at org-outline-regexp))
12026 (not (equal (match-string 1) org-clock-string)))
12027 (narrow-to-region (match-beginning 0) (match-end 0))
12029 (backward-char 1)
12030 (narrow-to-region (point) (point))
12031 (and org-adapt-indentation (org-indent-to-column col)))
12032 ;; Check if we have to remove something.
12033 (setq list (cons what remove))
12034 (while list
12035 (setq elt (pop list))
12036 (when (or (and (eq elt 'scheduled)
12037 (re-search-forward org-scheduled-time-regexp nil t))
12038 (and (eq elt 'deadline)
12039 (re-search-forward org-deadline-time-regexp nil t))
12040 (and (eq elt 'closed)
12041 (re-search-forward org-closed-time-regexp nil t)))
12042 (replace-match "")
12043 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12045 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12046 (when what
12047 (insert
12048 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12049 (cond ((eq what 'scheduled) org-scheduled-string)
12050 ((eq what 'deadline) org-deadline-string)
12051 ((eq what 'closed) org-closed-string))
12052 " ")
12053 (setq ts (org-insert-time-stamp
12054 time
12055 (or org-time-was-given
12056 (and (eq what 'closed) org-log-done-with-time))
12057 (eq what 'closed)
12058 nil nil (list org-end-time-was-given)))
12059 (insert
12060 (if (not (or (bolp) (eq (char-before) ?\ )
12061 (memq (char-after) '(32 10))
12062 (eobp))) " " ""))
12063 (end-of-line 1))
12064 (goto-char (point-min))
12065 (widen)
12068 (delete-region (1- (point)) (point-at-eol)))
12069 ts))))))
12071 (defvar org-log-note-marker (make-marker))
12072 (defvar org-log-note-purpose nil)
12073 (defvar org-log-note-state nil)
12074 (defvar org-log-note-previous-state nil)
12075 (defvar org-log-note-how nil)
12076 (defvar org-log-note-extra nil)
12077 (defvar org-log-note-window-configuration nil)
12078 (defvar org-log-note-return-to (make-marker))
12079 (defvar org-log-note-effective-time nil
12080 "Remembered current time so that dynamically scoped
12081 `org-extend-today-until' affects tha timestamps in state change
12082 log")
12084 (defvar org-log-post-message nil
12085 "Message to be displayed after a log note has been stored.
12086 The auto-repeater uses this.")
12088 (defun org-add-note ()
12089 "Add a note to the current entry.
12090 This is done in the same way as adding a state change note."
12091 (interactive)
12092 (org-add-log-setup 'note nil nil 'findpos nil))
12094 (defvar org-property-end-re)
12095 (defun org-add-log-setup (&optional purpose state prev-state
12096 findpos how extra)
12097 "Set up the post command hook to take a note.
12098 If this is about to TODO state change, the new state is expected in STATE.
12099 When FINDPOS is non-nil, find the correct position for the note in
12100 the current entry. If not, assume that it can be inserted at point.
12101 HOW is an indicator what kind of note should be created.
12102 EXTRA is additional text that will be inserted into the notes buffer."
12103 (let* ((org-log-into-drawer (org-log-into-drawer))
12104 (drawer (cond ((stringp org-log-into-drawer)
12105 org-log-into-drawer)
12106 (org-log-into-drawer "LOGBOOK")
12107 (t nil))))
12108 (save-restriction
12109 (save-excursion
12110 (when findpos
12111 (org-back-to-heading t)
12112 (narrow-to-region (point) (save-excursion
12113 (outline-next-heading) (point)))
12117 (goto-char (match-end 0))
12118 (cond
12119 (drawer
12121 nil t)
12122 (progn
12123 (goto-char (match-end 0))
12124 (or org-log-states-order-reversed
12125 (and (re-search-forward org-property-end-re nil t)
12126 (goto-char (1- (match-beginning 0))))))
12128 (beginning-of-line 0)
12129 (org-indent-line-function)
12130 (beginning-of-line 2)
12131 (org-indent-line-function)
12132 (end-of-line 0)))
12133 ((and org-log-state-notes-insert-after-drawers
12134 (save-excursion
12135 (forward-line) (looking-at org-drawer-regexp)))
12136 (forward-line)
12137 (while (looking-at org-drawer-regexp)
12138 (goto-char (match-end 0))
12139 (re-search-forward org-property-end-re (point-max) t)
12140 (forward-line))
12141 (forward-line -1)))
12142 (unless org-log-states-order-reversed
12144 (org-skip-over-state-notes)
12146 (move-marker org-log-note-marker (point))
12147 (setq org-log-note-purpose purpose
12148 org-log-note-state state
12149 org-log-note-previous-state prev-state
12150 org-log-note-how how
12151 org-log-note-extra extra
12152 org-log-note-effective-time (org-current-effective-time))
12153 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12155 (defun org-skip-over-state-notes ()
12156 "Skip past the list of State notes in an entry."
12158 (when (ignore-errors (goto-char (org-in-item-p)))
12159 (let* ((struct (org-list-struct))
12160 (prevs (org-list-prevs-alist struct)))
12162 (goto-char (or (org-list-get-next-item (point) struct prevs)
12163 (org-list-get-item-end (point) struct)))))))
12165 (defun org-add-log-note (&optional purpose)
12166 "Pop up a window for taking a note, and add this note later at point."
12167 (remove-hook 'post-command-hook 'org-add-log-note)
12168 (setq org-log-note-window-configuration (current-window-configuration))
12169 (delete-other-windows)
12170 (move-marker org-log-note-return-to (point))
12171 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12172 (goto-char org-log-note-marker)
12173 (org-switch-to-buffer-other-window "*Org Note*")
12174 (erase-buffer)
12175 (if (memq org-log-note-how '(time state))
12176 (let (current-prefix-arg) (org-store-log-note))
12177 (let ((org-inhibit-startup t)) (org-mode))
12178 (insert (format "# Insert note for %s.
12180 (cond
12181 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12182 ((eq org-log-note-purpose 'done) "closed todo item")
12183 ((eq org-log-note-purpose 'state)
12185 (or org-log-note-previous-state "")
12186 (or org-log-note-state "")))
12187 ((eq org-log-note-purpose 'reschedule)
12188 "rescheduling")
12189 ((eq org-log-note-purpose 'delschedule)
12190 "no longer scheduled")
12191 ((eq org-log-note-purpose 'redeadline)
12192 "changing deadline")
12193 ((eq org-log-note-purpose 'deldeadline)
12194 "removing deadline")
12195 ((eq org-log-note-purpose 'refile)
12196 "refiling")
12197 ((eq org-log-note-purpose 'note)
12198 "this entry")
12199 (t (error "This should not happen")))))
12200 (if org-log-note-extra (insert org-log-note-extra))
12201 (org-set-local 'org-finish-function 'org-store-log-note)
12202 (run-hooks 'org-log-buffer-setup-hook)))
12204 (defvar org-note-abort nil) ; dynamically scoped
12205 (defun org-store-log-note ()
12206 "Finish taking a log note, and insert it to where it belongs."
12207 (let ((txt (buffer-string))
12208 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12209 lines ind bul)
12210 (kill-buffer (current-buffer))
12212 (setq txt (replace-match "" t t txt)))
12214 (setq txt (replace-match "" t t txt)))
12217 (setq note
12218 (org-replace-escapes
12219 note
12220 (list (cons "%u" (user-login-name))
12221 (cons "%U" user-full-name)
12222 (cons "%t" (format-time-string
12223 (org-time-stamp-format 'long 'inactive)
12224 org-log-note-effective-time))
12225 (cons "%T" (format-time-string
12226 (org-time-stamp-format 'long nil)
12227 org-log-note-effective-time))
12228 (cons "%d" (format-time-string
12229 (org-time-stamp-format nil 'inactive)
12230 org-log-note-effective-time))
12231 (cons "%D" (format-time-string
12232 (org-time-stamp-format nil nil)
12233 org-log-note-effective-time))
12234 (cons "%s" (if org-log-note-state
12236 ""))
12237 (cons "%S" (if org-log-note-previous-state
12241 (push note lines))
12242 (when (or current-prefix-arg org-note-abort)
12243 (when org-log-into-drawer
12244 (org-remove-empty-drawer-at
12245 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12246 org-log-note-marker))
12247 (setq lines nil))
12248 (when lines
12249 (with-current-buffer (marker-buffer org-log-note-marker)
12250 (save-excursion
12251 (goto-char org-log-note-marker)
12252 (move-marker org-log-note-marker nil)
12253 (end-of-line 1)
12255 (setq ind (save-excursion
12256 (if (ignore-errors (goto-char (org-in-item-p)))
12257 (let ((struct (org-list-struct)))
12258 (org-list-get-ind
12259 (org-list-get-top-point struct) struct))
12261 (cond
12262 ((and (org-at-heading-p)
12263 org-adapt-indentation)
12264 (1+ (org-current-level)))
12265 ((org-at-heading-p) 0)
12266 (t (org-get-indentation))))))
12267 (setq bul (org-list-bullet-string "-"))
12268 (org-indent-line-to ind)
12269 (insert bul (pop lines))
12270 (let ((ind-body (+ (length bul) ind)))
12271 (while lines
12273 (org-indent-line-to ind-body)
12274 (insert (pop lines))))
12275 (message "Note stored")
12276 (org-back-to-heading t)
12277 (org-cycle-hide-drawers 'children)))))
12278 (set-window-configuration org-log-note-window-configuration)
12279 (with-current-buffer (marker-buffer org-log-note-return-to)
12280 (goto-char org-log-note-return-to))
12281 (move-marker org-log-note-return-to nil)
12282 (and org-log-post-message (message "%s" org-log-post-message)))
12284 (defun org-remove-empty-drawer-at (drawer pos)
12285 "Remove an empty drawer DRAWER at position POS.
12286 POS may also be a marker."
12287 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12288 (save-excursion
12289 (save-restriction
12290 (widen)
12291 (goto-char pos)
12292 (if (org-in-regexp
12294 (replace-match ""))))))
12296 (defun org-sparse-tree (&optional arg)
12297 "Create a sparse tree, prompt for the details.
12298 This command can create sparse trees. You first need to select the type
12299 of match used to create the tree:
12301 t Show all TODO entries.
12302 T Show entries with a specific TODO keyword.
12303 m Show entries selected by a tags/property match.
12304 p Enter a property name and its value (both with completion on existing
12305 names/values) and show entries with that property.
12306 r Show entries matching a regular expression (`/' can be used as well)
12307 d Show deadlines due within `org-deadline-warning-days'.
12308 b Show deadlines and scheduled items before a date.
12309 a Show deadlines and scheduled items after a date."
12310 (interactive "P")
12311 (let (ans kwd value)
12312 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12313 (setq ans (read-char-exclusive))
12314 (cond
12315 ((equal ans ?d)
12316 (call-interactively 'org-check-deadlines))
12317 ((equal ans ?b)
12318 (call-interactively 'org-check-before-date))
12319 ((equal ans ?a)
12320 (call-interactively 'org-check-after-date))
12321 ((equal ans ?t)
12322 (org-show-todo-tree nil))
12323 ((equal ans ?T)
12324 (org-show-todo-tree '(4)))
12325 ((member ans '(?T ?m))
12326 (call-interactively 'org-match-sparse-tree))
12327 ((member ans '(?p ?P))
12328 (setq kwd (org-icompleting-read "Property: "
12329 (mapcar 'list (org-buffer-property-keys))))
12330 (setq value (org-icompleting-read "Value: "
12331 (mapcar 'list (org-property-values kwd))))
12334 (org-match-sparse-tree arg (concat kwd "=" value)))
12335 ((member ans '(?r ?R ?/))
12336 (call-interactively 'org-occur))
12339 (defvar org-occur-highlights nil
12340 "List of overlays used for occur matches.")
12341 (make-variable-buffer-local 'org-occur-highlights)
12342 (defvar org-occur-parameters nil
12343 "Parameters of the active org-occur calls.
12344 This is a list, each call to org-occur pushes as cons cell,
12345 containing the regular expression and the callback, onto the list.
12346 The list can contain several entries if `org-occur' has been called
12347 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12348 will only contain one set of parameters. When the highlights are
12349 removed (for example with `C-c C-c', or with the next edit (depending
12350 on `org-remove-highlights-with-change'), this variable is emptied
12351 as well.")
12352 (make-variable-buffer-local 'org-occur-parameters)
12354 (defun org-occur (regexp &optional keep-previous callback)
12355 "Make a compact tree which shows all matches of REGEXP.
12356 The tree will show the lines where the regexp matches, and all higher
12357 headlines above the match. It will also show the heading after the match,
12358 to make sure editing the matching entry is easy.
12359 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12360 call to `org-occur' will be kept, to allow stacking of calls to this
12361 command.
12362 If CALLBACK is non-nil, it is a function which is called to confirm
12363 that the match should indeed be shown."
12365 (when (equal regexp "")
12366 (error "Regexp cannot be empty"))
12367 (unless keep-previous
12368 (org-remove-occur-highlights nil nil t))
12369 (push (cons regexp callback) org-occur-parameters)
12370 (let ((cnt 0))
12371 (save-excursion
12372 (goto-char (point-min))
12373 (if (or (not keep-previous) ; do not want to keep
12374 (not org-occur-highlights)) ; no previous matches
12375 ;; hide everything
12376 (org-overview))
12377 (while (re-search-forward regexp nil t)
12378 (when (or (not callback)
12379 (save-match-data (funcall callback)))
12380 (setq cnt (1+ cnt))
12381 (when org-highlight-sparse-tree-matches
12382 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12383 (org-show-context 'occur-tree))))
12384 (when org-remove-highlights-with-change
12385 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12386 nil 'local))
12387 (unless org-sparse-tree-open-archived-trees
12388 (org-hide-archived-subtrees (point-min) (point-max)))
12389 (run-hooks 'org-occur-hook)
12390 (if (org-called-interactively-p 'interactive)
12391 (message "%d match(es) for regexp %s" cnt regexp))
12392 cnt))
12394 (defun org-occur-next-match (&optional n reset)
12395 "Function for `next-error-function' to find sparse tree matches.
12396 N is the number of matches to move, when negative move backwards.
12397 RESET is entirely ignored - this function always goes back to the
12398 starting point when no match is found."
12399 (let* ((limit (if (< n 0) (point-min) (point-max)))
12400 (search-func (if (< n 0)
12401 'previous-single-char-property-change
12402 'next-single-char-property-change))
12403 (n (abs n))
12404 (pos (point))
12405 p1)
12406 (catch 'exit
12407 (while (setq p1 (funcall search-func (point) 'org-type))
12408 (when (equal p1 limit)
12409 (goto-char pos)
12410 (error "No more matches"))
12411 (when (equal (get-char-property p1 'org-type) 'org-occur)
12412 (setq n (1- n))
12413 (when (= n 0)
12414 (goto-char p1)
12415 (throw 'exit (point))))
12416 (goto-char p1))
12417 (goto-char p1)
12418 (error "No more matches"))))
12420 (defun org-show-context (&optional key)
12421 "Make sure point and context are visible.
12422 How much context is shown depends upon the variables
12423 `org-show-hierarchy-above', `org-show-following-heading'. and
12424 `org-show-siblings'."
12425 (let ((heading-p (org-on-heading-p t))
12426 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12427 (following-p (org-get-alist-option org-show-following-heading key))
12428 (entry-p (org-get-alist-option org-show-entry-below key))
12429 (siblings-p (org-get-alist-option org-show-siblings key)))
12430 (catch 'exit
12431 ;; Show heading or entry text
12432 (if (and heading-p (not entry-p))
12433 (org-flag-heading nil) ; only show the heading
12434 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12435 (org-show-hidden-entry))) ; show entire entry
12436 (when following-p
12437 ;; Show next sibling, or heading below text
12438 (save-excursion
12439 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12440 (org-flag-heading nil))))
12441 (when siblings-p (org-show-siblings))
12442 (when hierarchy-p
12443 ;; show all higher headings, possibly with siblings
12444 (save-excursion
12445 (while (and (condition-case nil
12446 (progn (org-up-heading-all 1) t)
12447 (error nil))
12448 (not (bobp)))
12449 (org-flag-heading nil)
12450 (when siblings-p (org-show-siblings))))))))
12452 (defvar org-reveal-start-hook nil
12453 "Hook run before revealing a location.")
12455 (defun org-reveal (&optional siblings)
12456 "Show current entry, hierarchy above it, and the following headline.
12457 This can be used to show a consistent set of context around locations
12458 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12459 not t for the search context.
12461 With optional argument SIBLINGS, on each level of the hierarchy all
12462 siblings are shown. This repairs the tree structure to what it would
12463 look like when opened with hierarchical calls to `org-cycle'.
12465 go to the parent and show the
12466 entire tree."
12467 (interactive "P")
12468 (run-hooks 'org-reveal-start-hook)
12469 (let ((org-show-hierarchy-above t)
12470 (org-show-following-heading t)
12471 (org-show-siblings (if siblings t org-show-siblings)))
12472 (org-show-context nil))
12473 (when (equal siblings '(16))
12474 (save-excursion
12475 (when (org-up-heading-safe)
12476 (org-show-subtree)
12477 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12479 (defun org-highlight-new-match (beg end)
12480 "Highlight from BEG to END and mark the highlight is an occur headline."
12481 (let ((ov (make-overlay beg end)))
12482 (overlay-put ov 'face 'secondary-selection)
12483 (overlay-put ov 'org-type 'org-occur)
12484 (push ov org-occur-highlights)))
12486 (defun org-remove-occur-highlights (&optional beg end noremove)
12487 "Remove the occur highlights from the buffer.
12488 BEG and END are ignored. If NOREMOVE is nil, remove this function
12489 from the `before-change-functions' in the current buffer."
12490 (interactive)
12491 (unless org-inhibit-highlight-removal
12492 (mapc 'delete-overlay org-occur-highlights)
12493 (setq org-occur-highlights nil)
12494 (setq org-occur-parameters nil)
12495 (unless noremove
12496 (remove-hook 'before-change-functions
12497 'org-remove-occur-highlights 'local))))
12499 ;;;; Priorities
12502 "Regular expression matching the priority indicator.")
12504 (defvar org-remove-priority-next-time nil)
12506 (defun org-priority-up ()
12507 "Increase the priority of the current item."
12508 (interactive)
12509 (org-priority 'up))
12511 (defun org-priority-down ()
12512 "Decrease the priority of the current item."
12513 (interactive)
12514 (org-priority 'down))
12516 (defun org-priority (&optional action)
12517 "Change the priority of an item by ARG.
12518 ACTION can be `set', `up', `down', or a character."
12519 (interactive)
12520 (unless org-enable-priority-commands
12521 (error "Priority commands are disabled"))
12522 (setq action (or action 'set))
12523 (let (current new news have remove)
12524 (save-excursion
12525 (org-back-to-heading t)
12526 (if (looking-at org-priority-regexp)
12527 (setq current (string-to-char (match-string 2))
12528 have t))
12529 (cond
12530 ((eq action 'remove)
12531 (setq remove t new ?\ ))
12532 ((or (eq action 'set)
12533 (if (featurep 'xemacs) (characterp action) (integerp action)))
12534 (if (not (eq action 'set))
12535 (setq new action)
12536 (message "Priority %c-%c, SPC to remove: "
12537 org-highest-priority org-lowest-priority)
12538 (save-match-data
12539 (setq new (read-char-exclusive))))
12540 (if (and (= (upcase org-highest-priority) org-highest-priority)
12541 (= (upcase org-lowest-priority) org-lowest-priority))
12542 (setq new (upcase new)))
12543 (cond ((equal new ?\ ) (setq remove t))
12544 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12545 (error "Priority must be between `%c' and `%c'"
12546 org-highest-priority org-lowest-priority))))
12547 ((eq action 'up)
12548 (setq new (if have
12549 (1- current) ; normal cycling
12550 ;; last priority was empty
12551 (if (eq last-command this-command)
12552 org-lowest-priority ; wrap around empty to lowest
12553 ;; default
12554 (if org-priority-start-cycle-with-default
12555 org-default-priority
12556 (1- org-default-priority))))))
12557 ((eq action 'down)
12558 (setq new (if have
12559 (1+ current) ; normal cycling
12560 ;; last priority was empty
12561 (if (eq last-command this-command)
12562 org-highest-priority ; wrap around empty to highest
12563 ;; default
12564 (if org-priority-start-cycle-with-default
12565 org-default-priority
12566 (1+ org-default-priority))))))
12567 (t (error "Invalid action")))
12568 (if (or (< (upcase new) org-highest-priority)
12569 (> (upcase new) org-lowest-priority))
12570 (if (and (memq action '(up down))
12571 (not have) (not (eq last-command this-command)))
12572 ;; `new' is from default priority
12573 (error
12574 "The default can not be set, see `org-default-priority' why")
12575 ;; normal cycling: `new' is beyond highest/lowest priority
12576 ;; and is wrapped around to the empty priority
12577 (setq remove t)))
12578 (setq news (format "%c" new))
12579 (if have
12580 (if remove
12581 (replace-match "" t t nil 1)
12582 (replace-match news t t nil 2))
12583 (if remove
12584 (error "No priority cookie found in line")
12585 (let ((case-fold-search nil))
12586 (looking-at org-todo-line-regexp))
12587 (if (match-end 2)
12588 (progn
12589 (goto-char (match-end 2))
12590 (insert " [#" news "]"))
12591 (goto-char (match-beginning 3))
12592 (insert "[#" news "] "))))
12593 (org-preserve-lc (org-set-tags nil 'align)))
12594 (if remove
12595 (message "Priority removed")
12596 (message "Priority of current item set to %s" news))))
12598 (defun org-get-priority (s)
12599 "Find priority cookie and return priority."
12600 (if (functionp org-get-priority-function)
12601 (funcall org-get-priority-function)
12602 (save-match-data
12603 (if (not (string-match org-priority-regexp s))
12604 (* 1000 (- org-lowest-priority org-default-priority))
12605 (* 1000 (- org-lowest-priority
12606 (string-to-char (match-string 2 s))))))))
12608 ;;;; Tags
12610 (defvar org-agenda-archives-mode)
12611 (defvar org-map-continue-from nil
12612 "Position from where mapping should continue.
12613 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12615 (defvar org-scanner-tags nil
12616 "The current tag list while the tags scanner is running.")
12617 (defvar org-trust-scanner-tags nil
12618 "Should `org-get-tags-at' use the tags for the scanner.
12619 This is for internal dynamical scoping only.
12620 When this is non-nil, the function `org-get-tags-at' will return the value
12621 of `org-scanner-tags' instead of building the list by itself. This
12622 can lead to large speed-ups when the tags scanner is used in a file with
12623 many entries, and when the list of tags is retrieved, for example to
12624 obtain a list of properties. Building the tags list for each entry in such
12625 a file becomes an N^2 operation - but with this variable set, it scales
12626 as N.")
12628 (defun org-scan-tags (action matcher &optional todo-only)
12629 "Scan headline tags with inheritance and produce output ACTION.
12631 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12632 or `agenda' to produce an entry list for an agenda view. It can also be
12633 a Lisp form or a function that should be called at each matched headline, in
12634 this case the return value is a list of all return values from these calls.
12636 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12637 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12638 only lines with a TODO keyword are included in the output."
12639 (require 'org-agenda)
12642 (org-re
12644 (props (list 'face 'default
12645 'done-face 'org-agenda-done
12646 'undone-face 'default
12647 'mouse-face 'highlight
12648 'org-not-done-regexp org-not-done-regexp
12649 'org-todo-regexp org-todo-regexp
12650 'help-echo
12651 (format "mouse-2 or RET jump to org file %s"
12652 (abbreviate-file-name
12653 (or (buffer-file-name (buffer-base-buffer))
12654 (buffer-name (buffer-base-buffer)))))))
12655 (case-fold-search nil)
12656 (org-map-continue-from nil)
12657 lspos tags tags-list
12658 (tags-alist (list (cons 0 org-file-tags)))
12659 (llast 0) rtn rtn1 level category i txt
12660 todo marker entry priority)
12661 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12662 (setq action (list 'lambda nil action)))
12663 (save-excursion
12664 (goto-char (point-min))
12665 (when (eq action 'sparse-tree)
12666 (org-overview)
12667 (org-remove-occur-highlights))
12668 (while (re-search-forward re nil t)
12669 (catch :skip
12670 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12671 tags (if (match-end 4) (org-match-string-no-properties 4)))
12672 (goto-char (setq lspos (match-beginning 0)))
12673 (setq level (org-reduced-level (funcall outline-level))
12674 category (org-get-category))
12675 (setq i llast llast level)
12676 ;; remove tag lists from same and sublevels
12677 (while (>= i level)
12678 (when (setq entry (assoc i tags-alist))
12679 (setq tags-alist (delete entry tags-alist)))
12680 (setq i (1- i)))
12681 ;; add the next tags
12682 (when tags
12683 (setq tags (org-split-string tags ":")
12684 tags-alist
12685 (cons (cons level tags) tags-alist)))
12686 ;; compile tags for current headline
12687 (setq tags-list
12688 (if org-use-tag-inheritance
12689 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12690 tags)
12691 org-scanner-tags tags-list)
12692 (when org-use-tag-inheritance
12693 (setcdr (car tags-alist)
12694 (mapcar (lambda (x)
12695 (setq x (copy-sequence x))
12696 (org-add-prop-inherited x))
12697 (cdar tags-alist))))
12698 (when (and tags org-use-tag-inheritance
12699 (or (not (eq t org-use-tag-inheritance))
12700 org-tags-exclude-from-inheritance))
12701 ;; selective inheritance, remove uninherited ones
12702 (setcdr (car tags-alist)
12703 (org-remove-uninherited-tags (cdar tags-alist))))
12704 (when (and
12706 ;; eval matcher only when the todo condition is OK
12707 (and (or (not todo-only) (member todo org-not-done-keywords))
12708 (let ((case-fold-search t)) (eval matcher)))
12710 ;; Call the skipper, but return t if it does not skip,
12711 ;; so that the `and' form continues evaluating
12712 (progn
12713 (unless (eq action 'sparse-tree) (org-agenda-skip))
12714 t)
12716 ;; Check if timestamps are deselecting this entry
12717 (or (not todo-only)
12718 (and (member todo org-not-done-keywords)
12719 (or (not org-agenda-tags-todo-honor-ignore-options)
12720 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12722 ;; Extra check for the archive tag
12723 ;; FIXME: Does the skipper already do this????
12724 (or
12725 (not (member org-archive-tag tags-list))
12726 ;; we have an archive tag, should we use this anyway?
12727 (or (not org-agenda-skip-archived-trees)
12728 (and (eq action 'agenda) org-agenda-archives-mode))))
12730 ;; select this headline
12732 (cond
12733 ((eq action 'sparse-tree)
12734 (and org-highlight-sparse-tree-matches
12735 (org-get-heading) (match-end 0)
12736 (org-highlight-new-match
12737 (match-beginning 0) (match-beginning 1)))
12738 (org-show-context 'tags-tree))
12739 ((eq action 'agenda)
12740 (setq txt (org-agenda-format-item
12741 ""
12742 (concat
12743 (if (eq org-tags-match-list-sublevels 'indented)
12744 (make-string (1- level) ?.) "")
12745 (org-get-heading))
12746 category
12747 tags-list
12748 )
12749 priority (org-get-priority txt))
12750 (goto-char lspos)
12751 (setq marker (org-agenda-new-marker))
12752 (org-add-props txt props
12753 'org-marker marker 'org-hd-marker marker 'org-category category
12754 'todo-state todo
12755 'priority priority 'type "tagsmatch")
12756 (push txt rtn))
12757 ((functionp action)
12758 (setq org-map-continue-from nil)
12759 (save-excursion
12760 (setq rtn1 (funcall action))
12761 (push rtn1 rtn)))
12762 (t (error "Invalid action")))
12764 ;; if we are to skip sublevels, jump to end of subtree
12765 (unless org-tags-match-list-sublevels
12766 (org-end-of-subtree t)
12767 (backward-char 1))))
12768 ;; Get the correct position from where to continue
12769 (if org-map-continue-from
12770 (goto-char org-map-continue-from)
12771 (and (= (point) lspos) (end-of-line 1)))))
12772 (when (and (eq action 'sparse-tree)
12773 (not org-sparse-tree-open-archived-trees))
12774 (org-hide-archived-subtrees (point-min) (point-max)))
12775 (nreverse rtn)))
12777 (defun org-remove-uninherited-tags (tags)
12778 "Remove all tags that are not inherited from the list TAGS."
12779 (cond
12780 ((eq org-use-tag-inheritance t)
12781 (if org-tags-exclude-from-inheritance
12782 (org-delete-all org-tags-exclude-from-inheritance tags)
12783 tags))
12784 ((not org-use-tag-inheritance) nil)
12785 ((stringp org-use-tag-inheritance)
12786 (delq nil (mapcar
12787 (lambda (x)
12788 (if (and (string-match org-use-tag-inheritance x)
12789 (not (member x org-tags-exclude-from-inheritance)))
12790 x nil))
12791 tags)))
12792 ((listp org-use-tag-inheritance)
12793 (delq nil (mapcar
12794 (lambda (x)
12795 (if (member x org-use-tag-inheritance) x nil))
12796 tags)))))
12798 (defvar todo-only) ;; dynamically scoped
12800 (defun org-match-sparse-tree (&optional todo-only match)
12801 "Create a sparse tree according to tags string MATCH.
12802 MATCH can contain positive and negative selection of tags, like
12804 If optional argument TODO-ONLY is non-nil, only select lines that are
12805 also TODO lines."
12806 (interactive "P")
12807 (org-prepare-agenda-buffers (list (current-buffer)))
12808 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12810 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12812 (defvar org-cached-props nil)
12813 (defun org-cached-entry-get (pom property)
12814 (if (or (eq t org-use-property-inheritance)
12815 (and (stringp org-use-property-inheritance)
12816 (string-match org-use-property-inheritance property))
12817 (and (listp org-use-property-inheritance)
12818 (member property org-use-property-inheritance)))
12819 ;; Caching is not possible, check it directly
12820 (org-entry-get pom property 'inherit)
12821 ;; Get all properties, so that we can do complicated checks easily
12822 (cdr (assoc property (or org-cached-props
12823 (setq org-cached-props
12824 (org-entry-properties pom)))))))
12826 (defun org-global-tags-completion-table (&optional files)
12827 "Return the list of all tags in all agenda buffer/files.
12828 Optional FILES argument is a list of files to which can be used
12829 instead of the agenda files."
12830 (save-excursion
12831 (org-uniquify
12832 (delq nil
12833 (apply 'append
12834 (mapcar
12835 (lambda (file)
12836 (set-buffer (find-file-noselect file))
12837 (append (org-get-buffer-tags)
12838 (mapcar (lambda (x) (if (stringp (car-safe x))
12839 (list (car-safe x)) nil))
12840 org-tag-alist)))
12841 (if (and files (car files))
12842 files
12843 (org-agenda-files))))))))
12845 (defun org-make-tags-matcher (match)
12846 "Create the TAGS/TODO matcher form for the selection string MATCH."
12847 ;; todo-only is scoped dynamically into this function, and the function
12848 ;; may change it if the matcher asks for it.
12849 (unless match
12850 ;; Get a new match request, with completion
12851 (let ((org-last-tags-completion-table
12852 (org-global-tags-completion-table)))
12853 (setq match (org-completing-read-no-i
12854 "Match: " 'org-tags-completion-function nil nil nil
12855 'org-tags-history))))
12857 ;; Parse the string and create a lisp form
12858 (let ((match0 match)
12859 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12860 minus tag mm
12861 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12862 orterms term orlist re-p str-p level-p level-op time-p
12863 prop-p pn pv po gv rest)
12864 (if (string-match "/+" match)
12865 ;; match contains also a todo-matching request
12866 (progn
12867 (setq tagsmatch (substring match 0 (match-beginning 0))
12868 todomatch (substring match (match-end 0)))
12869 (if (string-match "^!" todomatch)
12870 (setq todo-only t todomatch (substring todomatch 1)))
12872 (setq todomatch nil)))
12873 ;; only matching tags
12874 (setq tagsmatch match todomatch nil))
12876 ;; Make the tags matcher
12878 (setq tagsmatcher t)
12879 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12880 (while (setq term (pop orterms))
12882 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12883 (while (string-match re term)
12884 (setq rest (substring term (match-end 0))
12885 minus (and (match-end 1)
12886 (equal (match-string 1 term) "-"))
12887 tag (save-match-data (replace-regexp-in-string
12889 (match-string 2 term)))
12890 re-p (equal (string-to-char tag) ?{)
12891 level-p (match-end 4)
12892 prop-p (match-end 5)
12893 mm (cond
12894 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12895 (level-p
12896 (setq level-op (org-op-to-function (match-string 3 term)))
12897 `(,level-op level ,(string-to-number
12898 (match-string 4 term))))
12899 (prop-p
12900 (setq pn (match-string 5 term)
12901 po (match-string 6 term)
12902 pv (match-string 7 term)
12903 re-p (equal (string-to-char pv) ?{)
12905 time-p (save-match-data
12907 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12908 (if time-p (setq pv (org-matcher-time pv)))
12909 (setq po (org-op-to-function po (if time-p 'time str-p)))
12910 (cond
12911 ((equal pn "CATEGORY")
12912 (setq gv '(get-text-property (point) 'org-category)))
12913 ((equal pn "TODO")
12914 (setq gv 'todo))
12915 (t
12916 (setq gv `(org-cached-entry-get nil ,pn))))
12917 (if re-p
12918 (if (eq po 'org<>)
12919 `(not (string-match ,pv (or ,gv "")))
12920 `(string-match ,pv (or ,gv "")))
12921 (if str-p
12922 `(,po (or ,gv "") ,pv)
12923 `(,po (string-to-number (or ,gv ""))
12924 ,(string-to-number pv) ))))
12925 (t `(member ,tag tags-list)))
12926 mm (if minus (list 'not mm) mm)
12927 term rest)
12928 (push mm tagsmatcher))
12929 (push (if (> (length tagsmatcher) 1)
12930 (cons 'and tagsmatcher)
12931 (car tagsmatcher))
12932 orlist)
12933 (setq tagsmatcher nil))
12934 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12935 (setq tagsmatcher
12936 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12937 ;; Make the todo matcher
12939 (setq todomatcher t)
12940 (setq orterms (org-split-string todomatch "|") orlist nil)
12941 (while (setq term (pop orterms))
12942 (while (string-match re term)
12943 (setq minus (and (match-end 1)
12944 (equal (match-string 1 term) "-"))
12945 kwd (match-string 2 term)
12946 re-p (equal (string-to-char kwd) ?{)
12947 term (substring term (match-end 0))
12948 mm (if re-p
12949 `(string-match ,(substring kwd 1 -1) todo)
12950 (list 'equal 'todo kwd))
12951 mm (if minus (list 'not mm) mm))
12952 (push mm todomatcher))
12953 (push (if (> (length todomatcher) 1)
12954 (cons 'and todomatcher)
12955 (car todomatcher))
12956 orlist)
12957 (setq todomatcher nil))
12958 (setq todomatcher (if (> (length orlist) 1)
12959 (cons 'or orlist) (car orlist))))
12961 ;; Return the string and lisp forms of the matcher
12962 (setq matcher (if todomatcher
12963 (list 'and tagsmatcher todomatcher)
12964 tagsmatcher))
12965 (cons match0 matcher)))
12967 (defun org-op-to-function (op &optional stringp)
12968 "Turn an operator into the appropriate function."
12969 (setq op
12970 (cond
12971 ((equal op "<" ) '(< string< org-time<))
12972 ((equal op ">" ) '(> org-string> org-time>))
12973 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12974 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12975 ((member op '("=" "==")) '(= string= org-time=))
12976 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12977 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12979 (defun org<> (a b) (not (= a b)))
12980 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12981 (defun org-string>= (a b) (not (string< a b)))
12982 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12983 (defun org-string<> (a b) (not (string= a b)))
12984 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12985 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12986 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12987 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12988 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12989 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12990 (defun org-2ft (s)
12991 "Convert S to a floating point time.
12992 If S is already a number, just return it. If it is a string, parse
12993 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12994 (cond
12995 ((numberp s) s)
12996 ((stringp s)
12997 (condition-case nil
12998 (float-time (apply 'encode-time (org-parse-time-string s)))
12999 (error 0.)))
13000 (t 0.)))
13002 (defun org-time-today ()
13003 "Time in seconds today at 0:00.
13004 Returns the float number of seconds since the beginning of the
13005 epoch to the beginning of today (00:00)."
13006 (float-time (apply 'encode-time
13007 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13009 (defun org-matcher-time (s)
13010 "Interpret a time comparison value."
13011 (save-match-data
13012 (cond
13013 ((string= s "<now>") (float-time))
13014 ((string= s "<today>") (org-time-today))
13015 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13016 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13018 (+ (org-time-today)
13019 (* (string-to-number (match-string 1 s))
13020 (cdr (assoc (match-string 2 s)
13021 '(("d" . 86400.0) ("w" . 604800.0)
13022 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13023 (t (org-2ft s)))))
13025 (defun org-match-any-p (re list)
13026 "Does re match any element of list?"
13027 (setq list (mapcar (lambda (x) (string-match re x)) list))
13028 (delq nil list))
13030 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13031 (defvar org-tags-overlay (make-overlay 1 1))
13032 (org-detach-overlay org-tags-overlay)
13034 (defun org-get-local-tags-at (&optional pos)
13035 "Get a list of tags defined in the current headline."
13036 (org-get-tags-at pos 'local))
13038 (defun org-get-local-tags ()
13039 "Get a list of tags defined in the current headline."
13040 (org-get-tags-at nil 'local))
13042 (defun org-get-tags-at (&optional pos local)
13043 "Get a list of all headline tags applicable at POS.
13044 POS defaults to point. If tags are inherited, the list contains
13045 the targets in the same sequence as the headlines appear, i.e.
13046 the tags of the current headline come last.
13047 When LOCAL is non-nil, only return tags from the current headline,
13048 ignore inherited ones."
13049 (interactive)
13050 (if (and org-trust-scanner-tags
13051 (or (not pos) (equal pos (point)))
13052 (not local))
13053 org-scanner-tags
13054 (let (tags ltags lastpos parent)
13055 (save-excursion
13056 (save-restriction
13057 (widen)
13058 (goto-char (or pos (point)))
13059 (save-match-data
13060 (catch 'done
13061 (condition-case nil
13062 (progn
13063 (org-back-to-heading t)
13064 (while (not (equal lastpos (point)))
13065 (setq lastpos (point))
13066 (when (looking-at
13068 (setq ltags (org-split-string
13069 (org-match-string-no-properties 1) ":"))
13070 (when parent
13071 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13072 (setq tags (append
13073 (if parent
13074 (org-remove-uninherited-tags ltags)
13075 ltags)
13076 tags)))
13077 (or org-use-tag-inheritance (throw 'done t))
13078 (if local (throw 'done t))
13079 (or (org-up-heading-safe) (error nil))
13080 (setq parent t)))
13081 (error nil)))))
13082 (if local
13083 tags
13084 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13086 (defun org-add-prop-inherited (s)
13087 (add-text-properties 0 (length s) '(inherited t) s)
13088 s)
13090 (defun org-toggle-tag (tag &optional onoff)
13091 "Toggle the tag TAG for the current line.
13092 If ONOFF is `on' or `off', don't toggle but set to this state."
13093 (let (res current)
13094 (save-excursion
13095 (org-back-to-heading t)
13097 (point-at-eol) t)
13098 (progn
13099 (setq current (match-string 1))
13100 (replace-match ""))
13101 (setq current ""))
13102 (setq current (nreverse (org-split-string current ":")))
13103 (cond
13104 ((eq onoff 'on)
13105 (setq res t)
13106 (or (member tag current) (push tag current)))
13107 ((eq onoff 'off)
13108 (or (not (member tag current)) (setq current (delete tag current))))
13109 (t (if (member tag current)
13110 (setq current (delete tag current))
13111 (setq res t)
13112 (push tag current))))
13113 (end-of-line 1)
13114 (if current
13115 (progn
13116 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13117 (org-set-tags nil t))
13118 (delete-horizontal-space))
13119 (run-hooks 'org-after-tags-change-hook))
13120 res))
13122 (defun org-align-tags-here (to-col)
13123 ;; Assumes that this is a headline
13124 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13125 (beginning-of-line 1)
13127 (< pos (match-beginning 2)))
13128 (progn
13129 (setq tags-l (- (match-end 2) (match-beginning 2)))
13130 (goto-char (match-beginning 1))
13131 (insert " ")
13132 (delete-region (point) (1+ (match-beginning 2)))
13133 (setq ncol (max (current-column)
13134 (1+ col)
13135 (if (> to-col 0)
13136 to-col
13137 (- (abs to-col) tags-l))))
13138 (setq p (point))
13139 (insert (make-string (- ncol (current-column)) ?\ ))
13140 (setq ncol (current-column))
13141 (when indent-tabs-mode (tabify p (point-at-eol)))
13142 (org-move-to-column (min ncol col) t))
13143 (goto-char pos))))
13145 (defun org-set-tags-command (&optional arg just-align)
13146 "Call the set-tags command for the current entry."
13147 (interactive "P")
13148 (if (org-on-heading-p)
13149 (org-set-tags arg just-align)
13150 (save-excursion
13151 (org-back-to-heading t)
13152 (org-set-tags arg just-align))))
13154 (defun org-set-tags-to (data)
13155 "Set the tags of the current entry to DATA, replacing the current tags.
13156 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13157 If DATA is nil or the empty string, any tags will be removed."
13158 (interactive "sTags: ")
13159 (setq data
13160 (cond
13161 ((eq data nil) "")
13162 ((equal data "") "")
13163 ((stringp data)
13164 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13165 ":"))
13166 ((listp data)
13167 (concat ":" (mapconcat 'identity data ":") ":"))
13168 (t nil)))
13169 (when data
13170 (save-excursion
13171 (org-back-to-heading t)
13172 (when (looking-at org-complex-heading-regexp)
13173 (if (match-end 5)
13174 (progn
13175 (goto-char (match-beginning 5))
13176 (insert data)
13177 (delete-region (point) (point-at-eol))
13178 (org-set-tags nil 'align))
13179 (goto-char (point-at-eol))
13180 (insert " " data)
13181 (org-set-tags nil 'align)))
13182 (beginning-of-line 1)
13184 (delete-region (match-beginning 1) (match-end 1))))))
13186 (defun org-align-all-tags ()
13187 "Align the tags i all headings."
13188 (interactive)
13189 (save-excursion
13190 (or (ignore-errors (org-back-to-heading t))
13191 (outline-next-heading))
13192 (if (org-on-heading-p)
13193 (org-set-tags t)
13194 (message "No headings"))))
13196 (defvar org-indent-indentation-per-level)
13197 (defun org-set-tags (&optional arg just-align)
13198 "Set the tags for the current headline.
13199 With prefix ARG, realign all tags in headings in the current buffer."
13200 (interactive "P")
13201 (let* ((re org-outline-regexp-bol)
13202 (current (org-get-tags-string))
13203 (col (current-column))
13204 (org-setting-tags t)
13205 table current-tags inherited-tags ; computed below when needed
13206 tags p0 c0 c1 rpl di tc level)
13207 (if arg
13208 (save-excursion
13209 (goto-char (point-min))
13210 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13211 (while (re-search-forward re nil t)
13212 (org-set-tags nil t)
13213 (end-of-line 1)))
13214 (message "All tags realigned to column %d" org-tags-column))
13215 (if just-align
13216 (setq tags current)
13217 ;; Get a new set of tags from the user
13218 (save-excursion
13219 (setq table (append org-tag-persistent-alist
13220 (or org-tag-alist (org-get-buffer-tags))
13221 (and
13222 org-complete-tags-always-offer-all-agenda-tags
13223 (org-global-tags-completion-table
13224 (org-agenda-files))))
13225 org-last-tags-completion-table table
13226 current-tags (org-split-string current ":")
13227 inherited-tags (nreverse
13228 (nthcdr (length current-tags)
13229 (nreverse (org-get-tags-at))))
13230 tags
13231 (if (or (eq t org-use-fast-tag-selection)
13232 (and org-use-fast-tag-selection
13233 (delq nil (mapcar 'cdr table))))
13234 (org-fast-tag-selection
13235 current-tags inherited-tags table
13236 (if org-fast-tag-selection-include-todo
13237 org-todo-key-alist))
13238 (let ((org-add-colon-after-tag-completion t))
13239 (org-trim
13240 (org-icompleting-read "Tags: "
13241 'org-tags-completion-function
13242 nil nil current 'org-tags-history))))))
13243 (while (string-match "[-+&]+" tags)
13244 ;; No boolean logic, just a list
13245 (setq tags (replace-match ":" t t tags))))
13247 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13249 (if org-tags-sort-function
13250 (setq tags (mapconcat 'identity
13251 (sort (org-split-string
13252 tags (org-re "[^[:alnum:]_@#%]+"))
13253 org-tags-sort-function) ":")))
13256 (setq tags "")
13257 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13258 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13260 ;; Insert new tags at the correct column
13261 (beginning-of-line 1)
13262 (setq level (or (and (looking-at org-outline-regexp)
13263 (- (match-end 0) (point) 1))
13264 1))
13265 (cond
13266 ((and (equal current "") (equal tags "")))
13267 ((re-search-forward
13269 (point-at-eol) t)
13270 (if (equal tags "")
13271 (setq rpl "")
13272 (goto-char (match-beginning 0))
13273 (setq c0 (current-column)
13274 ;; compute offset for the case of org-indent-mode active
13275 di (if org-indent-mode
13276 (* (1- org-indent-indentation-per-level) (1- level))
13277 0)
13278 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13279 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13280 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13281 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13282 (replace-match rpl t t)
13283 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13284 tags)
13285 (t (error "Tags alignment failed")))
13286 (org-move-to-column col)
13287 (unless just-align
13288 (run-hooks 'org-after-tags-change-hook)))))
13290 (defun org-change-tag-in-region (beg end tag off)
13291 "Add or remove TAG for each entry in the region.
13292 This works in the agenda, and also in an org-mode buffer."
13293 (interactive
13294 (list (region-beginning) (region-end)
13295 (let ((org-last-tags-completion-table
13296 (if (eq major-mode 'org-mode)
13297 (org-get-buffer-tags)
13298 (org-global-tags-completion-table))))
13299 (org-icompleting-read
13300 "Tag: " 'org-tags-completion-function nil nil nil
13301 'org-tags-history))
13302 (progn
13304 (equal (read-char-exclusive) ?r))))
13305 (if (fboundp 'deactivate-mark) (deactivate-mark))
13306 (let ((agendap (equal major-mode 'org-agenda-mode))
13307 l1 l2 m buf pos newhead (cnt 0))
13308 (goto-char end)
13309 (setq l2 (1- (org-current-line)))
13310 (goto-char beg)
13311 (setq l1 (org-current-line))
13312 (loop for l from l1 to l2 do
13313 (org-goto-line l)
13314 (setq m (get-text-property (point) 'org-hd-marker))
13315 (when (or (and (eq major-mode 'org-mode) (org-on-heading-p))
13316 (and agendap m))
13317 (setq buf (if agendap (marker-buffer m) (current-buffer))
13318 pos (if agendap m (point)))
13319 (with-current-buffer buf
13320 (save-excursion
13321 (save-restriction
13322 (goto-char pos)
13323 (setq cnt (1+ cnt))
13324 (org-toggle-tag tag (if off 'off 'on))
13325 (setq newhead (org-get-heading)))))
13326 (and agendap (org-agenda-change-all-lines newhead m))))
13327 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13329 (defun org-tags-completion-function (string predicate &optional flag)
13330 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13331 (confirm (lambda (x) (stringp (car x)))))
13333 (setq s1 (match-string 1 string)
13334 s2 (match-string 2 string))
13335 (setq s1 "" s2 string))
13336 (cond
13337 ((eq flag nil)
13338 ;; try completion
13339 (setq rtn (try-completion s2 ctable confirm))
13340 (if (stringp rtn)
13341 (setq rtn
13342 (concat s1 s2 (substring rtn (length s2))
13343 (if (and org-add-colon-after-tag-completion
13344 (assoc rtn ctable))
13345 ":" ""))))
13346 rtn)
13347 ((eq flag t)
13348 ;; all-completions
13349 (all-completions s2 ctable confirm)
13350 )
13351 ((eq flag 'lambda)
13352 ;; exact match?
13353 (assoc s2 ctable)))
13354 ))
13356 (defun org-fast-tag-insert (kwd tags face &optional end)
13357 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13358 (insert (format "%-12s" (concat kwd ":"))
13359 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13360 (or end "")))
13362 (defun org-fast-tag-show-exit (flag)
13363 (save-excursion
13364 (org-goto-line 3)
13366 (replace-match ""))
13367 (when flag
13368 (end-of-line 1)
13369 (org-move-to-column (- (window-width) 19) t)
13370 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13372 (defun org-set-current-tags-overlay (current prefix)
13373 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13374 (if (featurep 'xemacs)
13375 (org-overlay-display org-tags-overlay (concat prefix s)
13376 'secondary-selection)
13377 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13378 (org-overlay-display org-tags-overlay (concat prefix s)))))
13380 (defvar org-last-tag-selection-key nil)
13381 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13382 "Fast tag selection with single keys.
13383 CURRENT is the current list of tags in the headline, INHERITED is the
13384 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13385 possibly with grouping information. TODO-TABLE is a similar table with
13386 TODO keywords, should these have keys assigned to them.
13387 If the keys are nil, a-z are automatically assigned.
13388 Returns the new tags string, or nil to not change the current settings."
13389 (let* ((fulltable (append table todo-table))
13390 (maxlen (apply 'max (mapcar
13391 (lambda (x)
13392 (if (stringp (car x)) (string-width (car x)) 0))
13393 fulltable)))
13394 (buf (current-buffer))
13395 (expert (eq org-fast-tag-selection-single-key 'expert))
13396 (buffer-tags nil)
13397 (fwidth (+ maxlen 3 1 3))
13398 (ncol (/ (- (window-width) 4) fwidth))
13399 (i-face 'org-done)
13400 (c-face 'org-todo)
13401 tg cnt e c char c1 c2 ntable tbl rtn
13402 ov-start ov-end ov-prefix
13403 (exit-after-next org-fast-tag-selection-single-key)
13404 (done-keywords org-done-keywords)
13405 groups ingroup)
13406 (save-excursion
13407 (beginning-of-line 1)
13408 (if (looking-at
13410 (setq ov-start (match-beginning 1)
13411 ov-end (match-end 1)
13412 ov-prefix "")
13413 (setq ov-start (1- (point-at-eol))
13414 ov-end (1+ ov-start))
13416 (setq ov-prefix
13417 (concat
13418 (buffer-substring (1- (point)) (point))
13419 (if (> (current-column) org-tags-column)
13420 " "
13421 (make-string (- org-tags-column (current-column)) ?\ ))))))
13422 (move-overlay org-tags-overlay ov-start ov-end)
13423 (save-window-excursion
13424 (if expert
13425 (set-buffer (get-buffer-create " *Org tags*"))
13426 (delete-other-windows)
13427 (split-window-vertically)
13428 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13429 (erase-buffer)
13430 (org-set-local 'org-done-keywords done-keywords)
13433 (org-fast-tag-show-exit exit-after-next)
13434 (org-set-current-tags-overlay current ov-prefix)
13435 (setq tbl fulltable char ?a cnt 0)
13436 (while (setq e (pop tbl))
13437 (cond
13438 ((equal (car e) :startgroup)
13439 (push '() groups) (setq ingroup t)
13440 (when (not (= cnt 0))
13441 (setq cnt 0)
13443 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13444 ((equal (car e) :endgroup)
13445 (setq ingroup nil cnt 0)
13447 ((equal e '(:newline))
13448 (when (not (= cnt 0))
13449 (setq cnt 0)
13451 (setq e (car tbl))
13452 (while (equal (car tbl) '(:newline))
13454 (setq tbl (cdr tbl)))))
13455 (t
13456 (setq tg (copy-sequence (car e)) c2 nil)
13457 (if (cdr e)
13458 (setq c (cdr e))
13459 ;; automatically assign a character.
13460 (setq c1 (string-to-char
13461 (downcase (substring
13462 tg (if (= (string-to-char tg) ?@) 1 0)))))
13463 (if (or (rassoc c1 ntable) (rassoc c1 table))
13464 (while (or (rassoc char ntable) (rassoc char table))
13465 (setq char (1+ char)))
13466 (setq c2 c1))
13467 (setq c (or c2 char)))
13468 (if ingroup (push tg (car groups)))
13469 (setq tg (org-add-props tg nil 'face
13470 (cond
13471 ((not (assoc tg table))
13472 (org-get-todo-face tg))
13473 ((member tg current) c-face)
13474 ((member tg inherited) i-face)
13475 (t nil))))
13476 (if (and (= cnt 0) (not ingroup)) (insert " "))
13477 (insert "[" c "] " tg (make-string
13478 (- fwidth 4 (length tg)) ?\ ))
13479 (push (cons tg c) ntable)
13480 (when (= (setq cnt (1+ cnt)) ncol)
13482 (if ingroup (insert " "))
13483 (setq cnt 0)))))
13484 (setq ntable (nreverse ntable))
13486 (goto-char (point-min))
13487 (if (not expert) (org-fit-window-to-buffer))
13488 (setq rtn
13489 (catch 'exit
13490 (while t
13491 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13492 (if (not groups) "no " "")
13493 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13494 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13495 (setq org-last-tag-selection-key c)
13496 (cond
13498 ((= c ?!)
13499 (setq groups (not groups))
13500 (goto-char (point-min))
13501 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13502 ((= c ?\C-c)
13503 (if (not expert)
13504 (org-fast-tag-show-exit
13505 (setq exit-after-next (not exit-after-next)))
13506 (setq expert nil)
13507 (delete-other-windows)
13508 (set-window-buffer (split-window-vertically) " *Org tags*")
13509 (org-switch-to-buffer-other-window " *Org tags*")
13510 (org-fit-window-to-buffer)))
13511 ((or (= c ?\C-g)
13512 (and (= c ?q) (not (rassoc c ntable))))
13513 (org-detach-overlay org-tags-overlay)
13514 (setq quit-flag t))
13515 ((= c ?\ )
13516 (setq current nil)
13517 (if exit-after-next (setq exit-after-next 'now)))
13519 (condition-case nil
13520 (setq tg (org-icompleting-read
13521 "Tag: "
13522 (or buffer-tags
13523 (with-current-buffer buf
13524 (org-get-buffer-tags)))))
13525 (quit (setq tg "")))
13527 (add-to-list 'buffer-tags (list tg))
13528 (if (member tg current)
13529 (setq current (delete tg current))
13530 (push tg current)))
13531 (if exit-after-next (setq exit-after-next 'now)))
13532 ((setq e (rassoc c todo-table) tg (car e))
13533 (with-current-buffer buf
13534 (save-excursion (org-todo tg)))
13535 (if exit-after-next (setq exit-after-next 'now)))
13536 ((setq e (rassoc c ntable) tg (car e))
13537 (if (member tg current)
13538 (setq current (delete tg current))
13539 (loop for g in groups do
13540 (if (member tg g)
13541 (mapc (lambda (x)
13542 (setq current (delete x current)))
13543 g)))
13544 (push tg current))
13545 (if exit-after-next (setq exit-after-next 'now))))
13547 ;; Create a sorted list
13548 (setq current
13549 (sort current
13550 (lambda (a b)
13551 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13552 (if (eq exit-after-next 'now) (throw 'exit t))
13553 (goto-char (point-min))
13554 (beginning-of-line 2)
13555 (delete-region (point) (point-at-eol))
13556 (org-fast-tag-insert "Current" current c-face)
13557 (org-set-current-tags-overlay current ov-prefix)
13558 (while (re-search-forward
13560 (setq tg (match-string 1))
13561 (add-text-properties
13562 (match-beginning 1) (match-end 1)
13563 (list 'face
13564 (cond
13565 ((member tg current) c-face)
13566 ((member tg inherited) i-face)
13567 (t (get-text-property (match-beginning 1) 'face))))))
13568 (goto-char (point-min)))))
13569 (org-detach-overlay org-tags-overlay)
13570 (if rtn
13571 (mapconcat 'identity current ":")
13572 nil))))
13574 (defun org-get-tags-string ()
13575 "Get the TAGS string in the current headline."
13576 (unless (org-on-heading-p t)
13577 (error "Not on a heading"))
13578 (save-excursion
13579 (beginning-of-line 1)
13581 (org-match-string-no-properties 1)
13582 "")))
13584 (defun org-get-tags ()
13585 "Get the list of tags specified in the current headline."
13586 (org-split-string (org-get-tags-string) ":"))
13588 (defun org-get-buffer-tags ()
13589 "Get a table of all tags used in the buffer, for completion."
13590 (let (tags)
13591 (save-excursion
13592 (goto-char (point-min))
13593 (while (re-search-forward
13595 (when (equal (char-after (point-at-bol 0)) ?*)
13596 (mapc (lambda (x) (add-to-list 'tags x))
13597 (org-split-string (org-match-string-no-properties 1) ":")))))
13598 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13599 (mapcar 'list tags)))
13601 ;;;; The mapping API
13603 ;;;###autoload
13604 (defun org-map-entries (func &optional match scope &rest skip)
13605 "Call FUNC at each headline selected by MATCH in SCOPE.
13607 FUNC is a function or a lisp form. The function will be called without
13608 arguments, with the cursor positioned at the beginning of the headline.
13609 The return values of all calls to the function will be collected and
13610 returned as a list.
13612 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13613 does not need to preserve point. After evaluation, the cursor will be
13614 moved to the end of the line (presumably of the headline of the
13615 processed entry) and search continues from there. Under some
13616 circumstances, this may not produce the wanted results. For example,
13617 if you have removed (e.g. archived) the current (sub)tree it could
13618 mean that the next entry will be skipped entirely. In such cases, you
13619 can specify the position from where search should continue by making
13620 FUNC set the variable `org-map-continue-from' to the desired buffer
13621 position.
13623 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13624 Only headlines that are matched by this query will be considered during
13625 the iteration. When MATCH is nil or t, all headlines will be
13626 visited by the iteration.
13628 SCOPE determines the scope of this command. It can be any of:
13630 nil The current buffer, respecting the restriction if any
13631 tree The subtree started with the entry at point
13632 region The entries within the active region, if any
13633 file The current buffer, without restriction
13634 file-with-archives
13635 The current buffer, and any archives associated with it
13636 agenda All agenda files
13637 agenda-with-archives
13638 All agenda files with any archive files associated with them
13639 \(file1 file2 ...)
13640 If this is a list, all files in the list will be scanned
13642 The remaining args are treated as settings for the skipping facilities of
13643 the scanner. The following items can be given here:
13645 archive skip trees with the archive tag.
13646 comment skip trees with the COMMENT keyword
13647 function or Emacs Lisp form:
13648 will be used as value for `org-agenda-skip-function', so whenever
13649 the function returns t, FUNC will not be called for that
13650 entry and search will continue from the point where the
13651 function leaves it.
13653 If your function needs to retrieve the tags including inherited tags
13654 at the *current* entry, you can use the value of the variable
13655 `org-scanner-tags' which will be much faster than getting the value
13656 with `org-get-tags-at'. If your function gets properties with
13657 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13658 to t around the call to `org-entry-properties' to get the same speedup.
13659 Note that if your function moves around to retrieve tags and properties at
13660 a *different* entry, you cannot use these techniques."
13661 (let* ((org-agenda-archives-mode nil) ; just to make sure
13662 (org-agenda-skip-archived-trees (memq 'archive skip))
13663 (org-agenda-skip-comment-trees (memq 'comment skip))
13664 (org-agenda-skip-function
13665 (car (org-delete-all '(comment archive) skip)))
13666 (org-tags-match-list-sublevels t)
13667 matcher file res
13668 org-todo-keywords-for-agenda
13669 org-done-keywords-for-agenda
13670 org-todo-keyword-alist-for-agenda
13671 org-drawers-for-agenda
13672 org-tag-alist-for-agenda)
13674 (cond
13675 ((eq match t) (setq matcher t))
13676 ((eq match nil) (setq matcher t))
13677 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13679 (save-excursion
13680 (save-restriction
13681 (cond ((eq scope 'tree)
13682 (org-back-to-heading t)
13683 (org-narrow-to-subtree)
13684 (setq scope nil))
13685 ((and (eq scope 'region) (org-region-active-p))
13686 (narrow-to-region (region-beginning) (region-end))
13687 (setq scope nil)))
13689 (if (not scope)
13690 (progn
13691 (org-prepare-agenda-buffers
13692 (list (buffer-file-name (current-buffer))))
13693 (setq res (org-scan-tags func matcher)))
13694 ;; Get the right scope
13695 (cond
13696 ((and scope (listp scope) (symbolp (car scope)))
13697 (setq scope (eval scope)))
13698 ((eq scope 'agenda)
13699 (setq scope (org-agenda-files t)))
13700 ((eq scope 'agenda-with-archives)
13701 (setq scope (org-agenda-files t))
13702 (setq scope (org-add-archive-files scope)))
13703 ((eq scope 'file)
13704 (setq scope (list (buffer-file-name))))
13705 ((eq scope 'file-with-archives)
13706 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13707 (org-prepare-agenda-buffers scope)
13708 (while (setq file (pop scope))
13709 (with-current-buffer (org-find-base-buffer-visiting file)
13710 (save-excursion
13711 (save-restriction
13712 (widen)
13713 (goto-char (point-min))
13714 (setq res (append res (org-scan-tags func matcher))))))))))
13715 res))
13717 ;;;; Properties
13719 ;;; Setting and retrieving properties
13721 (defconst org-special-properties
13722 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13723 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13724 "The special properties valid in Org-mode.
13726 These are properties that are not defined in the property drawer,
13727 but in some other way.")
13729 (defconst org-default-properties
13730 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13731 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13732 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13733 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13734 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13735 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13736 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13737 "Some properties that are used by Org-mode for various purposes.
13738 Being in this list makes sure that they are offered for completion.")
13741 "Regular expression matching the first line of a property drawer.")
13744 "Regular expression matching the last line of a property drawer.")
13747 "Regular expression matching the first line of a property drawer.")
13750 "Regular expression matching the first line of a property drawer.")
13752 (defconst org-property-drawer-re
13755 "Matches an entire property drawer.")
13757 (defconst org-clock-drawer-re
13760 "Matches an entire clock drawer.")
13762 (defsubst org-re-property (property)
13763 "Return a regexp matching PROPERTY.
13764 Match group 1 will be set to the value "
13767 (defun org-property-action ()
13768 "Do an action on properties."
13769 (interactive)
13770 (let (c)
13771 (org-at-property-p)
13772 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13773 (setq c (read-char-exclusive))
13774 (cond
13775 ((equal c ?s)
13776 (call-interactively 'org-set-property))
13777 ((equal c ?d)
13778 (call-interactively 'org-delete-property))
13779 ((equal c ?D)
13780 (call-interactively 'org-delete-property-globally))
13781 ((equal c ?c)
13782 (call-interactively 'org-compute-property-at-point))
13783 (t (error "No such property action %c" c)))))
13785 (defun org-set-effort (&optional value)
13786 "Set the effort property of the current entry.
13787 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13788 allowed value."
13789 (interactive "P")
13790 (if (equal value 0) (setq value 10))
13791 (let* ((completion-ignore-case t)
13792 (prop org-effort-property)
13793 (cur (org-entry-get nil prop))
13794 (allowed (org-property-get-allowed-values nil prop 'table))
13795 (existing (mapcar 'list (org-property-values prop)))
13796 rpl
13797 (val (cond
13798 ((stringp value) value)
13799 ((and allowed (integerp value))
13800 (or (car (nth (1- value) allowed))
13801 (car (org-last allowed))))
13802 (allowed
13803 (message "Select 1-9,0, [RET%s]: %s"
13804 (if cur (concat "=" cur) "")
13805 (mapconcat 'car allowed " "))
13806 (setq rpl (read-char-exclusive))
13808 cur
13809 (setq rpl (- rpl ?0))
13810 (if (equal rpl 0) (setq rpl 10))
13811 (if (and (> rpl 0) (<= rpl (length allowed)))
13812 (car (nth (1- rpl) allowed))
13813 (org-completing-read "Effort: " allowed nil))))
13814 (t
13815 (let (org-completion-use-ido org-completion-use-iswitchb)
13816 (org-completing-read
13818 (concat "[" cur "]") "")
13819 ": ")
13820 existing nil nil "" nil cur))))))
13821 (unless (equal (org-entry-get nil prop) val)
13822 (org-entry-put nil prop val))
13823 (message "%s is now %s" prop val)))
13825 (defun org-at-property-p ()
13826 "Is cursor inside a property drawer?"
13827 (save-excursion
13828 (beginning-of-line 1)
13830 (save-match-data ;; Used by calling procedures
13831 (let ((p (point))
13832 (range (unless (org-before-first-heading-p)
13833 (org-get-property-block))))
13834 (and range (<= (car range) p) (< p (cdr range))))))))
13836 (defun org-get-property-block (&optional beg end force)
13837 "Return the (beg . end) range of the body of the property drawer.
13838 BEG and END can be beginning and end of subtree, if not given
13839 they will be found.
13840 If the drawer does not exist and FORCE is non-nil, create the drawer."
13841 (catch 'exit
13842 (save-excursion
13843 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13844 (end (or end (progn (outline-next-heading) (point)))))
13845 (goto-char beg)
13846 (if (re-search-forward org-property-start-re end t)
13847 (setq beg (1+ (match-end 0)))
13848 (if force
13849 (save-excursion
13850 (org-insert-property-drawer)
13851 (setq end (progn (outline-next-heading) (point))))
13852 (throw 'exit nil))
13853 (goto-char beg)
13854 (if (re-search-forward org-property-start-re end t)
13855 (setq beg (1+ (match-end 0)))))
13856 (if (re-search-forward org-property-end-re end t)
13857 (setq end (match-beginning 0))
13858 (or force (throw 'exit nil))
13859 (goto-char beg)
13860 (setq end beg)
13861 (org-indent-line-function)
13863 (cons beg end)))))
13865 (defun org-entry-properties (&optional pom which specific)
13866 "Get all properties of the entry at point-or-marker POM.
13867 This includes the TODO keyword, the tags, time strings for deadline,
13868 scheduled, and clocking, and any additional properties defined in the
13869 entry. The return value is an alist, keys may occur multiple times
13870 if the property key was used several times.
13871 POM may also be nil, in which case the current entry is used.
13872 If WHICH is nil or `all', get all properties. If WHICH is
13873 `special' or `standard', only get that subclass. If WHICH
13874 is a string only get exactly this property. SPECIFIC can be a string, the
13875 specific property we are interested in. Specifying it can speed
13876 things up because then unnecessary parsing is avoided."
13877 (setq which (or which 'all))
13878 (org-with-point-at pom
13879 (let ((clockstr (substring org-clock-string 0 -1))
13880 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13881 (case-fold-search nil)
13882 beg end range props sum-props key key1 value string clocksum)
13883 (save-excursion
13884 (when (condition-case nil
13885 (and (eq major-mode 'org-mode) (org-back-to-heading t))
13886 (error nil))
13887 (setq beg (point))
13888 (setq sum-props (get-text-property (point) 'org-summaries))
13889 (setq clocksum (get-text-property (point) :org-clock-minutes))
13890 (outline-next-heading)
13891 (setq end (point))
13892 (when (memq which '(all special))
13893 ;; Get the special properties, like TODO and tags
13894 (goto-char beg)
13895 (when (and (or (not specific) (string= specific "TODO"))
13896 (looking-at org-todo-line-regexp) (match-end 2))
13897 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13898 (when (and (or (not specific) (string= specific "PRIORITY"))
13899 (looking-at org-priority-regexp))
13900 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13901 (when (or (not specific) (string= specific "FILE"))
13902 (push (cons "FILE" buffer-file-name) props))
13903 (when (and (or (not specific) (string= specific "TAGS"))
13904 (setq value (org-get-tags-string))
13906 (push (cons "TAGS" value) props))
13907 (when (and (or (not specific) (string= specific "ALLTAGS"))
13908 (setq value (org-get-tags-at)))
13909 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13910 ":"))
13911 props))
13912 (when (or (not specific) (string= specific "BLOCKED"))
13913 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13914 (when (or (not specific)
13915 (member specific
13916 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13917 "TIMESTAMP" "TIMESTAMP_IA")))
13918 (catch 'match
13919 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13920 (setq key (if (match-end 1)
13921 (substring (org-match-string-no-properties 1)
13922 0 -1))
13923 string (if (equal key clockstr)
13924 (org-no-properties
13925 (org-trim
13926 (buffer-substring
13927 (match-beginning 3) (goto-char
13928 (point-at-eol)))))
13929 (substring (org-match-string-no-properties 3)
13930 1 -1)))
13931 ;; Get the correct property name from the key. This is
13932 ;; necessary if the user has configured time keywords.
13933 (setq key1 (concat key ":"))
13934 (cond
13935 ((not key)
13936 (setq key
13937 (if (= (char-after (match-beginning 3)) ?\[)
13938 "TIMESTAMP_IA" "TIMESTAMP")))
13939 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13940 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13941 ((equal key1 org-closed-string) (setq key "CLOSED"))
13942 ((equal key1 org-clock-string) (setq key "CLOCK")))
13943 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13944 (progn
13945 (push (cons key string) props)
13946 ;; no need to search further if match is found
13947 (throw 'match t))
13948 (when (or (equal key "CLOCK") (not (assoc key props)))
13949 (push (cons key string) props))))))
13950 )
13952 (when (memq which '(all standard))
13953 ;; Get the standard properties, like :PROP: ...
13954 (setq range (org-get-property-block beg end))
13955 (when range
13956 (goto-char (car range))
13957 (while (re-search-forward
13959 (cdr range) t)
13960 (setq key (org-match-string-no-properties 1)
13961 value (org-trim (or (org-match-string-no-properties 2) "")))
13962 (unless (member key excluded)
13963 (push (cons key (or value "")) props)))))
13964 (if clocksum
13965 (push (cons "CLOCKSUM"
13966 (org-columns-number-to-string (/ (float clocksum) 60.)
13967 'add_times))
13968 props))
13969 (unless (assoc "CATEGORY" props)
13970 (push (cons "CATEGORY" (org-get-category)) props))
13971 (append sum-props (nreverse props)))))))
13973 (defun org-entry-get (pom property &optional inherit literal-nil)
13974 "Get value of PROPERTY for entry at point-or-marker POM.
13975 If INHERIT is non-nil and the entry does not have the property,
13976 then also check higher levels of the hierarchy.
13977 If INHERIT is the symbol `selective', use inheritance only if the setting
13978 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13979 If the property is present but empty, the return value is the empty string.
13980 If the property is not present at all, nil is returned.
13983 do not interpret it as the list atom nil. This is used for inheritance
13985 (org-with-point-at pom
13986 (if (and inherit (if (eq inherit 'selective)
13987 (org-property-inherit-p property)
13988 t))
13989 (org-entry-get-with-inheritance property literal-nil)
13990 (if (member property org-special-properties)
13991 ;; We need a special property. Use `org-entry-properties' to
13992 ;; retrieve it, but specify the wanted property
13993 (cdr (assoc property (org-entry-properties nil 'special property)))
13994 (let ((range (unless (org-before-first-heading-p)
13995 (org-get-property-block))))
13996 (if (and range
13997 (goto-char (car range))
13998 (re-search-forward
13999 (org-re-property property)
14000 (cdr range) t))
14001 ;; Found the property, return it.
14002 (if (match-end 1)
14003 (if literal-nil
14004 (org-match-string-no-properties 1)
14005 (org-not-nil (org-match-string-no-properties 1)))
14006 "")))))))
14008 (defun org-property-or-variable-value (var &optional inherit)
14009 "Check if there is a property fixing the value of VAR.
14010 If yes, return this value. If not, return the current value of the variable."
14011 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14013 (read prop)
14014 (symbol-value var))))
14016 (defun org-entry-delete (pom property)
14017 "Delete the property PROPERTY from entry at point-or-marker POM."
14018 (org-with-point-at pom
14019 (if (member property org-special-properties)
14020 nil ; cannot delete these properties.
14021 (let ((range (org-get-property-block)))
14022 (if (and range
14023 (goto-char (car range))
14024 (re-search-forward
14025 (org-re-property property)
14026 (cdr range) t))
14027 (progn
14028 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14029 t)
14030 nil)))))
14032 ;; Multi-values properties are properties that contain multiple values
14033 ;; These values are assumed to be single words, separated by whitespace.
14034 (defun org-entry-add-to-multivalued-property (pom property value)
14035 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14036 (let* ((old (org-entry-get pom property))
14038 (setq value (org-entry-protect-space value))
14039 (unless (member value values)
14040 (setq values (cons value values))
14041 (org-entry-put pom property
14042 (mapconcat 'identity values " ")))))
14044 (defun org-entry-remove-from-multivalued-property (pom property value)
14045 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14046 (let* ((old (org-entry-get pom property))
14048 (setq value (org-entry-protect-space value))
14049 (when (member value values)
14050 (setq values (delete value values))
14051 (org-entry-put pom property
14052 (mapconcat 'identity values " ")))))
14054 (defun org-entry-member-in-multivalued-property (pom property value)
14055 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14056 (let* ((old (org-entry-get pom property))
14058 (setq value (org-entry-protect-space value))
14059 (member value values)))
14061 (defun org-entry-get-multivalued-property (pom property)
14062 "Return a list of values in a multivalued property."
14063 (let* ((value (org-entry-get pom property))
14065 (mapcar 'org-entry-restore-space values)))
14067 (defun org-entry-put-multivalued-property (pom property &rest values)
14068 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14069 VALUES should be a list of strings. Spaces will be protected."
14070 (org-entry-put pom property
14071 (mapconcat 'org-entry-protect-space values " "))
14072 (let* ((value (org-entry-get pom property))
14074 (mapcar 'org-entry-restore-space values)))
14076 (defun org-entry-protect-space (s)
14077 "Protect spaces and newline in string S."
14078 (while (string-match " " s)
14079 (setq s (replace-match "%20" t t s)))
14081 (setq s (replace-match "%0A" t t s)))
14082 s)
14084 (defun org-entry-restore-space (s)
14085 "Restore spaces and newline in string S."
14086 (while (string-match "%20" s)
14087 (setq s (replace-match " " t t s)))
14088 (while (string-match "%0A" s)
14090 s)
14092 (defvar org-entry-property-inherited-from (make-marker)
14093 "Marker pointing to the entry from where a property was inherited.
14094 Each call to `org-entry-get-with-inheritance' will set this marker to the
14095 location of the entry where the inheritance search matched. If there was
14096 no match, the marker will point nowhere.
14097 Note that also `org-entry-get' calls this function, if the INHERIT flag
14098 is set.")
14100 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14101 "Get entry property, and search higher levels if not present.
14102 The search will stop at the first ancestor which has the property defined.
14104 should be considered as undefined (this is the meaning of nil here).
14106 (move-marker org-entry-property-inherited-from nil)
14107 (let (tmp)
14108 (unless (org-before-first-heading-p)
14109 (save-excursion
14110 (save-restriction
14111 (widen)
14112 (catch 'ex
14113 (while t
14114 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14115 (org-back-to-heading t)
14116 (move-marker org-entry-property-inherited-from (point))
14117 (throw 'ex tmp))
14118 (or (org-up-heading-safe) (throw 'ex nil)))))))
14119 (setq tmp (or tmp
14120 (cdr (assoc property org-file-properties))
14121 (cdr (assoc property org-global-properties))
14122 (cdr (assoc property org-global-properties-fixed))))
14123 (if literal-nil tmp (org-not-nil tmp))))
14125 (defvar org-property-changed-functions nil
14126 "Hook called when the value of a property has changed.
14127 Each hook function should accept two arguments, the name of the property
14128 and the new value.")
14130 (defun org-entry-put (pom property value)
14131 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14132 (org-with-point-at pom
14133 (org-back-to-heading t)
14134 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14135 range)
14136 (cond
14137 ((equal property "TODO")
14139 (not (member value org-todo-keywords-1)))
14141 (if (or (not value)
14143 (setq value 'none))
14144 (org-todo value)
14145 (org-set-tags nil 'align))
14146 ((equal property "PRIORITY")
14148 (string-to-char value) ?\ ))
14149 (org-set-tags nil 'align))
14150 ((equal property "SCHEDULED")
14151 (if (re-search-forward org-scheduled-time-regexp end t)
14152 (cond
14153 ((eq value 'earlier) (org-timestamp-change -1 'day))
14154 ((eq value 'later) (org-timestamp-change 1 'day))
14155 (t (call-interactively 'org-schedule)))
14156 (call-interactively 'org-schedule)))
14157 ((equal property "DEADLINE")
14158 (if (re-search-forward org-deadline-time-regexp end t)
14159 (cond
14160 ((eq value 'earlier) (org-timestamp-change -1 'day))
14161 ((eq value 'later) (org-timestamp-change 1 'day))
14162 (t (call-interactively 'org-deadline)))
14163 (call-interactively 'org-deadline)))
14164 ((member property org-special-properties)
14165 (error "The %s property can not yet be set with `org-entry-put'"
14166 property))
14167 (t ; a non-special property
14168 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14169 (setq range (org-get-property-block beg end 'force))
14170 (goto-char (car range))
14171 (if (re-search-forward
14172 (org-re-property property) (cdr range) t)
14173 (progn
14174 (delete-region (match-beginning 0) (match-end 0))
14175 (goto-char (match-beginning 0)))
14176 (goto-char (cdr range))
14178 (backward-char 1)
14179 (org-indent-line-function))
14180 (insert ":" property ":")
14181 (and value (insert " " value))
14182 (org-indent-line-function)))))
14183 (run-hook-with-args 'org-property-changed-functions property value)))
14185 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14186 "Get all property keys in the current buffer.
14187 With INCLUDE-SPECIALS, also list the special properties that reflect things
14188 like tags and TODO state.
14189 With INCLUDE-DEFAULTS, also include properties that has special meaning
14190 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14191 and others.
14192 With INCLUDE-COLUMNS, also include property names given in COLUMN
14193 formats in the current buffer."
14194 (let (rtn range cfmt s p)
14195 (save-excursion
14196 (save-restriction
14197 (widen)
14198 (goto-char (point-min))
14199 (while (re-search-forward org-property-start-re nil t)
14200 (setq range (org-get-property-block))
14201 (goto-char (car range))
14202 (while (re-search-forward
14204 (cdr range) t)
14205 (add-to-list 'rtn (org-match-string-no-properties 1)))
14206 (outline-next-heading))))
14208 (when include-specials
14209 (setq rtn (append org-special-properties rtn)))
14211 (when include-defaults
14212 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14213 (add-to-list 'rtn org-effort-property))
14215 (when include-columns
14216 (save-excursion
14217 (save-restriction
14218 (widen)
14219 (goto-char (point-min))
14220 (while (re-search-forward
14222 nil t)
14223 (setq cfmt (match-string 2) s 0)
14225 cfmt s)
14226 (setq s (match-end 0)
14227 p (match-string 1 cfmt))
14228 (unless (or (equal p "ITEM")
14229 (member p org-special-properties))
14230 (add-to-list 'rtn (match-string 1 cfmt))))))))
14232 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14234 (defun org-property-values (key)
14235 "Return a list of all values of property KEY in the current buffer."
14236 (save-excursion
14237 (save-restriction
14238 (widen)
14239 (goto-char (point-min))
14240 (let ((re (org-re-property key))
14241 values)
14242 (while (re-search-forward re nil t)
14243 (add-to-list 'values (org-trim (match-string 1))))
14244 (delete "" values)))))
14246 (defun org-insert-property-drawer ()
14247 "Insert a property drawer into the current entry."
14248 (interactive)
14249 (org-back-to-heading t)
14250 (looking-at org-outline-regexp)
14251 (let ((indent (if org-adapt-indentation
14252 (- (match-end 0)(match-beginning 0))
14253 0))
14254 (beg (point))
14256 end hiddenp)
14257 (outline-next-heading)
14258 (setq end (point))
14259 (goto-char beg)
14260 (while (re-search-forward re end t))
14261 (setq hiddenp (outline-invisible-p))
14262 (end-of-line 1)
14265 (if (member (match-string 1) '("CLOCK:" ":END:"))
14266 ;; just skip this line
14267 (beginning-of-line 2)
14268 ;; Drawer start, find the end
14270 (beginning-of-line 1)))
14271 (org-skip-over-state-notes)
14273 (if (eq (char-before) ?*) (forward-char 1))
14275 (beginning-of-line 0)
14276 (org-indent-to-column indent)
14277 (beginning-of-line 2)
14278 (org-indent-to-column indent)
14279 (beginning-of-line 0)
14280 (if hiddenp
14281 (save-excursion
14282 (org-back-to-heading t)
14283 (hide-entry))
14284 (org-flag-drawer t))))
14286 (defvar org-property-set-functions-alist nil
14287 "Property set function alist.
14288 Each entry should have the following format:
14290 (PROPERTY . READ-FUNCTION)
14292 The read function will be called with the same argument as
14293 `org-completing-read'.")
14295 (defun org-set-property-function (property)
14296 "Get the function that should be used to set PROPERTY.
14297 This is computed according to `org-property-set-functions-alist'."
14298 (or (cdr (assoc property org-property-set-functions-alist))
14299 'org-completing-read))
14301 (defun org-read-property-value (property)
14302 "Read PROPERTY value from user."
14303 (let* ((completion-ignore-case t)
14304 (allowed (org-property-get-allowed-values nil property 'table))
14305 (cur (org-entry-get nil property))
14306 (prompt (concat property " value"
14308 (concat " [" cur "]") "") ": "))
14309 (set-function (org-set-property-function property))
14310 (val (if allowed
14311 (funcall set-function prompt allowed nil
14312 (not (get-text-property 0 'org-unrestricted
14313 (caar allowed))))
14314 (let (org-completion-use-ido org-completion-use-iswitchb)
14315 (funcall set-function prompt
14316 (mapcar 'list (org-property-values property))
14317 nil nil "" nil cur)))))
14318 (if (equal val "")
14319 cur
14320 val)))
14322 (defvar org-last-set-property nil)
14323 (defun org-read-property-name ()
14324 "Read a property name."
14325 (let* ((completion-ignore-case t)
14326 (keys (org-buffer-property-keys nil t t))
14327 (default-prop (or (save-excursion
14328 (save-match-data
14329 (beginning-of-line)
14331 (null (string= (match-string 1) "END"))
14332 (match-string 1))))
14333 org-last-set-property))
14334 (property (org-icompleting-read
14335 (concat "Property"
14336 (if default-prop (concat " [" default-prop "]") "")
14337 ": ")
14338 (mapcar 'list keys)
14339 nil nil nil nil
14340 default-prop
14341 )))
14342 (if (member property keys)
14343 property
14344 (or (cdr (assoc (downcase property)
14345 (mapcar (lambda (x) (cons (downcase x) x))
14346 keys)))
14347 property))))
14349 (defun org-set-property (property value)
14350 "In the current entry, set PROPERTY to VALUE.
14351 When called interactively, this will prompt for a property name, offering
14352 completion on existing and default properties. And then it will prompt
14353 for a value, offering completion either on allowed values (via an inherited
14354 xxx_ALL property) or on existing values in other instances of this property
14355 in the current file."
14356 (interactive (list nil nil))
14357 (let* ((property (or property (org-read-property-name)))
14358 (value (or value (org-read-property-value property)))
14359 (fn (assoc property org-properties-postprocess-alist)))
14360 (setq org-last-set-property property)
14361 ;; Possibly postprocess the inserted value:
14362 (when fn (setq value (funcall (cadr fn) value)))
14363 (unless (equal (org-entry-get nil property) value)
14364 (org-entry-put nil property value))))
14366 (defun org-delete-property (property)
14367 "In the current entry, delete PROPERTY."
14368 (interactive
14369 (let* ((completion-ignore-case t)
14370 (prop (org-icompleting-read "Property: "
14371 (org-entry-properties nil 'standard))))
14372 (list prop)))
14373 (message "Property %s %s" property
14374 (if (org-entry-delete nil property)
14375 "deleted"
14376 "was not present in the entry")))
14378 (defun org-delete-property-globally (property)
14379 "Remove PROPERTY globally, from all entries."
14380 (interactive
14381 (let* ((completion-ignore-case t)
14382 (prop (org-icompleting-read
14383 "Globally remove property: "
14384 (mapcar 'list (org-buffer-property-keys)))))
14385 (list prop)))
14386 (save-excursion
14387 (save-restriction
14388 (widen)
14389 (goto-char (point-min))
14390 (let ((cnt 0))
14391 (while (re-search-forward
14392 (org-re-property property)
14393 nil t)
14394 (setq cnt (1+ cnt))
14395 (replace-match ""))
14398 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14400 (defun org-compute-property-at-point ()
14401 "Compute the property at point.
14402 This looks for an enclosing column format, extracts the operator and
14403 then applies it to the property in the column format's scope."
14404 (interactive)
14405 (unless (org-at-property-p)
14406 (error "Not at a property"))
14407 (let ((prop (org-match-string-no-properties 2)))
14408 (org-columns-get-format-and-top-level)
14409 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14410 (error "No operator defined for property %s" prop))
14411 (org-columns-compute prop)))
14413 (defvar org-property-allowed-value-functions nil
14414 "Hook for functions supplying allowed values for a specific property.
14415 The functions must take a single argument, the name of the property, and
14417 the values, this means that these values are intended as defaults for
14418 completion, but that other values should be allowed too.
14419 The functions must return nil if they are not responsible for this
14420 property.")
14422 (defun org-property-get-allowed-values (pom property &optional table)
14423 "Get allowed values for the property PROPERTY.
14424 When TABLE is non-nil, return an alist that can directly be used for
14425 completion."
14426 (let (vals)
14427 (cond
14428 ((equal property "TODO")
14429 (setq vals (org-with-point-at pom
14430 (append org-todo-keywords-1 '("")))))
14431 ((equal property "PRIORITY")
14432 (let ((n org-lowest-priority))
14433 (while (>= n org-highest-priority)
14434 (push (char-to-string n) vals)
14435 (setq n (1- n)))))
14436 ((member property org-special-properties))
14437 ((setq vals (run-hook-with-args-until-success
14438 'org-property-allowed-value-functions property)))
14439 (t
14440 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14442 (setq vals (car (read-from-string (concat "(" vals ")"))))
14443 (setq vals (mapcar (lambda (x)
14444 (cond ((stringp x) x)
14445 ((numberp x) (number-to-string x))
14446 ((symbolp x) (symbol-name x))
14447 (t "???")))
14448 vals)))))
14449 (when (member ":ETC" vals)
14450 (setq vals (remove ":ETC" vals))
14451 (org-add-props (car vals) '(org-unrestricted t)))
14452 (if table (mapcar 'list vals) vals)))
14454 (defun org-property-previous-allowed-value (&optional previous)
14455 "Switch to the next allowed value for this property."
14456 (interactive)
14457 (org-property-next-allowed-value t))
14459 (defun org-property-next-allowed-value (&optional previous)
14460 "Switch to the next allowed value for this property."
14461 (interactive)
14462 (unless (org-at-property-p)
14463 (error "Not at a property"))
14464 (let* ((key (match-string 2))
14465 (value (match-string 3))
14466 (allowed (or (org-property-get-allowed-values (point) key)
14467 (and (member value '("[ ]" "[-]" "[X]"))
14468 '("[ ]" "[X]"))))
14469 nval)
14470 (unless allowed
14471 (error "Allowed values for this property have not been defined"))
14472 (if previous (setq allowed (reverse allowed)))
14473 (if (member value allowed)
14474 (setq nval (car (cdr (member value allowed)))))
14475 (setq nval (or nval (car allowed)))
14476 (if (equal nval value)
14477 (error "Only one allowed value for this property"))
14478 (org-at-property-p)
14479 (replace-match (concat " :" key ": " nval) t t)
14480 (org-indent-line-function)
14481 (beginning-of-line 1)
14483 (run-hook-with-args 'org-property-changed-functions key nval)))
14485 (defun org-find-olp (path &optional this-buffer)
14486 "Return a marker pointing to the entry at outline path OLP.
14487 If anything goes wrong, throw an error.
14488 You can wrap this call to catch the error like this:
14490 (condition-case msg
14491 (org-mobile-locate-entry (match-string 4))
14492 (error (nth 1 msg)))
14494 The return value will then be either a string with the error message,
14495 or a marker if everything is OK.
14497 If THIS-BUFFER is set, the outline path does not contain a file,
14498 only headings."
14499 (let* ((file (if this-buffer buffer-file-name (pop path)))
14500 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14501 (level 1)
14502 (lmin 1)
14503 (lmax 1)
14504 limit re end found pos heading cnt flevel)
14505 (unless buffer (error "File not found :%s" file))
14506 (with-current-buffer buffer
14507 (save-excursion
14508 (save-restriction
14509 (widen)
14510 (setq limit (point-max))
14511 (goto-char (point-min))
14512 (while (setq heading (pop path))
14513 (setq re (format org-complex-heading-regexp-format
14514 (regexp-quote heading)))
14515 (setq cnt 0 pos (point))
14516 (while (re-search-forward re end t)
14517 (setq level (- (match-end 1) (match-beginning 1)))
14518 (if (and (>= level lmin) (<= level lmax))
14519 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14520 (when (= cnt 0) (error "Heading not found on level %d: %s"
14521 lmax heading))
14522 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14523 lmax heading))
14524 (goto-char found)
14525 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14526 (setq end (save-excursion (org-end-of-subtree t t))))
14527 (when (org-on-heading-p)
14528 (move-marker (make-marker) (point))))))))
14530 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14531 "Find node HEADING in BUFFER.
14532 Return a marker to the heading if it was found, or nil if not.
14533 If POS-ONLY is set, return just the position instead of a marker.
14535 The heading text must match exact, but it may have a TODO keyword,
14536 a priority cookie and tags in the standard locations."
14537 (with-current-buffer (or buffer (current-buffer))
14538 (save-excursion
14539 (save-restriction
14540 (widen)
14541 (goto-char (point-min))
14542 (let (case-fold-search)
14543 (if (re-search-forward
14544 (format org-complex-heading-regexp-format
14545 (regexp-quote heading)) nil t)
14546 (if pos-only
14547 (match-beginning 0)
14548 (move-marker (make-marker) (match-beginning 0)))))))))
14550 (defun org-find-exact-heading-in-directory (heading &optional dir)
14551 "Find Org node headline HEADING in all .org files in directory DIR.
14552 When the target headline is found, return a marker to this location."
14553 (let ((files (directory-files (or dir default-directory)
14555 file visiting m buffer)
14556 (catch 'found
14557 (while (setq file (pop files))
14558 (message "trying %s" file)
14559 (setq visiting (org-find-base-buffer-visiting file))
14560 (setq buffer (or visiting (find-file-noselect file)))
14561 (setq m (org-find-exact-headline-in-buffer
14562 heading buffer))
14563 (when (and (not m) (not visiting)) (kill-buffer buffer))
14564 (and m (throw 'found m))))))
14566 (defun org-find-entry-with-id (ident)
14567 "Locate the entry that contains the ID property with exact value IDENT.
14568 IDENT can be a string, a symbol or a number, this function will search for
14569 the string representation of it.
14570 Return the position where this entry starts, or nil if there is no such entry."
14571 (interactive "sID: ")
14572 (let ((id (cond
14573 ((stringp ident) ident)
14574 ((symbol-name ident) (symbol-name ident))
14575 ((numberp ident) (number-to-string ident))
14576 (t (error "IDENT %s must be a string, symbol or number" ident))))
14577 (case-fold-search nil))
14578 (save-excursion
14579 (save-restriction
14580 (widen)
14581 (goto-char (point-min))
14582 (when (re-search-forward
14584 nil t)
14585 (org-back-to-heading t)
14586 (point))))))
14588 ;;;; Timestamps
14590 (defvar org-last-changed-timestamp nil)
14591 (defvar org-last-inserted-timestamp nil
14592 "The last time stamp inserted with `org-insert-time-stamp'.")
14593 (defvar org-time-was-given) ; dynamically scoped parameter
14594 (defvar org-end-time-was-given) ; dynamically scoped parameter
14595 (defvar org-ts-what) ; dynamically scoped parameter
14597 (defun org-time-stamp (arg &optional inactive)
14598 "Prompt for a date/time and insert a time stamp.
14599 If the user specifies a time like HH:MM, or if this command is called
14600 with a prefix argument, the time stamp will contain date and time.
14601 Otherwise, only the date will be included. All parts of a date not
14602 specified by the user will be filled in from the current date/time.
14603 So if you press just return without typing anything, the time stamp
14604 will represent the current date/time. If there is already a timestamp
14605 at the cursor, it will be modified."
14606 (interactive "P")
14607 (let* ((ts nil)
14608 (default-time
14609 ;; Default time is either today, or, when entering a range,
14610 ;; the range start.
14611 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14612 (save-excursion
14613 (re-search-backward
14615 (- (point) 20) t)))
14616 (apply 'encode-time (org-parse-time-string (match-string 1)))
14617 (current-time)))
14618 (default-input (and ts (org-get-compact-tod ts)))
14619 (repeater (save-excursion
14620 (save-match-data
14621 (beginning-of-line)
14622 (when (re-search-forward
14624 (save-excursion (progn (end-of-line) (point))) t)
14625 (match-string 0)))))
14626 org-time-was-given org-end-time-was-given time)
14627 (cond
14628 ((and (org-at-timestamp-p t)
14629 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14630 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14631 (insert "--")
14632 (setq time (let ((this-command this-command))
14633 (org-read-date arg 'totime nil nil
14634 default-time default-input)))
14635 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14636 ((org-at-timestamp-p t)
14637 (setq time (let ((this-command this-command))
14638 (org-read-date arg 'totime nil nil default-time default-input)))
14639 (when (org-at-timestamp-p t) ; just to get the match data
14640 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14641 (replace-match "")
14642 (setq org-last-changed-timestamp
14643 (org-insert-time-stamp
14644 time (or org-time-was-given arg)
14645 inactive nil nil (list org-end-time-was-given)))
14646 (when repeater (goto-char (1- (point))) (insert " " repeater)
14647 (setq org-last-changed-timestamp
14648 (concat (substring org-last-inserted-timestamp 0 -1)
14649 " " repeater ">"))))
14650 (message "Timestamp updated"))
14651 (t
14652 (setq time (let ((this-command this-command))
14653 (org-read-date arg 'totime nil nil default-time default-input)))
14654 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14655 nil nil (list org-end-time-was-given))))))
14657 ;; FIXME: can we use this for something else, like computing time differences?
14658 (defun org-get-compact-tod (s)
14659 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14660 (let* ((t1 (match-string 1 s))
14661 (h1 (string-to-number (match-string 2 s)))
14662 (m1 (string-to-number (match-string 3 s)))
14663 (t2 (and (match-end 4) (match-string 5 s)))
14664 (h2 (and t2 (string-to-number (match-string 6 s))))
14665 (m2 (and t2 (string-to-number (match-string 7 s))))
14666 dh dm)
14667 (if (not t2)
14668 t1
14669 (setq dh (- h2 h1) dm (- m2 m1))
14670 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14671 (concat t1 "+" (number-to-string dh)
14672 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14674 (defun org-time-stamp-inactive (&optional arg)
14675 "Insert an inactive time stamp.
14676 An inactive time stamp is enclosed in square brackets instead of angle
14677 brackets. It is inactive in the sense that it does not trigger agenda entries,
14678 does not link to the calendar and cannot be changed with the S-cursor keys.
14679 So these are more for recording a certain time/date."
14680 (interactive "P")
14681 (org-time-stamp arg 'inactive))
14683 (defvar org-date-ovl (make-overlay 1 1))
14684 (overlay-put org-date-ovl 'face 'org-warning)
14685 (org-detach-overlay org-date-ovl)
14687 (defvar org-ans1) ; dynamically scoped parameter
14688 (defvar org-ans2) ; dynamically scoped parameter
14690 (defvar org-plain-time-of-day-regexp) ; defined below
14692 (defvar org-overriding-default-time nil) ; dynamically scoped
14693 (defvar org-read-date-overlay nil)
14694 (defvar org-dcst nil) ; dynamically scoped
14695 (defvar org-read-date-history nil)
14696 (defvar org-read-date-final-answer nil)
14697 (defvar org-read-date-analyze-futurep nil)
14698 (defvar org-read-date-analyze-forced-year nil)
14700 (defun org-read-date (&optional with-time to-time from-string prompt
14701 default-time default-input)
14702 "Read a date, possibly a time, and make things smooth for the user.
14703 The prompt will suggest to enter an ISO date, but you can also enter anything
14704 which will at least partially be understood by `parse-time-string'.
14705 Unrecognized parts of the date will default to the current day, month, year,
14706 hour and minute. If this command is called to replace a timestamp at point,
14707 of to enter the second timestamp of a range, the default time is taken
14708 from the existing stamp. Furthermore, the command prefers the future,
14709 so if you are giving a date where the year is not given, and the day-month
14710 combination is already past in the current year, it will assume you
14711 mean next year. For details, see the manual. A few examples:
14713 3-2-5 --> 2003-02-05
14714 feb 15 --> currentyear-02-15
14715 2/15 --> currentyear-02-15
14716 sep 12 9 --> 2009-09-12
14717 12:45 --> today 12:45
14718 22 sept 0:34 --> currentyear-09-22 0:34
14719 12 --> currentyear-currentmonth-12
14720 Fri --> nearest Friday (today or later)
14721 etc.
14723 Furthermore you can specify a relative date by giving, as the *first* thing
14724 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14725 change in days weeks, months, years.
14726 With a single plus or minus, the date is relative to today. With a double
14727 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14728 +4d --> four days from today
14729 +4 --> same as above
14730 +2w --> two weeks from today
14731 ++5 --> five days from default date
14733 The function understands only English month and weekday abbreviations,
14734 but this can be configured with the variables `parse-time-months' and
14735 `parse-time-weekdays'.
14737 While prompting, a calendar is popped up - you can also select the
14738 date with the mouse (button 1). The calendar shows a period of three
14739 months. To scroll it to other months, use the keys `>' and `<'.
14740 If you don't like the calendar, turn it off with
14741 \(setq org-read-date-popup-calendar nil)
14743 With optional argument TO-TIME, the date will immediately be converted
14744 to an internal time.
14745 With an optional argument WITH-TIME, the prompt will suggest to also
14746 insert a time. Note that when WITH-TIME is not set, you can still
14747 enter a time, and this function will inform the calling routine about
14748 this change. The calling routine may then choose to change the format
14749 used to insert the time stamp into the buffer to include the time.
14750 With optional argument FROM-STRING, read from this string instead from
14751 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14752 the time/date that is used for everything that is not specified by the
14753 user."
14754 (require 'parse-time)
14755 (let* ((org-time-stamp-rounding-minutes
14756 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14757 (org-dcst org-display-custom-times)
14758 (ct (org-current-time))
14759 (def (or org-overriding-default-time default-time ct))
14760 (defdecode (decode-time def))
14761 (dummy (progn
14762 (when (< (nth 2 defdecode) org-extend-today-until)
14763 (setcar (nthcdr 2 defdecode) -1)
14764 (setcar (nthcdr 1 defdecode) 59)
14765 (setq def (apply 'encode-time defdecode)
14766 defdecode (decode-time def)))))
14767 (calendar-frame-setup nil)
14768 (calendar-setup nil)
14769 (calendar-move-hook nil)
14770 (calendar-view-diary-initially-flag nil)
14771 (calendar-view-holidays-initially-flag nil)
14772 (timestr (format-time-string
14773 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14774 (prompt (concat (if prompt (concat prompt " ") "")
14775 (format "Date+time [%s]: " timestr)))
14776 ans (org-ans0 "") org-ans1 org-ans2 final)
14778 (cond
14779 (from-string (setq ans from-string))
14780 (org-read-date-popup-calendar
14781 (save-excursion
14782 (save-window-excursion
14783 (calendar)
14784 (unwind-protect
14785 (progn
14786 (calendar-forward-day (- (time-to-days def)
14787 (calendar-absolute-from-gregorian
14788 (calendar-current-date))))
14789 (org-eval-in-calendar nil t)
14790 (let* ((old-map (current-local-map))
14791 (map (copy-keymap calendar-mode-map))
14792 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14793 (org-defkey map (kbd "RET") 'org-calendar-select)
14794 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14795 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14796 (org-defkey minibuffer-local-map [(meta shift left)]
14797 (lambda () (interactive)
14798 (org-eval-in-calendar '(calendar-backward-month 1))))
14799 (org-defkey minibuffer-local-map [(meta shift right)]
14800 (lambda () (interactive)
14801 (org-eval-in-calendar '(calendar-forward-month 1))))
14802 (org-defkey minibuffer-local-map [(meta shift up)]
14803 (lambda () (interactive)
14804 (org-eval-in-calendar '(calendar-backward-year 1))))
14805 (org-defkey minibuffer-local-map [(meta shift down)]
14806 (lambda () (interactive)
14807 (org-eval-in-calendar '(calendar-forward-year 1))))
14808 (org-defkey minibuffer-local-map [?\e (shift left)]
14809 (lambda () (interactive)
14810 (org-eval-in-calendar '(calendar-backward-month 1))))
14811 (org-defkey minibuffer-local-map [?\e (shift right)]
14812 (lambda () (interactive)
14813 (org-eval-in-calendar '(calendar-forward-month 1))))
14814 (org-defkey minibuffer-local-map [?\e (shift up)]
14815 (lambda () (interactive)
14816 (org-eval-in-calendar '(calendar-backward-year 1))))
14817 (org-defkey minibuffer-local-map [?\e (shift down)]
14818 (lambda () (interactive)
14819 (org-eval-in-calendar '(calendar-forward-year 1))))
14820 (org-defkey minibuffer-local-map [(shift up)]
14821 (lambda () (interactive)
14822 (org-eval-in-calendar '(calendar-backward-week 1))))
14823 (org-defkey minibuffer-local-map [(shift down)]
14824 (lambda () (interactive)
14825 (org-eval-in-calendar '(calendar-forward-week 1))))
14826 (org-defkey minibuffer-local-map [(shift left)]
14827 (lambda () (interactive)
14828 (org-eval-in-calendar '(calendar-backward-day 1))))
14829 (org-defkey minibuffer-local-map [(shift right)]
14830 (lambda () (interactive)
14831 (org-eval-in-calendar '(calendar-forward-day 1))))
14832 (org-defkey minibuffer-local-map ">"
14833 (lambda () (interactive)
14834 (org-eval-in-calendar '(scroll-calendar-left 1))))
14835 (org-defkey minibuffer-local-map "<"
14836 (lambda () (interactive)
14837 (org-eval-in-calendar '(scroll-calendar-right 1))))
14838 (org-defkey minibuffer-local-map "\C-v"
14839 (lambda () (interactive)
14840 (org-eval-in-calendar
14841 '(calendar-scroll-left-three-months 1))))
14842 (org-defkey minibuffer-local-map "\M-v"
14843 (lambda () (interactive)
14844 (org-eval-in-calendar
14845 '(calendar-scroll-right-three-months 1))))
14846 (run-hooks 'org-read-date-minibuffer-setup-hook)
14847 (unwind-protect
14848 (progn
14849 (use-local-map map)
14850 (add-hook 'post-command-hook 'org-read-date-display)
14851 (setq org-ans0 (read-string prompt default-input
14852 'org-read-date-history nil))
14853 ;; org-ans0: from prompt
14854 ;; org-ans1: from mouse click
14855 ;; org-ans2: from calendar motion
14856 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14857 (remove-hook 'post-command-hook 'org-read-date-display)
14858 (use-local-map old-map)
14859 (when org-read-date-overlay
14860 (delete-overlay org-read-date-overlay)
14861 (setq org-read-date-overlay nil)))))
14862 (bury-buffer "*Calendar*")))))
14864 (t ; Naked prompt only
14865 (unwind-protect
14866 (setq ans (read-string prompt default-input
14867 'org-read-date-history timestr))
14868 (when org-read-date-overlay
14869 (delete-overlay org-read-date-overlay)
14870 (setq org-read-date-overlay nil)))))
14872 (setq final (org-read-date-analyze ans def defdecode))
14874 (when org-read-date-analyze-forced-year
14875 (message "Year was forced into %s"
14876 (if org-read-date-force-compatible-dates
14877 "compatible range (1970-2037)"
14878 "range representable on this machine"))
14879 (ding))
14881 ;; One round trip to get rid of 34th of August and stuff like that....
14882 (setq final (decode-time (apply 'encode-time final)))
14884 (setq org-read-date-final-answer ans)
14886 (if to-time
14887 (apply 'encode-time final)
14888 (if (and (boundp 'org-time-was-given) org-time-was-given)
14889 (format "%04d-%02d-%02d %02d:%02d"
14890 (nth 5 final) (nth 4 final) (nth 3 final)
14891 (nth 2 final) (nth 1 final))
14892 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14894 (defvar def)
14895 (defvar defdecode)
14896 (defvar with-time)
14897 (defun org-read-date-display ()
14898 "Display the current date prompt interpretation in the minibuffer."
14899 (when org-read-date-display-live
14900 (when org-read-date-overlay
14901 (delete-overlay org-read-date-overlay))
14902 (let ((p (point)))
14903 (end-of-line 1)
14904 (while (not (equal (buffer-substring
14905 (max (point-min) (- (point) 4)) (point))
14906 " "))
14907 (insert " "))
14908 (goto-char p))
14909 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14910 " " (or org-ans1 org-ans2)))
14911 (org-end-time-was-given nil)
14912 (f (org-read-date-analyze ans def defdecode))
14913 (fmts (if org-dcst
14914 org-time-stamp-custom-formats
14915 org-time-stamp-formats))
14916 (fmt (if (or with-time
14917 (and (boundp 'org-time-was-given) org-time-was-given))
14918 (cdr fmts)
14919 (car fmts)))
14920 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14921 (when (and org-end-time-was-given
14922 (string-match org-plain-time-of-day-regexp txt))
14923 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14924 org-end-time-was-given
14925 (substring txt (match-end 0)))))
14926 (when org-read-date-analyze-futurep
14927 (setq txt (concat txt " (=>F)")))
14928 (setq org-read-date-overlay
14929 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14930 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14932 (defun org-read-date-analyze (ans def defdecode)
14933 "Analyze the combined answer of the date prompt."
14934 ;; FIXME: cleanup and comment
14935 (let ((nowdecode (decode-time (current-time)))
14936 delta deltan deltaw deltadef year month day
14937 hour minute second wday pm h2 m2 tl wday1
14938 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14939 (setq org-read-date-analyze-futurep nil
14940 org-read-date-analyze-forced-year nil)
14942 (setq ans "+0"))
14944 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14945 (setq ans (replace-match "" t t ans)
14946 deltan (car delta)
14947 deltaw (nth 1 delta)
14948 deltadef (nth 2 delta)))
14950 ;; Check if there is an iso week date in there
14951 ;; If yes, store the info and postpone interpreting it until the rest
14952 ;; of the parsing is done
14953 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14954 (setq iso-year (if (match-end 1)
14955 (org-small-year-to-year
14956 (string-to-number (match-string 1 ans))))
14957 iso-weekday (if (match-end 3)
14958 (string-to-number (match-string 3 ans)))
14959 iso-week (string-to-number (match-string 2 ans)))
14960 (setq ans (replace-match "" t t ans)))
14962 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14963 (when (string-match
14965 (setq year (if (match-end 2)
14966 (string-to-number (match-string 2 ans))
14967 (progn (setq kill-year t)
14968 (string-to-number (format-time-string "%Y"))))
14969 month (string-to-number (match-string 3 ans))
14970 day (string-to-number (match-string 4 ans)))
14971 (if (< year 100) (setq year (+ 2000 year)))
14973 t nil ans)))
14975 ;; Help matching dottet european dates
14976 (when (string-match
14977 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14978 (setq year (if (match-end 3)
14979 (string-to-number (match-string 3 ans))
14980 (progn (setq kill-year t)
14981 (string-to-number (format-time-string "%Y"))))
14982 day (string-to-number (match-string 1 ans))
14983 month (string-to-number (match-string 2 ans))
14985 t nil ans)))
14987 ;; Help matching american dates, like 5/30 or 5/30/7
14988 (when (string-match
14989 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14990 (setq year (if (match-end 4)
14991 (string-to-number (match-string 4 ans))
14992 (progn (setq kill-year t)
14993 (string-to-number (format-time-string "%Y"))))
14994 month (string-to-number (match-string 1 ans))
14995 day (string-to-number (match-string 2 ans)))
14996 (if (< year 100) (setq year (+ 2000 year)))
14998 t nil ans)))
14999 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15000 ;; If there is a time with am/pm, and *no* time without it, we convert
15001 ;; so that matching will be successful.
15002 (loop for i from 1 to 2 do ; twice, for end time as well
15005 (setq hour (string-to-number (match-string 1 ans))
15006 minute (if (match-end 3)
15007 (string-to-number (match-string 3 ans))
15008 0)
15009 pm (equal ?p
15010 (string-to-char (downcase (match-string 4 ans)))))
15011 (if (and (= hour 12) (not pm))
15012 (setq hour 0)
15013 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15014 (setq ans (replace-match (format "%02d:%02d" hour minute)
15015 t t ans))))
15017 ;; Check if a time range is given as a duration
15018 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15019 (setq hour (string-to-number (match-string 1 ans))
15020 h2 (+ hour (string-to-number (match-string 3 ans)))
15021 minute (string-to-number (match-string 2 ans))
15022 m2 (+ minute (if (match-end 5) (string-to-number
15023 (match-string 5 ans))0)))
15024 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15025 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15026 t t ans)))
15028 ;; Check if there is a time range
15029 (when (boundp 'org-end-time-was-given)
15030 (setq org-time-was-given nil)
15031 (when (and (string-match org-plain-time-of-day-regexp ans)
15032 (match-end 8))
15033 (setq org-end-time-was-given (match-string 8 ans))
15034 (setq ans (concat (substring ans 0 (match-beginning 7))
15035 (substring ans (match-end 7))))))
15037 (setq tl (parse-time-string ans)
15038 day (or (nth 3 tl) (nth 3 defdecode))
15039 month (or (nth 4 tl)
15040 (if (and org-read-date-prefer-future
15041 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15042 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15043 (nth 4 defdecode)))
15044 year (or (and (not kill-year) (nth 5 tl))
15045 (if (and org-read-date-prefer-future
15046 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15047 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15048 (nth 5 defdecode)))
15049 hour (or (nth 2 tl) (nth 2 defdecode))
15050 minute (or (nth 1 tl) (nth 1 defdecode))
15051 second (or (nth 0 tl) 0)
15052 wday (nth 6 tl))
15054 (when (and (eq org-read-date-prefer-future 'time)
15055 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15056 (equal day (nth 3 nowdecode))
15057 (equal month (nth 4 nowdecode))
15058 (equal year (nth 5 nowdecode))
15059 (nth 2 tl)
15060 (or (< (nth 2 tl) (nth 2 nowdecode))
15061 (and (= (nth 2 tl) (nth 2 nowdecode))
15062 (nth 1 tl)
15063 (< (nth 1 tl) (nth 1 nowdecode)))))
15064 (setq day (1+ day)
15065 futurep t))
15067 ;; Special date definitions below
15068 (cond
15069 (iso-week
15070 ;; There was an iso week
15071 (require 'cal-iso)
15072 (setq futurep nil)
15073 (setq year (or iso-year year)
15074 day (or iso-weekday wday 1)
15075 wday nil ; to make sure that the trigger below does not match
15076 iso-date (calendar-gregorian-from-absolute
15077 (calendar-absolute-from-iso
15078 (list iso-week day year))))
15079 ; FIXME: Should we also push ISO weeks into the future?
15080 ; (when (and org-read-date-prefer-future
15081 ; (not iso-year)
15082 ; (< (calendar-absolute-from-gregorian iso-date)
15083 ; (time-to-days (current-time))))
15084 ; (setq year (1+ year)
15085 ; iso-date (calendar-gregorian-from-absolute
15086 ; (calendar-absolute-from-iso
15087 ; (list iso-week day year)))))
15088 (setq month (car iso-date)
15089 year (nth 2 iso-date)
15090 day (nth 1 iso-date)))
15091 (deltan
15092 (setq futurep nil)
15093 (unless deltadef
15094 (let ((now (decode-time (current-time))))
15095 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15096 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15097 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15098 ((equal deltaw "m") (setq month (+ month deltan)))
15099 ((equal deltaw "y") (setq year (+ year deltan)))))
15100 ((and wday (not (nth 3 tl)))
15101 (setq futurep nil)
15102 ;; Weekday was given, but no day, so pick that day in the week
15103 ;; on or after the derived date.
15104 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15105 (unless (equal wday wday1)
15106 (setq day (+ day (% (- wday wday1 -7) 7))))))
15107 (if (and (boundp 'org-time-was-given)
15108 (nth 2 tl))
15109 (setq org-time-was-given t))
15110 (if (< year 100) (setq year (+ 2000 year)))
15111 ;; Check of the date is representable
15112 (if org-read-date-force-compatible-dates
15113 (progn
15114 (if (< year 1970)
15115 (setq year 1970 org-read-date-analyze-forced-year t))
15116 (if (> year 2037)
15117 (setq year 2037 org-read-date-analyze-forced-year t)))
15118 (condition-case nil
15119 (ignore (encode-time second minute hour day month year))
15120 (error
15121 (setq year (nth 5 defdecode))
15122 (setq org-read-date-analyze-forced-year t))))
15123 (setq org-read-date-analyze-futurep futurep)
15124 (list second minute hour day month year)))
15126 (defvar parse-time-weekdays)
15128 (defun org-read-date-get-relative (s today default)
15129 "Check string S for special relative date string.
15130 TODAY and DEFAULT are internal times, for today and for a default.
15131 Return shift list (N what def-flag)
15133 N is the number of WHATs to shift.
15134 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15135 the DEFAULT date rather than TODAY."
15136 (when (and
15137 (string-match
15138 (concat
15143 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15144 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15145 (string-to-char (substring (match-string 1 s) -1))
15146 ?+))
15147 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15148 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15149 (what (if (match-end 3) (match-string 3 s) "d"))
15150 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15151 (date (if rel default today))
15152 (wday (nth 6 (decode-time date)))
15153 delta)
15154 (if wday1
15155 (progn
15156 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15157 (if (= dir ?-) (setq delta (- delta 7)))
15158 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15159 (list delta "d" rel))
15160 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15162 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15163 "Turn a user-specified date into the internal representation.
15164 The internal representation needed by the calendar is (month day year).
15165 This is a wrapper to handle the brain-dead convention in calendar that
15166 user function argument order change dependent on argument order."
15167 (if (boundp 'calendar-date-style)
15168 (cond
15169 ((eq calendar-date-style 'american)
15170 (list arg1 arg2 arg3))
15171 ((eq calendar-date-style 'european)
15172 (list arg2 arg1 arg3))
15173 ((eq calendar-date-style 'iso)
15174 (list arg2 arg3 arg1)))
15175 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15176 (if (org-bound-and-true-p european-calendar-style)
15177 (list arg2 arg1 arg3)
15178 (list arg1 arg2 arg3)))))
15180 (defun org-eval-in-calendar (form &optional keepdate)
15181 "Eval FORM in the calendar window and return to current window.
15182 Also, store the cursor date in variable org-ans2."
15183 (let ((sf (selected-frame))
15184 (sw (selected-window)))
15185 (select-window (get-buffer-window "*Calendar*" t))
15186 (eval form)
15187 (when (and (not keepdate) (calendar-cursor-to-date))
15188 (let* ((date (calendar-cursor-to-date))
15189 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15190 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15191 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15192 (select-window sw)
15193 (org-select-frame-set-input-focus sf)))
15195 (defun org-calendar-select ()
15196 "Return to `org-read-date' with the date currently selected.
15197 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15198 (interactive)
15199 (when (calendar-cursor-to-date)
15200 (let* ((date (calendar-cursor-to-date))
15201 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15202 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15203 (if (active-minibuffer-window) (exit-minibuffer))))
15205 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15206 "Insert a date stamp for the date given by the internal TIME.
15207 WITH-HM means use the stamp format that includes the time of the day.
15208 INACTIVE means use square brackets instead of angular ones, so that the
15209 stamp will not contribute to the agenda.
15210 PRE and POST are optional strings to be inserted before and after the
15211 stamp.
15212 The command returns the inserted time stamp."
15213 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15214 stamp)
15215 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15216 (insert-before-markers (or pre ""))
15217 (when (listp extra)
15218 (setq extra (car extra))
15219 (if (and (stringp extra)
15221 (setq extra (format "-%02d:%02d"
15222 (string-to-number (match-string 1 extra))
15223 (string-to-number (match-string 2 extra))))
15224 (setq extra nil)))
15225 (when extra
15226 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15227 (insert-before-markers (setq stamp (format-time-string fmt time)))
15228 (insert-before-markers (or post ""))
15229 (setq org-last-inserted-timestamp stamp)))
15231 (defun org-toggle-time-stamp-overlays ()
15232 "Toggle the use of custom time stamp formats."
15233 (interactive)
15234 (setq org-display-custom-times (not org-display-custom-times))
15235 (unless org-display-custom-times
15236 (let ((p (point-min)) (bmp (buffer-modified-p)))
15237 (while (setq p (next-single-property-change p 'display))
15238 (if (and (get-text-property p 'display)
15239 (eq (get-text-property p 'face) 'org-date))
15240 (remove-text-properties
15241 p (setq p (next-single-property-change p 'display))
15242 '(display t))))
15243 (set-buffer-modified-p bmp)))
15244 (if (featurep 'xemacs)
15245 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15246 (org-restart-font-lock)
15247 (setq org-table-may-need-update t)
15248 (if org-display-custom-times
15249 (message "Time stamps are overlayed with custom format")
15250 (message "Time stamp overlays removed")))
15252 (defun org-display-custom-time (beg end)
15253 "Overlay modified time stamp format over timestamp between BEG and END."
15254 (let* ((ts (buffer-substring beg end))
15255 t1 w1 with-hm tf time str w2 (off 0))
15256 (save-match-data
15257 (setq t1 (org-parse-time-string ts t))
15258 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15259 (setq off (- (match-end 0) (match-beginning 0)))))
15260 (setq end (- end off))
15261 (setq w1 (- end beg)
15262 with-hm (and (nth 1 t1) (nth 2 t1))
15263 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15264 time (org-fix-decoded-time t1)
15265 str (org-add-props
15266 (format-time-string
15267 (substring tf 1 -1) (apply 'encode-time time))
15268 nil 'mouse-face 'highlight)
15269 w2 (length str))
15270 (if (not (= w2 w1))
15271 (add-text-properties (1+ beg) (+ 2 beg)
15272 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15273 (if (featurep 'xemacs)
15274 (progn
15275 (put-text-property beg end 'invisible t)
15276 (put-text-property beg end 'end-glyph (make-glyph str)))
15277 (put-text-property beg end 'display str))))
15279 (defun org-translate-time (string)
15280 "Translate all timestamps in STRING to custom format.
15281 But do this only if the variable `org-display-custom-times' is set."
15282 (when org-display-custom-times
15283 (save-match-data
15284 (let* ((start 0)
15285 (re org-ts-regexp-both)
15286 t1 with-hm inactive tf time str beg end)
15287 (while (setq start (string-match re string start))
15288 (setq beg (match-beginning 0)
15289 end (match-end 0)
15290 t1 (save-match-data
15291 (org-parse-time-string (substring string beg end) t))
15292 with-hm (and (nth 1 t1) (nth 2 t1))
15293 inactive (equal (substring string beg (1+ beg)) "[")
15294 tf (funcall (if with-hm 'cdr 'car)
15295 org-time-stamp-custom-formats)
15296 time (org-fix-decoded-time t1)
15297 str (format-time-string
15298 (concat
15299 (if inactive "[" "<") (substring tf 1 -1)
15300 (if inactive "]" ">"))
15301 (apply 'encode-time time))
15302 string (replace-match str t t string)
15303 start (+ start (length str)))))))
15304 string)
15306 (defun org-fix-decoded-time (time)
15307 "Set 0 instead of nil for the first 6 elements of time.
15308 Don't touch the rest."
15309 (let ((n 0))
15310 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15312 (defun org-days-to-time (timestamp-string)
15313 "Difference between TIMESTAMP-STRING and now in days."
15314 (- (time-to-days (org-time-string-to-time timestamp-string))
15315 (time-to-days (current-time))))
15317 (defun org-deadline-close (timestamp-string &optional ndays)
15318 "Is the time in TIMESTAMP-STRING close to the current date?"
15319 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15320 (and (< (org-days-to-time timestamp-string) ndays)
15321 (not (org-entry-is-done-p))))
15323 (defun org-get-wdays (ts)
15324 "Get the deadline lead time appropriate for timestring TS."
15325 (cond
15326 ((<= org-deadline-warning-days 0)
15327 ;; 0 or negative, enforce this value no matter what
15328 (- org-deadline-warning-days))
15330 ;; lead time is specified.
15331 (floor (* (string-to-number (match-string 1 ts))
15332 (cdr (assoc (match-string 2 ts)
15333 '(("d" . 1) ("w" . 7)
15334 ("m" . 30.4) ("y" . 365.25)))))))
15335 ;; go for the default.
15336 (t org-deadline-warning-days)))
15338 (defun org-calendar-select-mouse (ev)
15339 "Return to `org-read-date' with the date currently selected.
15340 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15341 (interactive "e")
15342 (mouse-set-point ev)
15343 (when (calendar-cursor-to-date)
15344 (let* ((date (calendar-cursor-to-date))
15345 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15346 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15347 (if (active-minibuffer-window) (exit-minibuffer))))
15349 (defun org-check-deadlines (ndays)
15350 "Check if there are any deadlines due or past due.
15351 A deadline is considered due if it happens within `org-deadline-warning-days'
15352 days from today's date. If the deadline appears in an entry marked DONE,
15353 it is not shown. The prefix arg NDAYS can be used to test that many
15355 (interactive "P")
15356 (let* ((org-warn-days
15357 (cond
15358 ((equal ndays '(4)) 100000)
15359 (ndays (prefix-numeric-value ndays))
15360 (t (abs org-deadline-warning-days))))
15361 (case-fold-search nil)
15363 (callback
15364 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15366 (message "%d deadlines past-due or due within %d days"
15367 (org-occur regexp nil callback)
15368 org-warn-days)))
15370 (defun org-check-before-date (date)
15371 "Check if there are deadlines or scheduled entries before DATE."
15372 (interactive (list (org-read-date)))
15373 (let ((case-fold-search nil)
15377 (callback
15378 (lambda () (time-less-p
15379 (org-time-string-to-time (match-string 2))
15380 (org-time-string-to-time date)))))
15381 (message "%d entries before %s"
15382 (org-occur regexp nil callback) date)))
15384 (defun org-check-after-date (date)
15385 "Check if there are deadlines or scheduled entries after DATE."
15386 (interactive (list (org-read-date)))
15387 (let ((case-fold-search nil)
15391 (callback
15392 (lambda () (not
15393 (time-less-p
15394 (org-time-string-to-time (match-string 2))
15395 (org-time-string-to-time date))))))
15396 (message "%d entries after %s"
15397 (org-occur regexp nil callback) date)))
15399 (defun org-evaluate-time-range (&optional to-buffer)
15400 "Evaluate a time range by computing the difference between start and end.
15401 Normally the result is just printed in the echo area, but with prefix arg
15402 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15403 If the time range is actually in a table, the result is inserted into the
15404 next column.
15405 For time difference computation, a year is assumed to be exactly 365
15406 days in order to avoid rounding problems."
15407 (interactive "P")
15408 (or
15409 (org-clock-update-time-maybe)
15410 (save-excursion
15411 (unless (org-at-date-range-p t)
15412 (goto-char (point-at-bol))
15413 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15414 (if (not (org-at-date-range-p t))
15415 (error "Not at a time-stamp range, and none found in current line")))
15416 (let* ((ts1 (match-string 1))
15417 (ts2 (match-string 2))
15418 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15419 (match-end (match-end 0))
15420 (time1 (org-time-string-to-time ts1))
15421 (time2 (org-time-string-to-time ts2))
15422 (t1 (org-float-time time1))
15423 (t2 (org-float-time time2))
15424 (diff (abs (- t2 t1)))
15425 (negative (< (- t2 t1) 0))
15426 ;; (ys (floor (* 365 24 60 60)))
15427 (ds (* 24 60 60))
15428 (hs (* 60 60))
15429 (fy "%dy %dd %02d:%02d")
15430 (fy1 "%dy %dd")
15431 (fd "%dd %02d:%02d")
15432 (fd1 "%dd")
15433 (fh "%02d:%02d")
15434 y d h m align)
15435 (if havetime
15436 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15437 y 0
15438 d (floor (/ diff ds)) diff (mod diff ds)
15439 h (floor (/ diff hs)) diff (mod diff hs)
15440 m (floor (/ diff 60)))
15441 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15442 y 0
15443 d (floor (+ (/ diff ds) 0.5))
15444 h 0 m 0))
15445 (if (not to-buffer)
15446 (message "%s" (org-make-tdiff-string y d h m))
15447 (if (org-at-table-p)
15448 (progn
15449 (goto-char match-end)
15450 (setq align t)
15451 (and (looking-at " *|") (goto-char (match-end 0))))
15452 (goto-char match-end))
15453 (if (looking-at
15455 (replace-match ""))
15456 (if negative (insert " -"))
15457 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15458 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15459 (insert " " (format fh h m))))
15460 (if align (org-table-align))
15461 (message "Time difference inserted")))))
15463 (defun org-make-tdiff-string (y d h m)
15464 (let ((fmt "")
15465 (l nil))
15466 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15467 l (push y l)))
15468 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15469 l (push d l)))
15470 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15471 l (push h l)))
15472 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15473 l (push m l)))
15474 (apply 'format fmt (nreverse l))))
15476 (defun org-time-string-to-time (s &optional buffer pos)
15477 (condition-case errdata
15478 (apply 'encode-time (org-parse-time-string s))
15480 s (if (not (and buffer pos))
15481 ""
15482 (format " at %d in buffer `%s'" pos buffer))
15483 (cdr errdata)))))
15485 (defun org-time-string-to-seconds (s)
15486 (org-float-time (org-time-string-to-time s)))
15488 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15489 "Convert a time stamp to an absolute day number.
15490 If there is a specifier for a cyclic time stamp, get the closest date to
15491 DAYNR.
15492 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15493 The variable date is bound by the calendar when this is called."
15494 (cond
15496 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15497 daynr
15498 (+ daynr 1000)))
15500 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15501 (time-to-days (current-time))) (match-string 0 s)
15502 prefer show-all))
15503 (t (time-to-days
15504 (condition-case errdata
15505 (apply 'encode-time (org-parse-time-string s))
15507 s (if (not (and buffer pos))
15508 ""
15509 (format " at %d in buffer `%s'" pos buffer))
15510 (cdr errdata))))))))
15512 (defun org-days-to-iso-week (days)
15513 "Return the iso week number."
15514 (require 'cal-iso)
15515 (car (calendar-iso-from-absolute days)))
15517 (defun org-small-year-to-year (year)
15518 "Convert 2-digit years into 4-digit years.
15519 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15520 The year 2000 cannot be abbreviated. Any year larger than 99
15521 is returned unchanged."
15522 (if (< year 38)
15523 (setq year (+ 2000 year))
15524 (if (< year 100)
15525 (setq year (+ 1900 year))))
15526 year)
15528 (defun org-time-from-absolute (d)
15529 "Return the time corresponding to date D.
15530 D may be an absolute day number, or a calendar-type list (month day year)."
15531 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15532 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15534 (defun org-calendar-holiday ()
15535 "List of holidays, for Diary display in Org-mode."
15536 (require 'holidays)
15537 (let ((hl (funcall
15538 (if (fboundp 'calendar-check-holidays)
15539 'calendar-check-holidays 'check-calendar-holidays) date)))
15540 (if hl (mapconcat 'identity hl "; "))))
15542 (defun org-diary-sexp-entry (sexp entry date)
15543 "Process a SEXP diary ENTRY for DATE."
15544 (require 'diary-lib)
15545 (let ((result (if calendar-debug-sexp
15546 (let ((stack-trace-on-error t))
15547 (eval (car (read-from-string sexp))))
15548 (condition-case nil
15549 (eval (car (read-from-string sexp)))
15550 (error
15551 (beep)
15552 (message "Bad sexp at line %d in %s: %s"
15553 (org-current-line)
15554 (buffer-file-name) sexp)
15555 (sleep-for 2))))))
15556 (cond ((stringp result) (split-string result "; "))
15557 ((and (consp result)
15558 (not (consp (cdr result)))
15559 (stringp (cdr result))) (cdr result))
15560 ((and (consp result)
15561 (stringp (car result))) result)
15562 (result entry)
15563 (t nil))))
15565 (defun org-diary-to-ical-string (frombuf)
15566 "Get iCalendar entries from diary entries in buffer FROMBUF.
15567 This uses the icalendar.el library."
15568 (let* ((tmpdir (if (featurep 'xemacs)
15569 (temp-directory)
15570 temporary-file-directory))
15571 (tmpfile (make-temp-name
15572 (expand-file-name "orgics" tmpdir)))
15573 buf rtn b e)
15574 (with-current-buffer frombuf
15575 (icalendar-export-region (point-min) (point-max) tmpfile)
15576 (setq buf (find-buffer-visiting tmpfile))
15577 (set-buffer buf)
15578 (goto-char (point-min))
15579 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15580 (setq b (match-beginning 0)))
15581 (goto-char (point-max))
15582 (if (re-search-backward "^END:VEVENT" nil t)
15583 (setq e (match-end 0)))
15585 (kill-buffer buf)
15586 (delete-file tmpfile)
15587 rtn))
15589 (defun org-closest-date (start current change prefer show-all)
15590 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15591 When PREFER is `past', return a date that is either CURRENT or past.
15592 When PREFER is `future', return a date that is either CURRENT or future.
15593 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15594 ;; Make the proper lists from the dates
15595 (catch 'exit
15596 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15597 dn dw sday cday n1 n2 n0
15598 d m y y1 y2 date1 date2 nmonths nm ny m2)
15600 (setq start (org-date-to-gregorian start)
15601 current (org-date-to-gregorian
15602 (if show-all
15603 current
15604 (time-to-days (current-time))))
15605 sday (calendar-absolute-from-gregorian start)
15606 cday (calendar-absolute-from-gregorian current))
15608 (if (<= cday sday) (throw 'exit sday))
15611 (setq dn (string-to-number (match-string 1 change))
15612 dw (cdr (assoc (match-string 2 change) a1)))
15613 (error "Invalid change specifier: %s" change))
15614 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15615 (cond
15616 ((eq dw 'day)
15617 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15618 n2 (+ n1 dn)))
15619 ((eq dw 'year)
15620 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15621 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15622 (setq date1 (list m d y1)
15623 n1 (calendar-absolute-from-gregorian date1)
15624 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15625 n2 (calendar-absolute-from-gregorian date2)))
15626 ((eq dw 'month)
15627 ;; approx number of month between the two dates
15628 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15629 ;; How often does dn fit in there?
15630 (setq d (nth 1 start) m (car start) y (nth 2 start)
15631 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15632 m (+ m nm)
15633 ny (floor (/ m 12))
15634 y (+ y ny)
15635 m (- m (* ny 12)))
15636 (while (> m 12) (setq m (- m 12) y (1+ y)))
15637 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15638 (setq m2 (+ m dn) y2 y)
15639 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15640 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15641 (while (<= n2 cday)
15642 (setq n1 n2 m m2 y y2)
15643 (setq m2 (+ m dn) y2 y)
15644 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15645 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15646 ;; Make sure n1 is the earlier date
15647 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15648 (if show-all
15649 (cond
15650 ((eq prefer 'past) (if (= cday n2) n2 n1))
15651 ((eq prefer 'future) (if (= cday n1) n1 n2))
15652 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15653 (cond
15654 ((eq prefer 'past) (if (= cday n2) n2 n1))
15655 ((eq prefer 'future) (if (= cday n1) n1 n2))
15656 (t (if (= cday n1) n1 n2)))))))
15658 (defun org-date-to-gregorian (date)
15659 "Turn any specification of DATE into a Gregorian date for the calendar."
15660 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15661 ((and (listp date) (= (length date) 3)) date)
15662 ((stringp date)
15663 (setq date (org-parse-time-string date))
15664 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15665 ((listp date)
15666 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15668 (defun org-parse-time-string (s &optional nodefault)
15669 "Parse the standard Org-mode time string.
15670 This should be a lot faster than the normal `parse-time-string'.
15671 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15672 hour and minute fields will be nil if not given."
15673 (if (string-match org-ts-regexp0 s)
15674 (list 0
15675 (if (or (match-beginning 8) (not nodefault))
15676 (string-to-number (or (match-string 8 s) "0")))
15677 (if (or (match-beginning 7) (not nodefault))
15678 (string-to-number (or (match-string 7 s) "0")))
15679 (string-to-number (match-string 4 s))
15680 (string-to-number (match-string 3 s))
15681 (string-to-number (match-string 2 s))
15682 nil nil nil)
15683 (error "Not a standard Org-mode time string: %s" s)))
15685 (defun org-timestamp-up (&optional arg)
15686 "Increase the date item at the cursor by one.
15687 If the cursor is on the year, change the year. If it is on the month,
15688 the day or the time, change that.
15689 With prefix ARG, change by that many units."
15690 (interactive "p")
15691 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15693 (defun org-timestamp-down (&optional arg)
15694 "Decrease the date item at the cursor by one.
15695 If the cursor is on the year, change the year. If it is on the month,
15696 the day or the time, change that.
15697 With prefix ARG, change by that many units."
15698 (interactive "p")
15699 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15701 (defun org-timestamp-up-day (&optional arg)
15702 "Increase the date in the time stamp by one day.
15703 With prefix ARG, change that many days."
15704 (interactive "p")
15705 (if (and (not (org-at-timestamp-p t))
15706 (org-on-heading-p))
15707 (org-todo 'up)
15708 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15710 (defun org-timestamp-down-day (&optional arg)
15711 "Decrease the date in the time stamp by one day.
15712 With prefix ARG, change that many days."
15713 (interactive "p")
15714 (if (and (not (org-at-timestamp-p t))
15715 (org-on-heading-p))
15716 (org-todo 'down)
15717 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15719 (defun org-at-timestamp-p (&optional inactive-ok)
15720 "Determine if the cursor is in or at a timestamp."
15721 (interactive)
15722 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15723 (pos (point))
15724 (ans (or (looking-at tsr)
15725 (save-excursion
15727 (if (> (point) (point-min)) (backward-char 1))
15728 (and (looking-at tsr)
15729 (> (- (match-end 0) pos) -1))))))
15730 (and ans
15731 (boundp 'org-ts-what)
15732 (setq org-ts-what
15733 (cond
15734 ((= pos (match-beginning 0)) 'bracket)
15735 ;; Point is considered to be "on the bracket" whether
15736 ;; it's really on it or right after it.
15737 ((or (= pos (1- (match-end 0)))
15738 (= pos (match-end 0))) 'bracket)
15739 ((org-pos-in-match-range pos 2) 'year)
15740 ((org-pos-in-match-range pos 3) 'month)
15741 ((org-pos-in-match-range pos 7) 'hour)
15742 ((org-pos-in-match-range pos 8) 'minute)
15743 ((or (org-pos-in-match-range pos 4)
15744 (org-pos-in-match-range pos 5)) 'day)
15745 ((and (> pos (or (match-end 8) (match-end 5)))
15746 (< pos (match-end 0)))
15747 (- pos (or (match-end 8) (match-end 5))))
15748 (t 'day))))
15749 ans))
15751 (defun org-toggle-timestamp-type ()
15752 "Toggle the type (<active> or [inactive]) of a time stamp."
15753 (interactive)
15754 (when (org-at-timestamp-p t)
15755 (let ((beg (match-beginning 0)) (end (match-end 0))
15756 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15757 (save-excursion
15758 (goto-char beg)
15759 (while (re-search-forward "[][<>]" end t)
15760 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15761 t t)))
15762 (message "Timestamp is now %sactive"
15763 (if (equal (char-after beg) ?<) "" "in")))))
15765 (defun org-timestamp-change (n &optional what updown)
15766 "Change the date in the time stamp at point.
15767 The date will be changed by N times WHAT. WHAT can be `day', `month',
15768 `year', `minute', `second'. If WHAT is not given, the cursor position
15769 in the timestamp determines what will be changed."
15770 (let ((origin (point)) origin-cat
15771 with-hm inactive
15772 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15773 org-ts-what
15774 extra rem
15775 ts time time0)
15776 (if (not (org-at-timestamp-p t))
15777 (error "Not at a timestamp"))
15778 (if (and (not what) (eq org-ts-what 'bracket))
15779 (org-toggle-timestamp-type)
15780 ;; Point isn't on brackets. Remember the part of the time-stamp
15781 ;; the point was in. Indeed, size of time-stamps may change,
15782 ;; but point must be kept in the same category nonetheless.
15783 (setq origin-cat org-ts-what)
15784 (if (and (not what) (not (eq org-ts-what 'day))
15785 org-display-custom-times
15786 (get-text-property (point) 'display)
15787 (not (get-text-property (1- (point)) 'display)))
15788 (setq org-ts-what 'day))
15789 (setq org-ts-what (or what org-ts-what)
15790 inactive (= (char-after (match-beginning 0)) ?\[)
15791 ts (match-string 0))
15792 (replace-match "")
15793 (if (string-match
15795 ts)
15796 (setq extra (match-string 1 ts)))
15798 (setq with-hm t))
15799 (setq time0 (org-parse-time-string ts))
15800 (when (and updown
15801 (eq org-ts-what 'minute)
15802 (not current-prefix-arg))
15803 ;; This looks like s-up and s-down. Change by one rounding step.
15804 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15805 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15806 (setcar (cdr time0) (+ (nth 1 time0)
15807 (if (> n 0) (- rem) (- dm rem))))))
15808 (setq time
15809 (encode-time (or (car time0) 0)
15810 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15811 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15812 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15813 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15814 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15815 (nthcdr 6 time0)))
15816 (when (and (member org-ts-what '(hour minute))
15817 extra
15819 (setq extra (org-modify-ts-extra
15820 extra
15821 (if (eq org-ts-what 'hour) 2 5)
15822 n dm)))
15823 (when (integerp org-ts-what)
15824 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15825 (if (eq what 'calendar)
15826 (let ((cal-date (org-get-date-from-calendar)))
15827 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15828 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15829 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15830 (setcar time0 (or (car time0) 0))
15831 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15832 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15833 (setq time (apply 'encode-time time0))))
15834 ;; Insert the new time-stamp, and ensure point stays in the same
15835 ;; category as before (i.e. not after the last position in that
15836 ;; category).
15837 (let ((pos (point)))
15838 ;; Stay before inserted string. `save-excursion' is of no use.
15839 (setq org-last-changed-timestamp
15840 (org-insert-time-stamp time with-hm inactive nil nil extra))
15841 (goto-char pos))
15842 (save-match-data
15843 (looking-at org-ts-regexp3)
15844 (goto-char (cond
15845 ;; `day' category ends before `hour' if any, or at
15846 ;; the end of the day name.
15847 ((eq origin-cat 'day)
15848 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15849 ((eq origin-cat 'hour) (min (match-end 7) origin))
15850 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15851 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15852 ;; `year' and `month' have both fixed size: point
15853 ;; couldn't have moved into another part.
15854 (t origin))))
15855 ;; Update clock if on a CLOCK line.
15856 (org-clock-update-time-maybe)
15857 ;; Try to recenter the calendar window, if any.
15858 (if (and org-calendar-follow-timestamp-change
15859 (get-buffer-window "*Calendar*" t)
15860 (memq org-ts-what '(day month year)))
15861 (org-recenter-calendar (time-to-days time))))))
15863 (defun org-modify-ts-extra (s pos n dm)
15864 "Change the different parts of the lead-time and repeat fields in timestamp."
15865 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15866 ng h m new rem)
15867 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15868 (cond
15869 ((or (org-pos-in-match-range pos 2)
15870 (org-pos-in-match-range pos 3))
15871 (setq m (string-to-number (match-string 3 s))
15872 h (string-to-number (match-string 2 s)))
15873 (if (org-pos-in-match-range pos 2)
15874 (setq h (+ h n))
15875 (setq n (* dm (org-no-warnings (signum n))))
15876 (when (not (= 0 (setq rem (% m dm))))
15877 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15878 (setq m (+ m n)))
15879 (if (< m 0) (setq m (+ m 60) h (1- h)))
15880 (if (> m 59) (setq m (- m 60) h (1+ h)))
15881 (setq h (min 24 (max 0 h)))
15882 (setq ng 1 new (format "-%02d:%02d" h m)))
15883 ((org-pos-in-match-range pos 6)
15884 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15885 ((org-pos-in-match-range pos 5)
15886 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15888 ((org-pos-in-match-range pos 9)
15889 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15890 ((org-pos-in-match-range pos 8)
15891 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15893 (when ng
15894 (setq s (concat
15895 (substring s 0 (match-beginning ng))
15896 new
15897 (substring s (match-end ng))))))
15898 s))
15900 (defun org-recenter-calendar (date)
15901 "If the calendar is visible, recenter it to DATE."
15902 (let* ((win (selected-window))
15903 (cwin (get-buffer-window "*Calendar*" t))
15904 (calendar-move-hook nil))
15905 (when cwin
15906 (select-window cwin)
15907 (calendar-goto-date (if (listp date) date
15908 (calendar-gregorian-from-absolute date)))
15909 (select-window win))))
15911 (defun org-goto-calendar (&optional arg)
15912 "Go to the Emacs calendar at the current date.
15913 If there is a time stamp in the current line, go to that date.
15914 A prefix ARG can be used to force the current date."
15915 (interactive "P")
15916 (let ((tsr org-ts-regexp) diff
15917 (calendar-move-hook nil)
15918 (calendar-view-holidays-initially-flag nil)
15919 (calendar-view-diary-initially-flag nil))
15920 (if (or (org-at-timestamp-p)
15921 (save-excursion
15922 (beginning-of-line 1)
15923 (looking-at (concat ".*" tsr))))
15924 (let ((d1 (time-to-days (current-time)))
15925 (d2 (time-to-days
15926 (org-time-string-to-time (match-string 1)))))
15927 (setq diff (- d2 d1))))
15928 (calendar)
15929 (calendar-goto-today)
15930 (if (and diff (not arg)) (calendar-forward-day diff))))
15932 (defun org-get-date-from-calendar ()
15933 "Return a list (month day year) of date at point in calendar."
15934 (with-current-buffer "*Calendar*"
15935 (save-match-data
15936 (calendar-cursor-to-date))))
15938 (defun org-date-from-calendar ()
15939 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15940 If there is already a time stamp at the cursor position, update it."
15941 (interactive)
15942 (if (org-at-timestamp-p t)
15943 (org-timestamp-change 0 'calendar)
15944 (let ((cal-date (org-get-date-from-calendar)))
15945 (org-insert-time-stamp
15946 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15948 (defun org-minutes-to-hh:mm-string (m)
15949 "Compute H:MM from a number of minutes."
15950 (let ((h (/ m 60)))
15951 (setq m (- m (* 60 h)))
15952 (format org-time-clocksum-format h m)))
15954 (defun org-hh:mm-string-to-minutes (s)
15955 "Convert a string H:MM to a number of minutes.
15956 If the string is just a number, interpret it as minutes.
15957 In fact, the first hh:mm or number in the string will be taken,
15958 there can be extra stuff in the string.
15959 If no number is found, the return value is 0."
15960 (cond
15961 ((integerp s) s)
15963 (+ (* (string-to-number (match-string 1 s)) 60)
15964 (string-to-number (match-string 2 s))))
15966 (string-to-number (match-string 1 s)))
15967 (t 0)))
15969 (defcustom org-effort-durations
15970 `(("h" . 60)
15971 ("d" . ,(* 60 8))
15972 ("w" . ,(* 60 8 5))
15973 ("m" . ,(* 60 8 5 4))
15974 ("y" . ,(* 60 8 5 40)))
15975 "Conversion factor to minutes for an effort modifier.
15977 Each entry has the form (MODIFIER . MINUTES).
15979 In an effort string, a number followed by MODIFIER is multiplied
15980 by the specified number of MINUTES to obtain an effort in
15981 minutes.
15985 :group 'org-agenda
15986 :type '(alist :key-type (string :tag "Modifier")
15987 :value-type (number :tag "Minutes")))
15989 (defun org-duration-string-to-minutes (s)
15990 "Convert a duration string S to minutes.
15992 A bare number is interpreted as minutes, modifiers can be set by
15993 customizing `org-effort-durations' (which see).
15995 Entries containing a colon are interpreted as H:MM by
15996 `org-hh:mm-string-to-minutes'."
15997 (let ((result 0)
15999 (regexp-opt (mapcar 'car org-effort-durations))
16001 (while (string-match re s)
16002 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16003 (string-to-number (match-string 1 s))))
16004 (setq s (replace-match "" nil t s)))
16005 (incf result (org-hh:mm-string-to-minutes s))
16006 result))
16008 ;;;; Files
16010 (defun org-save-all-org-buffers ()
16011 "Save all Org-mode buffers without user confirmation."
16012 (interactive)
16013 (message "Saving all Org-mode buffers...")
16014 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16015 (when (featurep 'org-id) (org-id-locations-save))
16016 (message "Saving all Org-mode buffers... done"))
16018 (defun org-revert-all-org-buffers ()
16019 "Revert all Org-mode buffers.
16020 Prompt for confirmation when there are unsaved changes.
16021 Be sure you know what you are doing before letting this function
16022 overwrite your changes.
16024 This function is useful in a setup where one tracks org files
16025 with a version control system, to revert on one machine after pulling
16026 changes from another. I believe the procedure must be like this:
16028 1. M-x org-save-all-org-buffers
16029 2. Pull changes from the other machine, resolve conflicts
16030 3. M-x org-revert-all-org-buffers"
16031 (interactive)
16032 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16033 (error "Abort"))
16034 (save-excursion
16035 (save-window-excursion
16036 (mapc
16037 (lambda (b)
16038 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16039 (with-current-buffer b buffer-file-name))
16040 (org-pop-to-buffer-same-window b)
16041 (revert-buffer t 'no-confirm)))
16042 (buffer-list))
16043 (when (and (featurep 'org-id) org-id-track-globally)
16044 (org-id-locations-load)))))
16046 ;;;; Agenda files
16048 ;;;###autoload
16049 (defun org-switchb (&optional arg)
16050 "Switch between Org buffers.
16051 With a prefix argument, restrict available to files.
16052 With two prefix arguments, restrict available buffers to agenda files.
16054 Defaults to `iswitchb' for buffer name completion.
16055 Set `org-completion-use-ido' to make it use ido instead."
16056 (interactive "P")
16057 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16058 ((equal arg '(16)) (org-buffer-list 'agenda))
16059 (t (org-buffer-list))))
16060 (org-completion-use-iswitchb org-completion-use-iswitchb)
16061 (org-completion-use-ido org-completion-use-ido))
16062 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16063 (setq org-completion-use-iswitchb t))
16064 (org-pop-to-buffer-same-window
16065 (org-icompleting-read "Org buffer: "
16066 (mapcar 'list (mapcar 'buffer-name blist))
16067 nil t))))
16069 ;;; Define some older names previously used for this functionality
16070 ;;;###autoload
16071 (defalias 'org-ido-switchb 'org-switchb)
16072 ;;;###autoload
16073 (defalias 'org-iswitchb 'org-switchb)
16075 (defun org-buffer-list (&optional predicate exclude-tmp)
16076 "Return a list of Org buffers.
16077 PREDICATE can be `export', `files' or `agenda'.
16079 export restrict the list to Export buffers.
16080 files restrict the list to buffers visiting Org files.
16081 agenda restrict the list to buffers visiting agenda files.
16083 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16084 (let* ((bfn nil)
16085 (agenda-files (and (eq predicate 'agenda)
16086 (mapcar 'file-truename (org-agenda-files t))))
16087 (filter
16088 (cond
16089 ((eq predicate 'files)
16090 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16091 ((eq predicate 'export)
16092 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16093 ((eq predicate 'agenda)
16094 (lambda (b)
16095 (with-current-buffer b
16096 (and (eq major-mode 'org-mode)
16097 (setq bfn (buffer-file-name b))
16098 (member (file-truename bfn) agenda-files)))))
16099 (t (lambda (b) (with-current-buffer b
16100 (or (eq major-mode 'org-mode)
16101 (string-match "\*Org .*Export"
16102 (buffer-name b)))))))))
16103 (delq nil
16104 (mapcar
16105 (lambda(b)
16106 (if (and (funcall filter b)
16107 (or (not exclude-tmp)
16108 (not (string-match "tmp" (buffer-name b)))))
16109 b
16110 nil))
16111 (buffer-list)))))
16113 (defun org-agenda-files (&optional unrestricted archives)
16114 "Get the list of agenda files.
16115 Optional UNRESTRICTED means return the full list even if a restriction
16116 is currently in place.
16117 When ARCHIVES is t, include all archive files that are really being
16118 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16119 `org-agenda-archives-mode' is t."
16120 (let ((files
16121 (cond
16122 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16123 ((stringp org-agenda-files) (org-read-agenda-file-list))
16124 ((listp org-agenda-files) org-agenda-files)
16125 (t (error "Invalid value of `org-agenda-files'")))))
16126 (setq files (apply 'append
16127 (mapcar (lambda (f)
16128 (if (file-directory-p f)
16129 (directory-files
16130 f t org-agenda-file-regexp)
16131 (list f)))
16132 files)))
16133 (when org-agenda-skip-unavailable-files
16134 (setq files (delq nil
16135 (mapcar (function
16136 (lambda (file)
16137 (and (file-readable-p file) file)))
16138 files))))
16139 (when (or (eq archives t)
16140 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16141 (setq files (org-add-archive-files files)))
16142 files))
16144 (defun org-agenda-file-p (&optional file)
16145 "Return non-nil, if FILE is an agenda file.
16146 If FILE is omitted, use the file associated with the current
16147 buffer."
16148 (member (or file (buffer-file-name))
16149 (org-agenda-files t)))
16151 (defun org-edit-agenda-file-list ()
16152 "Edit the list of agenda files.
16153 Depending on setup, this either uses customize to edit the variable
16154 `org-agenda-files', or it visits the file that is holding the list. In the
16155 latter case, the buffer is set up in a way that saving it automatically kills
16156 the buffer and restores the previous window configuration."
16157 (interactive)
16158 (if (stringp org-agenda-files)
16159 (let ((cw (current-window-configuration)))
16160 (find-file org-agenda-files)
16161 (org-set-local 'org-window-configuration cw)
16162 (org-add-hook 'after-save-hook
16163 (lambda ()
16164 (set-window-configuration
16165 (prog1 org-window-configuration
16166 (kill-buffer (current-buffer))))
16167 (org-install-agenda-files-menu)
16168 (message "New agenda file list installed"))
16169 nil 'local)
16170 (message "%s" (substitute-command-keys
16172 (customize-variable 'org-agenda-files)))
16174 (defun org-store-new-agenda-file-list (list)
16175 "Set new value for the agenda file list and save it correctly."
16176 (if (stringp org-agenda-files)
16177 (let ((fe (org-read-agenda-file-list t)) b u)
16178 (while (setq b (find-buffer-visiting org-agenda-files))
16179 (kill-buffer b))
16180 (with-temp-file org-agenda-files
16181 (insert
16182 (mapconcat
16183 (lambda (f) ;; Keep un-expanded entries.
16184 (if (setq u (assoc f fe))
16185 (cdr u)
16186 f))
16189 (let ((org-mode-hook nil) (org-inhibit-startup t)
16190 (org-insert-mode-line-in-empty-file nil))
16191 (setq org-agenda-files list)
16192 (customize-save-variable 'org-agenda-files org-agenda-files))))
16194 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16195 "Read the list of agenda files from a file.
16196 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16197 filenames, used by `org-store-new-agenda-file-list' to write back
16198 un-expanded file names."
16199 (when (file-directory-p org-agenda-files)
16200 (error "`org-agenda-files' cannot be a single directory"))
16201 (when (stringp org-agenda-files)
16202 (with-temp-buffer
16203 (insert-file-contents org-agenda-files)
16204 (mapcar
16205 (lambda (f)
16206 (let ((e (expand-file-name (substitute-in-file-name f)
16207 org-directory)))
16208 (if pair-with-expansion
16209 (cons e f)
16210 e)))
16213 ;;;###autoload
16214 (defun org-cycle-agenda-files ()
16215 "Cycle through the files in `org-agenda-files'.
16216 If the current buffer visits an agenda file, find the next one in the list.
16217 If the current buffer does not, find the first agenda file."
16218 (interactive)
16219 (let* ((fs (org-agenda-files t))
16220 (files (append fs (list (car fs))))
16221 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16222 file)
16223 (unless files (error "No agenda files"))
16224 (catch 'exit
16225 (while (setq file (pop files))
16226 (if (equal (file-truename file) tcf)
16227 (when (car files)
16228 (find-file (car files))
16229 (throw 'exit t))))
16230 (find-file (car fs)))
16231 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16233 (defun org-agenda-file-to-front (&optional to-end)
16234 "Move/add the current file to the top of the agenda file list.
16235 If the file is not present in the list, it is added to the front. If it is
16236 present, it is moved there. With optional argument TO-END, add/move to the
16237 end of the list."
16238 (interactive "P")
16239 (let ((org-agenda-skip-unavailable-files nil)
16240 (file-alist (mapcar (lambda (x)
16241 (cons (file-truename x) x))
16242 (org-agenda-files t)))
16243 (ctf (file-truename buffer-file-name))
16244 x had)
16245 (setq x (assoc ctf file-alist) had x)
16247 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16248 (if to-end
16249 (setq file-alist (append (delq x file-alist) (list x)))
16250 (setq file-alist (cons x (delq x file-alist))))
16251 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16252 (org-install-agenda-files-menu)
16253 (message "File %s to %s of agenda file list"
16254 (if had "moved" "added") (if to-end "end" "front"))))
16256 (defun org-remove-file (&optional file)
16257 "Remove current file from the list of files in variable `org-agenda-files'.
16258 These are the files which are being checked for agenda entries.
16259 Optional argument FILE means use this file instead of the current."
16260 (interactive)
16261 (let* ((org-agenda-skip-unavailable-files nil)
16262 (file (or file buffer-file-name))
16263 (true-file (file-truename file))
16264 (afile (abbreviate-file-name file))
16265 (files (delq nil (mapcar
16266 (lambda (x)
16267 (if (equal true-file
16268 (file-truename x))
16269 nil x))
16270 (org-agenda-files t)))))
16271 (if (not (= (length files) (length (org-agenda-files t))))
16272 (progn
16273 (org-store-new-agenda-file-list files)
16274 (org-install-agenda-files-menu)
16275 (message "Removed file: %s" afile))
16276 (message "File was not in list: %s (not removed)" afile))))
16278 (defun org-file-menu-entry (file)
16279 (vector file (list 'find-file file) t))
16281 (defun org-check-agenda-file (file)
16282 "Make sure FILE exists. If not, ask user what to do."
16283 (when (not (file-exists-p file))
16284 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16285 (abbreviate-file-name file))
16286 (let ((r (downcase (read-char-exclusive))))
16287 (cond
16288 ((equal r ?r)
16289 (org-remove-file file)
16290 (throw 'nextfile t))
16291 (t (error "Abort"))))))
16293 (defun org-get-agenda-file-buffer (file)
16294 "Get a buffer visiting FILE. If the buffer needs to be created, add
16295 it to the list of buffers which might be released later."
16296 (let ((buf (org-find-base-buffer-visiting file)))
16297 (if buf
16298 buf ; just return it
16299 ;; Make a new buffer and remember it
16300 (setq buf (find-file-noselect file))
16301 (if buf (push buf org-agenda-new-buffers))
16302 buf)))
16304 (defun org-release-buffers (blist)
16305 "Release all buffers in list, asking the user for confirmation when needed.
16306 When a buffer is unmodified, it is just killed. When modified, it is saved
16307 \(if the user agrees) and then killed."
16308 (let (buf file)
16309 (while (setq buf (pop blist))
16310 (setq file (buffer-file-name buf))
16311 (when (and (buffer-modified-p buf)
16312 file
16313 (y-or-n-p (format "Save file %s? " file)))
16314 (with-current-buffer buf (save-buffer)))
16315 (kill-buffer buf))))
16317 (defun org-prepare-agenda-buffers (files)
16318 "Create buffers for all agenda files, protect archived trees and comments."
16319 (interactive)
16320 (let ((pa '(:org-archived t))
16321 (pc '(:org-comment t))
16322 (pall '(:org-archived t :org-comment t))
16323 (inhibit-read-only t)
16324 (rea (concat ":" org-archive-tag ":"))
16325 bmp file re)
16326 (save-excursion
16327 (save-restriction
16328 (while (setq file (pop files))
16329 (catch 'nextfile
16330 (if (bufferp file)
16331 (set-buffer file)
16332 (org-check-agenda-file file)
16333 (set-buffer (org-get-agenda-file-buffer file)))
16334 (widen)
16335 (setq bmp (buffer-modified-p))
16336 (org-refresh-category-properties)
16337 (setq org-todo-keywords-for-agenda
16338 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16339 (setq org-done-keywords-for-agenda
16340 (append org-done-keywords-for-agenda org-done-keywords))
16341 (setq org-todo-keyword-alist-for-agenda
16342 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16343 (setq org-drawers-for-agenda
16344 (append org-drawers-for-agenda org-drawers))
16345 (setq org-tag-alist-for-agenda
16346 (append org-tag-alist-for-agenda org-tag-alist))
16348 (save-excursion
16349 (remove-text-properties (point-min) (point-max) pall)
16350 (when org-agenda-skip-archived-trees
16351 (goto-char (point-min))
16352 (while (re-search-forward rea nil t)
16353 (if (org-on-heading-p t)
16354 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16355 (goto-char (point-min))
16357 (while (re-search-forward re nil t)
16358 (add-text-properties
16359 (match-beginning 0) (org-end-of-subtree t) pc)))
16360 (set-buffer-modified-p bmp)))))
16361 (setq org-todo-keywords-for-agenda
16362 (org-uniquify org-todo-keywords-for-agenda))
16363 (setq org-todo-keyword-alist-for-agenda
16364 (org-uniquify org-todo-keyword-alist-for-agenda)
16365 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16367 ;;;; Embedded LaTeX
16369 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16370 "Keymap for the minor `org-cdlatex-mode'.")
16372 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16373 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16374 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16375 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16376 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16378 (defvar org-cdlatex-texmathp-advice-is-done nil
16379 "Flag remembering if we have applied the advice to texmathp already.")
16381 (define-minor-mode org-cdlatex-mode
16382 "Toggle the minor `org-cdlatex-mode'.
16383 This mode supports entering LaTeX environment and math in LaTeX fragments
16384 in Org-mode.
16386 nil " OCDL" nil
16387 (when org-cdlatex-mode
16388 (require 'cdlatex)
16389 (run-hooks 'cdlatex-mode-hook)
16390 (cdlatex-compute-tables))
16391 (unless org-cdlatex-texmathp-advice-is-done
16392 (setq org-cdlatex-texmathp-advice-is-done t)
16393 (defadvice texmathp (around org-math-always-on activate)
16394 "Always return t in org-mode buffers.
16395 This is because we want to insert math symbols without dollars even outside
16396 the LaTeX math segments. If Orgmode thinks that point is actually inside
16397 an embedded LaTeX fragment, let texmathp do its job.
16399 (interactive)
16400 (let (p)
16401 (cond
16402 ((not (eq major-mode 'org-mode)) ad-do-it)
16403 ((eq this-command 'cdlatex-math-symbol)
16404 (setq ad-return-value t
16405 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16406 (t
16407 (let ((p (org-inside-LaTeX-fragment-p)))
16408 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16409 (setq ad-return-value t
16410 texmathp-why '("Org-mode embedded math" . 0))
16411 (if p ad-do-it)))))))))
16413 (defun turn-on-org-cdlatex ()
16414 "Unconditionally turn on `org-cdlatex-mode'."
16415 (org-cdlatex-mode 1))
16417 (defun org-inside-LaTeX-fragment-p ()
16418 "Test if point is inside a LaTeX fragment.
16420 sequence appearing also before point.
16421 Even though the matchers for math are configurable, this function assumes
16423 delimiters are skipped when they have been removed by customization.
16424 The return value is nil, or a cons cell with the delimiter and the
16425 position of this delimiter.
16427 This function does a reasonably good job, but can locally be fooled by
16428 for example currency specifications. For example it will assume being in
16430 fragments that are properly closed, but during editing, we have to live
16431 with the uncertainty caused by missing closing delimiters. This function
16432 looks only before point, not after."
16433 (catch 'exit
16434 (let ((pos (point))
16435 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16436 (lim (progn
16438 (point)))
16439 dd-on str (start 0) m re)
16440 (goto-char pos)
16441 (when dodollar
16443 re (nth 1 (assoc "$" org-latex-regexps)))
16444 (while (string-match re str start)
16445 (cond
16446 ((= (match-end 0) (length str))
16447 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16448 ((= (match-end 0) (- (length str) 5))
16449 (throw 'exit nil))
16450 (t (setq start (match-end 0))))))
16451 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16452 (goto-char pos)
16453 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16454 (and (match-beginning 2) (throw 'exit nil))
16455 ;; count $$
16457 (setq dd-on (not dd-on)))
16458 (goto-char pos)
16459 (if dd-on (cons "$$" m))))))
16461 (defun org-inside-latex-macro-p ()
16462 "Is point inside a LaTeX macro or its arguments?"
16463 (save-match-data
16464 (org-in-regexp
16467 (defun org-try-cdlatex-tab ()
16468 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16469 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16470 - inside a LaTeX fragment, or
16471 - after the first word in a line, where an abbreviation expansion could
16472 insert a LaTeX environment."
16473 (when org-cdlatex-mode
16474 (cond
16475 ((save-excursion
16476 (skip-chars-backward "a-zA-Z0-9*")
16478 (bolp))
16479 (cdlatex-tab) t)
16480 ((org-inside-LaTeX-fragment-p)
16481 (cdlatex-tab) t)
16482 (t nil))))
16484 (defun org-cdlatex-underscore-caret (&optional arg)
16485 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16486 Revert to the normal definition outside of these fragments."
16487 (interactive "P")
16488 (if (org-inside-LaTeX-fragment-p)
16489 (call-interactively 'cdlatex-sub-superscript)
16490 (let (org-cdlatex-mode)
16491 (call-interactively (key-binding (vector last-input-event))))))
16493 (defun org-cdlatex-math-modify (&optional arg)
16494 "Execute `cdlatex-math-modify' in LaTeX fragments.
16495 Revert to the normal definition outside of these fragments."
16496 (interactive "P")
16497 (if (org-inside-LaTeX-fragment-p)
16498 (call-interactively 'cdlatex-math-modify)
16499 (let (org-cdlatex-mode)
16500 (call-interactively (key-binding (vector last-input-event))))))
16502 (defvar org-latex-fragment-image-overlays nil
16503 "List of overlays carrying the images of latex fragments.")
16504 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16506 (defun org-remove-latex-fragment-image-overlays ()
16507 "Remove all overlays with LaTeX fragment images in current buffer."
16508 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16509 (setq org-latex-fragment-image-overlays nil))
16511 (defun org-preview-latex-fragment (&optional subtree)
16512 "Preview the LaTeX fragment at point, or all locally or globally.
16513 If the cursor is in a LaTeX fragment, create the image and overlay
16514 it over the source code. If there is no fragment at point, display
16515 all fragments in the current text, from one headline to the next. With
16516 prefix SUBTREE, display all fragments in the current subtree. With a
16518 the cursor is before the first headline,
16519 display all fragments in the buffer.
16521 (interactive "P")
16522 (org-remove-latex-fragment-image-overlays)
16523 (save-excursion
16524 (save-restriction
16525 (let (beg end at msg)
16526 (cond
16527 ((or (equal subtree '(16))
16528 (not (save-excursion
16529 (re-search-backward org-outline-regexp-bol nil t))))
16530 (setq beg (point-min) end (point-max)
16531 msg "Creating images for buffer...%s"))
16532 ((equal subtree '(4))
16533 (org-back-to-heading)
16534 (setq beg (point) end (org-end-of-subtree t)
16535 msg "Creating images for subtree...%s"))
16536 (t
16537 (if (setq at (org-inside-LaTeX-fragment-p))
16538 (goto-char (max (point-min) (- (cdr at) 2)))
16539 (org-back-to-heading))
16540 (setq beg (point) end (progn (outline-next-heading) (point))
16541 msg (if at "Creating image...%s"
16542 "Creating images for entry...%s"))))
16543 (message msg "")
16544 (narrow-to-region beg end)
16545 (goto-char beg)
16546 (org-format-latex
16547 (concat "ltxpng/" (file-name-sans-extension
16548 (file-name-nondirectory
16549 buffer-file-name)))
16550 default-directory 'overlays msg at 'forbuffer 'dvipng)
16551 (message msg "done. Use `C-c C-c' to remove images.")))))
16553 (defvar org-latex-regexps
16555 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16558 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16562 "Regular expressions for matching embedded LaTeX.")
16564 (defvar org-export-have-math nil) ;; dynamic scoping
16565 (defun org-format-latex (prefix &optional dir overlays msg at
16566 forbuffer processing-type)
16567 "Replace LaTeX fragments with links to an image, and produce images.
16568 Some of the options can be changed using the variable
16569 `org-format-latex-options'."
16570 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16571 (let* ((prefixnodir (file-name-nondirectory prefix))
16572 (absprefix (expand-file-name prefix dir))
16573 (todir (file-name-directory absprefix))
16574 (opt org-format-latex-options)
16575 (matchers (plist-get opt :matchers))
16576 (re-list org-latex-regexps)
16577 (org-format-latex-header-extra
16578 (plist-get (org-infile-export-plist) :latex-header-extra))
16579 (cnt 0) txt hash link beg end re e checkdir
16580 executables-checked string
16581 m n block-type block linkfile movefile ov)
16582 ;; Check the different regular expressions
16583 (while (setq e (pop re-list))
16584 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16586 (when (member m matchers)
16587 (goto-char (point-min))
16588 (while (re-search-forward re nil t)
16589 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16590 (not (get-text-property (match-beginning n)
16591 'org-protected))
16592 (or (not overlays)
16593 (not (eq (get-char-property (match-beginning n)
16594 'org-overlay-type)
16595 'org-latex-overlay))))
16596 (setq org-export-have-math t)
16597 (cond
16598 ((eq processing-type 'verbatim)
16599 ;; Leave the text verbatim, just protect it
16600 (add-text-properties (match-beginning n) (match-end n)
16601 '(org-protected t)))
16602 ((eq processing-type 'mathjax)
16603 ;; Prepare for MathJax processing
16604 (setq string (match-string n))
16605 (if (member m '("$" "$1"))
16606 (save-excursion
16607 (delete-region (match-beginning n) (match-end n))
16608 (goto-char (match-beginning n))
16611 '(org-protected t))))
16612 (add-text-properties (match-beginning n) (match-end n)
16613 '(org-protected t))))
16614 ((eq processing-type 'dvipng)
16615 ;; Process to an image
16616 (setq txt (match-string n)
16617 beg (match-beginning n) end (match-end n)
16618 cnt (1+ cnt))
16619 (let (print-length print-level) ; make sure full list is printed
16620 (setq hash (sha1 (prin1-to-string
16621 (list org-format-latex-header
16622 org-format-latex-header-extra
16623 org-export-latex-default-packages-alist
16624 org-export-latex-packages-alist
16625 org-format-latex-options
16626 forbuffer txt)))
16627 linkfile (format "%s_%s.png" prefix hash)
16628 movefile (format "%s_%s.png" absprefix hash)))
16629 (setq link (concat block "[[file:" linkfile "]]" block))
16630 (if msg (message msg cnt))
16631 (goto-char beg)
16632 (unless checkdir ; make sure the directory exists
16633 (setq checkdir t)
16634 (or (file-directory-p todir) (make-directory todir t)))
16636 (unless executables-checked
16637 (org-check-external-command
16638 "latex" "needed to convert LaTeX fragments to images")
16639 (org-check-external-command
16640 "dvipng" "needed to convert LaTeX fragments to images")
16641 (setq executables-checked t))
16643 (unless (file-exists-p movefile)
16644 (org-create-formula-image
16645 txt movefile opt forbuffer))
16646 (if overlays
16647 (progn
16648 (mapc (lambda (o)
16649 (if (eq (overlay-get o 'org-overlay-type)
16650 'org-latex-overlay)
16651 (delete-overlay o)))
16652 (overlays-in beg end))
16653 (setq ov (make-overlay beg end))
16654 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16655 (if (featurep 'xemacs)
16656 (progn
16657 (overlay-put ov 'invisible t)
16658 (overlay-put
16659 ov 'end-glyph
16660 (make-glyph (vector 'png :file movefile))))
16661 (overlay-put
16662 ov 'display
16663 (list 'image :type 'png :file movefile :ascent 'center)))
16664 (push ov org-latex-fragment-image-overlays)
16665 (goto-char end))
16666 (delete-region beg end)
16667 (insert (org-add-props link
16668 (list 'org-latex-src
16669 (replace-regexp-in-string
16671 'org-latex-src-embed-type
16672 (if block-type 'paragraph 'character))))))
16673 ((eq processing-type 'mathml)
16674 ;; Process to MathML
16675 (unless executables-checked
16676 (unless (save-match-data (org-format-latex-mathml-available-p))
16677 (error "LaTeX to MathML converter not configured"))
16678 (setq executables-checked t))
16679 (setq txt (match-string n)
16680 beg (match-beginning n) end (match-end n)
16681 cnt (1+ cnt))
16682 (if msg (message msg cnt))
16683 (goto-char beg)
16684 (delete-region beg end)
16685 (insert (org-format-latex-as-mathml
16686 txt block-type prefix dir)))
16687 (t
16688 (error "Unknown conversion type %s for latex fragments"
16689 processing-type)))))))))
16691 (defun org-create-math-formula (latex-frag &optional mathml-file)
16692 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16693 Use `org-latex-to-mathml-convert-command'. If the conversion is
16695 elements otherwise return nil. When MATHML-FILE is specified,
16696 write the results in to that file. When invoked as an
16697 interactive command, prompt for LATEX-FRAG, with initial value
16698 set to the current active region and echo the results for user
16699 inspection."
16700 (interactive (list (let ((frag (when (region-active-p)
16701 (buffer-substring-no-properties
16702 (region-beginning) (region-end)))))
16703 (read-string "LaTeX Fragment: " frag nil frag))))
16704 (unless latex-frag (error "Invalid latex-frag"))
16705 (let* ((tmp-in-file (file-relative-name
16706 (make-temp-name (expand-file-name "ltxmathml-in"))))
16707 (ignore (write-region latex-frag nil tmp-in-file))
16708 (tmp-out-file (file-relative-name
16709 (make-temp-name (expand-file-name "ltxmathml-out"))))
16710 (cmd (format-spec
16711 org-latex-to-mathml-convert-command
16712 `((?j . ,(shell-quote-argument
16713 (expand-file-name org-latex-to-mathml-jar-file)))
16714 (?I . ,(shell-quote-argument tmp-in-file))
16715 (?o . ,(shell-quote-argument tmp-out-file)))))
16716 mathml shell-command-output)
16717 (when (org-called-interactively-p 'any)
16718 (unless (org-format-latex-mathml-available-p)
16719 (error "LaTeX to MathML converter not configured")))
16720 (message "Running %s" cmd)
16721 (setq shell-command-output (shell-command-to-string cmd))
16722 (setq mathml
16723 (when (file-readable-p tmp-out-file)
16724 (with-current-buffer (find-file-noselect tmp-out-file t)
16725 (goto-char (point-min))
16726 (when (re-search-forward
16727 (concat
16728 (regexp-quote
16731 (regexp-quote "</math>")) nil t)
16732 (prog1 (match-string 0) (kill-buffer))))))
16733 (cond
16734 (mathml
16735 (setq mathml
16737 (when mathml-file
16738 (write-region mathml nil mathml-file))
16739 (when (org-called-interactively-p 'any)
16740 (message mathml)))
16741 ((message "LaTeX to MathML conversion failed")
16742 (message shell-command-output)))
16743 (delete-file tmp-in-file)
16744 (when (file-exists-p tmp-out-file)
16745 (delete-file tmp-out-file))
16746 mathml))
16748 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16749 prefix &optional dir)
16750 "Use `org-create-math-formula' but check local cache first."
16751 (let* ((absprefix (expand-file-name prefix dir))
16752 (print-length nil) (print-level nil)
16753 (formula-id (concat
16754 "formula-"
16755 (sha1
16756 (prin1-to-string
16757 (list latex-frag
16758 org-latex-to-mathml-convert-command)))))
16759 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16760 (formula-cache-dir (file-name-directory formula-cache)))
16762 (unless (file-directory-p formula-cache-dir)
16763 (make-directory formula-cache-dir t))
16765 (unless (file-exists-p formula-cache)
16766 (org-create-math-formula latex-frag formula-cache))
16768 (if (file-exists-p formula-cache)
16769 ;; Successful conversion. Return the link to MathML file.
16770 (org-add-props
16771 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16773 'org-latex-src-embed-type (if latex-frag-type
16774 'paragraph 'character)))
16775 ;; Failed conversion. Return the LaTeX fragment verbatim
16776 (add-text-properties
16777 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16778 latex-frag)))
16780 ;; This function borrows from Ganesh Swami's latex2png.el
16781 (defun org-create-formula-image (string tofile options buffer)
16782 "This calls dvipng."
16783 (require 'org-latex)
16784 (let* ((tmpdir (if (featurep 'xemacs)
16785 (temp-directory)
16786 temporary-file-directory))
16787 (texfilebase (make-temp-name
16788 (expand-file-name "orgtex" tmpdir)))
16789 (texfile (concat texfilebase ".tex"))
16790 (dvifile (concat texfilebase ".dvi"))
16791 (pngfile (concat texfilebase ".png"))
16792 (fnh (if (featurep 'xemacs)
16793 (font-height (get-face-font 'default))
16794 (face-attribute 'default :height nil)))
16795 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16796 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16797 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16798 "Black"))
16799 (bg (or (plist-get options (if buffer :background :html-background))
16800 "Transparent")))
16801 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16802 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16803 (with-temp-file texfile
16804 (insert (org-splice-latex-header
16805 org-format-latex-header
16806 org-export-latex-default-packages-alist
16807 org-export-latex-packages-alist t
16808 org-format-latex-header-extra))
16810 (require 'org-latex)
16811 (org-export-latex-fix-inputenc))
16812 (let ((dir default-directory))
16813 (condition-case nil
16814 (progn
16815 (cd tmpdir)
16816 (call-process "latex" nil nil nil texfile))
16817 (error nil))
16818 (cd dir))
16819 (if (not (file-exists-p dvifile))
16820 (progn (message "Failed to create dvi file from %s" texfile) nil)
16821 (condition-case nil
16822 (call-process "dvipng" nil nil nil
16823 "-fg" fg "-bg" bg
16824 "-D" dpi
16825 ;;"-x" scale "-y" scale
16826 "-T" "tight"
16827 "-o" pngfile
16828 dvifile)
16829 (error nil))
16830 (if (not (file-exists-p pngfile))
16831 (if org-format-latex-signal-error
16832 (error "Failed to create png file from %s" texfile)
16833 (message "Failed to create png file from %s" texfile)
16834 nil)
16835 ;; Use the requested file name and clean up
16836 (copy-file pngfile tofile 'replace)
16837 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16838 (delete-file (concat texfilebase e)))
16839 pngfile))))
16841 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16842 "Fill a LaTeX header template TPL.
16843 In the template, the following place holders will be recognized:
16846 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16848 [NO-PACKAGES] do not include PKG
16849 [EXTRA] the string EXTRA
16850 [NO-EXTRA] do not include EXTRA
16852 For backward compatibility, if both the positive and the negative place
16854 assumed to be present at the end of the template.
16855 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16856 EXTRA is a string.
16857 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16858 (let (rpl (end ""))
16860 (setq rpl (if (or (match-end 1) (not def-pkg))
16861 "" (org-latex-packages-to-string def-pkg snippets-p t))
16862 tpl (replace-match rpl t t tpl))
16863 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16866 (setq rpl (if (or (match-end 1) (not pkg))
16867 "" (org-latex-packages-to-string pkg snippets-p t))
16868 tpl (replace-match rpl t t tpl))
16869 (if pkg (setq end
16871 (org-latex-packages-to-string pkg snippets-p)))))
16874 (setq rpl (if (or (match-end 1) (not extra))
16876 tpl (replace-match rpl t t tpl))
16882 tpl)))
16884 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16886 (setq pkg (mapconcat (lambda(p)
16887 (cond
16888 ((stringp p) p)
16889 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16890 (format "%% Package %s omitted" (cadr p)))
16891 ((equal "" (car p))
16893 (t
16895 (car p) (cadr p)))))
16896 pkg
16900 (defun org-dvipng-color (attr)
16901 "Return an rgb color specification for dvipng."
16902 (apply 'format "rgb %s %s %s"
16903 (mapcar 'org-normalize-color
16904 (color-values (face-attribute 'default attr nil)))))
16906 (defun org-normalize-color (value)
16907 "Return string to be used as color value for an RGB component."
16908 (format "%g" (/ value 65535.0)))
16910 ;; Image display
16913 (defvar org-inline-image-overlays nil)
16914 (make-variable-buffer-local 'org-inline-image-overlays)
16916 (defun org-toggle-inline-images (&optional include-linked)
16917 "Toggle the display of inline images.
16918 INCLUDE-LINKED is passed to `org-display-inline-images'."
16919 (interactive "P")
16920 (if org-inline-image-overlays
16921 (progn
16922 (org-remove-inline-images)
16923 (message "Inline image display turned off"))
16924 (org-display-inline-images include-linked)
16925 (if org-inline-image-overlays
16926 (message "%d images displayed inline"
16927 (length org-inline-image-overlays))
16928 (message "No images to display inline"))))
16930 (defun org-display-inline-images (&optional include-linked refresh beg end)
16931 "Display inline images.
16932 Normally only links without a description part are inlined, because this
16933 is how it will work for export. When INCLUDE-LINKED is set, also links
16934 with a description part will be inlined. This can be nice for a quick
16935 look at those images, but it does not reflect what exported files will look
16936 like.
16937 When REFRESH is set, refresh existing images between BEG and END.
16938 This will create new image displays only if necessary.
16939 BEG and END default to the buffer boundaries."
16940 (interactive "P")
16941 (unless refresh
16942 (org-remove-inline-images)
16943 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16944 (save-excursion
16945 (save-restriction
16946 (widen)
16947 (setq beg (or beg (point-min)) end (or end (point-max)))
16948 (goto-char (point-min))
16950 (substring (org-image-file-name-regexp) 0 -2)
16952 old file ov img)
16953 (while (re-search-forward re end t)
16954 (setq old (get-char-property-and-overlay (match-beginning 1)
16955 'org-image-overlay))
16956 (setq file (expand-file-name
16957 (concat (or (match-string 3) "") (match-string 4))))
16958 (when (file-exists-p file)
16959 (if (and (car-safe old) refresh)
16960 (image-refresh (overlay-get (cdr old) 'display))
16961 (setq img (save-match-data (create-image file)))
16962 (when img
16963 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16964 (overlay-put ov 'display img)
16965 (overlay-put ov 'face 'default)
16966 (overlay-put ov 'org-image-overlay t)
16967 (overlay-put ov 'modification-hooks
16968 (list 'org-display-inline-modification-hook))
16969 (push ov org-inline-image-overlays)))))))))
16971 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16972 "Remove inline-display overlay if a corresponding region is modified."
16973 (let ((inhibit-modification-hooks t))
16974 (when (and ov after)
16975 (delete ov org-inline-image-overlays)
16976 (delete-overlay ov))))
16978 (defun org-remove-inline-images ()
16979 "Remove inline display of images."
16980 (interactive)
16981 (mapc 'delete-overlay org-inline-image-overlays)
16982 (setq org-inline-image-overlays nil))
16984 ;;;; Key bindings
16986 ;; Remap outline keys
16987 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
16988 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
16990 ;; Make `C-c C-x' a prefix key
16991 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16993 ;; TAB key with modifiers
16994 (org-defkey org-mode-map "\C-i" 'org-cycle)
16995 (org-defkey org-mode-map [(tab)] 'org-cycle)
16996 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16997 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16999 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17000 ;; The following line is necessary under Suse GNU/Linux
17001 (unless (featurep 'xemacs)
17002 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17003 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17004 (define-key org-mode-map [backtab] 'org-shifttab)
17006 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17007 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17008 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17010 ;; Cursor keys with modifiers
17011 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17012 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17013 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17014 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17016 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17017 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17018 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17019 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17021 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17022 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17023 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17024 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17026 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17027 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17028 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17029 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17031 ;; Babel keys
17032 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17033 (mapc (lambda (pair)
17034 (define-key org-babel-map (car pair) (cdr pair)))
17035 org-babel-key-bindings)
17037 ;;; Extra keys for tty access.
17038 ;; We only set them when really needed because otherwise the
17039 ;; menus don't show the simple keys
17041 (when (or org-use-extra-keys
17042 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17043 (not window-system))
17044 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17045 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17046 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17047 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17048 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17049 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17050 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17051 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17052 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17053 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17054 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17055 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17056 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17057 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17058 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17059 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17060 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17061 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17062 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17063 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17064 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17065 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17066 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17067 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17068 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17069 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17070 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17071 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17073 ;; All the other keys
17075 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17076 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17077 (if (boundp 'narrow-map)
17078 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17079 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17080 (if (boundp 'narrow-map)
17081 (org-defkey narrow-map "b" 'org-narrow-to-block)
17082 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17083 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17084 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17085 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17086 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17087 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17088 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17089 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17090 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17091 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17092 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17093 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17094 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17095 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17096 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17097 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17098 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17100 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17101 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17102 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17103 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17104 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17105 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17106 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17107 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17108 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17109 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17110 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17111 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17112 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17113 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17114 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17115 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17116 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17117 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17118 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17119 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17121 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17122 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17123 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17124 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17125 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17126 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17127 (org-defkey org-mode-map "\C-c^" 'org-sort)
17128 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17129 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17130 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17131 (org-defkey org-mode-map "\C-m" 'org-return)
17132 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17133 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17134 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17135 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17136 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17137 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17138 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17139 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17140 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17141 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17142 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17143 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17144 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17145 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17146 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17147 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17148 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17149 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17150 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17151 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17152 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17153 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17155 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17156 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17157 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17158 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17160 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17161 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17162 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17163 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17164 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17165 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17166 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17167 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17168 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17169 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17171 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17172 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17173 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17174 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17175 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17176 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17177 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17179 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17180 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17181 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17182 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17183 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17185 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17187 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17189 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17190 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17192 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17195 (when (featurep 'xemacs)
17196 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17199 (defconst org-speed-commands-default
17200 '(
17201 ("Outline Navigation")
17202 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17203 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17204 ("f" . (org-speed-move-safe 'org-forward-same-level))
17205 ("b" . (org-speed-move-safe 'org-backward-same-level))
17206 ("u" . (org-speed-move-safe 'outline-up-heading))
17207 ("j" . org-goto)
17208 ("g" . (org-refile t))
17209 ("Outline Visibility")
17210 ("c" . org-cycle)
17211 ("C" . org-shifttab)
17212 (" " . org-display-outline-path)
17213 ("Outline Structure Editing")
17214 ("U" . org-shiftmetaup)
17215 ("D" . org-shiftmetadown)
17216 ("r" . org-metaright)
17217 ("l" . org-metaleft)
17218 ("R" . org-shiftmetaright)
17219 ("L" . org-shiftmetaleft)
17220 ("i" . (progn (forward-char 1) (call-interactively
17221 'org-insert-heading-respect-content)))
17222 ("^" . org-sort)
17223 ("w" . org-refile)
17224 ("a" . org-archive-subtree-default-with-confirmation)
17225 ("." . org-mark-subtree)
17226 ("Clock Commands")
17227 ("I" . org-clock-in)
17228 ("O" . org-clock-out)
17229 ("Meta Data Editing")
17230 ("t" . org-todo)
17231 ("0" . (org-priority ?\ ))
17232 ("1" . (org-priority ?A))
17233 ("2" . (org-priority ?B))
17234 ("3" . (org-priority ?C))
17235 (";" . org-set-tags-command)
17236 ("e" . org-set-effort)
17237 ("Agenda Views etc")
17238 ("v" . org-agenda)
17239 ("/" . org-sparse-tree)
17240 ("Misc")
17241 ("o" . org-open-at-point)
17242 ("?" . org-speed-command-help)
17243 ("<" . (org-agenda-set-restriction-lock 'subtree))
17244 (">" . (org-agenda-remove-restriction-lock))
17245 )
17246 "The default speed commands.")
17248 (defun org-print-speed-command (e)
17249 (if (> (length (car e)) 1)
17250 (progn
17252 (princ (car e))
17254 (princ (make-string (length (car e)) ?-))
17256 (princ (car e))
17257 (princ " ")
17258 (if (symbolp (cdr e))
17259 (princ (symbol-name (cdr e)))
17260 (prin1 (cdr e)))
17263 (defun org-speed-command-help ()
17264 "Show the available speed commands."
17265 (interactive)
17266 (if (not org-use-speed-commands)
17267 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17268 (with-output-to-temp-buffer "*Help*"
17270 (mapc 'org-print-speed-command org-speed-commands-user)
17273 (mapc 'org-print-speed-command org-speed-commands-default))
17274 (with-current-buffer "*Help*"
17275 (setq truncate-lines t))))
17277 (defun org-speed-move-safe (cmd)
17278 "Execute CMD, but make sure that the cursor always ends up in a headline.
17279 If not, return to the original position and throw an error."
17280 (interactive)
17281 (let ((pos (point)))
17282 (call-interactively cmd)
17283 (unless (and (bolp) (org-on-heading-p))
17284 (goto-char pos)
17285 (error "Boundary reached while executing %s" cmd))))
17287 (defvar org-self-insert-command-undo-counter 0)
17289 (defvar org-table-auto-blank-field) ; defined in org-table.el
17290 (defvar org-speed-command nil)
17292 (defun org-speed-command-default-hook (keys)
17293 "Hook for activating single-letter speed commands.
17294 `org-speed-commands-default' specifies a minimal command set.
17295 Use `org-speed-commands-user' for further customization."
17296 (when (or (and (bolp) (looking-at org-outline-regexp))
17297 (and (functionp org-use-speed-commands)
17298 (funcall org-use-speed-commands)))
17299 (cdr (assoc keys (append org-speed-commands-user
17300 org-speed-commands-default)))))
17302 (defun org-babel-speed-command-hook (keys)
17303 "Hook for activating single-letter code block commands."
17304 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17305 (cdr (assoc keys org-babel-key-bindings))))
17307 (defcustom org-speed-command-hook
17308 '(org-speed-command-default-hook org-babel-speed-command-hook)
17309 "Hook for activating speed commands at strategic locations.
17310 Hook functions are called in sequence until a valid handler is
17311 found.
17313 Each hook takes a single argument, a user-pressed command key
17314 which is also a `self-insert-command' from the global map.
17316 Within the hook, examine the cursor position and the command key
17317 and return nil or a valid handler as appropriate. Handler could
17318 be one of an interactive command, a function, or a form.
17320 Set `org-use-speed-commands' to non-nil value to enable this
17321 hook. The default setting is `org-speed-command-default-hook'."
17322 :group 'org-structure
17323 :type 'hook)
17325 (defun org-self-insert-command (N)
17326 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17327 If the cursor is in a table looking at whitespace, the whitespace is
17328 overwritten, and the table is not marked as requiring realignment."
17329 (interactive "p")
17330 (cond
17331 ((and org-use-speed-commands
17332 (setq org-speed-command
17333 (run-hook-with-args-until-success
17334 'org-speed-command-hook (this-command-keys))))
17335 (cond
17336 ((commandp org-speed-command)
17337 (setq this-command org-speed-command)
17338 (call-interactively org-speed-command))
17339 ((functionp org-speed-command)
17340 (funcall org-speed-command))
17341 ((and org-speed-command (listp org-speed-command))
17342 (eval org-speed-command))
17343 (t (let (org-use-speed-commands)
17344 (call-interactively 'org-self-insert-command)))))
17345 ((and
17346 (org-table-p)
17347 (progn
17348 ;; check if we blank the field, and if that triggers align
17349 (and (featurep 'org-table) org-table-auto-blank-field
17350 (member last-command
17351 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17353 ;; got extra space, this field does not determine column width
17354 (let (org-table-may-need-update) (org-table-blank-field))
17355 ;; no extra space, this field may determine column width
17356 (org-table-blank-field)))
17357 t)
17358 (eq N 1)
17360 (let (org-table-may-need-update)
17361 (goto-char (1- (match-end 0)))
17362 (delete-char -1)
17363 (goto-char (match-beginning 0))
17364 (self-insert-command N)))
17365 (t
17366 (setq org-table-may-need-update t)
17367 (self-insert-command N)
17368 (org-fix-tags-on-the-fly)
17369 (if org-self-insert-cluster-for-undo
17370 (if (not (eq last-command 'org-self-insert-command))
17371 (setq org-self-insert-command-undo-counter 1)
17372 (if (>= org-self-insert-command-undo-counter 20)
17373 (setq org-self-insert-command-undo-counter 1)
17374 (and (> org-self-insert-command-undo-counter 0)
17375 buffer-undo-list (listp buffer-undo-list)
17376 (not (cadr buffer-undo-list)) ; remove nil entry
17377 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17378 (setq org-self-insert-command-undo-counter
17379 (1+ org-self-insert-command-undo-counter))))))))
17381 (defun org-fix-tags-on-the-fly ()
17382 (when (and (equal (char-after (point-at-bol)) ?*)
17383 (org-on-heading-p))
17384 (org-align-tags-here org-tags-column)))
17386 (defun org-delete-backward-char (N)
17387 "Like `delete-backward-char', insert whitespace at field end in tables.
17388 When deleting backwards, in tables this function will insert whitespace in
17390 still be marked for re-alignment if the field did fill the entire column,
17391 because, in this case the deletion might narrow the column."
17392 (interactive "p")
17393 (if (and (org-table-p)
17394 (eq N 1)
17395 (string-match "|" (buffer-substring (point-at-bol) (point)))
17396 (looking-at ".*?|"))
17397 (let ((pos (point))
17399 (c org-table-may-need-update))
17400 (backward-delete-char N)
17401 (if (not overwrite-mode)
17402 (progn
17403 (skip-chars-forward "^|")
17404 (insert " ")
17405 (goto-char (1- pos))))
17406 ;; noalign: if there were two spaces at the end, this field
17407 ;; does not determine the width of the column.
17408 (if noalign (setq org-table-may-need-update c)))
17409 (backward-delete-char N)
17410 (org-fix-tags-on-the-fly)))
17412 (defun org-delete-char (N)
17413 "Like `delete-char', but insert whitespace at field end in tables.
17414 When deleting characters, in tables this function will insert whitespace in
17416 still be marked for re-alignment if the field did fill the entire column,
17417 because, in this case the deletion might narrow the column."
17418 (interactive "p")
17419 (if (and (org-table-p)
17420 (not (bolp))
17421 (not (= (char-after) ?|))
17422 (eq N 1))
17423 (if (looking-at ".*?|")
17424 (let ((pos (point))
17426 (c org-table-may-need-update))
17427 (replace-match (concat
17428 (substring (match-string 0) 1 -1)
17429 " |"))
17430 (goto-char pos)
17431 ;; noalign: if there were two spaces at the end, this field
17432 ;; does not determine the width of the column.
17433 (if noalign (setq org-table-may-need-update c)))
17434 (delete-char N))
17435 (delete-char N)
17436 (org-fix-tags-on-the-fly)))
17438 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17439 (put 'org-self-insert-command 'delete-selection t)
17440 (put 'orgtbl-self-insert-command 'delete-selection t)
17441 (put 'org-delete-char 'delete-selection 'supersede)
17442 (put 'org-delete-backward-char 'delete-selection 'supersede)
17443 (put 'org-yank 'delete-selection 'yank)
17445 ;; Make `flyspell-mode' delay after some commands
17446 (put 'org-self-insert-command 'flyspell-delayed t)
17447 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17448 (put 'org-delete-char 'flyspell-delayed t)
17449 (put 'org-delete-backward-char 'flyspell-delayed t)
17451 ;; Make pabbrev-mode expand after org-mode commands
17452 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17453 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17455 ;; How to do this: Measure non-white length of current string
17456 ;; If equal to column width, we should realign.
17458 (defun org-remap (map &rest commands)
17459 "In MAP, remap the functions given in COMMANDS.
17460 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17461 (let (new old)
17462 (while commands
17463 (setq old (pop commands) new (pop commands))
17464 (if (fboundp 'command-remapping)
17465 (org-defkey map (vector 'remap old) new)
17466 (substitute-key-definition old new map global-map)))))
17468 (when (eq org-enable-table-editor 'optimized)
17469 ;; If the user wants maximum table support, we need to hijack
17470 ;; some standard editing functions
17471 (org-remap org-mode-map
17472 'self-insert-command 'org-self-insert-command
17473 'delete-char 'org-delete-char
17474 'delete-backward-char 'org-delete-backward-char)
17475 (org-defkey org-mode-map "|" 'org-force-self-insert))
17477 (defvar org-ctrl-c-ctrl-c-hook nil
17478 "Hook for functions attaching themselves to `C-c C-c'.
17480 This can be used to add additional functionality to the C-c C-c
17481 key which executes context-dependent commands. This hook is run
17482 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17483 run after the last test.
17485 Each function will be called with no arguments. The function
17486 must check if the context is appropriate for it to act. If yes,
17487 it should do its thing and then return a non-nil value. If the
17488 context is wrong, just do nothing and return nil.")
17490 (defvar org-ctrl-c-ctrl-c-final-hook nil
17491 "Hook for functions attaching themselves to `C-c C-c'.
17493 This can be used to add additional functionality to the C-c C-c
17494 key which executes context-dependent commands. This hook is run
17495 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17496 before the first test.
17498 Each function will be called with no arguments. The function
17499 must check if the context is appropriate for it to act. If yes,
17500 it should do its thing and then return a non-nil value. If the
17501 context is wrong, just do nothing and return nil.")
17503 (defvar org-tab-first-hook nil
17504 "Hook for functions to attach themselves to TAB.
17505 See `org-ctrl-c-ctrl-c-hook' for more information.
17506 This hook runs as the first action when TAB is pressed, even before
17507 `org-cycle' messes around with the `outline-regexp' to cater for
17508 inline tasks and plain list item folding.
17509 If any function in this hook returns t, any other actions that
17510 would have been caused by TAB (such as table field motion or visibility
17511 cycling) will not occur.")
17513 (defvar org-tab-after-check-for-table-hook nil
17514 "Hook for functions to attach themselves to TAB.
17515 See `org-ctrl-c-ctrl-c-hook' for more information.
17516 This hook runs after it has been established that the cursor is not in a
17517 table, but before checking if the cursor is in a headline or if global cycling
17518 should be done.
17519 If any function in this hook returns t, not other actions like visibility
17520 cycling will be done.")
17522 (defvar org-tab-after-check-for-cycling-hook nil
17523 "Hook for functions to attach themselves to TAB.
17524 See `org-ctrl-c-ctrl-c-hook' for more information.
17525 This hook runs after it has been established that not table field motion and
17526 not visibility should be done because of current context. This is probably
17527 the place where a package like yasnippets can hook in.")
17529 (defvar org-tab-before-tab-emulation-hook nil
17530 "Hook for functions to attach themselves to TAB.
17531 See `org-ctrl-c-ctrl-c-hook' for more information.
17532 This hook runs after every other options for TAB have been exhausted, but
17535 (defvar org-metaleft-hook nil
17536 "Hook for functions attaching themselves to `M-left'.
17537 See `org-ctrl-c-ctrl-c-hook' for more information.")
17538 (defvar org-metaright-hook nil
17539 "Hook for functions attaching themselves to `M-right'.
17540 See `org-ctrl-c-ctrl-c-hook' for more information.")
17541 (defvar org-metaup-hook nil
17542 "Hook for functions attaching themselves to `M-up'.
17543 See `org-ctrl-c-ctrl-c-hook' for more information.")
17544 (defvar org-metadown-hook nil
17545 "Hook for functions attaching themselves to `M-down'.
17546 See `org-ctrl-c-ctrl-c-hook' for more information.")
17547 (defvar org-shiftmetaleft-hook nil
17548 "Hook for functions attaching themselves to `M-S-left'.
17549 See `org-ctrl-c-ctrl-c-hook' for more information.")
17550 (defvar org-shiftmetaright-hook nil
17551 "Hook for functions attaching themselves to `M-S-right'.
17552 See `org-ctrl-c-ctrl-c-hook' for more information.")
17553 (defvar org-shiftmetaup-hook nil
17554 "Hook for functions attaching themselves to `M-S-up'.
17555 See `org-ctrl-c-ctrl-c-hook' for more information.")
17556 (defvar org-shiftmetadown-hook nil
17557 "Hook for functions attaching themselves to `M-S-down'.
17558 See `org-ctrl-c-ctrl-c-hook' for more information.")
17559 (defvar org-metareturn-hook nil
17560 "Hook for functions attaching themselves to `M-RET'.
17561 See `org-ctrl-c-ctrl-c-hook' for more information.")
17562 (defvar org-shiftup-hook nil
17563 "Hook for functions attaching themselves to `S-up'.
17564 See `org-ctrl-c-ctrl-c-hook' for more information.")
17565 (defvar org-shiftup-final-hook nil
17566 "Hook for functions attaching themselves to `S-up'.
17567 This one runs after all other options except shift-select have been excluded.
17568 See `org-ctrl-c-ctrl-c-hook' for more information.")
17569 (defvar org-shiftdown-hook nil
17570 "Hook for functions attaching themselves to `S-down'.
17571 See `org-ctrl-c-ctrl-c-hook' for more information.")
17572 (defvar org-shiftdown-final-hook nil
17573 "Hook for functions attaching themselves to `S-down'.
17574 This one runs after all other options except shift-select have been excluded.
17575 See `org-ctrl-c-ctrl-c-hook' for more information.")
17576 (defvar org-shiftleft-hook nil
17577 "Hook for functions attaching themselves to `S-left'.
17578 See `org-ctrl-c-ctrl-c-hook' for more information.")
17579 (defvar org-shiftleft-final-hook nil
17580 "Hook for functions attaching themselves to `S-left'.
17581 This one runs after all other options except shift-select have been excluded.
17582 See `org-ctrl-c-ctrl-c-hook' for more information.")
17583 (defvar org-shiftright-hook nil
17584 "Hook for functions attaching themselves to `S-right'.
17585 See `org-ctrl-c-ctrl-c-hook' for more information.")
17586 (defvar org-shiftright-final-hook nil
17587 "Hook for functions attaching themselves to `S-right'.
17588 This one runs after all other options except shift-select have been excluded.
17589 See `org-ctrl-c-ctrl-c-hook' for more information.")
17591 (defun org-modifier-cursor-error ()
17592 "Throw an error, a modified cursor command was applied in wrong context."
17593 (error "This command is active in special context like tables, headlines or items"))
17595 (defun org-shiftselect-error ()
17596 "Throw an error because Shift-Cursor command was applied in wrong context."
17597 (if (and (boundp 'shift-select-mode) shift-select-mode)
17598 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17599 (error "This command works only in special context like headlines or timestamps")))
17601 (defun org-call-for-shift-select (cmd)
17602 (let ((this-command-keys-shift-translated t))
17603 (call-interactively cmd)))
17605 (defun org-shifttab (&optional arg)
17606 "Global visibility cycling or move to previous table field.
17607 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17608 on context.
17609 See the individual commands for more information."
17610 (interactive "P")
17611 (cond
17612 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17613 ((integerp arg)
17614 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17615 (message "Content view to level: %d" arg)
17616 (org-content (prefix-numeric-value arg2))
17617 (setq org-cycle-global-status 'overview)))
17618 (t (call-interactively 'org-global-cycle))))
17620 (defun org-shiftmetaleft ()
17621 "Promote subtree or delete table column.
17622 Calls `org-promote-subtree', `org-outdent-item',
17623 or `org-table-delete-column', depending on context.
17624 See the individual commands for more information."
17625 (interactive)
17626 (cond
17627 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17628 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17629 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17630 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17631 (t (org-modifier-cursor-error))))
17633 (defun org-shiftmetaright ()
17634 "Demote subtree or insert table column.
17635 Calls `org-demote-subtree', `org-indent-item',
17636 or `org-table-insert-column', depending on context.
17637 See the individual commands for more information."
17638 (interactive)
17639 (cond
17640 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17641 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17642 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17643 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17644 (t (org-modifier-cursor-error))))
17646 (defun org-shiftmetaup (&optional arg)
17647 "Move subtree up or kill table row.
17648 Calls `org-move-subtree-up' or `org-table-kill-row' or
17649 `org-move-item-up' depending on context. See the individual commands
17650 for more information."
17651 (interactive "P")
17652 (cond
17653 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17654 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17655 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17656 ((org-at-item-p) (call-interactively 'org-move-item-up))
17657 (t (org-modifier-cursor-error))))
17659 (defun org-shiftmetadown (&optional arg)
17660 "Move subtree down or insert table row.
17661 Calls `org-move-subtree-down' or `org-table-insert-row' or
17662 `org-move-item-down', depending on context. See the individual
17663 commands for more information."
17664 (interactive "P")
17665 (cond
17666 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17667 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17668 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17669 ((org-at-item-p) (call-interactively 'org-move-item-down))
17670 (t (org-modifier-cursor-error))))
17672 (defsubst org-hidden-tree-error ()
17673 (error
17674 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17676 (defun org-metaleft (&optional arg)
17677 "Promote heading or move table column to left.
17678 Calls `org-do-promote' or `org-table-move-column', depending on context.
17679 With no specific context, calls the Emacs default `backward-word'.
17680 See the individual commands for more information."
17681 (interactive "P")
17682 (cond
17683 ((run-hook-with-args-until-success 'org-metaleft-hook))
17684 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17685 ((org-with-limited-levels
17686 (or (org-on-heading-p)
17687 (and (org-region-active-p)
17688 (save-excursion
17689 (goto-char (region-beginning))
17690 (org-on-heading-p)))))
17691 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17692 (call-interactively 'org-do-promote))
17693 ;; At an inline task.
17694 ((org-on-heading-p)
17695 (call-interactively 'org-inlinetask-promote))
17696 ((or (org-at-item-p)
17697 (and (org-region-active-p)
17698 (save-excursion
17699 (goto-char (region-beginning))
17700 (org-at-item-p))))
17701 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17702 (call-interactively 'org-outdent-item))
17703 (t (call-interactively 'backward-word))))
17705 (defun org-metaright (&optional arg)
17706 "Demote subtree or move table column to right.
17707 Calls `org-do-demote' or `org-table-move-column', depending on context.
17708 With no specific context, calls the Emacs default `forward-word'.
17709 See the individual commands for more information."
17710 (interactive "P")
17711 (cond
17712 ((run-hook-with-args-until-success 'org-metaright-hook))
17713 ((org-at-table-p) (call-interactively 'org-table-move-column))
17714 ((org-with-limited-levels
17715 (or (org-on-heading-p)
17716 (and (org-region-active-p)
17717 (save-excursion
17718 (goto-char (region-beginning))
17719 (org-on-heading-p)))))
17720 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17721 (call-interactively 'org-do-demote))
17722 ;; At an inline task.
17723 ((org-on-heading-p)
17724 (call-interactively 'org-inlinetask-demote))
17725 ((or (org-at-item-p)
17726 (and (org-region-active-p)
17727 (save-excursion
17728 (goto-char (region-beginning))
17729 (org-at-item-p))))
17730 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17731 (call-interactively 'org-indent-item))
17732 (t (call-interactively 'forward-word))))
17734 (defun org-check-for-hidden (what)
17735 "Check if there are hidden headlines/items in the current visual line.
17736 WHAT can be either `headlines' or `items'. If the current line is
17737 an outline or item heading and it has a folded subtree below it,
17738 this function returns t, nil otherwise."
17739 (let ((re (cond
17740 ((eq what 'headlines) org-outline-regexp-bol)
17741 ((eq what 'items) (org-item-beginning-re))
17742 (t (error "This should not happen"))))
17743 beg end)
17744 (save-excursion
17745 (catch 'exit
17746 (unless (org-region-active-p)
17747 (setq beg (point-at-bol))
17748 (beginning-of-line 2)
17749 (while (and (not (eobp)) ;; this is like `next-line'
17750 (get-char-property (1- (point)) 'invisible))
17751 (beginning-of-line 2))
17752 (setq end (point))
17753 (goto-char beg)
17754 (goto-char (point-at-eol))
17755 (setq end (max end (point)))
17756 (while (re-search-forward re end t)
17757 (if (get-char-property (match-beginning 0) 'invisible)
17758 (throw 'exit t))))
17759 nil))))
17761 (defun org-metaup (&optional arg)
17762 "Move subtree up or move table row up.
17763 Calls `org-move-subtree-up' or `org-table-move-row' or
17764 `org-move-item-up', depending on context. See the individual commands
17765 for more information."
17766 (interactive "P")
17767 (cond
17768 ((run-hook-with-args-until-success 'org-metaup-hook))
17769 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17770 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17771 ((org-at-item-p) (call-interactively 'org-move-item-up))
17772 (t (transpose-lines 1) (beginning-of-line -1))))
17774 (defun org-metadown (&optional arg)
17775 "Move subtree down or move table row down.
17776 Calls `org-move-subtree-down' or `org-table-move-row' or
17777 `org-move-item-down', depending on context. See the individual
17778 commands for more information."
17779 (interactive "P")
17780 (cond
17781 ((run-hook-with-args-until-success 'org-metadown-hook))
17782 ((org-at-table-p) (call-interactively 'org-table-move-row))
17783 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17784 ((org-at-item-p) (call-interactively 'org-move-item-down))
17785 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17787 (defun org-shiftup (&optional arg)
17788 "Increase item in timestamp or increase priority of current headline.
17789 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17790 depending on context. See the individual commands for more information."
17791 (interactive "P")
17792 (cond
17793 ((run-hook-with-args-until-success 'org-shiftup-hook))
17794 ((and org-support-shift-select (org-region-active-p))
17795 (org-call-for-shift-select 'previous-line))
17796 ((org-at-timestamp-p t)
17797 (call-interactively (if org-edit-timestamp-down-means-later
17798 'org-timestamp-down 'org-timestamp-up)))
17799 ((and (not (eq org-support-shift-select 'always))
17800 org-enable-priority-commands
17801 (org-on-heading-p))
17802 (call-interactively 'org-priority-up))
17803 ((and (not org-support-shift-select) (org-at-item-p))
17804 (call-interactively 'org-previous-item))
17805 ((org-clocktable-try-shift 'up arg))
17806 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17807 (org-support-shift-select
17808 (org-call-for-shift-select 'previous-line))
17809 (t (org-shiftselect-error))))
17811 (defun org-shiftdown (&optional arg)
17812 "Decrease item in timestamp or decrease priority of current headline.
17813 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17814 depending on context. See the individual commands for more information."
17815 (interactive "P")
17816 (cond
17817 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17818 ((and org-support-shift-select (org-region-active-p))
17819 (org-call-for-shift-select 'next-line))
17820 ((org-at-timestamp-p t)
17821 (call-interactively (if org-edit-timestamp-down-means-later
17822 'org-timestamp-up 'org-timestamp-down)))
17823 ((and (not (eq org-support-shift-select 'always))
17824 org-enable-priority-commands
17825 (org-on-heading-p))
17826 (call-interactively 'org-priority-down))
17827 ((and (not org-support-shift-select) (org-at-item-p))
17828 (call-interactively 'org-next-item))
17829 ((org-clocktable-try-shift 'down arg))
17830 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17831 (org-support-shift-select
17832 (org-call-for-shift-select 'next-line))
17833 (t (org-shiftselect-error))))
17835 (defun org-shiftright (&optional arg)
17836 "Cycle the thing at point or in the current line, depending on context.
17837 Depending on context, this does one of the following:
17839 - switch a timestamp at point one day into the future
17840 - on a headline, switch to the next TODO keyword.
17841 - on an item, switch entire list to the next bullet type
17842 - on a property line, switch to the next allowed value
17843 - on a clocktable definition line, move time block into the future"
17844 (interactive "P")
17845 (cond
17846 ((run-hook-with-args-until-success 'org-shiftright-hook))
17847 ((and org-support-shift-select (org-region-active-p))
17848 (org-call-for-shift-select 'forward-char))
17849 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17850 ((and (not (eq org-support-shift-select 'always))
17851 (org-on-heading-p))
17852 (let ((org-inhibit-logging
17853 (not org-treat-S-cursor-todo-selection-as-state-change))
17854 (org-inhibit-blocking
17855 (not org-treat-S-cursor-todo-selection-as-state-change)))
17856 (org-call-with-arg 'org-todo 'right)))
17857 ((or (and org-support-shift-select
17858 (not (eq org-support-shift-select 'always))
17859 (org-at-item-bullet-p))
17860 (and (not org-support-shift-select) (org-at-item-p)))
17861 (org-call-with-arg 'org-cycle-list-bullet nil))
17862 ((and (not (eq org-support-shift-select 'always))
17863 (org-at-property-p))
17864 (call-interactively 'org-property-next-allowed-value))
17865 ((org-clocktable-try-shift 'right arg))
17866 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17867 (org-support-shift-select
17868 (org-call-for-shift-select 'forward-char))
17869 (t (org-shiftselect-error))))
17871 (defun org-shiftleft (&optional arg)
17872 "Cycle the thing at point or in the current line, depending on context.
17873 Depending on context, this does one of the following:
17875 - switch a timestamp at point one day into the past
17876 - on a headline, switch to the previous TODO keyword.
17877 - on an item, switch entire list to the previous bullet type
17878 - on a property line, switch to the previous allowed value
17879 - on a clocktable definition line, move time block into the past"
17880 (interactive "P")
17881 (cond
17882 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17883 ((and org-support-shift-select (org-region-active-p))
17884 (org-call-for-shift-select 'backward-char))
17885 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17886 ((and (not (eq org-support-shift-select 'always))
17887 (org-on-heading-p))
17888 (let ((org-inhibit-logging
17889 (not org-treat-S-cursor-todo-selection-as-state-change))
17890 (org-inhibit-blocking
17891 (not org-treat-S-cursor-todo-selection-as-state-change)))
17892 (org-call-with-arg 'org-todo 'left)))
17893 ((or (and org-support-shift-select
17894 (not (eq org-support-shift-select 'always))
17895 (org-at-item-bullet-p))
17896 (and (not org-support-shift-select) (org-at-item-p)))
17897 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17898 ((and (not (eq org-support-shift-select 'always))
17899 (org-at-property-p))
17900 (call-interactively 'org-property-previous-allowed-value))
17901 ((org-clocktable-try-shift 'left arg))
17902 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17903 (org-support-shift-select
17904 (org-call-for-shift-select 'backward-char))
17905 (t (org-shiftselect-error))))
17907 (defun org-shiftcontrolright ()
17908 "Switch to next TODO set."
17909 (interactive)
17910 (cond
17911 ((and org-support-shift-select (org-region-active-p))
17912 (org-call-for-shift-select 'forward-word))
17913 ((and (not (eq org-support-shift-select 'always))
17914 (org-on-heading-p))
17915 (org-call-with-arg 'org-todo 'nextset))
17916 (org-support-shift-select
17917 (org-call-for-shift-select 'forward-word))
17918 (t (org-shiftselect-error))))
17920 (defun org-shiftcontrolleft ()
17921 "Switch to previous TODO set."
17922 (interactive)
17923 (cond
17924 ((and org-support-shift-select (org-region-active-p))
17925 (org-call-for-shift-select 'backward-word))
17926 ((and (not (eq org-support-shift-select 'always))
17927 (org-on-heading-p))
17928 (org-call-with-arg 'org-todo 'previousset))
17929 (org-support-shift-select
17930 (org-call-for-shift-select 'backward-word))
17931 (t (org-shiftselect-error))))
17933 (defun org-shiftcontrolup ()
17934 "Change timestamps synchronously up in CLOCK log lines."
17935 (interactive)
17936 (cond ((and (not org-support-shift-select)
17937 (org-at-clock-log-p)
17938 (org-at-timestamp-p t))
17939 (org-clock-timestamps-up))
17940 (t (org-shiftselect-error))))
17942 (defun org-shiftcontroldown ()
17943 "Change timestamps synchronously down in CLOCK log lines."
17944 (interactive)
17945 (cond ((and (not org-support-shift-select)
17946 (org-at-clock-log-p)
17947 (org-at-timestamp-p t))
17948 (org-clock-timestamps-down))
17949 (t (org-shiftselect-error))))
17951 (defun org-ctrl-c-ret ()
17952 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17953 (interactive)
17954 (cond
17955 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17956 (t (call-interactively 'org-insert-heading))))
17958 (defun org-find-visible ()
17959 (let ((s (point)))
17960 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17961 (get-char-property s 'invisible)))
17962 s))
17963 (defun org-find-invisible ()
17964 (let ((s (point)))
17965 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17966 (not (get-char-property s 'invisible))))
17967 s))
17969 (defun org-copy-visible (beg end)
17970 "Copy the visible parts of the region."
17971 (interactive "r")
17972 (let (snippets s)
17973 (save-excursion
17974 (save-restriction
17975 (narrow-to-region beg end)
17976 (setq s (goto-char (point-min)))
17977 (while (not (= (point) (point-max)))
17978 (goto-char (org-find-invisible))
17979 (push (buffer-substring s (point)) snippets)
17980 (setq s (goto-char (org-find-visible))))))
17981 (kill-new (apply 'concat (nreverse snippets)))))
17983 (defun org-copy-special ()
17984 "Copy region in table or copy current subtree.
17985 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17986 See the individual commands for more information."
17987 (interactive)
17988 (call-interactively
17989 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17991 (defun org-cut-special ()
17992 "Cut region in table or cut current subtree.
17993 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17994 See the individual commands for more information."
17995 (interactive)
17996 (call-interactively
17997 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17999 (defun org-paste-special (arg)
18000 "Paste rectangular region into table, or past subtree relative to level.
18001 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18002 See the individual commands for more information."
18003 (interactive "P")
18004 (if (org-at-table-p)
18005 (org-table-paste-rectangle)
18006 (org-paste-subtree arg)))
18008 (defun org-edit-special (&optional arg)
18009 "Call a special editor for the stuff at point.
18010 When at a table, call the formula editor with `org-table-edit-formulas'.
18011 When at the first line of an src example, call `org-edit-src-code'.
18012 When in an #+include line, visit the include file. Otherwise call
18013 `ffap' to visit the file at point."
18014 (interactive)
18015 ;; possibly prep session before editing source
18016 (when arg
18017 (let* ((info (org-babel-get-src-block-info))
18018 (lang (nth 0 info))
18019 (params (nth 2 info))
18020 (session (cdr (assoc :session params))))
18021 (when (and info session) ;; we are in a source-code block with a session
18022 (funcall
18023 (intern (concat "org-babel-prep-session:" lang)) session params))))
18024 (cond ;; proceed with `org-edit-special'
18025 ((save-excursion
18026 (beginning-of-line 1)
18027 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18028 (find-file (org-trim (match-string 1))))
18029 ((org-edit-src-code))
18030 ((org-edit-fixed-width-region))
18031 ((org-at-table.el-p)
18032 (org-edit-src-code))
18033 ((or (org-at-table-p)
18034 (save-excursion
18035 (beginning-of-line 1)
18037 (call-interactively 'org-table-edit-formulas))
18038 (t (call-interactively 'ffap))))
18040 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18041 (defun org-ctrl-c-ctrl-c (&optional arg)
18042 "Set tags in headline, or update according to changed information at point.
18044 This command does many different things, depending on context:
18046 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18047 this is what we do.
18049 - If the cursor is on a statistics cookie, update it.
18051 - If the cursor is in a headline, prompt for tags and insert them
18052 into the current line, aligned to `org-tags-column'. When called
18053 with prefix arg, realign all tags in the current buffer.
18055 - If the cursor is in one of the special #+KEYWORD lines, this
18056 triggers scanning the buffer for these lines and updating the
18057 information.
18059 - If the cursor is inside a table, realign the table. This command
18060 works even if the automatic table editor has been turned off.
18062 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18063 the entire table.
18065 - If the cursor is at a footnote reference or definition, jump to
18066 the corresponding definition or references, respectively.
18068 - If the cursor is a the beginning of a dynamic block, update it.
18070 - If the current buffer is a capture buffer, close note and file it.
18072 - If the cursor is on a <<<target>>>, update radio targets and
18073 corresponding links in this buffer.
18075 - If the cursor is on a numbered item in a plain list, renumber the
18076 ordered list.
18078 - If the cursor is on a checkbox, toggle it.
18080 - If the cursor is on a code block, evaluate it. The variable
18081 `org-confirm-babel-evaluate' can be used to control prompting
18082 before code block evaluation, by default every code block
18083 evaluation requires confirmation. Code block evaluation can be
18084 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18085 (interactive "P")
18086 (let ((org-enable-table-editor t))
18087 (cond
18088 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18089 org-occur-highlights
18090 org-latex-fragment-image-overlays)
18091 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18092 (org-remove-occur-highlights)
18093 (org-remove-latex-fragment-image-overlays)
18094 (message "Temporary highlights/overlays removed from current buffer"))
18095 ((and (local-variable-p 'org-finish-function (current-buffer))
18096 (fboundp org-finish-function))
18097 (funcall org-finish-function))
18098 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18099 ((or (looking-at org-property-start-re)
18100 (org-at-property-p))
18101 (call-interactively 'org-property-action))
18102 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
18104 (or (org-on-heading-p) (org-at-item-p)))
18105 (call-interactively 'org-update-statistics-cookies))
18106 ((org-on-heading-p) (call-interactively 'org-set-tags))
18107 ((org-at-table.el-p)
18108 (message "Use C-c ' to edit table.el tables"))
18109 ((org-at-table-p)
18110 (org-table-maybe-eval-formula)
18111 (if arg
18112 (call-interactively 'org-table-recalculate)
18113 (org-table-maybe-recalculate-line))
18114 (call-interactively 'org-table-align)
18115 (orgtbl-send-table 'maybe))
18116 ((or (org-footnote-at-reference-p)
18117 (org-footnote-at-definition-p))
18118 (call-interactively 'org-footnote-action))
18119 ((org-at-item-checkbox-p)
18120 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18121 ;; list only if at top item.
18122 (let* ((cbox (match-string 1))
18123 (struct (org-list-struct))
18124 (old-struct (copy-tree struct))
18125 (parents (org-list-parents-alist struct))
18126 (orderedp (org-entry-get nil "ORDERED"))
18127 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18128 block-item)
18129 ;; Use a light version of `org-toggle-checkbox' to avoid
18130 ;; computing list structure twice.
18131 (org-list-set-checkbox (point-at-bol) struct
18132 (cond
18133 ((equal arg '(16)) "[-]")
18134 ((equal arg '(4)) nil)
18135 ((equal "[X]" cbox) "[ ]")
18136 (t "[X]")))
18137 ;; Replicate `org-list-write-struct', while grabbing a return
18138 ;; value from `org-list-struct-fix-box'.
18139 (org-list-struct-fix-ind struct parents 2)
18140 (org-list-struct-fix-item-end struct)
18141 (let ((prevs (org-list-prevs-alist struct)))
18142 (org-list-struct-fix-bul struct prevs)
18143 (org-list-struct-fix-ind struct parents)
18144 (setq block-item
18145 (org-list-struct-fix-box struct parents prevs orderedp)))
18146 (org-list-struct-apply-struct struct old-struct)
18147 (org-update-checkbox-count-maybe)
18148 (when block-item
18149 (message
18150 "Checkboxes were removed due to unchecked box at line %d"
18151 (org-current-line block-item)))
18152 (when firstp (org-list-send-list 'maybe))))
18153 ((org-at-item-p)
18154 ;; Cursor at an item: repair list. Do checkbox related actions
18155 ;; only if function was called with an argument. Send list only
18156 ;; if at top item.
18157 (let* ((struct (org-list-struct))
18158 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
18159 (when arg (org-list-set-checkbox (point-at-bol) struct "[ ]"))
18160 (org-list-write-struct struct (org-list-parents-alist struct))
18161 (when arg (org-update-checkbox-count-maybe))
18162 (when firstp (org-list-send-list 'maybe))))
18163 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18164 ;; Dynamic block
18165 (beginning-of-line 1)
18166 (save-excursion (org-update-dblock)))
18167 ((save-excursion
18168 (beginning-of-line 1)
18170 (cond
18171 ((equal (match-string 1) "TBLFM")
18172 ;; Recalculate the table before this line
18173 (save-excursion
18174 (beginning-of-line 1)
18176 (if (org-at-table-p)
18177 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18178 (t
18179 (let ((org-inhibit-startup-visibility-stuff t)
18180 (org-startup-align-all-tables nil))
18181 (when (boundp 'org-table-coordinate-overlays)
18182 (mapc 'delete-overlay org-table-coordinate-overlays)
18183 (setq org-table-coordinate-overlays nil))
18184 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18185 (message "Local setup has been refreshed"))))
18186 ((org-clock-update-time-maybe))
18187 (t
18188 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18189 (error "C-c C-c can do nothing useful at this location"))))))
18191 (defun org-mode-restart ()
18192 "Restart Org-mode, to scan again for special lines.
18193 Also updates the keyword regular expressions."
18194 (interactive)
18195 (org-mode)
18196 (message "Org-mode restarted"))
18198 (defun org-kill-note-or-show-branches ()
18199 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18200 (interactive)
18201 (if (not org-finish-function)
18202 (progn
18203 (hide-subtree)
18204 (call-interactively 'show-branches))
18205 (let ((org-note-abort t))
18206 (funcall org-finish-function))))
18208 (defun org-return (&optional indent)
18209 "Goto next table row or insert a newline.
18210 Calls `org-table-next-row' or `newline', depending on context.
18211 See the individual commands for more information."
18212 (interactive)
18213 (cond
18214 ((bobp) (if indent (newline-and-indent) (newline)))
18215 ((org-at-table-p)
18216 (org-table-justify-field-maybe)
18217 (call-interactively 'org-table-next-row))
18218 ;; when `newline-and-indent' is called within a list, make sure
18219 ;; text moved stays inside the item.
18220 ((and (org-in-item-p) indent)
18221 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18222 (progn
18223 (save-match-data (newline))
18224 (org-indent-line-to (length (match-string 0))))
18225 (let ((ind (org-get-indentation)))
18226 (newline)
18227 (if (org-looking-back org-list-end-re)
18228 (org-indent-line-function)
18229 (org-indent-line-to ind)))))
18230 ((and org-return-follows-link
18231 (eq (get-text-property (point) 'face) 'org-link))
18232 (call-interactively 'org-open-at-point))
18233 ((and (org-at-heading-p)
18234 (looking-at
18236 (org-show-entry)
18237 (end-of-line 1)
18238 (newline))
18239 (t (if indent (newline-and-indent) (newline)))))
18241 (defun org-return-indent ()
18242 "Goto next table row or insert a newline and indent.
18243 Calls `org-table-next-row' or `newline-and-indent', depending on
18244 context. See the individual commands for more information."
18245 (interactive)
18246 (org-return t))
18248 (defun org-ctrl-c-star ()
18249 "Compute table, or change heading status of lines.
18250 Calls `org-table-recalculate' or `org-toggle-heading',
18251 depending on context."
18252 (interactive)
18253 (cond
18254 ((org-at-table-p)
18255 (call-interactively 'org-table-recalculate))
18256 (t
18257 ;; Convert all lines in region to list items
18258 (call-interactively 'org-toggle-heading))))
18260 (defun org-ctrl-c-minus ()
18261 "Insert separator line in table or modify bullet status of line.
18262 Also turns a plain line or a region of lines into list items.
18263 Calls `org-table-insert-hline', `org-toggle-item', or
18264 `org-cycle-list-bullet', depending on context."
18265 (interactive)
18266 (cond
18267 ((org-at-table-p)
18268 (call-interactively 'org-table-insert-hline))
18269 ((org-region-active-p)
18270 (call-interactively 'org-toggle-item))
18271 ((org-in-item-p)
18272 (call-interactively 'org-cycle-list-bullet))
18273 (t
18274 (call-interactively 'org-toggle-item))))
18276 (defun org-toggle-item (arg)
18277 "Convert headings or normal lines to items, items to normal lines.
18278 If there is no active region, only the current line is considered.
18280 If the first non blank line in the region is an headline, convert
18281 all headlines to items, shifting text accordingly.
18283 If it is an item, convert all items to normal lines.
18285 If it is normal text, change region into an item. With a prefix
18286 argument ARG, change each line in region into an item."
18287 (interactive "P")
18288 (let ((shift-text
18289 (function
18290 ;; Shift text in current section to IND, from point to END.
18291 ;; The function leaves point to END line.
18292 (lambda (ind end)
18293 (let ((min-i 1000) (end (copy-marker end)))
18294 ;; First determine the minimum indentation (MIN-I) of
18295 ;; the text.
18296 (save-excursion
18297 (catch 'exit
18298 (while (< (point) end)
18299 (let ((i (org-get-indentation)))
18300 (cond
18301 ;; Skip blank lines and inline tasks.
18303 ((looking-at org-outline-regexp-bol))
18304 ;; We can't find less than 0 indentation.
18305 ((zerop i) (throw 'exit (setq min-i 0)))
18306 ((< i min-i) (setq min-i i))))
18307 (forward-line))))
18308 ;; Then indent each line so that a line indented to
18309 ;; MIN-I becomes indented to IND. Ignore blank lines
18310 ;; and inline tasks in the process.
18311 (let ((delta (- ind min-i)))
18312 (while (< (point) end)
18314 (looking-at org-outline-regexp-bol))
18315 (org-indent-line-to (+ (org-get-indentation) delta)))
18316 (forward-line)))))))
18317 (skip-blanks
18318 (function
18319 ;; Return beginning of first non-blank line, starting from
18320 ;; line at POS.
18321 (lambda (pos)
18322 (save-excursion
18323 (goto-char pos)
18325 (point-at-bol)))))
18326 beg end)
18327 ;; Determine boundaries of changes.
18328 (if (org-region-active-p)
18329 (setq beg (funcall skip-blanks (region-beginning))
18330 end (copy-marker (region-end)))
18331 (setq beg (funcall skip-blanks (point-at-bol))
18332 end (copy-marker (point-at-eol))))
18333 ;; Depending on the starting line, choose an action on the text
18334 ;; between BEG and END.
18335 (org-with-limited-levels
18336 (save-excursion
18337 (goto-char beg)
18338 (cond
18339 ;; Case 1. Start at an item: de-itemize. Note that it only
18340 ;; happens when a region is active: `org-ctrl-c-minus'
18341 ;; would call `org-cycle-list-bullet' otherwise.
18342 ((org-at-item-p)
18343 (while (< (point) end)
18344 (when (org-at-item-p)
18346 (delete-region (point) (match-end 0)))
18347 (forward-line)))
18348 ;; Case 2. Start at an heading: convert to items.
18349 ((org-on-heading-p)
18350 (let* ((bul (org-list-bullet-string "-"))
18351 (bul-len (length bul))
18352 ;; Indentation of the first heading. It should be
18353 ;; relative to the indentation of its parent, if any.
18354 (start-ind (save-excursion
18355 (cond
18356 ((not org-adapt-indentation) 0)
18357 ((not (outline-previous-heading)) 0)
18358 (t (length (match-string 0))))))
18359 ;; Level of first heading. Further headings will be
18360 ;; compared to it to determine hierarchy in the list.
18361 (ref-level (org-reduced-level (org-outline-level))))
18362 (while (< (point) end)
18363 (let* ((level (org-reduced-level (org-outline-level)))
18364 (delta (max 0 (- level ref-level))))
18365 ;; If current headline is less indented than the first
18366 ;; one, set it as reference, in order to preserve
18367 ;; subtrees.
18368 (when (< level ref-level) (setq ref-level level))
18369 (replace-match bul t t)
18370 (org-indent-line-to (+ start-ind (* delta bul-len)))
18371 ;; Ensure all text down to END (or SECTION-END) belongs
18372 ;; to the newly created item.
18373 (let ((section-end (save-excursion
18374 (or (outline-next-heading) (point)))))
18375 (forward-line)
18376 (funcall shift-text
18377 (+ start-ind (* (1+ delta) bul-len))
18378 (min end section-end)))))))
18379 ;; Case 3. Normal line with ARG: turn each non-item line into
18380 ;; an item.
18381 (arg
18382 (while (< (point) end)
18383 (unless (or (org-on-heading-p) (org-at-item-p))
18385 (replace-match
18387 (forward-line)))
18388 ;; Case 4. Normal line without ARG: make the first line of
18389 ;; region an item, and shift indentation of others
18390 ;; lines to set them as item's body.
18391 (t (let* ((bul (org-list-bullet-string "-"))
18392 (bul-len (length bul))
18393 (ref-ind (org-get-indentation)))
18395 (insert bul)
18396 (forward-line)
18397 (while (< (point) end)
18398 ;; Ensure that lines less indented than first one
18399 ;; still get included in item body.
18400 (funcall shift-text
18401 (+ ref-ind bul-len)
18402 (min end (save-excursion (or (outline-next-heading)
18403 (point)))))
18404 (forward-line)))))))))
18406 (defun org-toggle-heading (&optional nstars)
18407 "Convert headings to normal text, or items or text to headings.
18408 If there is no active region, only the current line is considered.
18410 If the first non blank line is an headline, remove the stars from
18411 all headlines in the region.
18413 If it is a plain list item, turn all plain list items into headings.
18415 If it is a normal line, turn each and every normal line (i.e. not
18416 an heading or an item) in the region into a heading.
18418 When converting a line into a heading, the number of stars is chosen
18419 such that the lines become children of the current entry. However,
18420 when a prefix argument is given, its value determines the number of
18421 stars to add."
18422 (interactive "P")
18423 (let ((skip-blanks
18424 (function
18425 ;; Return beginning of first non-blank line, starting from
18426 ;; line at POS.
18427 (lambda (pos)
18428 (save-excursion
18429 (goto-char pos)
18431 (point-at-bol)))))
18432 beg end)
18433 ;; Determine boundaries of changes. If region ends at a bol, do
18434 ;; not consider the last line to be in the region.
18435 (if (org-region-active-p)
18436 (setq beg (funcall skip-blanks (region-beginning))
18437 end (copy-marker (save-excursion
18438 (goto-char (region-end))
18439 (if (bolp) (point) (point-at-eol)))))
18440 (setq beg (funcall skip-blanks (point-at-bol))
18441 end (copy-marker (point-at-eol))))
18442 ;; Ensure inline tasks don't count as headings.
18443 (org-with-limited-levels
18444 (save-excursion
18445 (goto-char beg)
18446 (cond
18447 ;; Case 1. Started at an heading: de-star headings.
18448 ((org-on-heading-p)
18449 (while (< (point) end)
18450 (when (org-on-heading-p t)
18451 (looking-at org-outline-regexp) (replace-match ""))
18452 (forward-line)))
18453 ;; Case 2. Started at an item: change items into headlines.
18454 ;; One star will be added by `org-list-to-subtree'.
18455 ((org-at-item-p)
18456 (let* ((stars (make-string
18457 (if nstars
18458 ;; subtract the star that will be added again by
18459 ;; `org-list-to-subtree'
18460 (1- (prefix-numeric-value current-prefix-arg))
18461 (or (org-current-level) 0))
18462 ?*))
18463 (add-stars
18464 (cond (nstars "") ; stars from prefix only
18465 ((equal stars "") "") ; before first heading
18466 (org-odd-levels-only "*") ; inside heading, odd
18467 (t "")))) ; inside heading, oddeven
18468 (while (< (point) end)
18469 (when (org-at-item-p)
18470 ;; Pay attention to cases when region ends before list.
18471 (let* ((struct (org-list-struct))
18472 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18473 (save-restriction
18474 (narrow-to-region (point) list-end)
18475 (insert
18476 (org-list-to-subtree
18477 (org-list-parse-list t)
18478 '(:istart (concat stars add-stars (funcall get-stars depth))
18479 :icount (concat stars add-stars (funcall get-stars depth))))))))
18480 (forward-line))))
18481 ;; Case 3. Started at normal text: make every line an heading,
18482 ;; skipping headlines and items.
18483 (t (let* ((stars (make-string
18484 (if nstars
18485 (prefix-numeric-value current-prefix-arg)
18486 (or (org-current-level) 0))
18487 ?*))
18488 (add-stars
18489 (cond (nstars "") ; stars from prefix only
18490 ((equal stars "") "*") ; before first heading
18491 (org-odd-levels-only "**") ; inside heading, odd
18492 (t "*"))) ; inside heading, oddeven
18493 (rpl (concat stars add-stars " ")))
18494 (while (< (point) end)
18495 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18497 (replace-match (concat rpl (match-string 2))))
18498 (forward-line)))))))))
18500 (defun org-meta-return (&optional arg)
18501 "Insert a new heading or wrap a region in a table.
18502 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18503 See the individual commands for more information."
18504 (interactive "P")
18505 (cond
18506 ((run-hook-with-args-until-success 'org-metareturn-hook))
18507 ((org-at-table-p)
18508 (call-interactively 'org-table-wrap-region))
18509 (t (call-interactively 'org-insert-heading))))
18511 ;;; Menu entries
18513 ;; Define the Org-mode menus
18514 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18515 '("Tbl"
18516 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18517 ["Next Field" org-cycle (org-at-table-p)]
18518 ["Previous Field" org-shifttab (org-at-table-p)]
18519 ["Next Row" org-return (org-at-table-p)]
18520 "--"
18521 ["Blank Field" org-table-blank-field (org-at-table-p)]
18522 ["Edit Field" org-table-edit-field (org-at-table-p)]
18523 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18524 "--"
18525 ("Column"
18526 ["Move Column Left" org-metaleft (org-at-table-p)]
18527 ["Move Column Right" org-metaright (org-at-table-p)]
18528 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18529 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18530 ("Row"
18531 ["Move Row Up" org-metaup (org-at-table-p)]
18532 ["Move Row Down" org-metadown (org-at-table-p)]
18533 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18534 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18535 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18536 "--"
18537 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18538 ("Rectangle"
18539 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18540 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18541 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18542 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18543 "--"
18544 ("Calculate"
18545 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18546 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18547 ["Edit Formulas" org-edit-special (org-at-table-p)]
18548 "--"
18549 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18550 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18551 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18552 "--"
18553 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18554 "--"
18555 ["Sum Column/Rectangle" org-table-sum
18556 (or (org-at-table-p) (org-region-active-p))]
18557 ["Which Column?" org-table-current-column (org-at-table-p)])
18558 ["Debug Formulas"
18559 org-table-toggle-formula-debugger
18560 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18561 ["Show Col/Row Numbers"
18562 org-table-toggle-coordinate-overlays
18563 :style toggle
18564 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18565 "--"
18566 ["Create" org-table-create (and (not (org-at-table-p))
18567 org-enable-table-editor)]
18568 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18569 ["Import from File" org-table-import (not (org-at-table-p))]
18570 ["Export to File" org-table-export (org-at-table-p)]
18571 "--"
18572 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18574 (easy-menu-define org-org-menu org-mode-map "Org menu"
18575 '("Org"
18576 ("Show/Hide"
18577 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18578 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18579 ["Sparse Tree..." org-sparse-tree t]
18580 ["Reveal Context" org-reveal t]
18581 ["Show All" show-all t]
18582 "--"
18583 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18584 "--"
18585 ["New Heading" org-insert-heading t]
18586 ("Navigate Headings"
18587 ["Up" outline-up-heading t]
18588 ["Next" outline-next-visible-heading t]
18589 ["Previous" outline-previous-visible-heading t]
18590 ["Next Same Level" outline-forward-same-level t]
18591 ["Previous Same Level" outline-backward-same-level t]
18592 "--"
18593 ["Jump" org-goto t])
18594 ("Edit Structure"
18595 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18596 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18597 "--"
18598 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18599 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18600 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18601 "--"
18602 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18603 "--"
18604 ["Copy visible text" org-copy-visible t]
18605 "--"
18606 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18607 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18608 ["Demote Heading" org-metaright (not (org-at-table-p))]
18609 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18610 "--"
18611 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18612 "--"
18613 ["Convert to odd levels" org-convert-to-odd-levels t]
18614 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18615 ("Editing"
18616 ["Emphasis..." org-emphasize t]
18617 ["Edit Source Example" org-edit-special t]
18618 "--"
18619 ["Footnote new/jump" org-footnote-action t]
18620 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18621 ("Archive"
18622 ["Archive (default method)" org-archive-subtree-default t]
18623 "--"
18624 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18625 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18626 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18627 )
18628 "--"
18629 ("Hyperlinks"
18630 ["Store Link (Global)" org-store-link t]
18631 ["Find existing link to here" org-occur-link-in-agenda-files t]
18632 ["Insert Link" org-insert-link t]
18633 ["Follow Link" org-open-at-point t]
18634 "--"
18635 ["Next link" org-next-link t]
18636 ["Previous link" org-previous-link t]
18637 "--"
18638 ["Descriptive Links"
18639 org-toggle-link-display
18640 :style radio
18641 :selected org-descriptive-links
18642 ]
18643 ["Literal Links"
18644 org-toggle-link-display
18645 :style radio
18646 :selected (not org-descriptive-links)])
18647 "--"
18648 ("TODO Lists"
18649 ["TODO/DONE/-" org-todo t]
18650 ("Select keyword"
18651 ["Next keyword" org-shiftright (org-on-heading-p)]
18652 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18653 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18654 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18655 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18656 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18657 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18658 "--"
18659 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18660 :selected org-enforce-todo-dependencies :style toggle :active t]
18661 "Settings for tree at point"
18662 ["Do Children sequentially" org-toggle-ordered-property :style radio
18663 :selected (org-entry-get nil "ORDERED")
18664 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18665 ["Do Children parallel" org-toggle-ordered-property :style radio
18666 :selected (not (org-entry-get nil "ORDERED"))
18667 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18668 "--"
18669 ["Set Priority" org-priority t]
18670 ["Priority Up" org-shiftup t]
18671 ["Priority Down" org-shiftdown t]
18672 "--"
18673 ["Get news from all feeds" org-feed-update-all t]
18674 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18675 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18676 ("TAGS and Properties"
18677 ["Set Tags" org-set-tags-command t]
18678 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18679 "--"
18680 ["Set property" org-set-property t]
18681 ["Column view of properties" org-columns t]
18682 ["Insert Column View DBlock" org-insert-columns-dblock t])
18683 ("Dates and Scheduling"
18684 ["Timestamp" org-time-stamp t]
18685 ["Timestamp (inactive)" org-time-stamp-inactive t]
18686 ("Change Date"
18687 ["1 Day Later" org-shiftright t]
18688 ["1 Day Earlier" org-shiftleft t]
18689 ["1 ... Later" org-shiftup t]
18690 ["1 ... Earlier" org-shiftdown t])
18691 ["Compute Time Range" org-evaluate-time-range t]
18692 ["Schedule Item" org-schedule t]
18693 ["Deadline" org-deadline t]
18694 "--"
18695 ["Custom time format" org-toggle-time-stamp-overlays
18696 :style radio :selected org-display-custom-times]
18697 "--"
18698 ["Goto Calendar" org-goto-calendar t]
18699 ["Date from Calendar" org-date-from-calendar t]
18700 "--"
18701 ["Start/Restart Timer" org-timer-start t]
18702 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18703 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18704 ["Insert Timer String" org-timer t]
18705 ["Insert Timer Item" org-timer-item t])
18706 ("Logging work"
18707 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18708 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18709 ["Clock out" org-clock-out t]
18710 ["Clock cancel" org-clock-cancel t]
18711 "--"
18712 ["Mark as default task" org-clock-mark-default-task t]
18713 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18714 ["Goto running clock" org-clock-goto t]
18715 "--"
18716 ["Display times" org-clock-display t]
18717 ["Create clock table" org-clock-report t]
18718 "--"
18719 ["Record DONE time"
18720 (progn (setq org-log-done (not org-log-done))
18721 (message "Switching to %s will %s record a timestamp"
18722 (car org-done-keywords)
18723 (if org-log-done "automatically" "not")))
18724 :style toggle :selected org-log-done])
18725 "--"
18726 ["Agenda Command..." org-agenda t]
18727 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18728 ("File List for Agenda")
18729 ("Special views current file"
18730 ["TODO Tree" org-show-todo-tree t]
18731 ["Check Deadlines" org-check-deadlines t]
18732 ["Timeline" org-timeline t]
18733 ["Tags/Property tree" org-match-sparse-tree t])
18734 "--"
18735 ["Export/Publish..." org-export t]
18736 ("LaTeX"
18737 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18738 :selected org-cdlatex-mode]
18739 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18740 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18741 ["Modify math symbol" org-cdlatex-math-modify
18742 (org-inside-LaTeX-fragment-p)]
18743 ["Insert citation" org-reftex-citation t]
18744 "--"
18745 ["Template for BEAMER" org-insert-beamer-options-template t])
18746 "--"
18747 ("MobileOrg"
18748 ["Push Files and Views" org-mobile-push t]
18749 ["Get Captured and Flagged" org-mobile-pull t]
18750 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18751 "--"
18752 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18753 "--"
18754 ("Documentation"
18755 ["Show Version" org-version t]
18756 ["Info Documentation" org-info t])
18757 ("Customize"
18758 ["Browse Org Group" org-customize t]
18759 "--"
18760 ["Expand This Menu" org-create-customize-menu
18761 (fboundp 'customize-menu-create)])
18762 ["Send bug report" org-submit-bug-report t]
18763 "--"
18764 ("Refresh/Reload"
18765 ["Refresh setup current buffer" org-mode-restart t]
18766 ["Reload Org (after update)" org-reload t]
18767 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18768 ))
18770 (defun org-info (&optional node)
18771 "Read documentation for Org-mode in the info system.
18772 With optional NODE, go directly to that node."
18773 (interactive)
18774 (info (format "(org)%s" (or node ""))))
18776 ;;;###autoload
18777 (defun org-submit-bug-report ()
18778 "Submit a bug report on Org-mode via mail.
18780 Don't hesitate to report any problems or inaccurate documentation.
18782 If you don't have setup sending mail from (X)Emacs, please copy the
18783 output buffer into your mail program, as it gives us important
18784 information about your Org-mode version and configuration."
18785 (interactive)
18786 (require 'reporter)
18787 (org-load-modules-maybe)
18788 (org-require-autoloaded-modules)
18789 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18790 (reporter-submit-bug-report
18791 "emacs-orgmode@gnu.org"
18792 (org-version)
18793 (let (list)
18794 (save-window-excursion
18795 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18796 (delete-other-windows)
18797 (erase-buffer)
18798 (insert "You are about to submit a bug report to the Org-mode mailing list.
18800 We would like to add your full Org-mode and Outline configuration to the
18801 bug report. This greatly simplifies the work of the maintainer and
18802 other experts on the mailing list.
18804 HOWEVER, some variables you have customized may contain private
18805 information. The names of customers, colleagues, or friends, might
18806 appear in the form of file names, tags, todo states, or search strings.
18807 If you answer yes to the prompt, you might want to check and remove
18808 such private information before sending the email.")
18809 (add-text-properties (point-min) (point-max) '(face org-warning))
18810 (when (yes-or-no-p "Include your Org-mode configuration ")
18811 (mapatoms
18812 (lambda (v)
18813 (and (boundp v)
18815 (or (and (symbol-value v)
18817 (and
18818 (get v 'custom-type) (get v 'standard-value)
18819 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18820 (push v list)))))
18821 (kill-buffer (get-buffer "*Warn about privacy*"))
18822 list))
18823 nil nil
18824 "Remember to cover the basics, that is, what you expected to happen and
18825 what in fact did happen. You don't know how to make a good report? See
18827 http://orgmode.org/manual/Feedback.html#Feedback
18829 Your bug report will be posted to the Org-mode mailing list.
18830 ------------------------------------------------------------------------")
18831 (save-excursion
18836 (defun org-install-agenda-files-menu ()
18837 (let ((bl (buffer-list)))
18838 (save-excursion
18839 (while bl
18840 (set-buffer (pop bl))
18841 (if (eq major-mode 'org-mode) (setq bl nil)))
18842 (when (eq major-mode 'org-mode)
18843 (easy-menu-change
18844 '("Org") "File List for Agenda"
18845 (append
18846 (list
18847 ["Edit File List" (org-edit-agenda-file-list) t]
18848 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18849 ["Remove Current File from List" org-remove-file t]
18850 ["Cycle through agenda files" org-cycle-agenda-files t]
18851 ["Occur in all agenda files" org-occur-in-agenda-files t]
18852 "--")
18853 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18855 ;;;; Documentation
18857 ;;;###autoload
18858 (defun org-require-autoloaded-modules ()
18859 (interactive)
18860 (mapc 'require
18861 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18862 org-docbook org-exp org-html org-icalendar
18863 org-id org-latex
18864 org-publish org-remember org-table
18865 org-timer org-xoxo)))
18867 ;;;###autoload
18868 (defun org-reload (&optional uncompiled)
18869 "Reload all org lisp files.
18870 With prefix arg UNCOMPILED, load the uncompiled versions."
18871 (interactive "P")
18872 (require 'find-func)
18874 (dir-org (file-name-directory (org-find-library-name "org")))
18875 (dir-org-contrib (ignore-errors
18876 (file-name-directory
18877 (org-find-library-name "org-contribdir"))))
18878 (babel-files
18879 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18880 (append (list nil "comint" "eval" "exp" "keys"
18881 "lob" "ref" "table" "tangle")
18882 (delq nil
18883 (mapcar
18884 (lambda (lang)
18885 (when (cdr lang) (symbol-name (car lang))))
18886 org-babel-load-languages)))))
18887 (files
18888 (append (directory-files dir-org t file-re)
18889 babel-files
18890 (and dir-org-contrib
18891 (directory-files dir-org-contrib t file-re))))
18892 (remove-re (concat (if (featurep 'xemacs)
18893 "org-colview" "org-colview-xemacs")
18895 (setq files (mapcar 'file-name-sans-extension files))
18896 (setq files (mapcar
18897 (lambda (x) (if (string-match remove-re x) nil x))
18898 files))
18899 (setq files (delq nil files))
18900 (mapc
18901 (lambda (f)
18902 (when (featurep (intern (file-name-nondirectory f)))
18903 (if (and (not uncompiled)
18904 (file-exists-p (concat f ".elc")))
18905 (load (concat f ".elc") nil nil t)
18906 (load (concat f ".el") nil nil t))))
18907 files))
18908 (org-version))
18910 ;;;###autoload
18911 (defun org-customize ()
18912 "Call the customize function with org as argument."
18913 (interactive)
18914 (org-load-modules-maybe)
18915 (org-require-autoloaded-modules)
18916 (customize-browse 'org))
18918 (defun org-create-customize-menu ()
18919 "Create a full customization menu for Org-mode, insert it into the menu."
18920 (interactive)
18921 (org-load-modules-maybe)
18922 (org-require-autoloaded-modules)
18923 (if (fboundp 'customize-menu-create)
18924 (progn
18925 (easy-menu-change
18926 '("Org") "Customize"
18927 `(["Browse Org group" org-customize t]
18928 "--"
18929 ,(customize-menu-create 'org)
18930 ["Set" Custom-set t]
18931 ["Save" Custom-save t]
18932 ["Reset to Current" Custom-reset-current t]
18933 ["Reset to Saved" Custom-reset-saved t]
18934 ["Reset to Standard Settings" Custom-reset-standard t]))
18936 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18938 ;;;; Miscellaneous stuff
18940 ;;; Generally useful functions
18942 (defun org-get-at-bol (property)
18943 "Get text property PROPERTY at beginning of line."
18944 (get-text-property (point-at-bol) property))
18946 (defun org-find-text-property-in-string (prop s)
18947 "Return the first non-nil value of property PROP in string S."
18948 (or (get-text-property 0 prop s)
18949 (get-text-property (or (next-single-property-change 0 prop s) 0)
18950 prop s)))
18952 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18953 "Display the given MESSAGE as a warning."
18954 (if (fboundp 'display-warning)
18955 (display-warning 'org message
18956 (if (featurep 'xemacs) 'warning :warning))
18957 (let ((buf (get-buffer-create "*Org warnings*")))
18958 (with-current-buffer buf
18959 (goto-char (point-max))
18960 (insert "Warning (Org): " message)
18961 (unless (bolp)
18962 (newline)))
18963 (display-buffer buf)
18964 (sit-for 0))))
18966 (defun org-eval (form)
18967 "Eval FORM and return result."
18968 (condition-case error
18969 (eval form)
18970 (error (format "%%![Error: %s]" error))))
18972 (defun org-in-commented-line ()
18973 "Is point in a line starting with `#'?"
18974 (equal (char-after (point-at-bol)) ?#))
18976 (defun org-in-indented-comment-line ()
18977 "Is point in a line starting with `#' after some white space?"
18978 (save-excursion
18979 (save-match-data
18980 (goto-char (point-at-bol))
18983 (defun org-in-verbatim-emphasis ()
18984 (save-match-data
18985 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18987 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18988 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18989 (if (and marker (marker-buffer marker)
18990 (buffer-live-p (marker-buffer marker)))
18991 (progn
18992 (org-pop-to-buffer-same-window (marker-buffer marker))
18993 (if (or (> marker (point-max)) (< marker (point-min)))
18994 (widen))
18995 (goto-char marker)
18996 (org-show-context 'org-goto))
18997 (if bookmark
18998 (bookmark-jump bookmark)
18999 (error "Cannot find location"))))
19001 (defun org-quote-csv-field (s)
19002 "Quote field for inclusion in CSV material."
19005 s))
19007 (defun org-force-self-insert (N)
19008 "Needed to enforce self-insert under remapping."
19009 (interactive "p")
19010 (self-insert-command N))
19012 (defun org-string-width (s)
19013 "Compute width of string, ignoring invisible characters.
19014 This ignores character with invisibility property `org-link', and also
19015 characters with property `org-cwidth', because these will become invisible
19016 upon the next fontification round."
19017 (let (b l)
19018 (when (or (eq t buffer-invisibility-spec)
19019 (assq 'org-link buffer-invisibility-spec))
19020 (while (setq b (text-property-any 0 (length s)
19021 'invisible 'org-link s))
19022 (setq s (concat (substring s 0 b)
19023 (substring s (or (next-single-property-change
19024 b 'invisible s) (length s)))))))
19025 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19026 (setq s (concat (substring s 0 b)
19027 (substring s (or (next-single-property-change
19028 b 'org-cwidth s) (length s))))))
19029 (setq l (string-width s) b -1)
19030 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19031 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19032 l))
19034 (defun org-shorten-string (s maxlength)
19035 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19036 If the string is shorter or has length MAXLENGTH, just return the
19037 original string. If it is longer, the functions finds a space in the
19038 string, breaks this string off at that locations and adds three dots
19039 as ellipsis. Including the ellipsis, the string will not be longer
19040 than MAXLENGTH. If finding a good breaking point in the string does
19041 not work, the string is just chopped off in the middle of a word
19042 if necessary."
19043 (if (<= (length s) maxlength)
19044 s
19045 (let* ((n (max (- maxlength 4) 1))
19047 (if (string-match re s)
19048 (concat (match-string 1 s) "...")
19049 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19051 (defun org-get-indentation (&optional line)
19052 "Get the indentation of the current line, interpreting tabs.
19053 When LINE is given, assume it represents a line and compute its indentation."
19054 (if line
19055 (if (string-match "^ *" (org-remove-tabs line))
19056 (match-end 0))
19057 (save-excursion
19058 (beginning-of-line 1)
19060 (current-column))))
19062 (defun org-get-string-indentation (s)
19063 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19064 (let ((n -1) (i 0) (w tab-width) c)
19065 (catch 'exit
19066 (while (< (setq n (1+ n)) (length s))
19067 (setq c (aref s n))
19068 (cond ((= c ?\ ) (setq i (1+ i)))
19070 (t (throw 'exit t)))))
19071 i))
19073 (defun org-remove-tabs (s &optional width)
19074 "Replace tabulators in S with spaces.
19075 Assumes that s is a single line, starting in column 0."
19076 (setq width (or width tab-width))
19078 (setq s (replace-match
19079 (make-string
19080 (- (* width (/ (+ (match-beginning 0) width) width))
19081 (match-beginning 0)) ?\ )
19082 t t s)))
19083 s)
19085 (defun org-fix-indentation (line ind)
19086 "Fix indentation in LINE.
19087 IND is a cons cell with target and minimum indentation.
19088 If the current indentation in LINE is smaller than the minimum,
19089 leave it alone. If it is larger than ind, set it to the target."
19090 (let* ((l (org-remove-tabs line))
19091 (i (org-get-indentation l))
19092 (i1 (car ind)) (i2 (cdr ind)))
19093 (if (>= i i2) (setq l (substring line i2)))
19094 (if (> i1 0)
19095 (concat (make-string i1 ?\ ) l)
19096 l)))
19098 (defun org-remove-indentation (code &optional n)
19099 "Remove the maximum common indentation from the lines in CODE.
19100 N may optionally be the number of spaces to remove."
19101 (with-temp-buffer
19102 (insert code)
19103 (org-do-remove-indentation n)
19104 (buffer-string)))
19106 (defun org-do-remove-indentation (&optional n)
19107 "Remove the maximum common indentation from the buffer."
19108 (untabify (point-min) (point-max))
19109 (let ((min 10000) re)
19110 (if n
19111 (setq min n)
19112 (goto-char (point-min))
19114 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19115 (unless (or (= min 0) (= min 10000))
19117 (goto-char (point-min))
19118 (while (re-search-forward re nil t)
19119 (replace-match "")
19120 (end-of-line 1))
19121 min)))
19123 (defun org-fill-template (template alist)
19124 "Find each %key of ALIST in TEMPLATE and replace it."
19125 (let ((case-fold-search nil)
19126 entry key value)
19127 (setq alist (sort (copy-sequence alist)
19128 (lambda (a b) (< (length (car a)) (length (car b))))))
19129 (while (setq entry (pop alist))
19130 (setq template
19131 (replace-regexp-in-string
19132 (concat "%" (regexp-quote (car entry)))
19133 (cdr entry) template t t)))
19134 template))
19136 (defun org-base-buffer (buffer)
19137 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19138 (if (not buffer)
19139 buffer
19140 (or (buffer-base-buffer buffer)
19141 buffer)))
19143 (defun org-trim (s)
19144 "Remove whitespace at beginning and end of string."
19147 s)
19149 (defun org-wrap (string &optional width lines)
19150 "Wrap string to either a number of lines, or a width in characters.
19151 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19152 that costs. If there is a word longer than WIDTH, the text is actually
19153 wrapped to the length of that word.
19154 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19155 many lines, whatever width that takes.
19156 The return value is a list of lines, without newlines at the end."
19158 (maxword (apply 'max (mapcar 'org-string-width words)))
19159 w ll)
19160 (cond (width
19161 (org-do-wrap words (max maxword width)))
19162 (lines
19163 (setq w maxword)
19164 (setq ll (org-do-wrap words maxword))
19165 (if (<= (length ll) lines)
19166 ll
19167 (setq ll words)
19168 (while (> (length ll) lines)
19169 (setq w (1+ w))
19170 (setq ll (org-do-wrap words w)))
19171 ll))
19172 (t (error "Cannot wrap this")))))
19174 (defun org-do-wrap (words width)
19175 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19176 (let (lines line)
19177 (while words
19178 (setq line (pop words))
19179 (while (and words (< (+ (length line) (length (car words))) width))
19180 (setq line (concat line " " (pop words))))
19181 (setq lines (push line lines)))
19182 (nreverse lines)))
19184 (defun org-split-string (string &optional separators)
19185 "Splits STRING into substrings at SEPARATORS.
19186 No empty strings are returned if there are matches at the beginning
19187 and end of string."
19189 (start 0)
19190 notfirst
19191 (list nil))
19192 (while (and (string-match rexp string
19193 (if (and notfirst
19194 (= start (match-beginning 0))
19195 (< start (length string)))
19196 (1+ start) start))
19197 (< (match-beginning 0) (length string)))
19198 (setq notfirst t)
19199 (or (eq (match-beginning 0) 0)
19200 (and (eq (match-beginning 0) (match-end 0))
19201 (eq (match-beginning 0) start))
19202 (setq list
19203 (cons (substring string start (match-beginning 0))
19204 list)))
19205 (setq start (match-end 0)))
19206 (or (eq start (length string))
19207 (setq list
19208 (cons (substring string start)
19209 list)))
19210 (nreverse list)))
19212 (defun org-quote-vert (s)
19214 (while (string-match "|" s)
19216 s)
19218 (defun org-uuidgen-p (s)
19219 "Is S an ID created by UUIDGEN?"
19220 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19222 (defun org-context ()
19223 "Return a list of contexts of the current cursor position.
19224 If several contexts apply, all are returned.
19225 Each context entry is a list with a symbol naming the context, and
19226 two positions indicating start and end of the context. Possible
19227 contexts are:
19229 :headline anywhere in a headline
19230 :headline-stars on the leading stars in a headline
19231 :todo-keyword on a TODO keyword (including DONE) in a headline
19232 :tags on the TAGS in a headline
19233 :priority on the priority cookie in a headline
19234 :item on the first line of a plain list item
19235 :item-bullet on the bullet/number of a plain list item
19236 :checkbox on the checkbox in a plain list item
19237 :table in an org-mode table
19238 :table-special on a special filed in a table
19239 :table-table in a table.el table
19240 :link on a hyperlink
19241 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19242 :target on a <<target>>
19243 :radio-target on a <<<radio-target>>>
19244 :latex-fragment on a LaTeX fragment
19245 :latex-preview on a LaTeX fragment with overlayed preview image
19247 This function expects the position to be visible because it uses font-lock
19248 faces as a help to recognize the following contexts: :table-special, :link,
19249 and :keyword."
19250 (let* ((f (get-text-property (point) 'face))
19251 (faces (if (listp f) f (list f)))
19252 (p (point)) clist o)
19253 ;; First the large context
19254 (cond
19255 ((org-on-heading-p t)
19256 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19257 (when (progn
19258 (beginning-of-line 1)
19259 (looking-at org-todo-line-tags-regexp))
19260 (push (org-point-in-group p 1 :headline-stars) clist)
19261 (push (org-point-in-group p 2 :todo-keyword) clist)
19262 (push (org-point-in-group p 4 :tags) clist))
19263 (goto-char p)
19266 (push (org-point-in-group p 0 :priority) clist)))
19268 ((org-at-item-p)
19269 (push (org-point-in-group p 2 :item-bullet) clist)
19270 (push (list :item (point-at-bol)
19271 (save-excursion (org-end-of-item) (point)))
19272 clist)
19273 (and (org-at-item-checkbox-p)
19274 (push (org-point-in-group p 0 :checkbox) clist)))
19276 ((org-at-table-p)
19277 (push (list :table (org-table-begin) (org-table-end)) clist)
19278 (if (memq 'org-formula faces)
19279 (push (list :table-special
19280 (previous-single-property-change p 'face)
19281 (next-single-property-change p 'face)) clist)))
19282 ((org-at-table-p 'any)
19283 (push (list :table-table) clist)))
19284 (goto-char p)
19286 ;; Now the small context
19287 (cond
19288 ((org-at-timestamp-p)
19289 (push (org-point-in-group p 0 :timestamp) clist))
19290 ((memq 'org-link faces)
19291 (push (list :link
19292 (previous-single-property-change p 'face)
19293 (next-single-property-change p 'face)) clist))
19294 ((memq 'org-special-keyword faces)
19295 (push (list :keyword
19296 (previous-single-property-change p 'face)
19297 (next-single-property-change p 'face)) clist))
19298 ((org-on-target-p)
19299 (push (org-point-in-group p 0 :target) clist)
19300 (goto-char (1- (match-beginning 0)))
19301 (if (looking-at org-radio-target-regexp)
19302 (push (org-point-in-group p 0 :radio-target) clist))
19303 (goto-char p))
19304 ((setq o (car (delq nil
19305 (mapcar
19306 (lambda (x)
19307 (if (memq x org-latex-fragment-image-overlays) x))
19308 (overlays-at (point))))))
19309 (push (list :latex-fragment
19310 (overlay-start o) (overlay-end o)) clist)
19311 (push (list :latex-preview
19312 (overlay-start o) (overlay-end o)) clist))
19313 ((org-inside-LaTeX-fragment-p)
19314 ;; FIXME: positions wrong.
19315 (push (list :latex-fragment (point) (point)) clist)))
19317 (setq clist (nreverse (delq nil clist)))
19318 clist))
19320 ;; FIXME: Compare with at-regexp-p Do we need both?
19321 (defun org-in-regexp (re &optional nlines visually)
19322 "Check if point is inside a match of regexp.
19323 Normally only the current line is checked, but you can include NLINES extra
19324 lines both before and after point into the search.
19325 If VISUALLY is set, require that the cursor is not after the match but
19326 really on, so that the block visually is on the match."
19327 (catch 'exit
19328 (let ((pos (point))
19329 (eol (point-at-eol (+ 1 (or nlines 0))))
19330 (inc (if visually 1 0)))
19331 (save-excursion
19332 (beginning-of-line (- 1 (or nlines 0)))
19333 (while (re-search-forward re eol t)
19334 (if (and (<= (match-beginning 0) pos)
19335 (>= (+ inc (match-end 0)) pos))
19336 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19338 (defun org-at-regexp-p (regexp)
19339 "Is point inside a match of REGEXP in the current line?"
19340 (catch 'exit
19341 (save-excursion
19342 (let ((pos (point)) (end (point-at-eol)))
19343 (beginning-of-line 1)
19344 (while (re-search-forward regexp end t)
19345 (if (and (<= (match-beginning 0) pos)
19346 (>= (match-end 0) pos))
19347 (throw 'exit t)))
19348 nil))))
19350 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19351 "Non-nil when point is between matches of START-RE and END-RE.
19353 Also return a non-nil value when point is on one of the matches.
19355 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19356 buffer positions. Default values are the positions of headlines
19357 surrounding the point.
19359 The functions returns a cons cell whose car (resp. cdr) is the
19360 position before START-RE (resp. after END-RE)."
19361 (save-match-data
19362 (let ((pos (point))
19363 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19364 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19365 beg end)
19366 (save-excursion
19367 ;; Point is on a block when on START-RE or if START-RE can be
19368 ;; found before it...
19369 (and (or (org-at-regexp-p start-re)
19370 (re-search-backward start-re limit-up t))
19371 (setq beg (match-beginning 0))
19372 ;; ... and END-RE after it...
19373 (goto-char (match-end 0))
19374 (re-search-forward end-re limit-down t)
19375 (> (setq end (match-end 0)) pos)
19376 ;; ... without another START-RE in-between.
19377 (goto-char (match-beginning 0))
19378 (not (re-search-backward start-re (1+ beg) t))
19379 ;; Return value.
19380 (cons beg end))))))
19382 (defun org-in-block-p (names)
19383 "Is point inside any block whose name belongs to NAMES?
19385 NAMES is a list of strings containing names of blocks."
19386 (save-match-data
19387 (catch 'exit
19388 (let ((case-fold-search t)
19389 (lim-up (save-excursion (outline-previous-heading)))
19390 (lim-down (save-excursion (outline-next-heading))))
19391 (mapc (lambda (name)
19392 (let ((n (regexp-quote name)))
19393 (when (org-between-regexps-p
19396 lim-up lim-down)
19397 (throw 'exit t))))
19398 names))
19399 nil)))
19401 (defun org-occur-in-agenda-files (regexp &optional nlines)
19402 "Call `multi-occur' with buffers for all agenda files."
19404 (let* ((files (org-agenda-files))
19405 (tnames (mapcar 'file-truename files))
19406 (extra org-agenda-text-search-extra-files)
19407 f)
19408 (when (eq (car extra) 'agenda-archives)
19409 (setq extra (cdr extra))
19410 (setq files (org-add-archive-files files)))
19411 (while (setq f (pop extra))
19412 (unless (member (file-truename f) tnames)
19413 (add-to-list 'files f 'append)
19414 (add-to-list 'tnames (file-truename f) 'append)))
19415 (multi-occur
19416 (mapcar (lambda (x)
19417 (with-current-buffer
19418 (or (get-file-buffer x) (find-file-noselect x))
19419 (widen)
19420 (current-buffer)))
19421 files)
19422 regexp)))
19424 (if (boundp 'occur-mode-find-occurrence-hook)
19425 ;; Emacs 23
19426 (add-hook 'occur-mode-find-occurrence-hook
19427 (lambda ()
19428 (when (eq major-mode 'org-mode)
19429 (org-reveal))))
19430 ;; Emacs 22
19431 (defadvice occur-mode-goto-occurrence
19432 (after org-occur-reveal activate)
19433 (and (eq major-mode 'org-mode) (org-reveal)))
19434 (defadvice occur-mode-goto-occurrence-other-window
19435 (after org-occur-reveal activate)
19436 (and (eq major-mode 'org-mode) (org-reveal)))
19437 (defadvice occur-mode-display-occurrence
19438 (after org-occur-reveal activate)
19439 (when (eq major-mode 'org-mode)
19440 (let ((pos (occur-mode-find-occurrence)))
19441 (with-current-buffer (marker-buffer pos)
19442 (save-excursion
19443 (goto-char pos)
19444 (org-reveal)))))))
19446 (defun org-occur-link-in-agenda-files ()
19447 "Create a link and search for it in the agendas.
19448 The link is not stored in `org-stored-links', it is just created
19449 for the search purpose."
19450 (interactive)
19451 (let ((link (condition-case nil
19452 (org-store-link nil)
19453 (error "Unable to create a link to here"))))
19454 (org-occur-in-agenda-files (regexp-quote link))))
19456 (defun org-uniquify (list)
19457 "Remove duplicate elements from LIST."
19458 (let (res)
19459 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19460 res))
19462 (defun org-delete-all (elts list)
19463 "Remove all elements in ELTS from LIST."
19464 (while elts
19465 (setq list (delete (pop elts) list)))
19466 list)
19468 (defun org-count (cl-item cl-seq)
19469 "Count the number of occurrences of ITEM in SEQ.
19470 Taken from `count' in cl-seq.el with all keyword arguments removed."
19471 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19472 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19473 (while (< cl-start cl-end)
19474 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19475 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19476 (setq cl-start (1+ cl-start)))
19477 cl-count))
19479 (defun org-remove-if (predicate seq)
19480 "Remove everything from SEQ that fulfills PREDICATE."
19481 (let (res e)
19482 (while seq
19483 (setq e (pop seq))
19484 (if (not (funcall predicate e)) (push e res)))
19485 (nreverse res)))
19487 (defun org-remove-if-not (predicate seq)
19488 "Remove everything from SEQ that does not fulfill PREDICATE."
19489 (let (res e)
19490 (while seq
19491 (setq e (pop seq))
19492 (if (funcall predicate e) (push e res)))
19493 (nreverse res)))
19495 (defun org-back-over-empty-lines ()
19496 "Move backwards over whitespace, to the beginning of the first empty line.
19497 Returns the number of empty lines passed."
19498 (let ((pos (point)))
19499 (if (cdr (assoc 'heading org-blank-before-new-entry))
19501 (unless (eobp)
19502 (forward-line -1)))
19503 (beginning-of-line 2)
19504 (goto-char (min (point) pos))
19505 (count-lines (point) pos)))
19507 (defun org-skip-whitespace ()
19510 (defun org-point-in-group (point group &optional context)
19511 "Check if POINT is in match-group GROUP.
19512 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19513 match. If the match group does not exist or point is not inside it,
19514 return nil."
19515 (and (match-beginning group)
19516 (>= point (match-beginning group))
19517 (<= point (match-end group))
19518 (if context
19519 (list context (match-beginning group) (match-end group))
19520 t)))
19522 (defun org-switch-to-buffer-other-window (&rest args)
19523 "Switch to buffer in a second window on the current frame.
19524 In particular, do not allow pop-up frames.
19525 Returns the newly created buffer."
19526 (let (pop-up-frames special-display-buffer-names special-display-regexps
19527 special-display-function)
19528 (apply 'switch-to-buffer-other-window args)))
19530 (defun org-combine-plists (&rest plists)
19531 "Create a single property list from all plists in PLISTS.
19532 The process starts by copying the first list, and then setting properties
19533 from the other lists. Settings in the last list are the most significant
19534 ones and overrule settings in the other lists."
19535 (let ((rtn (copy-sequence (pop plists)))
19536 p v ls)
19537 (while plists
19538 (setq ls (pop plists))
19539 (while ls
19540 (setq p (pop ls) v (pop ls))
19541 (setq rtn (plist-put rtn p v))))
19542 rtn))
19544 (defun org-move-line-down (arg)
19545 "Move the current line down. With prefix argument, move it past ARG lines."
19546 (interactive "p")
19547 (let ((col (current-column))
19548 beg end pos)
19549 (beginning-of-line 1) (setq beg (point))
19550 (beginning-of-line 2) (setq end (point))
19551 (beginning-of-line (+ 1 arg))
19552 (setq pos (move-marker (make-marker) (point)))
19553 (insert (delete-and-extract-region beg end))
19554 (goto-char pos)
19555 (org-move-to-column col)))
19557 (defun org-move-line-up (arg)
19558 "Move the current line up. With prefix argument, move it past ARG lines."
19559 (interactive "p")
19560 (let ((col (current-column))
19561 beg end pos)
19562 (beginning-of-line 1) (setq beg (point))
19563 (beginning-of-line 2) (setq end (point))
19564 (beginning-of-line (- arg))
19565 (setq pos (move-marker (make-marker) (point)))
19566 (insert (delete-and-extract-region beg end))
19567 (goto-char pos)
19568 (org-move-to-column col)))
19570 (defun org-replace-escapes (string table)
19571 "Replace %-escapes in STRING with values in TABLE.
19573 The sequences in STRING may contain normal field width and padding information,
19575 so values can contain further %-escapes if they are define later in TABLE."
19576 (let ((tbl (copy-alist table))
19577 (case-fold-search nil)
19578 (pchg 0)
19579 e re rpl)
19580 (while (setq e (pop tbl))
19581 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19582 (when (and (cdr e) (string-match re (cdr e)))
19583 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19584 (safe "SREF"))
19585 (add-text-properties 0 3 (list 'sref sref) safe)
19586 (setcdr e (replace-match safe t t (cdr e)))))
19587 (while (string-match re string)
19588 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19589 (cdr e)))
19590 (setq string (replace-match rpl t t string))))
19591 (while (setq pchg (next-property-change pchg string))
19592 (let ((sref (get-text-property pchg 'sref string)))
19593 (when (and sref (string-match "SREF" string pchg))
19594 (setq string (replace-match sref t t string)))))
19595 string))
19597 (defun org-sublist (list start end)
19598 "Return a section of LIST, from START to END.
19599 Counting starts at 1."
19600 (let (rtn (c start))
19601 (setq list (nthcdr (1- start) list))
19602 (while (and list (<= c end))
19603 (push (pop list) rtn)
19604 (setq c (1+ c)))
19605 (nreverse rtn)))
19607 (defun org-find-base-buffer-visiting (file)
19608 "Like `find-buffer-visiting' but always return the base buffer and
19609 not an indirect buffer."
19610 (let ((buf (or (get-file-buffer file)
19611 (find-buffer-visiting file))))
19612 (if buf
19613 (or (buffer-base-buffer buf) buf)
19614 nil)))
19616 (defun org-image-file-name-regexp (&optional extensions)
19617 "Return regexp matching the file names of images.
19618 If EXTENSIONS is given, only match these."
19619 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19620 (image-file-name-regexp)
19621 (let ((image-file-name-extensions
19622 (or extensions
19623 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19624 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19626 (regexp-opt (nconc (mapcar 'upcase
19627 image-file-name-extensions)
19628 image-file-name-extensions)
19629 t)
19632 (defun org-file-image-p (file &optional extensions)
19633 "Return non-nil if FILE is an image."
19634 (save-match-data
19635 (string-match (org-image-file-name-regexp extensions) file)))
19637 (defun org-get-cursor-date ()
19638 "Return the date at cursor in as a time.
19639 This works in the calendar and in the agenda, anywhere else it just
19640 returns the current time."
19641 (let (date day defd)
19642 (cond
19643 ((eq major-mode 'calendar-mode)
19644 (setq date (calendar-cursor-to-date)
19645 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19646 ((eq major-mode 'org-agenda-mode)
19647 (setq day (get-text-property (point) 'day))
19648 (if day
19649 (setq date (calendar-gregorian-from-absolute day)
19650 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19651 (nth 2 date))))))
19652 (or defd (current-time))))
19654 (defvar org-agenda-action-marker (make-marker)
19655 "Marker pointing to the entry for the next agenda action.")
19657 (defun org-mark-entry-for-agenda-action ()
19658 "Mark the current entry as target of an agenda action.
19659 Agenda actions are actions executed from the agenda with the key `k',
19660 which make use of the date at the cursor."
19661 (interactive)
19662 (move-marker org-agenda-action-marker
19663 (save-excursion (org-back-to-heading t) (point))
19664 (current-buffer))
19665 (message
19666 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19668 (defun org-mark-subtree ()
19669 "Mark the current subtree.
19670 This puts point at the start of the current subtree, and mark at the end.
19672 If point is in an inline task, mark that task instead."
19673 (interactive)
19674 (let ((inline-task-p
19675 (and (featurep 'org-inlinetask)
19676 (org-inlinetask-in-task-p)))
19677 (beg))
19678 ;; Get beginning of subtree
19679 (cond
19680 (inline-task-p (org-inlinetask-goto-beginning))
19681 ((org-at-heading-p) (beginning-of-line))
19682 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19683 (setq beg (point))
19684 ;; Get end of it
19685 (if inline-task-p
19686 (org-inlinetask-goto-end)
19687 (org-end-of-subtree))
19688 ;; Mark zone
19689 (push-mark (point) nil t)
19690 (goto-char beg)))
19692 ;;; Paragraph filling stuff.
19693 ;; We want this to be just right, so use the full arsenal.
19695 (defun org-indent-line-function ()
19696 "Indent line depending on context."
19697 (interactive)
19698 (let* ((pos (point))
19699 (itemp (org-at-item-p))
19700 (case-fold-search t)
19702 (inline-task-p (and (featurep 'org-inlinetask)
19703 (org-inlinetask-in-task-p)))
19704 (inline-re (and inline-task-p
19705 (org-inlinetask-outline-regexp)))
19706 column)
19707 (beginning-of-line 1)
19708 (cond
19709 ;; Comments
19710 ((looking-at "# ") (setq column 0))
19711 ;; Headings
19712 ((looking-at org-outline-regexp) (setq column 0))
19713 ;; Included files
19715 ;; Footnote definition
19716 ((looking-at org-footnote-definition-re) (setq column 0))
19717 ;; Literal examples
19719 (setq column (org-get-indentation))) ; do nothing
19720 ;; Lists
19721 ((ignore-errors (goto-char (org-in-item-p)))
19722 (setq column (if itemp
19723 (org-get-indentation)
19724 (org-list-item-body-column (point))))
19725 (goto-char pos))
19726 ;; Drawers
19728 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19729 (save-excursion
19730 (goto-char (1- (match-beginning 1)))
19731 (setq column (current-column))))
19732 ;; Special blocks
19734 (save-excursion
19735 (re-search-backward
19737 (setq column (org-get-indentation (match-string 0))))
19740 (save-excursion
19742 (setq column
19743 (cond ((equal (downcase (match-string 1)) "src")
19744 ;; src blocks: let `org-edit-src-exit' handle them
19745 (org-get-indentation))
19746 ((equal (downcase (match-string 1)) "example")
19747 (max (org-get-indentation)
19748 (org-get-indentation (match-string 0))))
19749 (t
19750 (org-get-indentation (match-string 0))))))
19751 ;; This line has nothing special, look at the previous relevant
19752 ;; line to compute indentation
19753 (t
19754 (beginning-of-line 0)
19755 (while (and (not (bobp))
19756 (not (looking-at org-drawer-regexp))
19757 ;; When point started in an inline task, do not move
19758 ;; above task starting line.
19759 (not (and inline-task-p (looking-at inline-re)))
19760 ;; Skip drawers, blocks, empty lines, verbatim,
19761 ;; comments, tables, footnotes definitions, lists,
19762 ;; inline tasks.
19764 (re-search-backward org-drawer-regexp nil t))
19768 (looking-at org-footnote-definition-re)
19769 (and (ignore-errors (goto-char (org-in-item-p)))
19770 (goto-char
19771 (org-list-get-top-point (org-list-struct))))
19772 (and (not inline-task-p)
19773 (featurep 'org-inlinetask)
19774 (org-inlinetask-in-task-p)
19775 (or (org-inlinetask-goto-beginning) t))))
19776 (beginning-of-line 0))
19777 (cond
19778 ;; There was an heading above.
19780 (if (not org-adapt-indentation)
19781 (setq column 0)
19782 (goto-char (match-end 0))
19783 (setq column (current-column))))
19784 ;; A drawer had started and is unfinished
19785 ((looking-at org-drawer-regexp)
19786 (goto-char (1- (match-beginning 1)))
19787 (setq column (current-column)))
19788 ;; Else, nothing noticeable found: get indentation and go on.
19789 (t (setq column (org-get-indentation))))))
19790 ;; Now apply indentation and move cursor accordingly
19791 (goto-char pos)
19792 (if (<= (current-column) (current-indentation))
19793 (org-indent-line-to column)
19794 (save-excursion (org-indent-line-to column)))
19795 ;; Special polishing for properties, see `org-property-format'
19796 (setq column (current-column))
19797 (beginning-of-line 1)
19798 (if (looking-at
19800 (replace-match (concat (match-string 1)
19801 (format org-property-format
19802 (match-string 2) (match-string 3)))
19803 t t))
19804 (org-move-to-column column)))
19806 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19807 "Variable to store copy of `adaptive-fill-regexp'.
19808 Since `adaptive-fill-regexp' is set to never match, we need to
19809 store a backup of its value before entering `org-mode' so that
19810 the functionality can be provided as a fall-back.")
19812 (defun org-set-autofill-regexps ()
19813 (interactive)
19814 ;; In the paragraph separator we include headlines, because filling
19815 ;; text in a line directly attached to a headline would otherwise
19816 ;; fill the headline as well.
19819 ;; The paragraph starter includes hand-formatted lists.
19820 (org-set-local
19821 'paragraph-start
19822 (concat
19831 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19832 ;; But only if the user has not turned off tables or fixed-width regions
19833 (org-set-local
19834 'auto-fill-inhibit-regexp
19835 (concat org-outline-regexp
19838 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19839 (concat
19841 (if org-enable-table-editor "|" "")
19842 (if org-enable-fixed-width-editor ":" "")
19843 "]"))))
19844 ;; We use our own fill-paragraph function, to make sure that tables
19845 ;; and fixed-width regions are not wrapped. That function will pass
19846 ;; through to `fill-paragraph' when appropriate.
19847 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19848 ;; Prevent auto-fill from inserting unwanted new items.
19849 (if (boundp 'fill-nobreak-predicate)
19850 (org-set-local 'fill-nobreak-predicate
19851 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19852 fill-nobreak-predicate
19853 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
19854 ;; Adaptive filling: To get full control, first make sure that
19855 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19856 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19857 (org-set-local 'org-adaptive-fill-regexp-backup
19858 adaptive-fill-regexp))
19860 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19861 (org-set-local 'adaptive-fill-function
19862 'org-adaptive-fill-function)
19863 (org-set-local
19864 'align-mode-rules-list
19865 '((org-in-buffer-settings
19867 (modes . '(org-mode))))))
19869 (defun org-fill-item-nobreak-p ()
19870 "Non-nil when a line break at point would insert a new item."
19871 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19873 (defun org-fill-paragraph (&optional justify)
19874 "Re-align a table, pass through to fill-paragraph if no table."
19875 (let ((table-p (org-at-table-p))
19876 (table.el-p (org-at-table.el-p))
19877 (itemp (org-in-item-p)))
19878 (cond ((and (equal (char-after (point-at-bol)) ?*)
19879 (save-excursion (goto-char (point-at-bol))
19880 (looking-at org-outline-regexp)))
19881 t) ; skip headlines
19882 (table.el-p t) ; skip table.el tables
19883 (table-p (org-table-align) t) ; align Org tables
19884 (itemp ; align text in items
19885 (let* ((struct (save-excursion (goto-char itemp)
19886 (org-list-struct)))
19887 (parents (org-list-parents-alist struct))
19888 (children (org-list-get-children itemp struct parents))
19889 beg end prev next prefix)
19890 ;; Determine in which part of item point is: before
19891 ;; first child, after last child, between two
19892 ;; sub-lists, or simply in item if there's no child.
19893 (cond
19894 ((not children)
19895 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19896 beg itemp
19897 end (org-list-get-item-end itemp struct)))
19898 ((< (point) (setq next (car children)))
19899 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19900 beg itemp
19901 end next))
19902 ((> (point) (setq prev (car (last children))))
19903 (setq beg (org-list-get-item-end prev struct)
19904 end (org-list-get-item-end itemp struct)
19905 prefix (save-excursion
19906 (goto-char beg)
19908 (make-string (current-column) ?\ ))))
19909 (t (catch 'exit
19910 (while (setq next (pop children))
19911 (if (> (point) next)
19912 (setq prev next)
19913 (setq beg (org-list-get-item-end prev struct)
19914 end next
19915 prefix (save-excursion
19916 (goto-char beg)
19918 (make-string (current-column) ?\ )))
19919 (throw 'exit nil))))))
19920 ;; Use `fill-paragraph' with buffer narrowed to item
19921 ;; without any child, and with our computed PREFIX.
19922 (flet ((fill-context-prefix (from to &optional flr) prefix))
19923 (save-restriction
19924 (narrow-to-region beg end)
19925 (save-excursion (fill-paragraph justify)))) t))
19926 ;; Special case where point is not in a list but is on
19927 ;; a paragraph adjacent to a list: make sure this paragraph
19928 ;; doesn't get merged with the end of the list by narrowing
19929 ;; buffer first.
19930 ((save-excursion (forward-paragraph -1)
19931 (setq itemp (org-in-item-p)))
19932 (let ((struct (save-excursion (goto-char itemp)
19933 (org-list-struct))))
19934 (save-restriction
19935 (narrow-to-region (org-list-get-bottom-point struct)
19936 (save-excursion (forward-paragraph 1)
19937 (point)))
19938 (fill-paragraph justify) t)))
19939 ;; Else simply call `fill-paragraph'.
19940 (t nil))))
19942 ;; For reference, this is the default value of adaptive-fill-regexp
19945 (defun org-adaptive-fill-function ()
19946 "Return a fill prefix for org-mode files."
19947 (let (itemp)
19948 (save-excursion
19949 (cond
19950 ;; Comment line
19952 (match-string-no-properties 0))
19953 ;; Plain list item
19954 ((org-at-item-p)
19955 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19956 ;; Point is in a list after `backward-paragraph': original
19957 ;; point wasn't in the list, or filling would have been taken
19958 ;; care of by `org-auto-fill-function', but the list and the
19959 ;; real paragraph are not separated by a blank line. Thus, move
19960 ;; point after the list to go back to real paragraph and
19961 ;; determine fill-prefix.
19962 ((setq itemp (org-in-item-p))
19963 (goto-char itemp)
19964 (let* ((struct (org-list-struct))
19965 (bottom (org-list-get-bottom-point struct)))
19966 (goto-char bottom)
19967 (make-string (org-get-indentation) ?\ )))
19968 ;; Other text
19969 ((looking-at org-adaptive-fill-regexp-backup)
19970 (match-string-no-properties 0))))))
19972 (defun org-auto-fill-function ()
19973 "Auto-fill function."
19974 (let (itemp prefix)
19975 ;; When in a list, compute an appropriate fill-prefix and make
19976 ;; sure it will be used by `do-auto-fill'.
19977 (if (setq itemp (org-in-item-p))
19978 (progn
19979 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19980 (flet ((fill-context-prefix (from to &optional flr) prefix))
19981 (do-auto-fill)))
19982 ;; Else just use `do-auto-fill'.
19983 (do-auto-fill))))
19985 ;;; Other stuff.
19987 (defun org-toggle-fixed-width-section (arg)
19988 "Toggle the fixed-width export.
19989 If there is no active region, the QUOTE keyword at the current headline is
19990 inserted or removed. When present, it causes the text between this headline
19991 and the next to be exported as fixed-width text, and unmodified.
19992 If there is an active region, this command adds or removes a colon as the
19993 first character of this line. If the first character of a line is a colon,
19994 this line is also exported in fixed-width font."
19995 (interactive "P")
19996 (let* ((cc 0)
19997 (regionp (org-region-active-p))
19998 (beg (if regionp (region-beginning) (point)))
19999 (end (if regionp (region-end)))
20000 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20001 (case-fold-search nil)
20003 off)
20004 (if regionp
20005 (save-excursion
20006 (goto-char beg)
20007 (setq cc (current-column))
20008 (beginning-of-line 1)
20009 (setq off (looking-at re))
20010 (while (> nlines 0)
20011 (setq nlines (1- nlines))
20012 (beginning-of-line 1)
20013 (cond
20014 (arg
20015 (org-move-to-column cc t)
20017 (forward-line -1))
20018 ((and off (looking-at re))
20019 (replace-match "" t t nil 1))
20020 ((not off) (org-move-to-column cc t) (insert ": ")))
20021 (forward-line 1)))
20022 (save-excursion
20023 (org-back-to-heading)
20024 (if (looking-at (concat org-outline-regexp
20026 (replace-match "" t t nil 1)
20027 (if (looking-at org-outline-regexp)
20028 (progn
20029 (goto-char (match-end 0))
20030 (insert org-quote-string " "))))))))
20032 (defun org-reftex-citation ()
20033 "Use reftex-citation to insert a citation into the buffer.
20034 This looks for a line like
20036 #+BIBLIOGRAPHY: foo plain option:-d
20038 and derives from it that foo.bib is the bibliography file relevant
20039 for this document. It then installs the necessary environment for RefTeX
20040 to work in this buffer and calls `reftex-citation' to insert a citation
20041 into the buffer.
20043 Export of such citations to both LaTeX and HTML is handled by the contributed
20044 package org-exp-bibtex by Taru Karttunen."
20045 (interactive)
20046 (let ((reftex-docstruct-symbol 'rds)
20048 rds bib)
20049 (save-excursion
20050 (save-restriction
20051 (widen)
20052 (let ((case-fold-search t)
20054 (if (not (save-excursion
20055 (or (re-search-forward re nil t)
20056 (re-search-backward re nil t))))
20057 (error "No bibliography defined in file")
20058 (setq bib (concat (match-string 1) ".bib")
20059 rds (list (list 'bib bib)))))))
20060 (call-interactively 'reftex-citation)))
20062 ;;;; Functions extending outline functionality
20064 (defun org-beginning-of-line (&optional arg)
20065 "Go to the beginning of the current line. If that is invisible, continue
20066 to a visible line beginning. This makes the function of C-a more intuitive.
20067 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20068 first attempt, and only move to after the tags when the cursor is already
20069 beyond the end of the headline."
20070 (interactive "P")
20071 (let ((pos (point))
20072 (special (if (consp org-special-ctrl-a/e)
20073 (car org-special-ctrl-a/e)
20074 org-special-ctrl-a/e))
20075 refpos)
20076 (if (org-bound-and-true-p line-move-visual)
20077 (beginning-of-visual-line 1)
20078 (beginning-of-line 1))
20079 (if (and arg (fboundp 'move-beginning-of-line))
20080 (call-interactively 'move-beginning-of-line)
20081 (if (bobp)
20082 nil
20083 (backward-char 1)
20084 (if (org-truely-invisible-p)
20085 (while (and (not (bobp)) (org-truely-invisible-p))
20086 (backward-char 1)
20087 (beginning-of-line 1))
20088 (forward-char 1))))
20089 (when special
20090 (cond
20091 ((and (looking-at org-complex-heading-regexp)
20092 (= (char-after (match-end 1)) ?\ ))
20093 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20094 (point-at-eol)))
20095 (goto-char
20096 (if (eq special t)
20097 (cond ((> pos refpos) refpos)
20098 ((= pos (point)) refpos)
20099 (t (point)))
20100 (cond ((> pos (point)) (point))
20101 ((not (eq last-command this-command)) (point))
20102 (t refpos)))))
20103 ((org-at-item-p)
20104 (goto-char
20105 (if (eq special t)
20106 (cond ((> pos (match-end 0)) (match-end 0))
20107 ((= pos (point)) (match-end 0))
20108 (t (point)))
20109 (cond ((> pos (point)) (point))
20110 ((not (eq last-command this-command)) (point))
20111 (t (match-end 0))))))))
20112 (org-no-warnings
20113 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20115 (defun org-end-of-line (&optional arg)
20116 "Go to the end of the line.
20117 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20118 first attempt, and only move to after the tags when the cursor is already
20119 beyond the end of the headline."
20120 (interactive "P")
20121 (let ((special (if (consp org-special-ctrl-a/e)
20122 (cdr org-special-ctrl-a/e)
20123 org-special-ctrl-a/e)))
20124 (cond
20125 ((or (not special) arg
20126 (not (or (org-on-heading-p) (org-at-item-p))))
20127 (call-interactively
20128 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20129 ((fboundp 'move-end-of-line) 'move-end-of-line)
20130 (t 'end-of-line))))
20131 ((org-on-heading-p)
20132 (let ((pos (point)))
20133 (beginning-of-line 1)
20135 (if (eq special t)
20136 (if (or (< pos (match-beginning 1))
20137 (= pos (match-end 0)))
20138 (goto-char (match-beginning 1))
20139 (goto-char (match-end 0)))
20140 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20141 (goto-char (match-end 0))
20142 (goto-char (match-beginning 1))))
20143 (call-interactively (if (fboundp 'move-end-of-line)
20144 'move-end-of-line
20145 'end-of-line)))))
20146 ;; At an item: Move before any hidden text.
20147 (t (call-interactively 'end-of-line)))
20148 (org-no-warnings
20149 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20151 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20152 (define-key org-mode-map "\C-e" 'org-end-of-line)
20154 (defun org-backward-sentence (&optional arg)
20155 "Go to beginning of sentence, or beginning of table field.
20156 This will call `backward-sentence' or `org-table-beginning-of-field',
20157 depending on context."
20158 (interactive "P")
20159 (cond
20160 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20161 (t (call-interactively 'backward-sentence))))
20163 (defun org-forward-sentence (&optional arg)
20164 "Go to end of sentence, or end of table field.
20165 This will call `forward-sentence' or `org-table-end-of-field',
20166 depending on context."
20167 (interactive "P")
20168 (cond
20169 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20170 (t (call-interactively 'forward-sentence))))
20172 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20173 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20175 (defun org-kill-line (&optional arg)
20176 "Kill line, to tags or end of line."
20177 (interactive "P")
20178 (cond
20179 ((or (not org-special-ctrl-k)
20180 (bolp)
20181 (not (org-on-heading-p)))
20182 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20183 org-ctrl-k-protect-subtree)
20184 (if (or (eq org-ctrl-k-protect-subtree 'error)
20185 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20186 (error "C-k aborted - would kill hidden subtree")))
20187 (call-interactively 'kill-line))
20189 (kill-region (point) (match-beginning 1))
20190 (org-set-tags nil t))
20191 (t (kill-region (point) (point-at-eol)))))
20193 (define-key org-mode-map "\C-k" 'org-kill-line)
20195 (defun org-yank (&optional arg)
20196 "Yank. If the kill is a subtree, treat it specially.
20197 This command will look at the current kill and check if is a single
20198 subtree, or a series of subtrees[1]. If it passes the test, and if the
20199 cursor is at the beginning of a line or after the stars of a currently
20200 empty headline, then the yank is handled specially. How exactly depends
20201 on the value of the following variables, both set by default.
20203 org-yank-folded-subtrees
20204 When set, the subtree(s) will be folded after insertion, but only
20205 if doing so would now swallow text after the yanked text.
20207 org-yank-adjusted-subtrees
20208 When set, the subtree will be promoted or demoted in order to
20209 fit into the local outline tree structure, which means that the level
20210 will be adjusted so that it becomes the smaller one of the two
20211 *visible* surrounding headings.
20213 Any prefix to this command will cause `yank' to be called directly with
20215 will just
20216 plainly yank the text as it is.
20218 \[1] The test checks if the first non-white line is a heading
20219 and if there are no other headings with fewer stars."
20220 (interactive "P")
20221 (org-yank-generic 'yank arg))
20223 (defun org-yank-generic (command arg)
20224 "Perform some yank-like command.
20226 This function implements the behavior described in the `org-yank'
20227 documentation. However, it has been generalized to work for any
20228 interactive command with similar behavior."
20230 ;; pretend to be command COMMAND
20231 (setq this-command command)
20233 (if arg
20234 (call-interactively command)
20236 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20237 (and (org-kill-is-subtree-p)
20238 (or (bolp)
20240 (string-match
20242 (buffer-substring (point-at-bol) (point)))))))
20243 swallowp)
20244 (cond
20245 ((and subtreep org-yank-folded-subtrees)
20246 (let ((beg (point))
20247 end)
20248 (if (and subtreep org-yank-adjusted-subtrees)
20249 (org-paste-subtree nil nil 'for-yank)
20250 (call-interactively command))
20252 (setq end (point))
20253 (goto-char beg)
20254 (when (and (bolp) subtreep
20255 (not (setq swallowp
20256 (org-yank-folding-would-swallow-text beg end))))
20257 (org-with-limited-levels
20258 (or (looking-at org-outline-regexp)
20259 (re-search-forward org-outline-regexp-bol end t))
20260 (while (and (< (point) end) (looking-at org-outline-regexp))
20261 (hide-subtree)
20262 (org-cycle-show-empty-lines 'folded)
20263 (condition-case nil
20264 (outline-forward-same-level 1)
20265 (error (goto-char end))))))
20266 (when swallowp
20267 (message
20268 "Inserted text not folded because that would swallow text"))
20270 (goto-char end)
20272 (beginning-of-line 1)
20273 (push-mark beg 'nomsg)))
20274 ((and subtreep org-yank-adjusted-subtrees)
20275 (let ((beg (point-at-bol)))
20276 (org-paste-subtree nil nil 'for-yank)
20277 (push-mark beg 'nomsg)))
20278 (t
20279 (call-interactively command))))))
20281 (defun org-yank-folding-would-swallow-text (beg end)
20282 "Would hide-subtree at BEG swallow any text after END?"
20283 (let (level)
20284 (org-with-limited-levels
20285 (save-excursion
20286 (goto-char beg)
20287 (when (or (looking-at org-outline-regexp)
20288 (re-search-forward org-outline-regexp-bol end t))
20289 (setq level (org-outline-level)))
20290 (goto-char end)
20292 (if (or (eobp)
20293 (and (bolp) (looking-at org-outline-regexp)
20294 (<= (org-outline-level) level)))
20295 nil ; Nothing would be swallowed
20296 t))))) ; something would swallow
20298 (define-key org-mode-map "\C-y" 'org-yank)
20300 (defun org-truely-invisible-p ()
20301 "Check if point is at a character currently not visible.
20302 This version does not only check the character property, but also
20303 `visible-mode'."
20304 ;; Early versions of noutline don't have `outline-invisible-p'.
20305 (if (org-bound-and-true-p visible-mode)
20306 nil
20307 (outline-invisible-p)))
20309 (defun org-invisible-p2 ()
20310 "Check if point is at a character currently not visible."
20311 (save-excursion
20312 (if (and (eolp) (not (bobp))) (backward-char 1))
20313 ;; Early versions of noutline don't have `outline-invisible-p'.
20314 (outline-invisible-p)))
20316 (defun org-back-to-heading (&optional invisible-ok)
20317 "Call `outline-back-to-heading', but provide a better error message."
20318 (condition-case nil
20319 (outline-back-to-heading invisible-ok)
20320 (error (error "Before first headline at position %d in buffer %s"
20321 (point) (current-buffer)))))
20323 (defun org-beginning-of-defun ()
20324 "Go to the beginning of the subtree, i.e. back to the heading."
20325 (org-back-to-heading))
20326 (defun org-end-of-defun ()
20327 "Go to the end of the subtree."
20328 (org-end-of-subtree nil t))
20330 (defun org-before-first-heading-p ()
20331 "Before first heading?"
20332 (save-excursion
20333 (end-of-line)
20334 (null (re-search-backward org-outline-regexp-bol nil t))))
20336 (defun org-on-heading-p (&optional ignored)
20337 (outline-on-heading-p t))
20338 (defun org-at-heading-p (&optional ignored)
20339 (outline-on-heading-p t))
20341 (defun org-point-at-end-of-empty-headline ()
20342 "If point is at the end of an empty headline, return t, else nil.
20343 If the heading only contains a TODO keyword, it is still still considered
20344 empty."
20346 (save-excursion
20347 (beginning-of-line 1)
20348 (let ((case-fold-search nil))
20351 (defun org-at-heading-or-item-p ()
20352 (or (org-on-heading-p) (org-at-item-p)))
20354 (defun org-on-target-p ()
20355 (or (org-in-regexp org-radio-target-regexp)
20356 (org-in-regexp org-target-regexp)))
20358 (defun org-up-heading-all (arg)
20359 "Move to the heading line of which the present line is a subheading.
20360 This function considers both visible and invisible heading lines.
20361 With argument, move up ARG levels."
20362 (if (fboundp 'outline-up-heading-all)
20363 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20364 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20366 (defun org-up-heading-safe ()
20367 "Move to the heading line of which the present line is a subheading.
20368 This version will not throw an error. It will return the level of the
20369 headline found, or nil if no higher level is found.
20371 Also, this function will be a lot faster than `outline-up-heading',
20372 because it relies on stars being the outline starters. This can really
20373 make a significant difference in outlines with very many siblings."
20374 (let (start-level re)
20375 (org-back-to-heading t)
20376 (setq start-level (funcall outline-level))
20377 (if (equal start-level 1)
20378 nil
20380 (if (re-search-backward re nil t)
20381 (funcall outline-level)))))
20383 (defun org-first-sibling-p ()
20384 "Is this heading the first child of its parents?"
20385 (interactive)
20386 (let ((re org-outline-regexp-bol)
20387 level l)
20388 (unless (org-at-heading-p t)
20389 (error "Not at a heading"))
20390 (setq level (funcall outline-level))
20391 (save-excursion
20392 (if (not (re-search-backward re nil t))
20393 t
20394 (setq l (funcall outline-level))
20395 (< l level)))))
20397 (defun org-goto-sibling (&optional previous)
20398 "Goto the next sibling, even if it is invisible.
20399 When PREVIOUS is set, go to the previous sibling instead. Returns t
20400 when a sibling was found. When none is found, return nil and don't
20401 move point."
20402 (let ((fun (if previous 're-search-backward 're-search-forward))
20403 (pos (point))
20404 (re org-outline-regexp-bol)
20405 level l)
20406 (when (condition-case nil (org-back-to-heading t) (error nil))
20407 (setq level (funcall outline-level))
20408 (catch 'exit
20409 (or previous (forward-char 1))
20410 (while (funcall fun re nil t)
20411 (setq l (funcall outline-level))
20412 (when (< l level) (goto-char pos) (throw 'exit nil))
20413 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20414 (goto-char pos)
20415 nil))))
20417 (defun org-show-siblings ()
20418 "Show all siblings of the current headline."
20419 (save-excursion
20420 (while (org-goto-sibling) (org-flag-heading nil)))
20421 (save-excursion
20422 (while (org-goto-sibling 'previous)
20423 (org-flag-heading nil))))
20425 (defun org-goto-first-child ()
20426 "Goto the first child, even if it is invisible.
20427 Return t when a child was found. Otherwise don't move point and
20428 return nil."
20429 (let (level (pos (point)) (re org-outline-regexp-bol))
20430 (when (condition-case nil (org-back-to-heading t) (error nil))
20431 (setq level (outline-level))
20432 (forward-char 1)
20433 (if (and (re-search-forward re nil t) (> (outline-level) level))
20434 (progn (goto-char (match-beginning 0)) t)
20435 (goto-char pos) nil))))
20437 (defun org-show-hidden-entry ()
20438 "Show an entry where even the heading is hidden."
20439 (save-excursion
20440 (org-show-entry)))
20442 (defun org-flag-heading (flag &optional entry)
20443 "Flag the current heading. FLAG non-nil means make invisible.
20444 When ENTRY is non-nil, show the entire entry."
20445 (save-excursion
20446 (org-back-to-heading t)
20447 ;; Check if we should show the entire entry
20448 (if entry
20449 (progn
20450 (org-show-entry)
20451 (save-excursion
20452 (and (outline-next-heading)
20453 (org-flag-heading nil))))
20454 (outline-flag-region (max (point-min) (1- (point)))
20455 (save-excursion (outline-end-of-heading) (point))
20456 flag))))
20458 (defun org-get-next-sibling ()
20459 "Move to next heading of the same level, and return point.
20460 If there is no such heading, return nil.
20461 This is like outline-next-sibling, but invisible headings are ok."
20462 (let ((level (funcall outline-level)))
20463 (outline-next-heading)
20464 (while (and (not (eobp)) (> (funcall outline-level) level))
20465 (outline-next-heading))
20466 (if (or (eobp) (< (funcall outline-level) level))
20467 nil
20468 (point))))
20470 (defun org-get-last-sibling ()
20471 "Move to previous heading of the same level, and return point.
20472 If there is no such heading, return nil."
20473 (let ((opoint (point))
20474 (level (funcall outline-level)))
20475 (outline-previous-heading)
20476 (when (and (/= (point) opoint) (outline-on-heading-p t))
20477 (while (and (> (funcall outline-level) level)
20478 (not (bobp)))
20479 (outline-previous-heading))
20480 (if (< (funcall outline-level) level)
20481 nil
20482 (point)))))
20484 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20485 ;; This contains an exact copy of the original function, but it uses
20486 ;; `org-back-to-heading', to make it work also in invisible
20487 ;; trees. And is uses an invisible-OK argument.
20488 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20489 ;; Furthermore, when used inside Org, finding the end of a large subtree
20490 ;; with many children and grandchildren etc, this can be much faster
20491 ;; than the outline version.
20492 (org-back-to-heading invisible-OK)
20493 (let ((first t)
20494 (level (funcall outline-level)))
20495 (if (and (eq major-mode 'org-mode) (< level 1000))
20496 ;; A true heading (not a plain list item), in Org-mode
20497 ;; This means we can easily find the end by looking
20498 ;; only for the right number of stars. Using a regexp to do
20499 ;; this is so much faster than using a Lisp loop.
20501 (forward-char 1)
20502 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20503 ;; something else, do it the slow way
20504 (while (and (not (eobp))
20505 (or first (> (funcall outline-level) level)))
20506 (setq first nil)
20507 (outline-next-heading)))
20508 (unless to-heading
20510 (progn
20511 ;; Go to end of line before heading
20512 (forward-char -1)
20514 ;; leave blank line before heading
20515 (forward-char -1))))))
20516 (point))
20518 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20519 "Use Org version in org-mode, for dramatic speed-up."
20520 (if (eq major-mode 'org-mode)
20521 (progn
20522 (org-end-of-subtree nil t)
20523 (unless (eobp) (backward-char 1)))
20524 ad-do-it))
20526 (defun org-end-of-meta-data-and-drawers ()
20527 "Jump to the first text after meta data and drawers in the current entry.
20528 This will move over empty lines, lines with planning time stamps,
20529 clocking lines, and drawers."
20530 (org-back-to-heading t)
20531 (let ((end (save-excursion (outline-next-heading) (point)))
20534 (forward-line 1)
20535 (while (re-search-forward re end t)
20536 (if (not (match-end 1))
20537 ;; empty or planning line
20538 (forward-line 1)
20539 ;; a drawer, find the end
20541 (forward-line 1)))
20543 (point)))
20545 (defun org-forward-same-level (arg &optional invisible-ok)
20546 "Move forward to the arg'th subheading at same level as this one.
20547 Stop at the first and last subheadings of a superior heading.
20548 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20549 it wil also look at invisible ones."
20550 (interactive "p")
20551 (org-back-to-heading invisible-ok)
20552 (org-on-heading-p)
20553 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20555 l)
20556 (forward-char 1)
20557 (while (> arg 0)
20558 (while (and (re-search-forward re nil 'move)
20559 (setq l (- (match-end 0) (match-beginning 0) 1))
20560 (= l level)
20561 (not invisible-ok)
20562 (progn (backward-char 1) (outline-invisible-p)))
20563 (if (< l level) (setq arg 1)))
20564 (setq arg (1- arg)))
20565 (beginning-of-line 1)))
20567 (defun org-backward-same-level (arg &optional invisible-ok)
20568 "Move backward to the arg'th subheading at same level as this one.
20569 Stop at the first and last subheadings of a superior heading."
20570 (interactive "p")
20571 (org-back-to-heading)
20572 (org-on-heading-p)
20573 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20575 l)
20576 (while (> arg 0)
20577 (while (and (re-search-backward re nil 'move)
20578 (setq l (- (match-end 0) (match-beginning 0) 1))
20579 (= l level)
20580 (not invisible-ok)
20581 (outline-invisible-p))
20582 (if (< l level) (setq arg 1)))
20583 (setq arg (1- arg)))))
20585 (defun org-show-subtree ()
20586 "Show everything after this heading at deeper levels."
20587 (outline-flag-region
20588 (point)
20589 (save-excursion
20590 (org-end-of-subtree t t))
20591 nil))
20593 (defun org-show-entry ()
20594 "Show the body directly following this heading.
20595 Show the heading too, if it is currently invisible."
20596 (interactive)
20597 (save-excursion
20598 (condition-case nil
20599 (progn
20600 (org-back-to-heading t)
20601 (outline-flag-region
20602 (max (point-min) (1- (point)))
20603 (save-excursion
20604 (if (re-search-forward
20606 (match-beginning 1)
20607 (point-max)))
20608 nil)
20609 (org-cycle-hide-drawers 'children))
20610 (error nil))))
20612 (defun org-make-options-regexp (kwds &optional extra)
20613 "Make a regular expression for keyword lines."
20614 (concat
20615 "^"
20622 ;; Make isearch reveal the necessary context
20623 (defun org-isearch-end ()
20624 "Reveal context after isearch exits."
20625 (when isearch-success ; only if search was successful
20626 (if (featurep 'xemacs)
20627 ;; Under XEmacs, the hook is run in the correct place,
20628 ;; we directly show the context.
20629 (org-show-context 'isearch)
20630 ;; In Emacs the hook runs *before* restoring the overlays.
20631 ;; So we have to use a one-time post-command-hook to do this.
20632 ;; (Emacs 22 has a special variable, see function `org-mode')
20633 (unless (and (boundp 'isearch-mode-end-hook-quit)
20634 isearch-mode-end-hook-quit)
20635 ;; Only when the isearch was not quitted.
20636 (org-add-hook 'post-command-hook 'org-isearch-post-command
20637 'append 'local)))))
20639 (defun org-isearch-post-command ()
20640 "Remove self from hook, and show context."
20641 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20642 (org-show-context 'isearch))
20645 ;;;; Integration with and fixes for other packages
20647 ;;; Imenu support
20649 (defvar org-imenu-markers nil
20650 "All markers currently used by Imenu.")
20651 (make-variable-buffer-local 'org-imenu-markers)
20653 (defun org-imenu-new-marker (&optional pos)
20654 "Return a new marker for use by Imenu, and remember the marker."
20655 (let ((m (make-marker)))
20656 (move-marker m (or pos (point)))
20657 (push m org-imenu-markers)
20658 m))
20660 (defun org-imenu-get-tree ()
20661 "Produce the index for Imenu."
20662 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20663 (setq org-imenu-markers nil)
20664 (let* ((n org-imenu-depth)
20665 (re (concat "^" (org-get-limited-outline-regexp)))
20666 (subs (make-vector (1+ n) nil))
20667 (last-level 0)
20668 m level head)
20669 (save-excursion
20670 (save-restriction
20671 (widen)
20672 (goto-char (point-max))
20673 (while (re-search-backward re nil t)
20674 (setq level (org-reduced-level (funcall outline-level)))
20675 (when (<= level n)
20676 (looking-at org-complex-heading-regexp)
20677 (setq head (org-link-display-format
20678 (org-match-string-no-properties 4))
20679 m (org-imenu-new-marker))
20680 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20681 (if (>= level last-level)
20682 (push (cons head m) (aref subs level))
20683 (push (cons head (aref subs (1+ level))) (aref subs level))
20684 (loop for i from (1+ level) to n do (aset subs i nil)))
20685 (setq last-level level)))))
20686 (aref subs 1)))
20688 (eval-after-load "imenu"
20689 '(progn
20690 (add-hook 'imenu-after-jump-hook
20691 (lambda ()
20692 (if (eq major-mode 'org-mode)
20693 (org-show-context 'org-goto))))))
20695 (defun org-link-display-format (link)
20696 "Replace a link with either the description, or the link target
20697 if no description is present"
20698 (save-match-data
20699 (if (string-match org-bracket-link-analytic-regexp link)
20700 (replace-match (if (match-end 5)
20701 (match-string 5 link)
20702 (concat (match-string 1 link)
20703 (match-string 3 link)))
20704 nil t link)
20705 link)))
20707 (defun org-toggle-link-display ()
20708 "Toggle the literal or descriptive display of links."
20709 (interactive)
20710 (if org-descriptive-links
20711 (progn (org-remove-from-invisibility-spec '(org-link))
20712 (org-restart-font-lock)
20713 (setq org-descriptive-links nil))
20714 (progn (add-to-invisibility-spec '(org-link))
20715 (org-restart-font-lock)
20716 (setq org-descriptive-links t))))
20718 ;; Speedbar support
20720 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20721 "Overlay marking the agenda restriction line in speedbar.")
20722 (overlay-put org-speedbar-restriction-lock-overlay
20723 'face 'org-agenda-restriction-lock)
20724 (overlay-put org-speedbar-restriction-lock-overlay
20725 'help-echo "Agendas are currently limited to this item.")
20726 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20728 (defun org-speedbar-set-agenda-restriction ()
20729 "Restrict future agenda commands to the location at point in speedbar.
20731 (interactive)
20732 (require 'org-agenda)
20733 (let (p m tp np dir txt)
20734 (cond
20735 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20736 'org-imenu t))
20737 (setq m (get-text-property p 'org-imenu-marker))
20738 (with-current-buffer (marker-buffer m)
20739 (goto-char m)
20740 (org-agenda-set-restriction-lock 'subtree)))
20741 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20742 'speedbar-function 'speedbar-find-file))
20743 (setq tp (previous-single-property-change
20744 (1+ p) 'speedbar-function)
20745 np (next-single-property-change
20746 tp 'speedbar-function)
20747 dir (speedbar-line-directory)
20748 txt (buffer-substring-no-properties (or tp (point-min))
20749 (or np (point-max))))
20750 (with-current-buffer (find-file-noselect
20751 (let ((default-directory dir))
20752 (expand-file-name txt)))
20753 (unless (eq major-mode 'org-mode)
20754 (error "Cannot restrict to non-Org-mode file"))
20755 (org-agenda-set-restriction-lock 'file)))
20756 (t (error "Don't know how to restrict Org-mode's agenda")))
20757 (move-overlay org-speedbar-restriction-lock-overlay
20758 (point-at-bol) (point-at-eol))
20759 (setq current-prefix-arg nil)
20760 (org-agenda-maybe-redo)))
20762 (eval-after-load "speedbar"
20763 '(progn
20764 (speedbar-add-supported-extension ".org")
20765 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20766 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20767 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20768 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20769 (add-hook 'speedbar-visiting-tag-hook
20770 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
20772 ;;; Fixes and Hacks for problems with other packages
20774 ;; Make flyspell not check words in links, to not mess up our keymap
20775 (defun org-mode-flyspell-verify ()
20776 "Don't let flyspell put overlays at active buttons, or on
20777 {todo,all-time,additional-option-like}-keywords."
20778 (let ((pos (max (1- (point)) (point-min)))
20779 (word (thing-at-point 'word)))
20780 (and (not (get-text-property pos 'keymap))
20781 (not (get-text-property pos 'org-no-flyspell))
20782 (not (member word org-todo-keywords-1))
20783 (not (member word org-all-time-keywords))
20784 (not (member word org-additional-option-like-keywords)))))
20786 (defun org-remove-flyspell-overlays-in (beg end)
20787 "Remove flyspell overlays in region."
20788 (and (org-bound-and-true-p flyspell-mode)
20789 (fboundp 'flyspell-delete-region-overlays)
20790 (flyspell-delete-region-overlays beg end))
20791 (add-text-properties beg end '(org-no-flyspell t)))
20793 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20794 (eval-after-load "bookmark"
20795 '(if (boundp 'bookmark-after-jump-hook)
20796 ;; We can use the hook
20797 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20798 ;; Hook not available, use advice
20799 (defadvice bookmark-jump (after org-make-visible activate)
20800 "Make the position visible."
20801 (org-bookmark-jump-unhide))))
20803 ;; Make sure saveplace shows the location if it was hidden
20804 (eval-after-load "saveplace"
20805 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20806 "Make the position visible."
20807 (org-bookmark-jump-unhide)))
20809 ;; Make sure ecb shows the location if it was hidden
20810 (eval-after-load "ecb"
20811 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20812 "Make hierarchy visible when jumping into location from ECB tree buffer."
20813 (if (eq major-mode 'org-mode)
20814 (org-show-context))))
20816 (defun org-bookmark-jump-unhide ()
20817 "Unhide the current position, to show the bookmark location."
20818 (and (eq major-mode 'org-mode)
20819 (or (outline-invisible-p)
20820 (save-excursion (goto-char (max (point-min) (1- (point))))
20821 (outline-invisible-p)))
20822 (org-show-context 'bookmark-jump)))
20824 ;; Make session.el ignore our circular variable
20825 (eval-after-load "session"
20826 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20828 ;;;; Experimental code
20830 (defun org-closed-in-range ()
20831 "Sparse tree of items closed in a certain time range.
20832 Still experimental, may disappear in the future."
20833 (interactive)
20834 ;; Get the time interval from the user.
20835 (let* ((time1 (org-float-time
20836 (org-read-date nil 'to-time nil "Starting date: ")))
20837 (time2 (org-float-time
20838 (org-read-date nil 'to-time nil "End date:")))
20839 ;; callback function
20840 (callback (lambda ()
20841 (let ((time
20842 (org-float-time
20843 (apply 'encode-time
20844 (org-parse-time-string
20845 (match-string 1))))))
20846 ;; check if time in interval
20847 (and (>= time time1) (<= time time2))))))
20848 ;; make tree, check each match with the callback
20851 ;;;; Finish up
20853 (provide 'org)
20855 (run-hooks 'org-load-hook)
20857 ;;; org.el ends here