| blob | 8337c32b25477b4524adef2545b5cbcf0f6f65bd |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2012 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.8.05
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
195 ;;;; Customization variables
197 "Remove ID property of clones of a subtree.
198 When non-nil, clones of a subtree don't inherit the ID property.
199 Otherwise they inherit the ID property with a new unique
200 identifier."
204 ;;; Version
209 ;;;###autoload
211 "Show the org-mode version in the echo area.
212 With prefix arg HERE, insert it at point."
238 ;;; Compatibility constants
240 ;;; The custom variables
243 "Outline-based notes management and organizer."
249 "Mode hook for Org-mode, run after the mode was turned on."
254 "Hook that is run after org.el has been loaded."
259 "Hook that is run after an Org log buffer is created."
268 "Load all extensions listed in `org-modules'."
273 org-modules)
277 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
286 (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)
287 "Modules that should always be loaded together with org.el.
288 If a description starts with <C>, the file is not part of Emacs
289 and loading it will require that you have downloaded and properly installed
290 the org-mode distribution.
292 You can also use this system to load external packages (i.e. neither Org
293 core modules, nor modules from the CONTRIB directory). Just add symbols
294 to the end of the list. If the package is called org-xyz.el, then you need
295 to add the symbol `xyz', and the package must have a call to
297 (provide 'org-xyz)"
300 :type
331 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
340 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
349 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
365 "Non-nil means make shift-cursor commands select text when possible.
367 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
368 start selecting a region, or enlarge regions started in this way.
369 In Org-mode, in special contexts, these same keys are used for
370 other purposes, important enough to compete with shift selection.
371 Org tries to balance these needs by supporting `shift-select-mode'
372 outside these special contexts, under control of this variable.
374 The default of this variable is nil, to avoid confusing behavior. Shifted
375 cursor keys will then execute Org commands in the following contexts:
376 - on a headline, changing TODO state (left/right) and priority (up/down)
377 - on a time stamp, changing the time
378 - in a plain list item, changing the bullet type
379 - in a property definition line, switching between allowed values
380 - in the BEGIN line of a clock table (changing the time block).
381 Outside these contexts, the commands will throw an error.
383 When this variable is t and the cursor is not in a special
384 context, Org-mode will support shift-selection for making and
385 enlarging regions. To make this more effective, the bullet
386 cycling will no longer happen anywhere in an item line, but only
387 if the cursor is exactly on the bullet.
389 If you set this variable to the symbol `always', then the keys
390 will not be special in headlines, property lines, and item lines,
391 to make shift selection work there as well. If this is what you
392 want, you can use the following alternative commands: `C-c C-t'
393 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
394 can be used to switch TODO sets, `C-c -' to cycle item bullet
395 types, and properties can be edited by hand or in column view.
397 However, when the cursor is on a timestamp, shift-cursor commands
398 will still edit the time stamp - this is just too good to give up.
400 XEmacs user should have this variable set to nil, because
401 `shift-select-mode' is in Emacs 23 or later only."
409 "Shall some commands act upon headlines in the active region?
411 When set to `t', some commands will be performed in all headlines
412 within the active region.
414 When set to `start-level', some commands will be performed in all
415 headlines within the active region, provided that these headlines
416 are of the same level than the first one.
418 When set to a string, those commands will be performed on the
419 matching headlines within the active region. Such string must be
420 a tags/property/todo match as it is used in the agenda tags view.
422 The list of commands is: `org-schedule', `org-deadline',
423 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
424 `org-archive-to-archive-sibling'. The archiving commands skip
425 already archived entries."
434 "Options concerning startup of Org-mode."
439 "Non-nil means entering Org-mode will switch to OVERVIEW.
440 This can also be configured on a per-file basis by adding one of
441 the following lines anywhere in the buffer:
443 #+STARTUP: fold (or `overview', this is equivalent)
444 #+STARTUP: nofold (or `showall', this is equivalent)
445 #+STARTUP: content
446 #+STARTUP: showeverything"
455 "Non-nil means entering Org-mode will set `truncate-lines'.
456 This is useful since some lines containing links can be very long and
457 uninteresting. Also tables look terrible when wrapped."
462 "Non-nil means turn on `org-indent-mode' on startup.
463 This can also be configured on a per-file basis by adding one of
464 the following lines anywhere in the buffer:
466 #+STARTUP: indent
467 #+STARTUP: noindent"
475 When this option is turned on, you can use TeX-like syntax for sub- and
477 considered as a single item - so grouping with {} is normally not
478 needed. For example, the following things will be parsed as single
479 sub- or superscripts.
481 10^24 or 10^tau several digits will be considered 1 item.
482 10^-12 or 10^-tau a leading sign with digits or a word
483 x^2-y^3 will be read as x^2 - y^3, because items are
484 terminated by almost any nonword/nondigit char.
485 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
487 Still, ambiguity is possible - so when in doubt use {} to enclose the
488 sub/superscript. If you set this variable to the symbol `{}',
489 the braces are *required* in order to trigger interpretations as
491 frequently in plain text.
493 Not all export backends support this, but HTML does.
508 "Non-nil means turn on `org-beamer-mode' on startup.
509 This can also be configured on a per-file basis by adding one of
510 the following lines anywhere in the buffer:
512 #+STARTUP: beamer"
517 "Non-nil means align all tables when visiting a file.
518 This is useful when the column width in tables is forced with <N> cookies
519 in table fields. Such tables will look correct only after the first re-align.
520 This can also be configured on a per-file basis by adding one of
521 the following lines anywhere in the buffer:
522 #+STARTUP: align
523 #+STARTUP: noalign"
528 "Non-nil means show inline images when loading a new Org file.
529 This can also be configured on a per-file basis by adding one of
530 the following lines anywhere in the buffer:
531 #+STARTUP: inlineimages
532 #+STARTUP: noinlineimages"
537 "Non-nil means insert the first line setting Org-mode in empty files.
538 When the function `org-mode' is called interactively in an empty file, this
539 normally means that the file name does not automatically trigger Org-mode.
540 To ensure that the file will always be in Org-mode in the future, a
541 line enforcing Org-mode will be inserted into the buffer, if this option
542 has been set."
547 "Non-nil means use alternative key bindings for some keys.
548 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
549 These keys are also used by other packages like shift-selection-mode'
550 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
551 If you want to use Org-mode together with one of these other modes,
552 or more generally if you would like to move some Org-mode commands to
553 other keys, set this variable and configure the keys with the variable
554 `org-disputed-keys'.
556 This option is only relevant at load-time of Org-mode, and must be set
557 *before* org.el is loaded. Changing it requires a restart of Emacs to
558 become effective."
563 "Non-nil means use extra key sequence definitions for certain commands.
564 This happens automatically if you run XEmacs or if `window-system'
565 is nil. This variable lets you do the same manually. You must
566 set it before loading org.
568 Example: on Carbon Emacs 22 running graphically, with an external
569 keyboard on a Powerbook, the default way of setting M-left might
570 not work for either Alt or ESC. Setting this variable will make
571 it work for ESC."
585 "Keys for which Org-mode and other modes compete.
586 This is an alist, cars are the default keys, second element specifies
587 the alternative to use when `org-replace-disputed-keys' is t.
589 Keys can be specified in any syntax supported by `define-key'.
590 The value of this option takes effect only at Org-mode's startup,
591 therefore you'll have to restart Emacs to apply it after changing."
596 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
597 Or return the original if not disputed.
598 Also apply the translations defined in `org-xemacs-key-equivalents'."
603 org-disputed-keys)))
607 key)
617 "Define a key, possibly translated, as returned by `org-key'."
621 "The ellipsis to use in the Org-mode outline.
622 When nil, just use the standard three dots. When a string, use that instead,
623 When a face, use the standard 3 dots, but with the specified face.
624 The change affects only Org-mode (which will then use its own display table).
625 Changing this requires executing `M-x org-mode' in a buffer to become
626 effective."
636 "Keywords in Org-mode."
641 "String to mark deadline entries.
642 A deadline is this string, followed by a time stamp. Should be a word,
643 terminated by a colon. You can insert a schedule keyword and
645 Changes become only effective after restarting Emacs."
650 "String to mark scheduled TODO entries.
651 A schedule is this string, followed by a time stamp. Should be a word,
652 terminated by a colon. You can insert a schedule keyword and
654 Changes become only effective after restarting Emacs."
659 "String used as the prefix for timestamps logging closing a TODO entry."
664 "String used as prefix for timestamps clocking work hours on an item."
669 "Entries starting with this keyword will never be exported.
670 An entry can be toggled between COMMENT and normal with
672 Changes become only effective after restarting Emacs."
677 "Entries starting with this keyword will be exported in fixed-width font.
678 Quoting applies only to the text in the entry following the headline, and does
679 not extend beyond the next headline, even if that is lower level.
680 An entry can be toggled between QUOTE and normal with
687 "Regular expression for specifying repeated events.
691 "Options concerning the general structure of Org-mode files."
696 "Options about how to make context of a location visible."
720 "Non-nil means show full hierarchy when revealing a location.
721 Org-mode often shows locations in an org-mode file which might have
722 been invisible before. When this is set, the hierarchy of headings
723 above the exposed location is shown.
724 Turning this off for example for sparse trees makes them very compact.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. Valid contexts are
727 agenda when exposing an entry from the agenda
728 org-goto when using the command `org-goto' on key C-c C-j
729 occur-tree when using the command `org-occur' on key C-c /
730 tags-tree when constructing a sparse tree based on tags matches
731 link-search when exposing search matches associated with a link
732 mark-goto when exposing the jump goal of a mark
733 bookmark-jump when exposing a bookmark location
734 isearch when exiting from an incremental search
735 default default for all contexts not set explicitly"
740 "Non-nil means show following heading when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before. When this is set, the heading following the
743 match is shown.
744 Turning this off for example for sparse trees makes them very compact,
745 but makes it harder to edit the location of the match. In such a case,
747 Instead of t, this can also be an alist specifying this option for different
748 contexts. See `org-show-hierarchy-above' for valid contexts."
753 "Non-nil means show all sibling heading when revealing a location.
754 Org-mode often shows locations in an org-mode file which might have
755 been invisible before. When this is set, the sibling of the current entry
756 heading are all made visible. If `org-show-hierarchy-above' is t,
757 the same happens on each level of the hierarchy above the current entry.
759 By default this is on for the isearch context, off for all other contexts.
760 Turning this off for example for sparse trees makes them very compact,
761 but makes it harder to edit the location of the match. In such a case,
763 Instead of t, this can also be an alist specifying this option for different
764 contexts. See `org-show-hierarchy-above' for valid contexts."
769 "Non-nil means show the entry below a headline when revealing a location.
770 Org-mode often shows locations in an org-mode file which might have
771 been invisible before. When this is set, the text below the headline that is
772 exposed is also shown.
774 By default this is off for all contexts.
775 Instead of t, this can also be an alist specifying this option for different
776 contexts. See `org-show-hierarchy-above' for valid contexts."
781 "How should indirect tree buffers be displayed?
782 This applies to indirect buffers created with the commands
784 Valid values are:
785 current-window Display in the current window
786 other-window Just display in another window.
787 dedicated-frame Create one new frame, and re-use it each time.
788 new-frame Make a new frame each time. Note that in this case
789 previously-made indirect buffers are kept, and you need to
790 kill these buffers yourself."
800 "Non-nil means activate single letter commands at beginning of a headline.
801 This may also be a function to test for appropriate locations where speed
802 commands should be active."
810 "Alist of additional speed commands.
811 This list will be checked before `org-speed-commands-default'
812 when the variable `org-use-speed-commands' is non-nil
813 and when the cursor is at the beginning of a headline.
814 The car if each entry is a string with a single letter, which must
815 be assigned to `self-insert-command' in the global map.
816 The cdr is either a command to be called interactively, a function
817 to be called, or a form to be evaluated.
818 An entry that is just a list with a single string will be interpreted
819 as a descriptive headline that will be added when listing the speed
820 commands in the Help buffer using the `?' speed command."
832 "Options concerning visibility cycling in Org-mode."
837 "Non-nil means skip CHILDREN state in entries that don't have any."
842 "Maximum level which should still be subject to visibility cycling.
843 Levels higher than this will, for cycling, be treated as text, not a headline.
844 When `org-odd-levels-only' is set, a value of N in this variable actually
845 means 2N-1 stars as the limiting headline.
846 When nil, cycle all levels.
847 Note that the limiting level of cycling is also influenced by
848 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
849 `org-inlinetask-min-level' is, cycling will be limited to levels one less
850 than its value."
857 "Names of drawers. Drawers are not opened by cycling on the headline above.
858 Drawers only open with a TAB on the drawer line itself. A drawer looks like
859 this:
860 :DRAWERNAME:
861 .....
862 :END:
864 the property API.
866 Drawers can be defined on the per-file basis with a line like:
868 #+DRAWERS: HIDDEN STATE PROPERTIES"
874 "Non-nil means entering Org-mode will fold all blocks.
875 This can also be set in on a per-file basis with
877 #+STARTUP: hideblocks
878 #+STARTUP: showblocks"
884 "Cycle globally if cursor is at beginning of buffer and not at a headline.
885 This makes it possible to do global cycling without having to use S-TAB or
887 of the buffer
888 must not be a headline - it may be empty or some other text. When used in
889 this way, `org-cycle-hook' is disables temporarily, to make sure the
890 cursor stays at the beginning of the buffer.
891 When this option is nil, don't do anything special at the beginning
892 of the buffer."
897 "Non-nil means cycle entry level or item indentation in new empty entries.
899 When the cursor is at the end of an empty headline, i.e with only stars
900 and maybe a TODO keyword, TAB will then switch the entry to become a child,
901 and then all possible ancestor states, before returning to the original state.
902 This makes data entry extremely fast: M-RET to create a new headline,
903 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
905 When the cursor is at the end of an empty plain list item, one TAB will
906 make it a subitem, two or more tabs will back up to make this an item
907 higher up in the item hierarchy."
912 "Where should `org-cycle' emulate TAB.
913 nil Never
914 white Only in completely white lines
915 whitestart Only at the beginning of lines, before the first non-white char
916 t Everywhere except in headlines
917 exc-hl-bol Everywhere except at the start of a headline
918 If TAB is used in a place where it does not emulate TAB, the current subtree
919 visibility is cycled."
926 ))
929 "Number of empty lines needed to keep an empty line between collapsed trees.
930 If you leave an empty line between the end of a subtree and the following
931 headline, this empty line is hidden when the subtree is folded.
932 Org-mode will leave (exactly) one empty line visible if the number of
933 empty lines is equal or larger to the number given in this variable.
934 So the default 2 means at least 2 empty lines after the end of a subtree
935 are needed to produce free space between a collapsed subtree and the
936 following headline.
938 If the number is negative, and the number of empty lines is at least -N,
939 all empty lines are shown.
941 Special case: when 0, never leave empty lines in collapsed view."
947 "Hook that is run before visibility cycling is happening.
948 The function(s) in this hook must accept a single argument which indicates
949 the new state that will be set right after running this hook. The
950 argument is a symbol. Before a global state change, it can have the values
951 `overview', `content', or `all'. Before a local state change, it can have
952 the values `folded', `children', or `subtree'."
957 org-cycle-hide-drawers
958 org-cycle-show-empty-lines
959 org-optimize-window-after-visibility-change)
960 "Hook that is run after `org-cycle' has changed the buffer visibility.
961 The function(s) in this hook must accept a single argument which indicates
962 the new state that was set by the most recent `org-cycle' command. The
963 argument is a symbol. After a global state change, it can have the values
964 `overview', `content', or `all'. After a local state change, it can have
965 the values `folded', `children', or `subtree'."
970 "Options concerning structure editing in Org-mode."
975 "Non-nil means skip even levels and only use odd levels for the outline.
976 This has the effect that two stars are being added/taken away in
977 promotion/demotion commands. It also influences how levels are
978 handled by the exporters.
979 Changing it requires restart of `font-lock-mode' to become effective
980 for fontification also in regions already fontified.
981 You may also set this on a per-file basis by adding one of the following
982 lines to the buffer:
984 #+STARTUP: odd
985 #+STARTUP: oddeven"
991 "Non-nil means adapt indentation to outline node level.
993 When this variable is set, Org assumes that you write outlines by
994 indenting text in each node to align with the headline (after the stars).
995 The following issues are influenced by this variable:
997 - When this is set and the *entire* text in an entry is indented, the
998 indentation is increased by one space in a demotion command, and
999 decreased by one in a promotion command. If any line in the entry
1000 body starts with text at column 0, indentation is not changed at all.
1002 - Property drawers and planning information is inserted indented when
1003 this variable s set. When nil, they will not be indented.
1005 - TAB indents a line relative to context. The lines below a headline
1006 will be indented when this variable is set.
1008 Note that this is all about true indentation, by adding and removing
1009 space characters. See also `org-indent.el' which does level-dependent
1010 indentation in a virtual way, i.e. at display time in Emacs."
1015 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1017 When t, `C-a' will bring back the cursor to the beginning of the
1018 headline text, i.e. after the stars and after a possible TODO keyword.
1019 In an item, this will be the position after the bullet.
1020 When the cursor is already at that position, another `C-a' will bring
1021 it to the beginning of the line.
1023 `C-e' will jump to the end of the headline, ignoring the presence of tags
1024 in the headline. A second `C-e' will then jump to the true end of the
1025 line, after any tags. This also means that, when this variable is
1026 non-nil, `C-e' also will never jump beyond the end of the heading of a
1027 folded section, i.e. not after the ellipses.
1029 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1030 going to the true line boundary first. Only a directly following, identical
1031 keypress will bring the cursor to the special positions.
1033 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1034 set separately."
1053 "Non-nil means `C-k' will behave specially in headlines.
1054 When nil, `C-k' will call the default `kill-line' command.
1055 When t, the following will happen while the cursor is in the headline:
1057 - When the cursor is at the beginning of a headline, kill the entire
1058 line and possible the folded subtree below the line.
1059 - When in the middle of the headline text, kill the headline up to the tags.
1060 - When after the headline text, kill the tags."
1065 "Non-nil means, do not delete a hidden subtree with C-k.
1066 When set to the symbol `error', simply throw an error when C-k is
1067 used to kill (part-of) a headline that has hidden text behind it.
1068 Any other non-nil value will result in a query to the user, if it is
1069 OK to kill that hidden subtree. When nil, kill without remorse."
1077 "Check if in invisible region before inserting or deleting a character.
1078 Valid values are:
1080 nil Do not check, so just do invisible edits.
1081 error Throw an error and do nothing.
1082 show Make point visible, and do the requested edit.
1083 show-and-error Make point visible, then throw an error and abort the edit.
1084 smart Make point visible, and do insertion/deletion if it is
1085 adjacent to visible text and the change feels predictable.
1086 Never delete a previously invisible character or add in the
1087 middle or right after an invisible region. Basically, this
1088 allows insertion and backward-delete right before ellipses.
1089 FIXME: maybe in this case we should not even show?"
1099 "Non-nil means when yanking subtrees, fold them.
1100 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1101 it starts with a heading and all other headings in it are either children
1102 or siblings, then fold all the subtrees. However, do this only if no
1103 text after the yank would be swallowed into a folded tree by this action."
1108 "Non-nil means when yanking subtrees, adjust the level.
1109 With this setting, `org-paste-subtree' is used to insert the subtree, see
1110 this function for details."
1115 "Non-nil means M-RET will split the line at the cursor position.
1116 When nil, it will go to the end of the line before making a
1117 new line.
1118 You may also set this option in a different way for different
1119 contexts. Valid contexts are:
1121 headline when creating a new headline
1122 item when creating a new item
1123 table in a table field
1124 default the value to be used for all contexts not explicitly
1125 customized"
1142 "Non-nil means insert new headings after the current subtree.
1143 When nil, the new heading is created directly after the current line.
1146 for the duration of the command."
1152 "Should `org-insert-heading' leave a blank line before new heading/item?
1153 The value is an alist, with `heading' and `plain-list-item' as CAR,
1154 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1155 which case Org will look at the surrounding headings/items and try to
1156 make an intelligent decision whether to insert a blank line or not.
1158 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1159 set, the setting here is ignored and no empty line is inserted, to avoid
1160 breaking the list structure."
1173 "Hook being run after inserting a new heading."
1179 This currently only means they are never auto-wrapped.
1180 When nil, such lines will be treated like ordinary lines.
1181 See also the QUOTE keyword."
1186 "Non-nil means typing characters in `org-goto' starts incremental search."
1191 "Options concerning sparse trees in Org-mode."
1196 "Non-nil means highlight all matches that define a sparse tree.
1197 The highlights will automatically disappear the next time the buffer is
1198 changed by an edit command."
1203 "Non-nil means any change to the buffer will remove temporary highlights.
1204 Such highlights are created by `org-occur' and `org-clock-display'.
1205 When nil, `C-c C-c needs to be used to get rid of the highlights.
1206 The highlights created by `org-preview-latex-fragment' always need
1207 `C-c C-c' to be removed."
1214 "Hook that is run after `org-occur' has constructed a sparse tree.
1215 This can be used to recenter the window to show as much of the structure
1216 as possible."
1221 "Options concerning imenu and speedbar in Org-mode."
1226 "The maximum level for Imenu access to Org-mode headlines.
1227 This also applied for speedbar access."
1232 "Options concerning tables in Org-mode."
1238 When nil, such lines will be treated like ordinary lines.
1240 When equal to the symbol `optimized', the table editor will be optimized to
1241 do the following:
1242 - Automatic overwrite mode in front of whitespace in table fields.
1243 This makes the structure of the table stay in tact as long as the edited
1244 field does not exceed the column width.
1245 - Minimize the number of realigns. Normally, the table is aligned each time
1246 TAB or RET are pressed to move to another field. With optimization this
1247 happens only if changes to a field might have changed the column width.
1248 Optimization requires replacing the functions `self-insert-command',
1249 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1250 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1251 very good at guessing when a re-align will be necessary, but you can always
1254 If you would like to use the optimized version in Org-mode, but the
1255 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1257 This variable can be used to turn on and off the table editor during a session,
1258 but in order to toggle optimization, a restart is required.
1260 See also the variable `org-table-auto-blank-field'."
1268 "Non-nil means cluster self-insert commands for undo when possible.
1269 If this is set, then, like in the Emacs command loop, 20 consecutive
1270 characters will be undone together.
1271 This is configurable, because there is some impact on typing performance."
1276 "Non-nil means TAB will automatically notice a table.el table.
1277 When it sees such a table, it moves point into it and - if necessary -
1278 calls `table-recognize-table'."
1283 "Options concerning links in Org-mode."
1288 "Buffer-local version of `org-link-abbrev-alist', which see.
1293 "Alist of link abbreviations.
1294 The car of each element is a string, to be replaced at the start of a link.
1296 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1298 [[linkkey:tag][description]]
1300 The 'linkkey' must be a word word, starting with a letter, followed
1301 by letters, numbers, '-' or '_'.
1303 If REPLACE is a string, the tag will simply be appended to create the link.
1306 be inserted at that point (see the function `url-hexify-string').
1308 REPLACE may also be a function that will be called with the tag as the
1309 only argument to create the link, which should be returned as a string.
1311 See the manual for examples."
1321 "Non-nil means Org will display descriptive links.
1322 E.g. [[http://orgmode.org][Org website]] will be displayed as
1324 description. When set to `nil', Org will display the full links
1325 literally.
1327 You can interactively set the value of this variable by calling
1328 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1333 "How the path name in file links should be stored.
1334 Valid values are:
1336 relative Relative to the current directory, i.e. the directory of the file
1337 into which the link is being inserted.
1338 absolute Absolute path, if possible with ~ for home directory.
1339 noabbrev Absolute path, no abbreviation of home directory.
1340 adaptive Use relative path for files in the current directory and sub-
1341 directories of it. For other files, use an absolute path."
1350 "Types of links that should be activated in Org-mode files.
1351 This is a list of symbols, each leading to the activation of a certain link
1352 type. In principle, it does not hurt to turn on most link types - there may
1353 be a small gain when turning off unused link types. The types are:
1355 bracket The recommended [[link][description]] or [[link]] links with hiding.
1356 angle Links in angular brackets that may contain whitespace like
1357 <bbdb:Carsten Dominik>.
1358 plain Plain links in normal text, no whitespace, like http://google.com.
1359 radio Text that is matched by a radio target, see manual for details.
1360 tag Tag settings in a headline (link to tag search).
1361 date Time stamps (link to calendar).
1362 footnote Footnote labels.
1364 Changing this variable requires a restart of Emacs to become effective."
1376 "Function to use to generate link descriptions from links.
1377 If nil the link location will be used. This function must take
1378 two parameters; the first is the link and the second the
1379 description `org-insert-link' has generated, and should return the
1380 description to use."
1385 "Options concerning storing links in Org-mode."
1390 "Format of the description part of a link to an email or usenet message.
1391 The following %-escapes will be replaced by corresponding information:
1399 %s subject
1400 %d date
1401 %m message-id.
1403 You may use normal field width specification between the % and the letter.
1404 This is for example useful to limit the length of the subject.
1418 It should match if the message is from the user him/herself."
1423 "Non-nil means storing a link to an Org file will use entry IDs.
1425 Note that before this variable is even considered, org-id must be loaded,
1426 so please customize `org-modules' and turn it on.
1428 The variable can have the following values:
1430 t Create an ID if needed to make a link to the current entry.
1432 create-if-interactive
1433 If `org-store-link' is called directly (interactively, as a user
1434 command), do create an ID to support the link. But when doing the
1435 job for remember, only use the ID if it already exists. The
1436 purpose of this setting is to avoid proliferation of unwanted
1437 IDs, just because you happen to be in an Org file when you
1438 call `org-remember' that automatically and preemptively
1439 creates a link. If you do want to get an ID link in a remember
1440 template to an entry not having an ID, create it first by
1441 explicitly creating a link to it, using `C-c C-l' first.
1443 create-if-interactive-and-no-custom-id
1444 Like create-if-interactive, but do not create an ID if there is
1445 a CUSTOM_ID property defined in the entry. This is the default.
1447 use-existing
1448 Use existing ID, do not create one.
1450 nil Never use an ID to make a link, instead link using a text search for
1451 the headline text."
1456 create-if-interactive)
1458 create-if-interactive-and-no-custom-id)
1463 "Non-nil means file links from `org-store-link' contain context.
1464 A search string will be added to the file name with :: as separator and
1465 used to find the context when the link is activated by the command
1466 `org-open-at-point'. When this option is t, the entire active region
1467 will be placed in the search string of the file link. If set to a
1468 positive integer, only the first n lines of context will be stored.
1471 negates this setting for the duration of the command."
1476 "Non-nil means keep link in list for entire session.
1478 The command `org-store-link' adds a link pointing to the current
1479 location to an internal list. These links accumulate during a session.
1480 The command `org-insert-link' can be used to insert links into any
1481 Org-mode file (offering completion for all stored links). When this
1483 will be removed from the list, to make completing the unused links
1484 more efficient."
1489 "Options concerning following links in Org-mode."
1494 "Function to translate links with different syntax to Org syntax.
1495 This can be used to translate links created for example by the Planner
1496 or emacs-wiki packages to Org syntax.
1497 The function must accept two parameters, a TYPE containing the link
1499 which is everything after the link protocol. It should return a cons
1500 with possibly modified values of type and path.
1501 Org contains a function for this, so if you set this variable to
1502 `org-translate-link-from-planner', you should be able follow many
1503 links created by planner."
1508 "Hook that is run after a link has been followed."
1513 "Non-nil means on links TAB will follow the link.
1514 Needs to be set before org.el is loaded.
1515 This really should not be used, it does not make sense, and the
1516 implementation is bad."
1521 "Non-nil means on links RET will follow the link."
1527 "Non-nil means mouse-1 on a link will follow the link.
1528 A longer mouse click will still set point. Does not work on XEmacs.
1529 Needs to be set before org.el is loaded."
1534 "Number of different positions to be recorded in the ring.
1535 Changing this requires a restart of Emacs to work correctly."
1540 "Non-nil means internal links in Org files must exactly match a headline.
1541 When nil, the link search tries to match a phrase with all words
1542 in the search text."
1548 query-to-create)))
1555 "Setup the frame configuration for following links.
1556 When following a link with Emacs, it may often be useful to display
1557 this link in another window or frame. This variable can be used to
1558 set this up for the different types of links.
1559 For VM, use any of
1560 `vm-visit-folder'
1561 `vm-visit-folder-other-window'
1562 `vm-visit-folder-other-frame'
1563 For Gnus, use any of
1564 `gnus'
1565 `gnus-other-frame'
1566 `org-gnus-no-new-news'
1567 For FILE, use any of
1568 `find-file'
1569 `find-file-other-window'
1570 `find-file-other-frame'
1571 For Wanderlust use any of
1572 `wl'
1573 `wl-other-frame'
1574 For the calendar, use the variable `calendar-setup'.
1575 For BBDB, it is currently only possible to display the matches in
1576 another window."
1600 "Non-nil means use indirect buffer to display infile links.
1601 Activating internal links (from one location in a file to another location
1602 in the same file) normally just jumps to the location. When the link is
1604 is displayed in
1605 another window. When this option is set, the other window actually displays
1606 an indirect buffer clone of the current buffer, to avoid any visibility
1607 changes to the current buffer."
1612 "Non-nil means `org-open-file' will open non-existing files.
1613 When nil, an error will be generated.
1614 This variable applies only to external applications because they
1615 might choke on non-existing files. If the link is to a file that
1616 will be opened in Emacs, the variable is ignored."
1621 "Non-nil means a link to a directory really means to index.org.
1622 When nil, following a directory link will run dired or open a finder/explorer
1623 window on that directory."
1628 "Function and arguments to call for following mailto links.
1629 This is a list with the first element being a Lisp function, and the
1630 remaining elements being arguments to the function. In string arguments,
1631 %a will be replaced by the address, and %s will be replaced by the subject
1632 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1641 "Non-nil means ask for confirmation before executing shell links.
1642 Shell links can be dangerous: just think about a link
1644 [[shell:rm -rf ~/*][Google Search]]
1647 but really it would remove your entire home directory.
1648 Therefore we advise against setting this variable to nil.
1649 Just change it to `y-or-n-p' if you want to confirm with a
1657 'safe-local-variable
1661 "A regexp to skip confirmation for shell links."
1666 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1667 Elisp links can be dangerous: just think about a link
1672 but really it would remove your entire home directory.
1673 Therefore we advise against setting this variable to nil.
1674 Just change it to `y-or-n-p' if you want to confirm with a
1682 'safe-local-variable
1686 "A regexp to skip confirmation for Elisp links."
1694 "Default file applications on a UNIX or GNU/Linux system.
1705 "Default file applications on a MacOS X system.
1707 for some files for which the OS does not have a good default.
1715 'mswindows-shell-execute
1720 'mswindows-shell-execute
1723 "Default file applications on a Windows NT system.
1728 '(
1733 )
1734 "External applications for opening `file:path' items in a document.
1735 Org-mode uses system defaults for different file types, but
1736 you can use this variable to set the application for a given file
1737 extension. The entries in this list are cons cells where the car identifies
1738 files and the cdr the corresponding command. Possible values for the
1739 file identifier are
1741 ways, depending on its contents:
1743 - Alphanumeric characters only:
1744 Match links with this file extension.
1746 to open PDFs with evince.
1748 - Regular expression: Match links where the
1749 filename matches the regexp. If you want to
1750 use groups here, use shy groups.
1754 to open *.html and *.xhtml with firefox.
1756 - Regular expression which contains (non-shy) groups:
1758 anything after that, matches the regexp.
1759 In a custom command string, %1, %2, etc. are replaced with
1760 the parts of the link that were matched by the groups.
1761 For backwards compatibility, if a command string is given
1762 that does not use any of the group matches, this case is
1763 handled identically to the second one (i.e. match against
1764 file name only).
1765 In a custom lisp form, you can access the group matches with
1766 (match-string n link).
1769 to open [[file:document.pdf::5]] with evince at page 5.
1771 `directory' Matches a directory
1772 `remote' Matches a remote file, accessible through tramp or efs.
1773 Remote files most likely should be visited through Emacs
1774 because external applications cannot handle such paths.
1775 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1776 so all files Emacs knows how to handle. Using this with
1777 command `emacs' will open most files in Emacs. Beware that this
1778 will also open html files inside Emacs, unless you add
1780 t Default for files not matched by any of the other options.
1781 `system' The system command to open files, like `open' on Windows
1782 and Mac OS X, and mailcap under GNU/Linux. This is the command
1783 that will be selected if you call `C-c C-o' with a double
1786 Possible values for the command are:
1787 `emacs' The file will be visited by the current Emacs process.
1788 `default' Use the default application for this file type, which is the
1789 association for t in the list, most likely in the system-specific
1790 part.
1791 This can be used to overrule an unwanted setting in the
1792 system-specific variable.
1794 This command is specified by the entry whose car is `system'.
1795 Most likely, the system-specific version of this variable
1796 does define this command, but you can overrule/replace it
1797 here.
1798 string A command to be executed by a shell; %s will be replaced
1799 by the path to the file.
1800 sexp A Lisp form which will be evaluated. The file path will
1801 be available in the Lisp variable `file'.
1802 For more examples, see the system specific constants
1803 `org-file-apps-defaults-macosx'
1804 `org-file-apps-defaults-windowsnt'
1805 `org-file-apps-defaults-gnu'."
1815 auto-mode))
1826 "Options concerning refiling entries in Org-mode."
1831 "Directory with org files.
1832 This is just a default location to look for Org files. There is no need
1833 at all to put your files into this directory. It is only used in the
1834 following situations:
1836 1. When a remember template specifies a target file that is not an
1837 absolute path. The path will then be interpreted relative to
1838 `org-directory'
1839 2. When a remember note is filed away in an interactive way (when exiting the
1840 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1841 with `org-directory' as the default path."
1847 "Default target for storing notes.
1848 Used as a fall back file for org-remember.el and org-capture.el, for
1849 templates that do not specify a target file."
1854 file))
1857 "The default interface to be used for `org-goto'.
1858 Allowed values are:
1859 outline The interface shows an outline of the relevant file
1860 and the correct heading is found by moving through
1861 the outline or by searching with incremental search.
1862 outline-path-completion Headlines in the current buffer are offered via
1863 completion. This is the interface also used by
1864 the refile command."
1871 "Maximum target level when running `org-goto' with refile interface."
1876 "Non-nil means store new notes at the beginning of a file or entry.
1877 When nil, new notes will be filed to the end of a file or entry.
1878 This can also be a list with cons cells of regular expressions that
1879 are matched against file names, and values."
1889 "Information to record when a task is refiled.
1891 Possible values are:
1893 nil Don't add anything
1894 time Add a time stamp to the task
1895 note Prompt for a note and add it with template `org-log-note-headings'
1897 This option can also be set with on a per-file-basis with
1899 #+STARTUP: nologrefile
1900 #+STARTUP: logrefile
1901 #+STARTUP: lognoterefile
1903 You can have local logging settings for a subtree by setting the LOGGING
1904 property to one or more of these keywords.
1906 When bulk-refiling from the agenda, the value `note' is forbidden and
1907 will temporarily be changed to `time'."
1917 This is a list of cons cells. Each cell contains:
1918 - a specification of the files to be considered, either a list of files,
1919 or a symbol whose function or variable value will be used to retrieve
1920 a file name or a list of file names. If you use `org-agenda-files' for
1921 that, all agenda files will be scanned for targets. Nil means consider
1922 headings in the current buffer.
1923 - A specification of how to find candidate refile targets. This may be
1924 any of:
1926 This tag has to be present in all target headlines, inheritance will
1927 not be considered.
1929 todo keyword.
1931 headlines that are refiling targets.
1932 - a cons cell (:level . N). Any headline of level N is considered a target.
1933 Note that, when `org-odd-levels-only' is set, level corresponds to
1934 order in hierarchy, not to the number of stars.
1935 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1936 Note that, when `org-odd-levels-only' is set, level corresponds to
1937 order in hierarchy, not to the number of stars.
1939 Each element of this list generates a set of possible targets.
1940 The union of these sets is presented (with completion) to
1941 the user by `org-refile'.
1943 You can set the variable `org-refile-target-verify-function' to a function
1944 to verify each headline found by the simple criteria above.
1946 When this variable is nil, all top-level headlines in the current buffer
1947 are used, equivalent to the value `((nil . (:level . 1))'."
1963 "Function to verify if the headline at point should be a refile target.
1964 The function will be called without arguments, with point at the
1965 beginning of the headline. It should return t and leave point
1966 where it is if the headline is a valid target for refiling.
1968 If the target should not be selected, the function must return nil.
1969 In addition to this, it may move point to a place from where the search
1970 should be continued. For example, the function may decide that the entire
1971 subtree of the current entry should be excluded and move point to the end
1972 of the subtree."
1977 "Non-nil means cache refile targets to speed up the process.
1978 The cache for a particular file will be updated automatically when
1979 the buffer has been killed, or when any of the marker used for flagging
1980 refile targets no longer points at a live buffer.
1981 If you have added new entries to a buffer that might themselves be targets,
1982 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1983 find that easier, `C-u C-u C-u C-c C-w'."
1988 "Non-nil means provide refile targets as paths.
1989 So a level 3 headline will be available as level1/level2/level3.
1991 When the value is `file', also include the file name (without directory)
1992 into the path. In this case, you can also stop the completion after
1993 the file name, to get entries inserted as top level in the file.
1995 When `full-file-path', include the full file path."
2004 "Non-nil means complete the outline path in hierarchical steps.
2005 When Org-mode uses the refile interface to select an outline path
2006 \(see variable `org-refile-use-outline-path'), the completion of
2007 the path can be done is a single go, or if can be done in steps down
2008 the headline hierarchy. Going in steps is probably the best if you
2009 do not use a special completion package like `ido' or `icicles'.
2010 However, when using these packages, going in one step can be very
2011 fast, while still showing the whole path to the entry."
2016 "Non-nil means allow to create new nodes as refile targets.
2018 of an existing node. When the value of this variable is `confirm',
2019 new node creation must be confirmed by the user (recommended)
2020 When nil, the completion must match an existing entry.
2022 Note that, if the new heading is not seen by the criteria
2023 listed in `org-refile-targets', multiple instances of the same
2024 heading would be created by trying again to file under the new
2025 heading."
2033 "Non-nil means also refile active region within a subtree.
2035 By default `org-refile' doesn't allow refiling regions if they
2036 don't contain a set of subtrees, but it might be convenient to
2037 do so sometimes: in that case, the first line of the region is
2038 converted to a headline before refiling."
2043 "Options concerning TODO items in Org-mode."
2048 "Options concerning Progress logging in Org-mode."
2055 "The available interpretation symbols for customizing `org-todo-keywords'.
2059 "List of TODO entry keyword sequences and their interpretation.
2062 Each sequence starts with a symbol, either `sequence' or `type',
2063 indicating if the keywords should be interpreted as a sequence of
2064 action steps, or as different types of TODO items. The first
2065 keywords are states requiring action - these states will select a headline
2066 for inclusion into the global TODO list Org-mode produces. If one of
2069 the last keyword is treated as the only DONE state of the sequence.
2072 additional state where no keyword is present. For details about this
2073 cycling, see the manual.
2075 TODO keywords and interpretation can also be set on a per-file basis with
2076 the special #+SEQ_TODO and #+TYP_TODO lines.
2078 Each keyword can optionally specify a character for fast state selection
2079 \(in combination with the variable `org-use-fast-todo-selection')
2080 and specifiers for state change logging, using the same syntax
2083 indicates to record a time stamp each time this state is selected.
2085 Each keyword may also specify if a timestamp or a note should be
2086 recorded when entering or leaving the state, by adding additional
2087 characters in the parenthesis after the keyword. This looks like this:
2089 record only the time of the state change. With X and Y being either
2091 Y when leaving the state if and only if the *target* state does not
2092 define X. You may omit any of the fast-selection key or X or /Y,
2093 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2095 For backward compatibility, this variable may also be just a list
2096 of keywords - in this case the interpretation (sequence or type) will be
2097 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2107 ;;Quick and dirty way to see
2108 ;;`org-todo-interpretations'. This takes the
2109 ;;place of item arguments
2110 :convert-widget
2117 org-todo-interpretation-widgets))
2118 widget))
2149 "Controls how TODO keywords are interpreted.
2150 This variable is in principle obsolete and is only used for
2151 backward compatibility, if the interpretation of todo keywords is
2152 not given already in `org-todo-keywords'. See that variable for
2153 more information."
2160 "Non-nil means use the fast todo selection scheme with C-c C-t.
2161 This variable describes if and under what circumstances the cycling
2162 mechanism for TODO keywords will be replaced by a single-key, direct
2163 selection scheme.
2165 When nil, fast selection is never used.
2167 When the symbol `prefix', it will be used when `org-todo' is called with
2168 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2169 in an agenda buffer.
2171 When t, fast selection is used by default. In this case, the prefix
2172 argument forces cycling instead.
2174 In all cases, the special interface is only used if access keys have actually
2175 been assigned by the user, i.e. if keywords in the configuration are followed
2176 by a letter in parenthesis, like TODO(t)."
2184 "Non-nil means update todo statistics after insert and toggle.
2185 ALL-HEADLINES means update todo statistics by including headlines
2186 with no TODO keyword as well, counting them as not done.
2187 A list of TODO keywords means the same, but skip keywords that are
2188 not in this list.
2190 When this is set, todo statistics is updated in the parent of the
2191 current entry each time a todo state is changed."
2201 "Non-nil means TODO statistics covers just direct children.
2202 When nil, all entries in the subtree are considered.
2203 This has only an effect if `org-provide-todo-statistics' is set.
2204 To set this to nil for only a single subtree, use a COOKIE_DATA
2210 "Hook which is run after the state of a TODO item was changed.
2211 The new state (a string with a TODO keyword, or nil) is available in the
2212 Lisp variable `state'."
2217 "Hook for functions that are allowed to block a state change.
2219 Each function gets as its single argument a property list, see
2220 `org-trigger-hook' for more information about this list.
2222 If any of the functions in this hook returns nil, the state change
2226 "Hook for functions that are triggered by a state change.
2228 Each function gets as its single argument a property list with at least
2229 the following elements:
2231 (:type type-of-change :position pos-at-entry-start
2232 :from old-state :to new-state)
2234 Depending on the type, more properties may be present.
2236 This mechanism is currently implemented for:
2238 TODO state changes
2239 ------------------
2240 :type todo-state-change
2241 :from previous state (keyword as a string), or nil, or a symbol
2242 'todo' or 'done', to indicate the general type of state.
2246 "Non-nil means undone TODO entries will block switching the parent to DONE.
2247 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2248 be blocked if any prior sibling is not yet done.
2249 Finally, if the parent is blocked because of ordered siblings of its own,
2250 the child will also be blocked.
2251 This variable needs to be set before org.el is loaded, and you need to
2252 restart Emacs after a change to make the change effective. The only way
2253 to change is while Emacs is running is through the customize interface."
2265 "Non-nil means unchecked boxes will block switching the parent to DONE.
2266 When this is nil, checkboxes have no influence on switching TODO states.
2267 When non-nil, you first need to check off all check boxes before the TODO
2268 entry can be switched to DONE.
2269 This variable needs to be set before org.el is loaded, and you need to
2270 restart Emacs after a change to make the change effective. The only way
2271 to change is while Emacs is running is through the customize interface."
2283 "Non-nil means inserting a TODO heading is treated as state change.
2285 logging will apply if appropriate. When nil, the new TODO item will
2286 be inserted directly, and no logging will take place."
2291 "Non-nil means switching TODO states with S-cursor counts as state change.
2292 This is the default behavior. However, setting this to nil allows a
2293 convenient way to select a TODO state and bypass any logging associated
2294 with that."
2299 "Tag changes that should be triggered by TODO state changes.
2300 This is a list. Each entry is
2302 (state-change (tag . flag) .......)
2304 State-change can be a string with a state, and empty string to indicate the
2305 state that has no TODO keyword, or it can be one of the symbols `todo'
2306 or `done', meaning any not-done or done state, respectively."
2320 "Information to record when a task moves to the DONE state.
2322 Possible values are:
2324 nil Don't add anything, just change the keyword
2325 time Add a time stamp to the task
2326 note Prompt for a note and add it with template `org-log-note-headings'
2328 This option can also be set with on a per-file-basis with
2330 #+STARTUP: nologdone
2331 #+STARTUP: logdone
2332 #+STARTUP: lognotedone
2334 You can have local logging settings for a subtree by setting the LOGGING
2335 property to one or more of these keywords."
2343 ;; Normalize old uses of org-log-done.
2350 "Information to record when the scheduling date of a tasks is modified.
2352 Possible values are:
2354 nil Don't add anything, just change the date
2355 time Add a time stamp to the task
2356 note Prompt for a note and add it with template `org-log-note-headings'
2358 This option can also be set with on a per-file-basis with
2360 #+STARTUP: nologreschedule
2361 #+STARTUP: logreschedule
2362 #+STARTUP: lognotereschedule"
2371 "Information to record when the deadline date of a tasks is modified.
2373 Possible values are:
2375 nil Don't add anything, just change the date
2376 time Add a time stamp to the task
2377 note Prompt for a note and add it with template `org-log-note-headings'
2379 This option can also be set with on a per-file-basis with
2381 #+STARTUP: nologredeadline
2382 #+STARTUP: logredeadline
2383 #+STARTUP: lognoteredeadline
2385 You can have local logging settings for a subtree by setting the LOGGING
2386 property to one or more of these keywords."
2395 "Non-nil means record a note when clocking out of an item.
2396 This can also be configured on a per-file basis by adding one of
2397 the following lines anywhere in the buffer:
2399 #+STARTUP: lognoteclock-out
2400 #+STARTUP: nolognoteclock-out"
2406 "Non-nil means the CLOSED time stamp will contain date and time.
2407 When nil, only the date will be recorded."
2421 "Headings for notes added to entries.
2422 The value is an alist, with the car being a symbol indicating the note
2423 context, and the cdr is the heading to be used. The heading may also be the
2424 empty string.
2425 %t in the heading will be replaced by a time stamp.
2426 %T will be an active time stamp instead the default inactive one
2427 %d will be replaced by a short-format time stamp.
2428 %D will be replaced by an active short-format time stamp.
2429 %s will be replaced by the new TODO state, in double quotes.
2430 %S will be replaced by the old TODO state, in double quotes.
2431 %u will be replaced by the user name.
2432 %U will be replaced by the full user name.
2434 In fact, it is not a good idea to change the `state' entry, because
2435 agenda log mode depends on the format of these entries."
2441 "Heading when changing todo state (todo sequence only)"
2455 "Non-nil means insert state change notes and time stamps into a drawer.
2456 When nil, state changes notes will be inserted after the headline and
2457 any scheduling and clock lines, but not inside a drawer.
2459 The value of this variable should be the name of the drawer to use.
2460 LOGBOOK is proposed as the default drawer for this purpose, you can
2461 also set this to a string to define the drawer of your choice.
2465 If this variable is set, `org-log-state-notes-insert-after-drawers'
2466 will be ignored.
2468 You can set the property LOG_INTO_DRAWER to overrule this setting for
2469 a subtree."
2481 "Return the value of `org-log-into-drawer', but let properties overrule.
2482 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2483 used instead of the default value."
2491 "Non-nil means insert state change notes after any drawers in entry.
2492 Only the drawers that *immediately* follow the headline and the
2493 deadline/scheduled line are skipped.
2494 When nil, insert notes right after the heading and perhaps the line
2495 with deadline/scheduling if present.
2497 This variable will have no effect if `org-log-into-drawer' is
2498 set."
2504 "Non-nil means the latest state note will be directly after heading.
2505 When nil, the state change notes will be ordered according to time."
2511 "The TODO state to which a repeater should return the repeating task.
2512 By default this is the first task in a TODO sequence, or the previous state
2513 in a TODO_TYP set. But you can specify another task here.
2514 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2520 "Non-nil means record moving through the DONE state when triggering repeat.
2521 An auto-repeating task is immediately switched back to TODO when
2524 record a closing note, there will be no record of the task moving
2525 through DONE. This variable forces taking a note anyway.
2527 nil Don't force a record
2528 time Record a time stamp
2529 note Record a note
2531 This option can also be set with on a per-file-basis with
2533 #+STARTUP: logrepeat
2534 #+STARTUP: lognoterepeat
2535 #+STARTUP: nologrepeat
2537 You can have local logging settings for a subtree by setting the LOGGING
2538 property to one or more of these keywords."
2548 "Priorities in Org-mode."
2553 "Non-nil means priority commands are active.
2554 When nil, these commands will be disabled, so that you never accidentally
2555 set a priority."
2560 "The highest priority of TODO items. A character like ?A, ?B etc.
2561 Must have a smaller ASCII number than `org-lowest-priority'."
2566 "The lowest priority of TODO items. A character like ?A, ?B etc.
2567 Must have a larger ASCII number than `org-highest-priority'."
2572 "The default priority of TODO items.
2573 This is the priority an item gets if no explicit priority is given.
2574 When starting to cycle on an empty priority the first step in the cycle
2575 depends on `org-priority-start-cycle-with-default'. The resulting first
2576 step priority must not exceed the range from `org-highest-priority' to
2577 `org-lowest-priority' which means that `org-default-priority' has to be
2578 in this range exclusive or inclusive the range boundaries. Else the
2579 first step refuses to set the default and the second will fall back
2580 to (depending on the command used) the highest or lowest priority."
2585 "Non-nil means start with default priority when starting to cycle.
2586 When this is nil, the first step in the cycle will be (depending on the
2587 command used) one higher or lower than the default priority.
2588 See also `org-default-priority'."
2593 "Function to extract the priority from a string.
2594 The string is normally the headline. If this is nil Org computes the
2595 priority from the priority cookie like [#A] in the headline. It returns
2596 an integer, increasing by 1000 for each priority level.
2597 The user can set a different function here, which should take a string
2598 as an argument and return the numeric priority."
2603 "Options concerning time stamps and deadlines in Org-mode."
2608 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2609 When nil, these labeled time stamps are forces into the second line of an
2610 entry, just after the headline. When scheduling from the global TODO list,
2611 the time stamp will always be forced into the second line."
2616 "Formats for `format-time-string' which are used for time stamps.
2620 "Number of minutes to round time stamps to.
2621 These are two values, the first applies when first creating a time stamp.
2622 The second applies when changing it with the commands `S-up' and `S-down'.
2623 When changing the time stamp, this means that it will change in steps
2624 of N minutes, as given by the second value.
2626 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2627 numbers should be factors of 60, so for example 5, 10, 15.
2629 When this is larger than 1, you can still force an exact time stamp by using
2630 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2631 and by using a prefix arg to `S-up/down' to specify the exact number
2632 of minutes to shift."
2642 ;; Normalize old customizations of this variable.
2646 org-time-stamp-rounding-minutes)))
2649 "Non-nil means overlay custom formats over all time stamps.
2650 The formats are defined through the variable `org-time-stamp-custom-formats'.
2651 To turn this on on a per-file basis, insert anywhere in the file:
2652 #+STARTUP: customtime"
2660 "Custom formats for time stamps. See `format-time-string' for the syntax.
2661 These are overlaid over the default ISO format if the variable
2662 `org-display-custom-times' is set. Time like %H:%M should be at the
2663 end of the second format. The custom formats are also honored by export
2664 commands, if custom time display is turned on at the time of export."
2669 "Get the right format for a time string."
2674 f)))
2677 "The format string used when creating CLOCKSUM lines.
2678 This is also used when org-mode generates a time duration."
2684 org-mode generates a time duration."
2689 "The format string used when creating CLOCKSUM lines, or when
2690 org-mode generates a time duration."
2695 "No. of days before expiration during which a deadline becomes active.
2696 This variable governs the display in sparse trees and in the agenda.
2697 When 0 or negative, it means use this number (the absolute value of it)
2698 even if a deadline has a different individual lead time specified.
2700 Custom commands can set this variable in the options section."
2706 "Non-nil means assume future for incomplete date input from user.
2707 This affects the following situations:
2708 1. The user gives a month but not a year.
2711 2. The user gives a day, but no month.
2714 it will be considered as *this* month.
2716 If you set this variable to the symbol `time', then also the following
2717 will work:
2719 3. If the user gives a time, but no day. If the time is before now,
2720 to will be interpreted as tomorrow.
2722 Currently none of this works for ISO week specifications.
2724 When this option is nil, the current day, month and year will always be
2725 used as defaults.
2727 See also `org-agenda-jump-prefer-future'."
2735 "Should the agenda jump command prefer the future for incomplete dates?
2736 The default is to do the same as configured in `org-read-date-prefer-future'.
2737 But you can also set a deviating value here.
2738 This may t or nil, or the symbol `org-read-date-prefer-future'."
2743 org-read-date-prefer-future)
2748 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2750 Depending on the system Emacs is running on, certain dates cannot
2751 be represented with the type used internally to represent time.
2752 Dates between 1970-1-1 and 2038-1-1 can always be represented
2753 correctly. Some systems allow for earlier dates, some for later,
2754 some for both. One way to find out it to insert any date into an
2755 Org buffer, putting the cursor on the year and hitting S-up and
2756 S-down to test the range.
2758 When this variable is set to t, the date/time prompt will not let
2759 you specify dates outside the 1970-2037 range, so it is certain that
2760 these dates will work in whatever version of Emacs you are
2761 running, and also that you can move a file from one Emacs implementation
2762 to another. WHenever Org is forcing the year for you, it will display
2763 a message and beep.
2765 When this variable is nil, Org will check if the date is
2766 representable in the specific Emacs implementation you are using.
2767 If not, it will force a year, usually the current year, and beep
2768 to remind you. Currently this setting is not recommended because
2769 the likelihood that you will open your Org files in an Emacs that
2770 has limited date range is not negligible.
2772 A workaround for this problem is to use diary sexp dates for time
2773 stamps outside of this range."
2778 "Non-nil means display current interpretation of date prompt live.
2779 This display will be in an overlay, in the minibuffer."
2784 "Non-nil means pop up a calendar when prompting for a date.
2785 In the calendar, the date can be selected with mouse-1. However, the
2786 minibuffer will also be active, and you can simply enter the date as well.
2787 When nil, only the minibuffer will be available."
2795 "Hook to be used to set up keys for the date/time interface.
2796 Add key definitions to `minibuffer-local-map', which will be a temporary
2797 copy."
2802 "The hour when your day really ends. Must be an integer.
2803 This has influence for the following applications:
2805 the time given here, the day recognized as TODAY is actually yesterday.
2806 - When a date is read from the user and it is still before the time given
2807 here, the current date and time will be assumed to be yesterday, 23:59.
2808 Also, timestamps inserted in remember templates follow this rule.
2810 IMPORTANT: This is a feature whose implementation is and likely will
2811 remain incomplete. Really, it is only here because past midnight seems to
2812 be the favorite working time of John Wiegley :-)"
2817 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2818 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2820 23:59 of the previous day."
2825 "Non-nil means S-down will increase the time in a time stamp.
2826 When nil, S-up will increase."
2831 "Non-nil means make the calendar window follow timestamp changes.
2832 When a timestamp is modified and the calendar window is visible, it will be
2833 moved to the new date."
2838 "Options concerning tags in Org-mode."
2843 "List of tags allowed in Org-mode files.
2844 When this list is nil, Org-mode will base TAG input on what is already in the
2845 buffer.
2846 The value of this variable is an alist, the car of each entry must be a
2847 keyword as a string, the cdr may be a character that is used to select
2848 that tag through the fast-tag-selection interface.
2849 See the manual for details."
2864 "List of tags that will always appear in all Org-mode files.
2865 This is in addition to any in buffer settings or customizations
2866 of `org-tag-alist'.
2867 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2868 The value of this variable is an alist, the car of each entry must be a
2869 keyword as a string, the cdr may be a character that is used to select
2870 that tag through the fast-tag-selection interface.
2871 See the manual for details.
2872 To disable these tags on a per-file basis, insert anywhere in the file:
2873 #+STARTUP: noptag"
2884 "If non-nil, always offer completion for all tags of all agenda files.
2885 Instead of customizing this variable directly, you might want to
2886 set it locally for capture buffers, because there no list of
2887 tags in that file can be created dynamically (there are none).
2889 (add-hook 'org-capture-mode-hook
2890 (lambda ()
2891 (set (make-local-variable
2892 'org-complete-tags-always-offer-all-agenda-tags)
2893 t)))"
2898 "List of tags that can be inherited by all entries in the file.
2899 The tags will be inherited if the variable `org-use-tag-inheritance'
2900 says they should be.
2904 "Non-nil means use fast tag selection scheme.
2905 This is a special interface to select and deselect tags with single keys.
2906 When nil, fast selection is never used.
2907 When the symbol `auto', fast selection is used if and only if selection
2908 characters for tags have been configured, either through the variable
2909 `org-tag-alist' or through a #+TAGS line in the buffer.
2910 When t, fast selection is always used and selection keys are assigned
2911 automatically if necessary."
2919 "Non-nil means fast tag selection exits after first change.
2920 When nil, you have to press RET to exit it.
2921 During fast tag selection, you can toggle this flag with `C-c'.
2922 This variable can also have the value `expert'. In this case, the window
2923 displaying the tags menu is not even shown, until you press C-c again."
2931 "Non-nil means fast tags selection interface will also offer TODO states.
2935 "The column to which tags should be indented in a headline.
2936 If this number is positive, it specifies the column. If it is negative,
2937 it means that the tags should be flushright to that column. For example,
2938 -80 works well for a normal 80 character screen.
2939 When 0, place tags directly after headline text, with only one space in
2940 between."
2945 "Non-nil keeps tags aligned when modifying headlines.
2946 Some operations (i.e. demoting) change the length of a headline and
2947 therefore shift the tags around. With this option turned on, after
2948 each such operation the tags are again aligned to `org-tags-column'."
2953 "Non-nil means tags in levels apply also for sublevels.
2954 When nil, only the tags directly given in a specific line apply there.
2955 This may also be a list of tags that should be inherited, or a regexp that
2956 matches tags that should be inherited. Additional control is possible
2957 with the variable `org-tags-exclude-from-inheritance' which gives an
2958 explicit list of tags to be excluded from inheritance., even if the value of
2959 `org-use-tag-inheritance' would select it for inheritance.
2961 If this option is t, a match early-on in a tree can lead to a large
2962 number of matches in the subtree when constructing the agenda or creating
2963 a sparse tree. If you only want to see the first match in a tree during
2964 a search, check out the variable `org-tags-match-list-sublevels'."
2973 "List of tags that should never be inherited.
2974 This is a way to exclude a few tags from inheritance. For way to do
2975 the opposite, to actively allow inheritance for selected tags,
2976 see the variable `org-use-tag-inheritance'."
2981 "Check if TAG is one that should be inherited."
2993 "Non-nil means list also sublevels of headlines matching a search.
2994 This variable applies to tags/property searches, and also to stuck
2995 projects because this search is based on a tags match as well.
2997 When set to the symbol `indented', sublevels are indented with
2998 leading dots.
3000 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3001 the sublevels of a headline matching a tag search often also match
3002 the same search. Listing all of them can create very long lists.
3003 Setting this variable to nil causes subtrees of a match to be skipped.
3005 This variable is semi-obsolete and probably should always be true. It
3006 is better to limit inheritance to certain tags using the variables
3007 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3015 "When set, tags are sorted using this function as a comparator."
3031 "Options concerning properties in Org-mode."
3036 "How property key/value pairs should be formatted by `indent-line'.
3037 When `indent-line' hits a property definition, it will format the line
3038 according to this format, mainly to make sure that the values are
3039 lined-up with respect to each other."
3044 "Alist of properties and functions to adjust inserted values.
3045 Elements of this alist must be of the form
3047 ([string] [function])
3049 where [string] must be a property name and [function] must be a
3050 lambda expression: this lambda expression must take one argument,
3051 the value to adjust, and return the new value as a string.
3055 and the clock summary:
3058 (let ((clocksum (org-clock-sum-current-item))
3059 (effort (org-duration-string-to-minutes
3061 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3066 "Non-nil means properties apply also for sublevels.
3068 This setting is chiefly used during property searches. Turning it on can
3069 cause significant overhead when doing a search, which is why it is not
3070 on by default.
3072 When nil, only the properties directly given in the current entry count.
3073 When t, every property is inherited. The value may also be a list of
3074 properties that should have inheritance, or a regular expression matching
3075 properties that should be inherited.
3077 However, note that some special properties use inheritance under special
3078 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3080 for valid values of a property.
3082 Note for programmers:
3083 When querying an entry with `org-entry-get', you can control if inheritance
3084 should be used. By default, `org-entry-get' looks only at the local
3085 properties. You can request inheritance by setting the inherit argument
3086 to t (to force inheritance) or to `selective' (to respect the setting
3087 in this variable)."
3096 "Check if PROPERTY is one that should be inherited."
3107 "The default column format, if no other format has been defined.
3108 This variable can be set on the per-file basis by inserting a line
3110 #+COLUMNS: %25ITEM ....."
3115 "The ellipses to be used when a field in column view is truncated.
3116 When this is the empty string, as many characters as possible are shown,
3117 but then there will be no visual indication that the field has been truncated.
3118 When this is a string of length N, the last N characters of a truncated
3119 field are replaced by this string. If the column is narrower than the
3120 ellipses string, only part of the ellipses string will be shown."
3125 "Function that modifies values for display in column view.
3126 For example, it can be used to cut out a certain part from a time stamp.
3127 The function must take 2 arguments:
3129 column-title The title of the column (*not* the property name)
3130 value The value that should be modified.
3132 The function should return the value that should be displayed,
3133 or nil if the normal value should be used."
3138 "The property that is being used to keep track of effort estimates.
3139 Effort estimates given in this property need to have the format H:MM."
3147 "List of property/value pairs that can be inherited by any entry.
3149 These are fixed values, for the preset properties. The user variable
3150 that can be used to add to this list is `org-global-properties'.
3152 The entries in this list are cons cells where the car is a property
3153 name and cdr is a string with the value. If the value represents
3158 "List of property/value pairs that can be inherited by any entry.
3160 This list will be combined with the constant `org-global-properties-fixed'.
3162 The entries in this list are cons cells where the car is a property
3163 name and cdr is a string with the value.
3165 You can set buffer-local values for the same purpose in the variable
3166 `org-file-properties' this by adding lines like
3168 #+PROPERTY: NAME VALUE"
3175 "List of property/value pairs that can be inherited by any entry.
3176 Valid for the current buffer.
3181 "Options concerning agenda views in Org-mode."
3186 "Variable used by org files to set a category for agenda display.
3187 Such files should use a file variable to set it, for example
3191 or contain a special line
3193 #+CATEGORY: ELisp
3195 If the file does not specify a category, then file's base name
3201 "The files to be used for agenda display.
3205 If an entry is a directory, all files in that directory that are matched by
3206 `org-agenda-file-regexp' will be part of the file list.
3208 If the value of the variable is not a list but a single file name, then
3209 the list of agenda files is actually stored and maintained in that file, one
3210 agenda file per line. In this file paths can be given relative to
3211 `org-directory'. Tilde expansion and environment variable substitution
3212 are also made."
3219 "Regular expression to match files for `org-agenda-files'.
3220 If any element in the list in that variable contains a directory instead
3221 of a normal file, all files in that directory that are matched by this
3222 regular expression will be included."
3227 "List of extra files to be searched by text search commands.
3228 These files will be search in addition to the agenda files by the
3229 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3230 Note that these files will only be searched for text search commands,
3231 not for the other agenda views like todo lists, tag searches or the weekly
3232 agenda. This variable is intended to list notes and possibly archive files
3233 that should also be searched by these two commands.
3234 In fact, if the first element in the list is the symbol `agenda-archives',
3235 than all archive files of all agenda files will be added to the search
3236 scope."
3247 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3248 A nil value means to remove them, after a query, from the list."
3253 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3254 The command `org-calendar-goto-agenda' will be bound to this key. The
3255 default is the character `c' because then `c' can be used to switch back and
3256 forth between agenda and calendar."
3261 "The key to be installed in `calendar-mode-map' for agenda-action.
3262 The command `org-agenda-action' will be bound to this key. The
3263 default is the character `k' because we use the same key in the agenda."
3268 "The key to be installed in `calendar-mode-map' for adding diary entries.
3269 This option is irrelevant until `org-agenda-diary-file' has been configured
3270 to point to an Org-mode file. When that is the case, the command
3271 `org-agenda-diary-entry' will be bound to the key given here, by default
3272 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3273 if you want to continue doing this, you need to change this to a different
3274 key."
3279 "File to which to add new entries with the `i' key in agenda and calendar.
3280 When this is the symbol `diary-file', the functionality in the Emacs
3281 calendar will be used to add entries to the `diary-file'. But when this
3282 points to a file, `org-agenda-diary-entry' will be used instead."
3298 org-calendar-insert-diary-entry-key
3302 "Options for embedding LaTeX code into Org-mode."
3310 "Options for creating images from LaTeX fragments.
3311 This is a property list with the following properties:
3313 `default' means use the foreground of the default face.
3315 `default' means use the background of the default face.
3316 :scale a scaling factor for the size of the images, to get more pixels
3317 :html-foreground, :html-background, :html-scale
3318 the same numbers for HTML export.
3319 :matchers a list indicating which matchers should be used to
3320 find LaTeX fragments. Valid members of this list are:
3331 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3332 When nil, just push out a message."
3337 Use this to specify additional executable file say a jar file.
3339 When using MathToWeb as the converter, specify the full-path to
3340 your mathtoweb.jar file."
3347 "Command to convert LaTeX fragments to MathML.
3348 Replace format-specifiers in the command as noted below and use
3349 `shell-command' to convert LaTeX to MathML.
3350 %j: Executable file in fully expanded form as specified by
3351 `org-latex-to-mathml-jar-file'.
3352 %I: Input LaTeX file in fully expanded form
3353 %o: Output MathML file
3354 This command is used by `org-create-math-formula'.
3356 When using MathToWeb as the converter, set this to
3364 "Return t if `org-latex-to-mathml-convert-command' is usable."
3367 org-latex-to-mathml-convert-command)
3369 org-latex-to-mathml-convert-command))))
3374 t))))))
3381 \[PACKAGES]
3382 \[DEFAULT-PACKAGES]
3383 % The settings below are copied from fullpage.sty
3396 "The document header used for processing LaTeX fragments.
3397 It is imperative that this header make sure that no page number
3398 appears on the page. The package defined in the variables
3399 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3401 will be appended."
3408 "Set the packages alist and make sure it has 3 elements per entry."
3412 x))
3413 val)))
3417 "Get the packages alist and make sure it has 3 elements per entry."
3421 x))
3424 ;; The following variables are defined here because is it also used
3425 ;; when formatting latex fragments. Originally it was part of the
3426 ;; LaTeX exporter, which is why the name includes "export".
3443 )
3444 "Alist of default packages to be inserted in the header.
3445 Change this only if one of the packages here causes an incompatibility
3446 with another package you are using.
3447 The packages in this list are needed by one part or another of Org-mode
3448 to function properly.
3450 - inputenc, fontenc: for basic font and character selection
3451 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3452 for interpreting the entities in `org-entities'. You can skip some of these
3453 packages if you don't use any of the symbols in it.
3454 - graphicx: for including images
3455 - float, wrapfig: for figure placement
3456 - longtable: for long tables
3457 - hyperref: for cross references
3459 Therefore you should not modify this variable unless you know what you
3460 are doing. The one reason to change it anyway is that you might be loading
3461 some other package that conflicts with one of the default packages.
3463 If SNIPPET-FLAG is t, the package also needs to be included when
3464 compiling LaTeX snippets into images for inclusion into HTML."
3477 "Alist of packages to be inserted in every LaTeX header.
3478 These will be inserted after `org-export-latex-default-packages-alist'.
3480 SNIPPET-FLAG, when t, indicates that this package is also needed when
3481 turning LaTeX snippets into images for inclusion into HTML.
3482 Make sure that you only list packages here which:
3483 - you want in every file
3484 - do not conflict with the default packages in
3485 `org-export-latex-default-packages-alist'
3486 - do not conflict with the setup in `org-format-latex-header'."
3500 "Settings for Org-mode appearance."
3505 "Non-nil means fontify only the stars in each headline.
3506 When nil, the entire headline is fontified.
3507 Changing it requires restart of `font-lock-mode' to become effective
3508 also in regions already fontified."
3513 "Non-nil means hide the first N-1 stars in a headline.
3514 This works by using the face `org-hide' for these stars. This
3515 face is white for a light background, and black for a dark
3516 background. You may have to customize the face `org-hide' to
3517 make this work.
3518 Changing it requires restart of `font-lock-mode' to become effective
3519 also in regions already fontified.
3520 You may also set this on a per-file basis by adding one of the following
3521 lines to the buffer:
3523 #+STARTUP: hidestars
3524 #+STARTUP: showstars"
3529 "List of symbols corresponding to keywords to be hidden the org buffer.
3530 For example, a value '(title) for this list will make the document's title
3531 appear in the buffer without the initial #+TITLE: keyword."
3539 "Non-nil means change the face of a headline if it is marked DONE.
3540 Normally, only the TODO/DONE keyword indicates the state of a headline.
3541 When this is non-nil, the headline after the keyword is set to the
3542 `org-headline-done' as an additional indication."
3547 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3548 Changing this variable requires a restart of Emacs to take effect."
3553 "Non-nil means fontify the whole line for headings.
3554 This is useful when setting a background color for the
3555 org-level-* faces."
3560 "Non-nil means fontify what is treated specially by the exporters."
3565 "Non-nil mean font-lock should hide the emphasis marker characters."
3570 "Non-nil means show entities as UTF8 characters.
3576 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3581 "Regular expression for matching emphasis.
3582 After a match, the match groups contain these elements:
3583 0 The match of the full regular expression, including the characters
3584 before and after the proper match
3585 1 The character before the proper match, or empty at beginning of line
3586 2 The proper match, including the leading and trailing markers
3587 3 The leading marker like * or /, indicating the type of highlighting
3588 4 The text between the emphasis markers, not including the markers
3595 "Set variable and compute the emphasis regular expression."
3599 org-emphasis-alist org-emphasis-regexp-components)
3611 ;; make sure special characters appear at the right position in the class
3623 ;; Make the regexp
3631 body1
3643 body1
3651 "Components used to build the regular expression for emphasis.
3652 This is a list with five entries. Terminology: In an emphasis string
3656 specify what is allowed/forbidden in each part:
3658 pre Chars allowed as prematch. Beginning of line will be allowed too.
3659 post Chars allowed as postmatch. End of line will be allowed too.
3660 border The chars *forbidden* as border characters.
3662 non-shy groups here, and don't allow newline here.
3663 newline The maximum number of newlines allowed in an emphasis exp.
3665 Use customize to modify this, or restart Emacs after changing it."
3684 )
3685 "Special syntax for emphasized text.
3686 Text starting and ending with a special character will be emphasized, for
3687 example *bold*, _underlined_ and /italic/. This variable sets the marker
3688 characters, the face to be used by font-lock for highlighting in Org-mode
3689 Emacs buffers, and the HTML tags to be used for this.
3690 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3691 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3692 Use customize to modify this, or restart Emacs after changing it."
3707 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3710 ;;; Miscellaneous options
3713 "Completion in Org-mode."
3718 "Non-nil means use ido completion wherever possible.
3719 Note that `ido-mode' must be active for this variable to be relevant.
3720 If you decide to turn this variable on, you might well want to turn off
3721 `org-outline-path-complete-in-steps'.
3722 See also `org-completion-use-iswitchb'."
3727 "Non-nil means use iswitchb completion wherever possible.
3728 Note that `iswitchb-mode' must be active for this variable to be relevant.
3729 If you decide to turn this variable on, you might well want to turn off
3730 `org-outline-path-complete-in-steps'.
3731 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3737 Normal means, no org-mode-specific context."
3741 ;;; Functions and variables from their packages
3742 ;; Declared here to avoid compiler warnings
3744 ;; XEmacs only
3750 ;; Emacs only
3753 ;; Various packages
3772 org-agenda-format-item "org-agenda"
3803 ;;; Autoload and prepare some org modules
3805 ;; Some table stuff that needs to be defined here, because it is used
3806 ;; by the functions setting up org-mode or checking for table context.
3819 "Detect the first line outside a table when searching from within it.
3822 ;; Autoload the functions in org-table.el that are needed by functions here.
3827 org-table-convert org-table-convert-region org-table-copy-down
3828 org-table-copy-region org-table-create
3829 org-table-create-or-convert-from-region
3830 org-table-create-with-table.el org-table-current-dline
3831 org-table-cut-region org-table-delete-column org-table-edit-field
3832 org-table-edit-formulas org-table-end org-table-eval-formula
3833 org-table-export org-table-field-info
3834 org-table-get-stored-formulas org-table-goto-column
3835 org-table-hline-and-move org-table-import org-table-insert-column
3836 org-table-insert-hline org-table-insert-row org-table-iterate
3837 org-table-justify-field-maybe org-table-kill-row
3838 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3839 org-table-move-column org-table-move-column-left
3840 org-table-move-column-right org-table-move-row
3841 org-table-move-row-down org-table-move-row-up
3842 org-table-next-field org-table-next-row org-table-paste-rectangle
3843 org-table-previous-field org-table-recalculate
3844 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3845 org-table-toggle-coordinate-overlays
3846 org-table-toggle-formula-debugger org-table-wrap-region
3847 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3848 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3849 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3852 "Return t if the cursor is inside an org-type table.
3853 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3858 org-table-line-regexp)))
3859 nil))
3863 "Return t if and only if we are at a table.el table."
3869 "If there is a table.el table nearby, recognize it and move into it."
3875 nil
3885 t
3890 t)
3891 nil)
3892 nil))
3895 "Return t if the cursor is inside a hline in a table."
3900 nil))
3905 "Apply FUNCTION to the start of all tables in the buffer."
3921 ;; Declare and autoload functions from org-exp.el & Co
3929 org-insert-export-options-template
3930 org-table-clean-before-export))
3933 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3934 org-export-region-as-ascii))
3937 org-replace-region-by-latex org-export-region-as-latex
3938 org-export-as-latex org-export-as-pdf
3939 org-export-as-pdf-and-open))
3942 org-export-as-html-batch org-export-as-html-to-buffer
3943 org-replace-region-by-html org-export-region-as-html
3944 org-export-as-html))
3947 org-replace-region-by-docbook org-export-region-as-docbook
3948 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3949 org-export-as-docbook))
3952 org-export-icalendar-all-agenda-files
3953 org-export-icalendar-combine-agenda-files))
3957 ;; Declare and autoload functions from org-agenda.el
3962 org-todo-list org-tags-view org-agenda-list-stuck-projects
3963 org-diary org-agenda-to-appt
3964 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3966 ;; Autoload org-remember
3971 org-remember-apply-template org-remember org-remember-handler)))
3976 org-capture-import-remember-templates)))
3978 ;; Autoload org-clock.el
3993 "Return non-nil if clock is currently running.
3994 The return value is actually the clock marker."
3999 "org-clock"
4001 org-clock-goto org-clock-sum org-clock-display
4002 org-clock-remove-overlays org-clock-report
4003 org-clocktable-shift org-dblock-write:clocktable
4004 org-get-clocktable org-resolve-clocks)))
4007 "If this is a CLOCK line, update it and return t.
4008 Otherwise, return nil."
4017 ts te h m s neg)
4020 nil)
4025 ;; The clock is running here
4046 t))))))
4049 "Check if the current buffer contains the running clock.
4050 If yes, offer to stop it and to save the buffer with the changes."
4059 "Check if this line starts a clock table, if yes, shift the time block."
4063 ;; Autoload org-timer.el
4067 "org-timer"
4069 org-timer-change-times-in-region
4070 org-timer-set-timer
4071 org-timer-reset-timers
4072 org-timer-show-remaining-time)))
4074 ;; Autoload org-feed.el
4078 "org-feed"
4082 ;; Autoload org-indent.el
4084 ;; Define the variable already here, to make sure we have it.
4086 "Non-nil if Org-Indent mode is enabled.
4091 "org-indent"
4094 ;; Autoload org-mobile.el
4098 "org-mobile"
4101 ;; Autoload archiving code
4102 ;; The stuff that is needed for cycling and tags has to be defined here.
4105 "Options concerning archiving in Org-mode."
4110 "The location where subtrees should be archived.
4112 The value of this variable is a string, consisting of two parts,
4113 separated by a double-colon. The first part is a filename and
4114 the second part is a headline.
4116 When the filename is omitted, archiving happens in the same file.
4117 %s in the filename will be replaced by the current file
4118 name (without the directory part). Archiving to a different file
4119 is useful to keep archived entries from contributing to the
4120 Org-mode Agenda.
4122 The archived entries will be filed as subtrees of the specified
4123 headline. When the headline is omitted, the subtrees are simply
4124 filed away at the end of the file, as top-level entries. Also in
4125 the heading you can use %s to represent the file name, this can be
4126 useful when using the same archive for a number of different files.
4128 Here are a few examples:
4130 If the current file is Projects.org, archive in file
4131 Projects.org_archive, as top-level trees. This is the default.
4134 Archive in the current file, under the top-level headline
4138 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4141 Archive in file ~/org/archive.org (absolute path), under headlines
4145 Archive in file ./basement (relative path), as level 3 trees
4148 You may set this option on a per-file basis by adding to the buffer a
4149 line like
4151 #+ARCHIVE: basement::** Finished Tasks
4153 You may also define it locally for a subtree by setting an ARCHIVE property
4154 in the entry. If such a property is found in an entry, or anywhere up
4155 the hierarchy, it will be used."
4160 "The tag that marks a subtree as archived.
4161 An archived subtree does not open during visibility cycling, and does
4162 not contribute to the agenda listings.
4163 After changing this, font-lock must be restarted in the relevant buffers to
4164 get the proper fontification."
4170 "Non-nil means the agenda will skip any items located in archived trees.
4171 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4172 variable is no longer recommended, you should leave it at the value t.
4173 Instead, use the key `v' to cycle the archives-mode in the agenda."
4179 "Non-nil means ignore archived trees when creating column view."
4185 "Non-nil means `org-cycle' will open archived trees.
4186 An archived tree is a tree marked with the tag ARCHIVE.
4187 When nil, archived trees will stay folded. You can still open them with
4188 normal outline commands like `show-all', but not with the cycling commands."
4194 "Non-nil means sparse tree construction shows matches in archived trees.
4195 When nil, matches in these trees are highlighted, but the trees are kept in
4196 collapsed state."
4202 "Re-hide all archived subtrees after a visibility state change."
4213 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4216 "Cycle subtree even if it is archived."
4223 "Re-hide all archived subtrees after a visibility state change."
4238 flag)))
4245 org-archive-to-archive-sibling org-toggle-archive-tag
4246 org-archive-subtree-default
4247 org-archive-subtree-default-with-confirmation)))
4249 ;; Autoload Column View Code
4257 org-columns-compute org-agenda-columns org-columns-remove-overlays
4260 ;; Autoload ID code
4268 org-id-get-with-outline-path-completion
4269 org-id-get-with-outline-drilling org-id-store-link
4270 org-id-goto org-id-find org-id-store-link))
4272 ;; Autoload Plotting Code
4277 ;;; Variables for pre-computed regular expressions, all buffer local
4295 "Matches a headline and puts everything into groups:
4296 group 1: the stars
4297 group 2: The todo keyword, maybe
4298 group 3: Priority cookie
4299 group 4: True headline
4303 "Printf format to make regexp to match an exact headline.
4304 This regexp will match the headline of any node which has the
4305 exact headline text that is put into the format, but may have any
4309 "Matches a headline and puts TODO state into group 2 if present.
4358 "Regular expression to match a plain time or time range.
4359 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4360 groups carry important information:
4361 0 the full match
4362 1 the first time, range or not
4370 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4371 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4372 groups carry important information:
4373 0 the full match
4374 7 hours of duration
4383 "Regular expression to match a timestamp time or time range.
4384 After a match, the following groups carry important information:
4385 0 the full match
4386 1 date plus weekday, for back referencing to make sure both times are on the same day
4387 2 the first time, range or not
4442 "Variable associated with STARTUP options for org-mode.
4443 Each element is a list of three items: The startup options as written
4444 in the #+STARTUP line, the corresponding variable, and the value to
4445 set this variable to if the option is found. An optional forth element PUSH
4449 "Update PROPS with KEY and VAL."
4463 "Printf format for a regexp matching an headline with some keyword.
4464 This regexp will match the headline of any node which has the
4465 exact keyword that is put into the format. The keyword isn't in
4469 "Printf format for a regexp matching an headline, possibly with some keyword.
4470 This regexp can match any headline with the specified keyword, or
4471 without a keyword. The keyword isn't in any group by default,
4475 "Precompute regular expressions for current buffer."
4495 kwds kws0 kwsa key log value cat arch tags const links hw dws
4496 tail sep kws1 prio props ftags drawers beamer-p
4518 ;; general TODO-like setup
4530 links)))
4537 props))))
4542 ftags
4552 l var val)
4582 ;; search for property blocks
4591 props)))))))
4608 ;; Process the TODO keywords
4610 ;; Use the global values as if they had been given locally.
4622 kws)))
4625 kwsa nil
4628 ;; 1 2
4636 kw)
4638 kws0)
4655 ;; Process the constants
4663 ;; Process the tags.
4674 tgs))
4682 ;; Compute the regular expressions and other local variables.
4683 ;; Using `org-outline-regexp-bol' would complicate them much,
4684 ;; because of the fixed white space at the end of that string.
4692 org-drawer-regexp
4696 org-not-done-keywords
4698 org-todo-regexp
4702 org-not-done-regexp
4706 org-not-done-heading-regexp
4708 org-todo-line-regexp
4710 org-complex-heading-regexp
4717 org-complex-heading-regexp-format
4722 ;; Stats cookies can be stuck to body.
4729 org-todo-line-tags-regexp
4736 org-deadline-time-regexp
4738 org-deadline-line-regexp
4740 org-scheduled-regexp
4742 org-scheduled-time-regexp
4744 org-closed-time-regexp
4746 org-keyword-time-regexp
4752 org-keyword-time-not-clock-regexp
4758 org-maybe-keyword-time-regexp
4764 org-planning-or-clock-line-re
4769 org-all-time-keywords
4772 org-clock-string org-closed-string))
4773 )
4778 "Return the contents of FILE, as a string."
4792 "Extract the log state setting from a TODO keyword string.
4806 "Remove a pair of parenthesis at the end of each string in LIST."
4810 x))
4811 list))
4814 "Assign fast keys to a keyword-key alist.
4815 Respect keys that are already there."
4833 ;;; Some variables used in various places
4840 "Function to be called when `C-c C-c' is used.
4844 ;; FIXME: Occasionally check by commenting these, to make sure
4845 ;; no other functions uses these, forgetting to let-bind them.
4850 ;; Defined somewhere in this file, but used before definition.
4856 ;;;; Define the Org-mode
4859 (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"))
4862 ;; We use a before-change function to check if a table might need
4863 ;; an update.
4865 "Indicates that a table might need an update.
4866 This variable is set by `org-before-change-function'.
4869 "Every change indicates that a table might need an update."
4879 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4880 ;; some places -- e.g. see the macro org-with-limited-levels.
4881 ;;
4882 ;; In Org buffers, the value of `outline-regexp' is that of
4883 ;; `org-outline-regexp'. The only function still directly relying on
4884 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4885 ;; job when `orgstruct-mode' is active.
4889 "Regexp to match Org headlines.
4890 This is similar to `org-outline-regexp' but additionally makes
4894 "Matches an headline, putting stars and text into groups.
4897 ;;;###autoload
4899 "Outline-based notes management and organizer, alias
4902 Org-mode develops organizational tasks around a NOTES file which
4903 contains information about projects as plain text. Org-mode is
4904 implemented on top of outline-mode, which is ideal to keep the content
4905 of large files well structured. It supports ToDo items, deadlines and
4906 time stamps, which magically appear in the diary listing of the Emacs
4907 calendar. Tables are easily created with a built-in table editor.
4908 Plain text URL-like links connect to websites, emails (VM), Usenet
4909 messages (Gnus), BBDB entries, and any files related to the project.
4910 For printing and sharing of notes, an Org-mode file (or a part of it)
4911 can be exported as a structured ASCII or HTML file.
4913 The following commands are available:
4917 ;; Get rid of Outline menus, they are not needed
4918 ;; Need to do this here because define-derived-mode sets up
4919 ;; the keymap so late. Still, it is a waste to call this each time
4920 ;; we switch another buffer into org-mode.
4923 ;; Assume this is Greg's port, it uses easymenu
4949 org-display-table 4
4952 org-ellipsis)))
4957 ;; tag faces set outside customize.... force initialization.
4959 ;; Calc embedded
4965 ;; Activate before-change-function
4969 ;; Check for running clock before killing a buffer
4971 ;; Paragraphs and auto-filling
4975 ;; Beginning/end of defun
4978 ;; Next error for sparse trees
4980 ;; Make sure dependence stuff works reliably, even for users who set it
4981 ;; too late :-(
4993 ;; Comment characters
4997 ;; Align options lines
4999 'align-mode-rules-list
5004 ;; Imenu
5008 ;; Make isearch reveal context
5011 ;; Emacs 21 and XEmacs make use of the hook
5013 ;; Emacs 22 deals with this through a special variable
5017 ;; Turn on org-beamer-mode?
5020 ;; Setup the pcomplete hooks
5033 ;; If empty file that did not turn on org-mode automatically, make it to.
5058 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5068 "Return today date, considering `org-extend-today-until'."
5073 ;;;; Font-Lock stuff, including the activators
5104 "Regular expression used to analyze links.
5105 Here is what the match groups contain after a match:
5106 1: http:
5107 2: http
5108 3: path
5109 4: [desc]
5117 "Number of stacked braces for sub/superscript matching.
5118 This has to be set before loading org.el to be effective."
5123 "Create a regular expression which will match a balanced sexp.
5124 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5125 as single character strings.
5126 The regexp returned will match the entire expression including the
5127 delimiters. It will also define a single group which contains the
5128 match except for the outermost delimiters. The maximum depth of
5129 stacked delimiters is N. Escaping delimiters is not possible."
5158 "Update the link regular expressions.
5159 This should be called after the variable `org-link-types' has changed."
5163 org-link-re-with-space
5169 org-link-re-with-space2
5175 org-link-re-with-space3
5180 org-angle-link-re
5186 org-plain-link-re
5190 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5191 org-bracket-link-regexp
5193 org-bracket-link-analytic-regexp
5201 org-bracket-link-analytic-regexp++
5209 org-any-link-re
5218 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5221 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5222 "Regular expression matching time strings for analysis.
5223 This one does not require the space after the date, so it can be used
5225 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5241 "Regular expression matching a time stamp or time stamp range.
5247 "Run through the buffer and add overlays to emphasized strings."
5256 'face
5269 rtn))
5272 "Insert or change an emphasis, i.e. a font like bold or italic.
5273 If there is an active region, change that region to a new emphasis.
5274 If there is no region, just insert the marker characters and position
5275 the cursor between them.
5276 CHAR should be either the marker character, or the first character of the
5277 HTML tag associated with that emphasis. If CHAR is a space, the means
5278 to remove the emphasis of the selected region.
5279 If char is not given (for example in an interactive call) it
5280 will be prompted for."
5331 "Run through the buffer and add overlays to links."
5340 nil
5346 t)))))
5354 t)))
5357 "When non-nil, fontify code in code blocks."
5368 "Fontify #+ lines and blocks, in the correct ways."
5371 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5372 limit t)
5380 end end1 quoting block-type ovl)
5383 ;; a single line of backend-specific content
5391 ; for backend-specific code
5392 t)
5394 ;; Truly a block
5406 beg end
5414 ;; remove old background overlays
5419 ;; add a background overlay
5433 t))
5446 ;; just any other in-buffer setting, but not indented
5450 t)
5458 t)
5466 "Strip protective commas between BEG and END in the current buffer."
5482 "Run through the buffer and add overlays to links."
5490 t)))
5493 "Run through the buffer and add overlays to footnotes."
5500 'keymap org-mouse-map
5501 'help-echo
5503 "Footnote definition"
5505 'font-lock-fontified t
5506 'font-lock-multiline t
5510 "Run through the buffer and add overlays to bracketed links."
5514 ;; FIXME: above we should remove the escapes.
5515 ;; but that requires another match, protecting match data,
5516 ;; a lot of overhead for font-lock.
5523 ;; We need to remove the invisible property here. Table narrowing
5524 ;; may have made some of this invisible.
5542 t)))
5545 "Run through the buffer and add overlays to dates."
5557 t)))
5566 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5570 "Run through the buffer and add overlays to target matches."
5578 'keymap org-mouse-map
5582 t)))))
5585 "Find all radio targets in this file and update the regular expression."
5600 t)))
5607 ;; This should be with the exporter code, but we also use if for font-locking
5617 "Compute regular expression for stuff treated specially by exporters."
5624 org-latex-regexps)))
5652 org-entities)))
5656 org-latex-entities)
5657 nil))
5659 ))
5660 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5663 org-export-html-special-string-regexps)))
5668 ))))
5670 'org-latex-and-specials-regexp
5675 "Run through the buffer and add overlays to links."
5679 limit t))
5693 rtn)))
5696 "Restart `font-lock-mode', to force refontification."
5702 "Return a list of all targets in this file.
5703 With optional argument RADIO, only find radio targets."
5705 rtn)
5710 rtn)))
5713 "Make regular expression matching all strings in TARGETS.
5714 The regular expression finds the targets also if there is a line break
5715 between words."
5724 x)
5725 targets
5737 t)))
5740 "Compute the outline level of the heading at point.
5741 This function assumes that the cursor is at the beginning of a line matched
5742 by `outline-regexp'. Otherwise it returns garbage.
5743 If this is called at a normal headline, the level is the number of stars.
5744 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5751 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5758 "Functions that can manipulate `org-font-lock-extra-keywords'.
5759 This is called after `org-font-lock-extra-keywords' is defined, but before
5760 it is installed to be used by font lock. This can be useful if something
5771 ;; Call the hook
5773 ;; Headlines
5780 ;; Table lines
5783 ;; Table internals
5788 ;; Drawers
5791 ;; Properties
5795 ;; Links
5805 ;; TODO keyword
5807 org-todo-regexp)
5809 ;; DONE
5817 nil)
5818 ;; Priorities
5820 ;; Tags
5822 ;; Special keywords
5827 ;; Emphasis
5832 ;; Checkboxes
5833 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5838 ;; Description list items
5841 ;; ARCHIVEd headings
5843 org-outline-regexp-bol
5846 ;; Specials
5850 ;; Code
5852 ;; COMMENT
5859 ;; Blocks and meta lines
5861 )))
5864 ;; Now set the full font-lock-keywords
5871 "Toggle the composition display of entities as UTF8 characters."
5883 "Find an entity to fontify."
5889 limit t)
5901 nil))))
5904 "Fontify string S like in Org-mode."
5916 "Get the right face for match N in font-lock matching of headlines."
5929 "Get the right face for a TODO keyword KWD.
5930 If KWD is a number, get the corresponding match group."
5938 "Create a face list that inherits INHERIT, but sets the foreground color.
5939 When FACE-OR-COLOR is not a string, just return it."
5943 face-or-color)
5944 face-or-color))
5947 "Add the special tag faces."
5956 "Add the special priority faces."
5963 org-priority-faces)))
5968 "Get the right face for a TODO keyword KWD.
5969 If KWD is a number, get the corresponding match group."
5976 "Remove fontification and activation overlays from links."
5981 deactivate-mark buffer-file-name buffer-file-truename)
5985 invisible t intangible t
5986 org-no-flyspell t org-emphasis t))
5996 "Remove specific display properties that have been added by font lock.
5997 The will remove the raise properties that are used to show superscripts
5998 and subscripts."
6008 "Add raise properties to sub/superscripts."
6012 org-match-substring-regexp
6013 org-match-substring-with-braces-regexp)
6014 limit t)
6024 ;; FIXME: Should we go back one character here, for a_b^c
6025 ;; (goto-char (1- pos)) ;????????????????????
6027 t
6029 'display
6045 t)))))
6047 ;;;; Visibility cycling, including org-goto and indirect buffer
6049 ;;; Cycling
6056 ;;;###autoload
6061 "TAB-action and visibility cycling for Org-mode.
6063 This is the command invoked in Org-mode by the TAB key. Its main purpose
6064 is outline visibility cycling, but it also invokes other actions
6065 in special contexts.
6067 - When this function is called with a prefix argument, rotate the entire
6068 buffer through 3 states (global cycling)
6069 1. OVERVIEW: Show only top-level headlines.
6070 2. CONTENTS: Show all headlines of all levels, but no body text.
6071 3. SHOW ALL: Show everything.
6072 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6073 determined by the variable `org-startup-folded', and by any VISIBILITY
6074 properties in the buffer.
6075 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6076 including any drawers.
6078 - When inside a table, re-align the table and move to the next field.
6080 - When point is at the beginning of a headline, rotate the subtree started
6081 by this line through 3 different states (local cycling)
6082 1. FOLDED: Only the main headline is shown.
6083 2. CHILDREN: The main headline and the direct children are shown.
6084 From this state, you can move to one of the children
6085 and zoom in further.
6086 3. SUBTREE: Show the entire subtree, including body text.
6087 If there is no subtree, switch directly from CHILDREN to FOLDED.
6089 - When point is at the beginning of an empty headline and the variable
6090 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6091 of the headline by demoting and promoting it to likely levels. This
6092 speeds up creation document structure by pressing TAB once or several
6093 times right after creating a new headline.
6095 - When there is a numeric prefix, go up to a heading with level ARG, do
6096 a `show-subtree' and return to the previous cursor position. If ARG
6097 is negative, go up that many levels.
6099 - When point is not at the beginning of a headline, execute the global
6100 binding for TAB, which is re-indenting the line. See the option
6101 `org-cycle-emulate-tab' for details.
6103 - Special case: if point is at the beginning of the buffer and there is
6104 no headline in line 1, this function will act as if called with prefix arg
6105 (C-u TAB, same as S-TAB) also when called without prefix arg.
6106 But only if also the variable `org-cycle-global-at-bob' is t."
6116 org-inlinetask-min-level
6121 limit-level)))
6124 outline-regexp
6132 org-cycle-hook))
6136 ;; special case: use global cycling
6150 ;; Table: enter it or move to the next field.
6161 ;; Global cycling: delegate to `org-cycle-internal-global'.
6164 ;; Drawers: delegate to `org-flag-drawer'.
6172 ;; Show-subtree, ARG levels up from here.
6180 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6188 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6195 ;; From there: TAB emulation and template completion.
6217 t
6226 "Do the global cycling action."
6230 ;; We just created the overview - now do table of contents
6231 ;; This can be slow in very large buffers, so indicate action
6241 ;; We just showed the table of contents - now show everything
6249 ;; Default action: go to overview
6257 "Do the local cycling action."
6259 ;; First, determine end of headline (EOH), end of subtree or item
6260 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6284 ;; Determine end invisible part of buffer (EOL)
6286 ;; XEmacs doesn't have `next-single-char-property-change'
6296 ;; Find out what to do next and set `this-command'
6299 ;; Nothing is hidden behind this heading
6311 org-cycle-skip-children-state-if-no-children))))
6312 ;; Entire subtree is hidden in one line: children view
6320 ;; Fold every list in subtree to top-level items.
6342 ;; We just showed the children, or no children are there,
6343 ;; now show everything.
6350 ;; Default action: hide the subtree.
6357 ;;;###autoload
6359 "Cycle the global visibility. For details see `org-cycle'.
6361 With a numeric prefix, show all headlines up to that level."
6377 "Set the visibility required by startup options and properties."
6392 "Switch subtree visibilities according to :VISIBILITY: property."
6399 nil t)
6423 ;; This function uses outline-regexp instead of the more fundamental
6424 ;; org-outline-regexp so that org-cycle-global works outside of Org
6425 ;; buffers, where outline-regexp is needed.
6427 "Switch to overview mode, showing only top-level headlines.
6428 Really, this shows all headlines with level equal or greater than the level
6429 of the first headline in the buffer. This is important, because if the
6430 first headline is not level one, then (hide-sublevels 1) gives confusing
6431 results."
6442 "Show all headlines in the buffer, like a table of contents.
6443 With numerical argument N, show content up to level N."
6446 ;; Visit all headings and show their offspring
6453 t)
6462 "Adjust the window after a change in outline visibility.
6463 This function is the default value of the hook `org-cycle-hook'."
6473 "Remove outline overlays that do not contain non-white stuff."
6483 "Fix visibility issues after moving a subtree."
6484 ;; First, find a reasonable region to look at:
6485 ;; Start two siblings above, end three below
6503 ;; Properly fold already folded siblings
6514 "Show empty lines above all visible headlines.
6515 The region to be covered depends on STATE when called through
6516 `org-cycle-hook'. Lisp program can use t for STATE to get the
6517 entire buffer covered. Note that an empty line is only shown if there
6518 are at least `org-cycle-separator-lines' empty lines before the headline."
6528 beg end b e)
6552 ;; Never hide empty lines at the end of the file.
6562 "Move to the parent and re-show empty lines before visible headlines."
6568 "Return `org-agenda-files' list, plus all open org-mode files.
6569 This is useful for operations that need to scan all of a user's
6570 open and agenda-wise Org files."
6578 files))
6581 "Return the beginning position of the current entry."
6585 "Return the end position of the current entry."
6589 "Re-hide all drawers after a visibility state change."
6615 "Is the end of the current subtree visible?"
6620 "Move cursor to the first headline and recenter the headline.
6621 Optional argument N means put the headline into the Nth line of the window."
6627 ;;; Saving and restoring visibility
6630 "Return a list of the locations of all outline overlays.
6631 These are overlays with the `invisible' property value `outline'.
6632 The return value is a list of cons cells, with start and stop
6633 positions for each overlay.
6634 If USE-MARKERS is set, return the positions as markers."
6652 "Create visibility overlays for all positions in DATA.
6653 DATA should have been made by `org-outline-overlay-data'."
6661 data)))))
6663 ;;; Folding of blocks
6670 "Call FUNCTION at the head of all source blocks in the current buffer.
6671 Optional arguments START and END can be used to limit the range."
6683 "Toggle the visibility of all blocks in the current buffer."
6687 "Fold all blocks in the current buffer."
6693 "Unfold all blocks in the current buffer."
6699 "Toggle visibility of block at point."
6710 "Toggle the visibility of the current block."
6717 ov)
6733 ;; make the block accessible to isearch
6735 ov 'isearch-open-invisible
6746 ;; org-tab-after-check-for-cycling-hook
6748 ;; Remove overlays when changing major mode
6753 ;;; Org-goto
6759 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6775 nil)
6776 (org-defkey map "q" 'org-goto-quit)
6777 (org-defkey map "n" 'outline-next-visible-heading)
6778 (org-defkey map "p" 'outline-previous-visible-heading)
6779 (org-defkey map "f" 'outline-forward-same-level)
6780 (org-defkey map "b" 'outline-backward-same-level)
6781 (org-defkey map "u" 'outline-up-heading))
6782 (org-defkey map "/" 'org-occur)
6783 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6784 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6785 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6786 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6787 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6788 map))
6790 (defconst org-goto-help
6791 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6792 RET=jump to location [Q]uit and return to previous location
6793 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6795 (defvar org-goto-start-pos) ; dynamically scoped parameter
6797 ;; FIXME: Docstring does not mention both interfaces
6798 (defun org-goto (&optional alternative-interface)
6799 "Look up a different location in the current file, keeping current visibility.
6801 When you want look-up or go to a different location in a document, the
6802 fastest way is often to fold the entire buffer and then dive into the tree.
6803 This method has the disadvantage, that the previous location will be folded,
6804 which may not be what you want.
6806 This command works around this by showing a copy of the current buffer
6807 in an indirect buffer, in overview mode. You can dive into the tree in
6808 that copy, use org-occur and incremental search to find a location.
6809 When pressing RET or `Q', the command returns to the original buffer in
6810 which the visibility is still unchanged. After RET it will also jump to
6811 the location selected in the indirect buffer and expose the headline
6812 hierarchy above."
6813 (interactive "P")
6814 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6815 (org-refile-use-outline-path t)
6816 (org-refile-target-verify-function nil)
6817 (interface
6818 (if (not alternative-interface)
6819 org-goto-interface
6820 (if (eq org-goto-interface 'outline)
6821 'outline-path-completion
6822 'outline)))
6823 (org-goto-start-pos (point))
6824 (selected-point
6825 (if (eq interface 'outline)
6826 (car (org-get-location (current-buffer) org-goto-help))
6827 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6828 (org-refile-check-position pa)
6829 (nth 3 pa)))))
6830 (if selected-point
6831 (progn
6832 (org-mark-ring-push org-goto-start-pos)
6833 (goto-char selected-point)
6834 (if (or (outline-invisible-p) (org-invisible-p2))
6835 (org-show-context 'org-goto)))
6836 (message "Quit"))))
6838 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6839 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6840 (defvar org-goto-local-auto-isearch-map) ; defined below
6842 (defun org-get-location (buf help)
6843 "Let the user select a location in the Org-mode buffer BUF.
6844 This function uses a recursive edit. It returns the selected position
6845 or nil."
6846 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6847 (isearch-hide-immediately nil)
6848 (isearch-search-fun-function
6849 (lambda () 'org-goto-local-search-headings))
6850 (org-goto-selected-point org-goto-exit-command)
6851 (pop-up-frames nil)
6852 (special-display-buffer-names nil)
6853 (special-display-regexps nil)
6854 (special-display-function nil))
6855 (save-excursion
6856 (save-window-excursion
6857 (delete-other-windows)
6858 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6859 (org-pop-to-buffer-same-window
6860 (condition-case nil
6861 (make-indirect-buffer (current-buffer) "*org-goto*")
6862 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6863 (with-output-to-temp-buffer "*Help*"
6864 (princ help))
6865 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6866 (setq buffer-read-only nil)
6867 (let ((org-startup-truncated t)
6868 (org-startup-folded nil)
6869 (org-startup-align-all-tables nil))
6870 (org-mode)
6871 (org-overview))
6872 (setq buffer-read-only t)
6873 (if (and (boundp 'org-goto-start-pos)
6874 (integer-or-marker-p org-goto-start-pos))
6875 (let ((org-show-hierarchy-above t)
6876 (org-show-siblings t)
6877 (org-show-following-heading t))
6878 (goto-char org-goto-start-pos)
6879 (and (outline-invisible-p) (org-show-context)))
6880 (goto-char (point-min)))
6881 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6882 (message "Select location and press RET")
6883 (use-local-map org-goto-map)
6884 (recursive-edit)
6885 ))
6886 (kill-buffer "*org-goto*")
6887 (cons org-goto-selected-point org-goto-exit-command)))
6889 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6890 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6891 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6892 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6894 (defun org-goto-local-search-headings (string bound noerror)
6895 "Search and make sure that any matches are in headlines."
6896 (catch 'return
6897 (while (if isearch-forward
6898 (search-forward string bound noerror)
6899 (search-backward string bound noerror))
6900 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6901 (and (member :headline context)
6902 (not (member :tags context))))
6903 (throw 'return (point))))))
6905 (defun org-goto-local-auto-isearch ()
6906 "Start isearch."
6907 (interactive)
6908 (goto-char (point-min))
6909 (let ((keys (this-command-keys)))
6910 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6911 (isearch-mode t)
6912 (isearch-process-search-char (string-to-char keys)))))
6914 (defun org-goto-ret (&optional arg)
6915 "Finish `org-goto' by going to the new location."
6916 (interactive "P")
6917 (setq org-goto-selected-point (point)
6918 org-goto-exit-command 'return)
6919 (throw 'exit nil))
6921 (defun org-goto-left ()
6922 "Finish `org-goto' by going to the new location."
6923 (interactive)
6924 (if (org-at-heading-p)
6925 (progn
6926 (beginning-of-line 1)
6927 (setq org-goto-selected-point (point)
6928 org-goto-exit-command 'left)
6929 (throw 'exit nil))
6930 (error "Not on a heading")))
6932 (defun org-goto-right ()
6933 "Finish `org-goto' by going to the new location."
6934 (interactive)
6935 (if (org-at-heading-p)
6936 (progn
6937 (setq org-goto-selected-point (point)
6938 org-goto-exit-command 'right)
6939 (throw 'exit nil))
6940 (error "Not on a heading")))
6942 (defun org-goto-quit ()
6943 "Finish `org-goto' without cursor motion."
6944 (interactive)
6945 (setq org-goto-selected-point nil)
6946 (setq org-goto-exit-command 'quit)
6947 (throw 'exit nil))
6949 ;;; Indirect buffer display of subtrees
6951 (defvar org-indirect-dedicated-frame nil
6952 "This is the frame being used for indirect tree display.")
6953 (defvar org-last-indirect-buffer nil)
6955 (defun org-tree-to-indirect-buffer (&optional arg)
6956 "Create indirect buffer and narrow it to current subtree.
6957 With numerical prefix ARG, go up to this level and then take that tree.
6958 If ARG is negative, go up that many levels.
6959 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6960 indirect buffer previously made with this command, to avoid proliferation of
6961 indirect buffers. However, when you call the command with a \
6963 when `org-indirect-buffer-display' is `new-frame', the last buffer
6964 is kept so that you can work with several indirect buffers at the same time.
6965 If `org-indirect-buffer-display' is `dedicated-frame', the \
6967 requests that a new frame be made for the new buffer, so that the dedicated
6968 frame is not changed."
6969 (interactive "P")
6970 (let ((cbuf (current-buffer))
6971 (cwin (selected-window))
6972 (pos (point))
6973 beg end level heading ibuf)
6974 (save-excursion
6975 (org-back-to-heading t)
6976 (when (numberp arg)
6977 (setq level (org-outline-level))
6978 (if (< arg 0) (setq arg (+ level arg)))
6979 (while (> (setq level (org-outline-level)) arg)
6980 (outline-up-heading 1 t)))
6981 (setq beg (point)
6982 heading (org-get-heading))
6983 (org-end-of-subtree t t)
6984 (if (org-at-heading-p) (backward-char 1))
6985 (setq end (point)))
6986 (if (and (buffer-live-p org-last-indirect-buffer)
6987 (not (eq org-indirect-buffer-display 'new-frame))
6988 (not arg))
6989 (kill-buffer org-last-indirect-buffer))
6990 (setq ibuf (org-get-indirect-buffer cbuf)
6991 org-last-indirect-buffer ibuf)
6992 (cond
6993 ((or (eq org-indirect-buffer-display 'new-frame)
6994 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6995 (select-frame (make-frame))
6996 (delete-other-windows)
6997 (org-pop-to-buffer-same-window ibuf)
6998 (org-set-frame-title heading))
6999 ((eq org-indirect-buffer-display 'dedicated-frame)
7000 (raise-frame
7001 (select-frame (or (and org-indirect-dedicated-frame
7002 (frame-live-p org-indirect-dedicated-frame)
7003 org-indirect-dedicated-frame)
7004 (setq org-indirect-dedicated-frame (make-frame)))))
7005 (delete-other-windows)
7006 (org-pop-to-buffer-same-window ibuf)
7007 (org-set-frame-title (concat "Indirect: " heading)))
7008 ((eq org-indirect-buffer-display 'current-window)
7009 (org-pop-to-buffer-same-window ibuf))
7010 ((eq org-indirect-buffer-display 'other-window)
7011 (pop-to-buffer ibuf))
7012 (t (error "Invalid value")))
7013 (if (featurep 'xemacs)
7014 (save-excursion (org-mode) (turn-on-font-lock)))
7015 (narrow-to-region beg end)
7016 (show-all)
7017 (goto-char pos)
7018 (run-hook-with-args 'org-cycle-hook 'all)
7019 (and (window-live-p cwin) (select-window cwin))))
7021 (defun org-get-indirect-buffer (&optional buffer)
7022 (setq buffer (or buffer (current-buffer)))
7023 (let ((n 1) (base (buffer-name buffer)) bname)
7024 (while (buffer-live-p
7025 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7026 (setq n (1+ n)))
7027 (condition-case nil
7028 (make-indirect-buffer buffer bname 'clone)
7029 (error (make-indirect-buffer buffer bname)))))
7031 (defun org-set-frame-title (title)
7032 "Set the title of the current frame to the string TITLE."
7033 ;; FIXME: how to name a single frame in XEmacs???
7034 (unless (featurep 'xemacs)
7035 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7037 ;;;; Structure editing
7039 ;;; Inserting headlines
7041 (defun org-previous-line-empty-p ()
7042 (save-excursion
7043 (and (not (bobp))
7044 (or (beginning-of-line 0) t)
7045 (save-match-data
7048 (defun org-insert-heading (&optional force-heading invisible-ok)
7049 "Insert a new heading or item with same depth at point.
7050 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7051 If point is at the beginning of a headline, insert a sibling before the
7052 current headline. If point is not at the beginning, split the line,
7053 create the new headline with the text in the current line after point
7054 \(but see also the variable `org-M-RET-may-split-line').
7056 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7057 This is important for non-interactive uses of the command."
7058 (interactive "P")
7059 (if (or (= (buffer-size) 0)
7060 (and (not (save-excursion
7061 (and (ignore-errors (org-back-to-heading invisible-ok))
7062 (org-at-heading-p))))
7063 (or force-heading (not (org-in-item-p)))))
7064 (progn
7066 (run-hooks 'org-insert-heading-hook))
7067 (when (or force-heading (not (org-insert-item)))
7068 (let* ((empty-line-p nil)
7069 (level nil)
7070 (on-heading (org-at-heading-p))
7071 (head (save-excursion
7072 (condition-case nil
7073 (progn
7074 (org-back-to-heading invisible-ok)
7075 (when (and (not on-heading)
7076 (featurep 'org-inlinetask)
7077 (integerp org-inlinetask-min-level)
7078 (>= (length (match-string 0))
7079 org-inlinetask-min-level))
7080 ;; Find a heading level before the inline task
7081 (while (and (setq level (org-up-heading-safe))
7082 (>= level org-inlinetask-min-level)))
7083 (if (org-at-heading-p)
7084 (org-back-to-heading invisible-ok)
7085 (error "This should not happen")))
7086 (setq empty-line-p (org-previous-line-empty-p))
7087 (match-string 0))
7088 (error "*"))))
7089 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7090 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7091 pos hide-previous previous-pos)
7092 (cond
7093 ((and (org-at-heading-p) (bolp)
7094 (or (bobp)
7095 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7096 ;; insert before the current line
7097 (open-line (if blank 2 1)))
7098 ((and (bolp)
7099 (not org-insert-heading-respect-content)
7100 (or (bobp)
7101 (save-excursion
7102 (backward-char 1) (not (outline-invisible-p)))))
7103 ;; insert right here
7104 nil)
7105 (t
7106 ;; somewhere in the line
7107 (save-excursion
7108 (setq previous-pos (point-at-bol))
7109 (end-of-line)
7110 (setq hide-previous (outline-invisible-p)))
7111 (and org-insert-heading-respect-content (org-show-subtree))
7112 (let ((split
7113 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7114 (save-excursion
7115 (let ((p (point)))
7116 (goto-char (point-at-bol))
7117 (and (looking-at org-complex-heading-regexp)
7118 (match-beginning 4)
7119 (> p (match-beginning 4)))))))
7120 tags pos)
7121 (cond
7122 (org-insert-heading-respect-content
7123 (org-end-of-subtree nil t)
7124 (when (featurep 'org-inlinetask)
7125 (while (and (not (eobp))
7127 (>= (length (match-string 1))
7128 org-inlinetask-min-level))
7129 (org-end-of-subtree nil t)))
7130 (or (bolp) (newline))
7131 (or (org-previous-line-empty-p)
7132 (and blank (newline)))
7133 (open-line 1))
7134 ((org-at-heading-p)
7135 (when hide-previous
7136 (show-children)
7137 (org-show-entry))
7139 (setq tags (and (match-end 2) (match-string 2)))
7140 (and (match-end 1)
7141 (delete-region (match-beginning 1) (match-end 1)))
7142 (setq pos (point-at-bol))
7143 (or split (end-of-line 1))
7144 (delete-horizontal-space)
7146 (buffer-substring (point-at-bol) (point)))
7147 (insert " "))
7148 (newline (if blank 2 1))
7149 (when tags
7150 (save-excursion
7151 (goto-char pos)
7152 (end-of-line 1)
7153 (insert " " tags)
7154 (org-set-tags nil 'align))))
7155 (t
7156 (or split (end-of-line 1))
7157 (newline (if blank 2 1)))))))
7158 (insert head) (just-one-space)
7159 (setq pos (point))
7160 (end-of-line 1)
7161 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7162 (when (and org-insert-heading-respect-content hide-previous)
7163 (save-excursion
7164 (goto-char previous-pos)
7165 (hide-subtree)))
7166 (run-hooks 'org-insert-heading-hook)))))
7168 (defun org-get-heading (&optional no-tags no-todo)
7169 "Return the heading of the current entry, without the stars.
7170 When NO-TAGS is non-nil, don't include tags.
7171 When NO-TODO is non-nil, don't include TODO keywords."
7172 (save-excursion
7173 (org-back-to-heading t)
7174 (cond
7175 ((and no-tags no-todo)
7176 (looking-at org-complex-heading-regexp)
7177 (match-string 4))
7178 (no-tags
7179 (looking-at (concat org-outline-regexp
7182 (match-string 1))
7183 (no-todo
7184 (looking-at org-todo-line-regexp)
7185 (match-string 3))
7186 (t (looking-at org-heading-regexp)
7187 (match-string 2)))))
7189 (defun org-heading-components ()
7190 "Return the components of the current heading.
7191 This is a list with the following elements:
7192 - the level as an integer
7193 - the reduced level, different if `org-odd-levels-only' is set.
7194 - the TODO keyword, or nil
7195 - the priority character, like ?A, or nil if no priority is given
7196 - the headline text itself, or the tags string if no headline text
7197 - the tags string, or nil."
7198 (save-excursion
7199 (org-back-to-heading t)
7200 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7201 (list (length (match-string 1))
7202 (org-reduced-level (length (match-string 1)))
7203 (org-match-string-no-properties 2)
7204 (and (match-end 3) (aref (match-string 3) 2))
7205 (org-match-string-no-properties 4)
7206 (org-match-string-no-properties 5)))))
7208 (defun org-get-entry ()
7209 "Get the entry text, after heading, entire subtree."
7210 (save-excursion
7211 (org-back-to-heading t)
7212 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7214 (defun org-insert-heading-after-current ()
7215 "Insert a new heading with same level as current, after current subtree."
7216 (interactive)
7217 (org-back-to-heading)
7218 (org-insert-heading)
7219 (org-move-subtree-down)
7220 (end-of-line 1))
7222 (defun org-insert-heading-respect-content ()
7223 (interactive)
7224 (let ((org-insert-heading-respect-content t))
7225 (org-insert-heading t)))
7227 (defun org-insert-todo-heading-respect-content (&optional force-state)
7228 (interactive "P")
7229 (let ((org-insert-heading-respect-content t))
7230 (org-insert-todo-heading force-state t)))
7232 (defun org-insert-todo-heading (arg &optional force-heading)
7233 "Insert a new heading with the same level and TODO state as current heading.
7234 If the heading has no TODO state, or if the state is DONE, use the first
7235 state (TODO by default). Also with prefix arg, force first state."
7236 (interactive "P")
7237 (when (or force-heading (not (org-insert-item 'checkbox)))
7238 (org-insert-heading force-heading)
7239 (save-excursion
7240 (org-back-to-heading)
7241 (outline-previous-heading)
7242 (looking-at org-todo-line-regexp))
7243 (let*
7244 ((new-mark-x
7245 (if (or arg
7246 (not (match-beginning 2))
7247 (member (match-string 2) org-done-keywords))
7248 (car org-todo-keywords-1)
7249 (match-string 2)))
7250 (new-mark
7251 (or
7252 (run-hook-with-args-until-success
7253 'org-todo-get-default-hook new-mark-x nil)
7254 new-mark-x)))
7255 (beginning-of-line 1)
7256 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7257 (if org-treat-insert-todo-heading-as-state-change
7258 (org-todo new-mark)
7259 (insert new-mark " "))))
7260 (when org-provide-todo-statistics
7261 (org-update-parent-todo-statistics))))
7263 (defun org-insert-subheading (arg)
7264 "Insert a new subheading and demote it.
7265 Works for outline headings and for plain lists alike."
7266 (interactive "P")
7267 (org-insert-heading arg)
7268 (cond
7269 ((org-at-heading-p) (org-do-demote))
7270 ((org-at-item-p) (org-indent-item))))
7272 (defun org-insert-todo-subheading (arg)
7273 "Insert a new subheading with TODO keyword or checkbox and demote it.
7274 Works for outline headings and for plain lists alike."
7275 (interactive "P")
7276 (org-insert-todo-heading arg)
7277 (cond
7278 ((org-at-heading-p) (org-do-demote))
7279 ((org-at-item-p) (org-indent-item))))
7281 ;;; Promotion and Demotion
7283 (defvar org-after-demote-entry-hook nil
7284 "Hook run after an entry has been demoted.
7285 The cursor will be at the beginning of the entry.
7286 When a subtree is being demoted, the hook will be called for each node.")
7288 (defvar org-after-promote-entry-hook nil
7289 "Hook run after an entry has been promoted.
7290 The cursor will be at the beginning of the entry.
7291 When a subtree is being promoted, the hook will be called for each node.")
7293 (defun org-promote-subtree ()
7294 "Promote the entire subtree.
7295 See also `org-promote'."
7296 (interactive)
7297 (save-excursion
7298 (org-with-limited-levels (org-map-tree 'org-promote)))
7299 (org-fix-position-after-promote))
7301 (defun org-demote-subtree ()
7302 "Demote the entire subtree. See `org-demote'.
7303 See also `org-promote'."
7304 (interactive)
7305 (save-excursion
7306 (org-with-limited-levels (org-map-tree 'org-demote)))
7307 (org-fix-position-after-promote))
7310 (defun org-do-promote ()
7311 "Promote the current heading higher up the tree.
7312 If the region is active in `transient-mark-mode', promote all headings
7313 in the region."
7314 (interactive)
7315 (save-excursion
7316 (if (org-region-active-p)
7317 (org-map-region 'org-promote (region-beginning) (region-end))
7318 (org-promote)))
7319 (org-fix-position-after-promote))
7321 (defun org-do-demote ()
7322 "Demote the current heading lower down the tree.
7323 If the region is active in `transient-mark-mode', demote all headings
7324 in the region."
7325 (interactive)
7326 (save-excursion
7327 (if (org-region-active-p)
7328 (org-map-region 'org-demote (region-beginning) (region-end))
7329 (org-demote)))
7330 (org-fix-position-after-promote))
7332 (defun org-fix-position-after-promote ()
7333 "Make sure that after pro/demotion cursor position is right."
7334 (let ((pos (point)))
7335 (when (save-excursion
7336 (beginning-of-line 1)
7337 (looking-at org-todo-line-regexp)
7338 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7339 (cond ((eobp) (insert " "))
7340 ((eolp) (insert " "))
7341 ((equal (char-after) ?\ ) (forward-char 1))))))
7343 (defun org-current-level ()
7344 "Return the level of the current entry, or nil if before the first headline.
7345 The level is the number of stars at the beginning of the headline."
7346 (save-excursion
7347 (org-with-limited-levels
7348 (if (ignore-errors (org-back-to-heading t))
7349 (funcall outline-level)))))
7351 (defun org-get-previous-line-level ()
7352 "Return the outline depth of the last headline before the current line.
7353 Returns 0 for the first headline in the buffer, and nil if before the
7354 first headline."
7355 (let ((current-level (org-current-level))
7356 (prev-level (when (> (line-number-at-pos) 1)
7357 (save-excursion
7358 (beginning-of-line 0)
7359 (org-current-level)))))
7360 (cond ((null current-level) nil) ; Before first headline
7361 ((null prev-level) 0) ; At first headline
7362 (prev-level))))
7364 (defun org-reduced-level (l)
7365 "Compute the effective level of a heading.
7366 This takes into account the setting of `org-odd-levels-only'."
7367 (cond
7368 ((zerop l) 0)
7369 (org-odd-levels-only (1+ (floor (/ l 2))))
7370 (t l)))
7372 (defun org-level-increment ()
7373 "Return the number of stars that will be added or removed at a
7374 time to headlines when structure editing, based on the value of
7375 `org-odd-levels-only'."
7376 (if org-odd-levels-only 2 1))
7378 (defun org-get-valid-level (level &optional change)
7379 "Rectify a level change under the influence of `org-odd-levels-only'
7380 LEVEL is a current level, CHANGE is by how much the level should be
7381 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7382 even level numbers will become the next higher odd number."
7383 (if org-odd-levels-only
7384 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7385 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7386 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7387 (max 1 (+ level (or change 0)))))
7389 (if (boundp 'define-obsolete-function-alias)
7390 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7391 (define-obsolete-function-alias 'org-get-legal-level
7392 'org-get-valid-level)
7393 (define-obsolete-function-alias 'org-get-legal-level
7394 'org-get-valid-level "23.1")))
7396 (defun org-promote ()
7397 "Promote the current heading higher up the tree.
7398 If the region is active in `transient-mark-mode', promote all headings
7399 in the region."
7400 (org-back-to-heading t)
7401 (let* ((level (save-match-data (funcall outline-level)))
7402 (after-change-functions (remove 'flyspell-after-change-function
7403 after-change-functions))
7404 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7405 (diff (abs (- level (length up-head) -1))))
7406 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7407 (replace-match up-head nil t)
7408 ;; Fixup tag positioning
7409 (and org-auto-align-tags (org-set-tags nil t))
7410 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7411 (run-hooks 'org-after-promote-entry-hook)))
7413 (defun org-demote ()
7414 "Demote the current heading lower down the tree.
7415 If the region is active in `transient-mark-mode', demote all headings
7416 in the region."
7417 (org-back-to-heading t)
7418 (let* ((level (save-match-data (funcall outline-level)))
7419 (after-change-functions (remove 'flyspell-after-change-function
7420 after-change-functions))
7421 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7422 (diff (abs (- level (length down-head) -1))))
7423 (replace-match down-head nil t)
7424 ;; Fixup tag positioning
7425 (and org-auto-align-tags (org-set-tags nil t))
7426 (if org-adapt-indentation (org-fixup-indentation diff))
7427 (run-hooks 'org-after-demote-entry-hook)))
7429 (defun org-cycle-level ()
7430 "Cycle the level of an empty headline through possible states.
7431 This goes first to child, then to parent, level, then up the hierarchy.
7432 After top level, it switches back to sibling level."
7433 (interactive)
7434 (let ((org-adapt-indentation nil))
7435 (when (org-point-at-end-of-empty-headline)
7436 (setq this-command 'org-cycle-level) ; Only needed for caching
7437 (let ((cur-level (org-current-level))
7438 (prev-level (org-get-previous-line-level)))
7439 (cond
7440 ;; If first headline in file, promote to top-level.
7441 ((= prev-level 0)
7442 (loop repeat (/ (- cur-level 1) (org-level-increment))
7443 do (org-do-promote)))
7444 ;; If same level as prev, demote one.
7445 ((= prev-level cur-level)
7446 (org-do-demote))
7447 ;; If parent is top-level, promote to top level if not already.
7448 ((= prev-level 1)
7449 (loop repeat (/ (- cur-level 1) (org-level-increment))
7450 do (org-do-promote)))
7451 ;; If top-level, return to prev-level.
7452 ((= cur-level 1)
7453 (loop repeat (/ (- prev-level 1) (org-level-increment))
7454 do (org-do-demote)))
7455 ;; If less than prev-level, promote one.
7456 ((< cur-level prev-level)
7457 (org-do-promote))
7458 ;; If deeper than prev-level, promote until higher than
7459 ;; prev-level.
7460 ((> cur-level prev-level)
7461 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7462 do (org-do-promote))))
7463 t))))
7465 (defun org-map-tree (fun)
7466 "Call FUN for every heading underneath the current one."
7467 (org-back-to-heading)
7468 (let ((level (funcall outline-level)))
7469 (save-excursion
7470 (funcall fun)
7471 (while (and (progn
7472 (outline-next-heading)
7473 (> (funcall outline-level) level))
7474 (not (eobp)))
7475 (funcall fun)))))
7477 (defun org-map-region (fun beg end)
7478 "Call FUN for every heading between BEG and END."
7479 (let ((org-ignore-region t))
7480 (save-excursion
7481 (setq end (copy-marker end))
7482 (goto-char beg)
7483 (if (and (re-search-forward org-outline-regexp-bol nil t)
7484 (< (point) end))
7485 (funcall fun))
7486 (while (and (progn
7487 (outline-next-heading)
7488 (< (point) end))
7489 (not (eobp)))
7490 (funcall fun)))))
7492 (defvar org-property-end-re) ; silence byte-compiler
7493 (defun org-fixup-indentation (diff)
7494 "Change the indentation in the current entry by DIFF.
7495 However, if any line in the current entry has no indentation, or if it
7496 would end up with no indentation after the change, nothing at all is done."
7497 (save-excursion
7498 (let ((end (save-excursion (outline-next-heading)
7499 (point-marker)))
7500 (prohibit (if (> diff 0)
7503 col)
7504 (unless (save-excursion (end-of-line 1)
7505 (re-search-forward prohibit end t))
7506 (while (and (< (point) end)
7508 (goto-char (match-end 0))
7509 (setq col (current-column))
7510 (if (< diff 0) (replace-match ""))
7511 (org-indent-to-column (+ diff col))))
7512 (move-marker end nil))))
7514 (defun org-convert-to-odd-levels ()
7515 "Convert an org-mode file with all levels allowed to one with odd levels.
7516 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7517 level 5 etc."
7518 (interactive)
7519 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7520 (let ((outline-level 'org-outline-level)
7521 (org-odd-levels-only nil) n)
7522 (save-excursion
7523 (goto-char (point-min))
7525 (setq n (- (length (match-string 0)) 2))
7526 (while (>= (setq n (1- n)) 0)
7527 (org-demote))
7528 (end-of-line 1))))))
7530 (defun org-convert-to-oddeven-levels ()
7531 "Convert an org-mode file with only odd levels to one with odd/even levels.
7532 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7533 file contains a section with an even level, conversion would
7534 destroy the structure of the file. An error is signaled in this
7535 case."
7536 (interactive)
7537 (goto-char (point-min))
7538 ;; First check if there are no even levels
7540 (org-show-context t)
7541 (error "Not all levels are odd in this file. Conversion not possible"))
7542 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7543 (let ((outline-regexp org-outline-regexp)
7544 (outline-level 'org-outline-level)
7545 (org-odd-levels-only nil) n)
7546 (save-excursion
7547 (goto-char (point-min))
7549 (setq n (/ (1- (length (match-string 0))) 2))
7550 (while (>= (setq n (1- n)) 0)
7551 (org-promote))
7552 (end-of-line 1))))))
7554 (defun org-tr-level (n)
7555 "Make N odd if required."
7556 (if org-odd-levels-only (1+ (/ n 2)) n))
7558 ;;; Vertical tree motion, cutting and pasting of subtrees
7560 (defun org-move-subtree-up (&optional arg)
7561 "Move the current subtree up past ARG headlines of the same level."
7562 (interactive "p")
7563 (org-move-subtree-down (- (prefix-numeric-value arg))))
7565 (defun org-move-subtree-down (&optional arg)
7566 "Move the current subtree down past ARG headlines of the same level."
7567 (interactive "p")
7568 (setq arg (prefix-numeric-value arg))
7569 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7570 'org-get-last-sibling))
7571 (ins-point (make-marker))
7572 (cnt (abs arg))
7573 (col (current-column))
7574 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7575 ;; Select the tree
7576 (org-back-to-heading)
7577 (setq beg0 (point))
7578 (save-excursion
7579 (setq ne-beg (org-back-over-empty-lines))
7580 (setq beg (point)))
7581 (save-match-data
7582 (save-excursion (outline-end-of-heading)
7583 (setq folded (outline-invisible-p)))
7584 (outline-end-of-subtree))
7585 (outline-next-heading)
7586 (setq ne-end (org-back-over-empty-lines))
7587 (setq end (point))
7588 (goto-char beg0)
7589 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7590 ;; include less whitespace
7591 (save-excursion
7592 (goto-char beg)
7593 (forward-line (- ne-beg ne-end))
7594 (setq beg (point))))
7595 ;; Find insertion point, with error handling
7596 (while (> cnt 0)
7597 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7598 (progn (goto-char beg0)
7599 (error "Cannot move past superior level or buffer limit")))
7600 (setq cnt (1- cnt)))
7601 (if (> arg 0)
7602 ;; Moving forward - still need to move over subtree
7603 (progn (org-end-of-subtree t t)
7604 (save-excursion
7605 (org-back-over-empty-lines)
7606 (or (bolp) (newline)))))
7607 (setq ne-ins (org-back-over-empty-lines))
7608 (move-marker ins-point (point))
7609 (setq txt (buffer-substring beg end))
7610 (org-save-markers-in-region beg end)
7611 (delete-region beg end)
7612 (org-remove-empty-overlays-at beg)
7613 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7614 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7616 (let ((bbb (point)))
7617 (insert-before-markers txt)
7618 (org-reinstall-markers-in-region bbb)
7619 (move-marker ins-point bbb))
7621 (setq ins-end (point))
7622 (goto-char ins-point)
7623 (org-skip-whitespace)
7624 (when (and (< arg 0)
7625 (org-first-sibling-p)
7626 (> ne-ins ne-beg))
7627 ;; Move whitespace back to beginning
7628 (save-excursion
7629 (goto-char ins-end)
7630 (let ((kill-whole-line t))
7631 (kill-line (- ne-ins ne-beg)) (point)))
7633 (move-marker ins-point nil)
7634 (if folded
7635 (hide-subtree)
7636 (org-show-entry)
7637 (show-children)
7638 (org-cycle-hide-drawers 'children))
7639 (org-clean-visibility-after-subtree-move)
7640 ;; move back to the initial column we were at
7641 (move-to-column col)))
7643 (defvar org-subtree-clip ""
7644 "Clipboard for cut and paste of subtrees.
7645 This is actually only a copy of the kill, because we use the normal kill
7646 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7648 (defvar org-subtree-clip-folded nil
7649 "Was the last copied subtree folded?
7650 This is used to fold the tree back after pasting.")
7652 (defun org-cut-subtree (&optional n)
7653 "Cut the current subtree into the clipboard.
7654 With prefix arg N, cut this many sequential subtrees.
7655 This is a short-hand for marking the subtree and then cutting it."
7656 (interactive "p")
7657 (org-copy-subtree n 'cut))
7659 (defun org-copy-subtree (&optional n cut force-store-markers)
7660 "Cut the current subtree into the clipboard.
7661 With prefix arg N, cut this many sequential subtrees.
7662 This is a short-hand for marking the subtree and then copying it.
7663 If CUT is non-nil, actually cut the subtree.
7664 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7665 of some markers in the region, even if CUT is non-nil. This is
7666 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7667 (interactive "p")
7668 (let (beg end folded (beg0 (point)))
7669 (if (org-called-interactively-p 'any)
7670 (org-back-to-heading nil) ; take what looks like a subtree
7671 (org-back-to-heading t)) ; take what is really there
7672 (org-back-over-empty-lines)
7673 (setq beg (point))
7675 (save-match-data
7676 (save-excursion (outline-end-of-heading)
7677 (setq folded (outline-invisible-p)))
7678 (condition-case nil
7679 (org-forward-same-level (1- n) t)
7680 (error nil))
7681 (org-end-of-subtree t t))
7682 (org-back-over-empty-lines)
7683 (setq end (point))
7684 (goto-char beg0)
7685 (when (> end beg)
7686 (setq org-subtree-clip-folded folded)
7687 (when (or cut force-store-markers)
7688 (org-save-markers-in-region beg end))
7689 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7690 (setq org-subtree-clip (current-kill 0))
7691 (message "%s: Subtree(s) with %d characters"
7692 (if cut "Cut" "Copied")
7693 (length org-subtree-clip)))))
7695 (defun org-paste-subtree (&optional level tree for-yank)
7696 "Paste the clipboard as a subtree, with modification of headline level.
7697 The entire subtree is promoted or demoted in order to match a new headline
7698 level.
7700 If the cursor is at the beginning of a headline, the same level as
7701 that headline is used to paste the tree
7703 If not, the new level is derived from the *visible* headings
7704 before and after the insertion point, and taken to be the inferior headline
7705 level of the two. So if the previous visible heading is level 3 and the
7706 next is level 4 (or vice versa), level 4 will be used for insertion.
7707 This makes sure that the subtree remains an independent subtree and does
7708 not swallow low level entries.
7710 You can also force a different level, either by using a numeric prefix
7711 argument, or by inserting the heading marker by hand. For example, if the
7714 If optional TREE is given, use this text instead of the kill ring.
7716 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7717 move back over whitespace before inserting, and move point to the end of
7718 the inserted text when done."
7719 (interactive "P")
7720 (setq tree (or tree (and kill-ring (current-kill 0))))
7721 (unless (org-kill-is-subtree-p tree)
7722 (error "%s"
7723 (substitute-command-keys
7725 (org-with-limited-levels
7726 (let* ((visp (not (outline-invisible-p)))
7727 (txt tree)
7729 (old-level (if (string-match org-outline-regexp-bol txt)
7730 (- (match-end 0) (match-beginning 0) 1)
7731 -1))
7732 (force-level (cond (level (prefix-numeric-value level))
7734 (string-match
7736 (point-at-bol) (point))))
7737 (- (match-end 1) (match-beginning 1)))
7738 ((and (bolp)
7739 (looking-at org-outline-regexp))
7740 (- (match-end 0) (point) 1))
7741 (t nil)))
7742 (previous-level (save-excursion
7743 (condition-case nil
7744 (progn
7745 (outline-previous-visible-heading 1)
7746 (if (looking-at ^re_)
7747 (- (match-end 0) (match-beginning 0) 1)
7748 1))
7749 (error 1))))
7750 (next-level (save-excursion
7751 (condition-case nil
7752 (progn
7753 (or (looking-at org-outline-regexp)
7754 (outline-next-visible-heading 1))
7755 (if (looking-at ^re_)
7756 (- (match-end 0) (match-beginning 0) 1)
7757 1))
7758 (error 1))))
7759 (new-level (or force-level (max previous-level next-level)))
7760 (shift (if (or (= old-level -1)
7761 (= new-level -1)
7762 (= old-level new-level))
7763 0
7764 (- new-level old-level)))
7765 (delta (if (> shift 0) -1 1))
7766 (func (if (> shift 0) 'org-demote 'org-promote))
7767 (org-odd-levels-only nil)
7768 beg end newend)
7769 ;; Remove the forced level indicator
7770 (if force-level
7771 (delete-region (point-at-bol) (point)))
7772 ;; Paste
7773 (beginning-of-line (if (bolp) 1 2))
7774 (unless for-yank (org-back-over-empty-lines))
7775 (setq beg (point))
7776 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7777 (insert-before-markers txt)
7779 (setq newend (point))
7780 (org-reinstall-markers-in-region beg)
7781 (setq end (point))
7782 (goto-char beg)
7784 (setq beg (point))
7785 (if (and (outline-invisible-p) visp)
7786 (save-excursion (outline-show-heading)))
7787 ;; Shift if necessary
7788 (unless (= shift 0)
7789 (save-restriction
7790 (narrow-to-region beg end)
7791 (while (not (= shift 0))
7792 (org-map-region func (point-min) (point-max))
7793 (setq shift (+ delta shift)))
7794 (goto-char (point-min))
7795 (setq newend (point-max))))
7796 (when (or (org-called-interactively-p 'interactive) for-yank)
7797 (message "Clipboard pasted as level %d subtree" new-level))
7798 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7799 kill-ring
7800 (eq org-subtree-clip (current-kill 0))
7801 org-subtree-clip-folded)
7802 ;; The tree was folded before it was killed/copied
7803 (hide-subtree))
7804 (and for-yank (goto-char newend)))))
7806 (defun org-kill-is-subtree-p (&optional txt)
7807 "Check if the current kill is an outline subtree, or a set of trees.
7808 Returns nil if kill does not start with a headline, or if the first
7809 headline level is not the largest headline level in the tree.
7810 So this will actually accept several entries of equal levels as well,
7811 which is OK for `org-paste-subtree'.
7812 If optional TXT is given, check this string instead of the current kill."
7813 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7814 (re (org-get-limited-outline-regexp))
7815 (^re (concat "^" re))
7816 (start-level (and kill
7817 (string-match
7819 kill)
7820 (- (match-end 2) (match-beginning 2) 1)))
7821 (start (1+ (or (match-beginning 2) -1))))
7822 (if (not start-level)
7823 (progn
7824 nil) ;; does not even start with a heading
7825 (catch 'exit
7826 (while (setq start (string-match ^re kill (1+ start)))
7827 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7828 (throw 'exit nil)))
7829 t))))
7831 (defvar org-markers-to-move nil
7832 "Markers that should be moved with a cut-and-paste operation.
7833 Those markers are stored together with their positions relative to
7834 the start of the region.")
7836 (defun org-save-markers-in-region (beg end)
7837 "Check markers in region.
7838 If these markers are between BEG and END, record their position relative
7839 to BEG, so that after moving the block of text, we can put the markers back
7840 into place.
7841 This function gets called just before an entry or tree gets cut from the
7842 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7843 called immediately, to move the markers with the entries."
7844 (setq org-markers-to-move nil)
7845 (when (featurep 'org-clock)
7846 (org-clock-save-markers-for-cut-and-paste beg end))
7847 (when (featurep 'org-agenda)
7848 (org-agenda-save-markers-for-cut-and-paste beg end)))
7850 (defun org-check-and-save-marker (marker beg end)
7851 "Check if MARKER is between BEG and END.
7852 If yes, remember the marker and the distance to BEG."
7853 (when (and (marker-buffer marker)
7854 (equal (marker-buffer marker) (current-buffer)))
7855 (if (and (>= marker beg) (< marker end))
7856 (push (cons marker (- marker beg)) org-markers-to-move))))
7858 (defun org-reinstall-markers-in-region (beg)
7859 "Move all remembered markers to their position relative to BEG."
7860 (mapc (lambda (x)
7861 (move-marker (car x) (+ beg (cdr x))))
7862 org-markers-to-move)
7863 (setq org-markers-to-move nil))
7865 (defun org-narrow-to-subtree ()
7866 "Narrow buffer to the current subtree."
7867 (interactive)
7868 (save-excursion
7869 (save-match-data
7870 (org-with-limited-levels
7871 (narrow-to-region
7872 (progn (org-back-to-heading t) (point))
7873 (progn (org-end-of-subtree t t)
7874 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7875 (point)))))))
7877 (defun org-narrow-to-block ()
7878 "Narrow buffer to the current block."
7879 (interactive)
7880 (let* ((case-fold-search t)
7883 (if blockp
7884 (narrow-to-region (car blockp) (cdr blockp))
7885 (error "Not in a block"))))
7887 (eval-when-compile
7888 (defvar org-property-drawer-re))
7890 (defvar org-property-start-re) ;; defined below
7891 (defun org-clone-subtree-with-time-shift (n &optional shift)
7892 "Clone the task (subtree) at point N times.
7893 The clones will be inserted as siblings.
7895 In interactive use, the user will be prompted for the number of
7896 clones to be produced, and for a time SHIFT, which may be a
7897 repeater as used in time stamps, for example `+3d'.
7899 When a valid repeater is given and the entry contains any time
7900 stamps, the clones will become a sequence in time, with time
7901 stamps in the subtree shifted for each clone produced. If SHIFT
7902 is nil or the empty string, time stamps will be left alone. The
7903 ID property of the original subtree is removed.
7905 If the original subtree did contain time stamps with a repeater,
7906 the following will happen:
7907 - the repeater will be removed in each clone
7908 - an additional clone will be produced, with the current, unshifted
7909 date(s) in the entry.
7910 - the original entry will be placed *after* all the clones, with
7911 repeater intact.
7912 - the start days in the repeater in the original entry will be shifted
7913 to past the last clone.
7914 In this way you can spell out a number of instances of a repeating task,
7915 and still retain the repeater to cover future instances of the task."
7916 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7917 (let (beg end template task idprop
7918 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7919 (drawer-re org-drawer-regexp))
7920 (if (not (and (integerp n) (> n 0)))
7921 (error "Invalid number of replications %s" n))
7924 shift)))
7925 (error "Invalid shift specification %s" shift))
7926 (when doshift
7927 (setq shift-n (string-to-number (match-string 1 shift))
7928 shift-what (cdr (assoc (match-string 2 shift)
7929 '(("d" . day) ("w" . week)
7930 ("m" . month) ("y" . year))))))
7931 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7932 (setq nmin 1 nmax n)
7933 (org-back-to-heading t)
7934 (setq beg (point))
7935 (setq idprop (org-entry-get nil "ID"))
7936 (org-end-of-subtree t t)
7938 (setq end (point))
7939 (setq template (buffer-substring beg end))
7940 (when (and doshift
7942 (delete-region beg end)
7943 (setq end beg)
7944 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7945 (goto-char end)
7946 (loop for n from nmin to nmax do
7947 ;; prepare clone
7948 (with-temp-buffer
7949 (insert template)
7950 (org-mode)
7951 (goto-char (point-min))
7952 (org-show-subtree)
7953 (and idprop (if org-clone-delete-id
7954 (org-entry-delete nil "ID")
7955 (org-id-get-create t)))
7956 (unless (= n 0)
7958 (kill-whole-line))
7959 (goto-char (point-min))
7960 (while (re-search-forward drawer-re nil t)
7961 (mapc (lambda (d)
7962 (org-remove-empty-drawer-at d (point))) org-drawers)))
7963 (goto-char (point-min))
7964 (when doshift
7965 (while (re-search-forward org-ts-regexp-both nil t)
7966 (org-timestamp-change (* n shift-n) shift-what))
7967 (unless (= n n-no-remove)
7968 (goto-char (point-min))
7969 (while (re-search-forward org-ts-regexp nil t)
7970 (save-excursion
7971 (goto-char (match-beginning 0))
7973 (delete-region (match-beginning 1) (match-end 1)))))))
7974 (setq task (buffer-string)))
7975 (insert task))
7976 (goto-char beg)))
7978 ;;; Outline Sorting
7980 (defun org-sort (with-case)
7981 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7982 Optional argument WITH-CASE means sort case-sensitively."
7983 (interactive "P")
7984 (cond
7985 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7986 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7987 (t
7988 (org-call-with-arg 'org-sort-entries with-case))))
7990 (defun org-sort-remove-invisible (s)
7991 (remove-text-properties 0 (length s) org-rm-props s)
7992 (while (string-match org-bracket-link-regexp s)
7993 (setq s (replace-match (if (match-end 2)
7994 (match-string 3 s)
7995 (match-string 1 s)) t t s)))
7996 s)
7998 (defvar org-priority-regexp) ; defined later in the file
8000 (defvar org-after-sorting-entries-or-items-hook nil
8001 "Hook that is run after a bunch of entries or items have been sorted.
8002 When children are sorted, the cursor is in the parent line when this
8003 hook gets called. When a region or a plain list is sorted, the cursor
8004 will be in the first entry of the sorted region/list.")
8006 (defun org-sort-entries
8007 (&optional with-case sorting-type getkey-func compare-func property)
8008 "Sort entries on a certain level of an outline tree.
8009 If there is an active region, the entries in the region are sorted.
8010 Else, if the cursor is before the first entry, sort the top-level items.
8011 Else, the children of the entry at point are sorted.
8013 Sorting can be alphabetically, numerically, by date/time as given by
8014 a time stamp, by a property or by priority.
8016 The command prompts for the sorting type unless it has been given to the
8017 function through the SORTING-TYPE argument, which needs to be a character,
8018 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8019 precise meaning of each character:
8021 n Numerically, by converting the beginning of the entry/item to a number.
8022 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8023 t By date/time, either the first active time stamp in the entry, or, if
8024 none exist, by the first inactive one.
8025 s By the scheduled date/time.
8026 d By deadline date/time.
8027 c By creation time, which is assumed to be the first inactive time stamp
8028 at the beginning of a line.
8029 p By priority according to the cookie.
8030 r By the value of a property.
8032 Capital letters will reverse the sort order.
8034 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8035 called with point at the beginning of the record. It must return either
8036 a string or a number that should serve as the sorting key for that record.
8038 Comparing entries ignores case by default. However, with an optional argument
8039 WITH-CASE, the sorting considers case as well."
8040 (interactive "P")
8041 (let ((case-func (if with-case 'identity 'downcase))
8042 start beg end stars re re2
8043 txt what tmp)
8044 ;; Find beginning and end of region to sort
8045 (cond
8046 ((org-region-active-p)
8047 ;; we will sort the region
8048 (setq end (region-end)
8049 what "region")
8050 (goto-char (region-beginning))
8051 (if (not (org-at-heading-p)) (outline-next-heading))
8052 (setq start (point)))
8053 ((or (org-at-heading-p)
8054 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8055 ;; we will sort the children of the current headline
8056 (org-back-to-heading)
8057 (setq start (point)
8058 end (progn (org-end-of-subtree t t)
8060 (org-back-over-empty-lines)
8061 (point))
8062 what "children")
8063 (goto-char start)
8064 (show-subtree)
8065 (outline-next-heading))
8066 (t
8067 ;; we will sort the top-level entries in this file
8068 (goto-char (point-min))
8069 (or (org-at-heading-p) (outline-next-heading))
8070 (setq start (point))
8071 (goto-char (point-max))
8072 (beginning-of-line 1)
8074 ;; File ends in a non-white line
8075 (end-of-line 1)
8077 (setq end (point-max))
8078 (setq what "top-level")
8079 (goto-char start)
8080 (show-all)))
8082 (setq beg (point))
8083 (if (>= beg end) (error "Nothing to sort"))
8086 (setq stars (match-string 1)
8087 re (concat "^" (regexp-quote stars) " +")
8089 txt (buffer-substring beg end))
8091 (if (and (not (equal stars "*")) (string-match re2 txt))
8092 (error "Region to sort contains a level above the first entry"))
8094 (unless sorting-type
8095 (message
8096 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8098 A/N/T/S/D/C/P/O/F means reversed:"
8099 what)
8100 (setq sorting-type (read-char-exclusive))
8102 (and (= (downcase sorting-type) ?f)
8103 (setq getkey-func
8104 (org-icompleting-read "Sort using function: "
8105 obarray 'fboundp t nil nil))
8106 (setq getkey-func (intern getkey-func)))
8108 (and (= (downcase sorting-type) ?r)
8109 (setq property
8110 (org-icompleting-read "Property: "
8111 (mapcar 'list (org-buffer-property-keys t))
8112 nil t))))
8114 (message "Sorting entries...")
8116 (save-restriction
8117 (narrow-to-region start end)
8118 (let ((dcst (downcase sorting-type))
8119 (case-fold-search nil)
8120 (now (current-time)))
8121 (sort-subr
8122 (/= dcst sorting-type)
8123 ;; This function moves to the beginning character of the "record" to
8124 ;; be sorted.
8125 (lambda nil
8126 (if (re-search-forward re nil t)
8127 (goto-char (match-beginning 0))
8128 (goto-char (point-max))))
8129 ;; This function moves to the last character of the "record" being
8130 ;; sorted.
8131 (lambda nil
8132 (save-match-data
8133 (condition-case nil
8134 (outline-forward-same-level 1)
8135 (error
8136 (goto-char (point-max))))))
8137 ;; This function returns the value that gets sorted against.
8138 (lambda nil
8139 (cond
8140 ((= dcst ?n)
8141 (if (looking-at org-complex-heading-regexp)
8142 (string-to-number (match-string 4))
8143 nil))
8144 ((= dcst ?a)
8145 (if (looking-at org-complex-heading-regexp)
8146 (funcall case-func (match-string 4))
8147 nil))
8148 ((= dcst ?t)
8149 (let ((end (save-excursion (outline-next-heading) (point))))
8150 (if (or (re-search-forward org-ts-regexp end t)
8151 (re-search-forward org-ts-regexp-both end t))
8152 (org-time-string-to-seconds (match-string 0))
8153 (org-float-time now))))
8154 ((= dcst ?c)
8155 (let ((end (save-excursion (outline-next-heading) (point))))
8156 (if (re-search-forward
8158 end t)
8159 (org-time-string-to-seconds (match-string 0))
8160 (org-float-time now))))
8161 ((= dcst ?s)
8162 (let ((end (save-excursion (outline-next-heading) (point))))
8163 (if (re-search-forward org-scheduled-time-regexp end t)
8164 (org-time-string-to-seconds (match-string 1))
8165 (org-float-time now))))
8166 ((= dcst ?d)
8167 (let ((end (save-excursion (outline-next-heading) (point))))
8168 (if (re-search-forward org-deadline-time-regexp end t)
8169 (org-time-string-to-seconds (match-string 1))
8170 (org-float-time now))))
8171 ((= dcst ?p)
8172 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8173 (string-to-char (match-string 2))
8174 org-default-priority))
8175 ((= dcst ?r)
8176 (or (org-entry-get nil property) ""))
8177 ((= dcst ?o)
8178 (if (looking-at org-complex-heading-regexp)
8179 (- 9999 (length (member (match-string 2)
8180 org-todo-keywords-1)))))
8181 ((= dcst ?f)
8182 (if getkey-func
8183 (progn
8184 (setq tmp (funcall getkey-func))
8185 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8186 tmp)
8187 (error "Invalid key function `%s'" getkey-func)))
8188 (t (error "Invalid sorting type `%c'" sorting-type))))
8189 nil
8190 (cond
8191 ((= dcst ?a) 'string<)
8192 ((= dcst ?f) compare-func)
8193 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8194 (t nil)))))
8195 (run-hooks 'org-after-sorting-entries-or-items-hook)
8196 (message "Sorting entries...done")))
8198 (defun org-do-sort (table what &optional with-case sorting-type)
8199 "Sort TABLE of WHAT according to SORTING-TYPE.
8200 The user will be prompted for the SORTING-TYPE if the call to this
8201 function does not specify it. WHAT is only for the prompt, to indicate
8202 what is being sorted. The sorting key will be extracted from
8203 the car of the elements of the table.
8204 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8205 (unless sorting-type
8206 (message
8207 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8208 what)
8209 (setq sorting-type (read-char-exclusive)))
8210 (let ((dcst (downcase sorting-type))
8211 extractfun comparefun)
8212 ;; Define the appropriate functions
8213 (cond
8214 ((= dcst ?n)
8215 (setq extractfun 'string-to-number
8216 comparefun (if (= dcst sorting-type) '< '>)))
8217 ((= dcst ?a)
8218 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8219 (lambda(x) (downcase (org-sort-remove-invisible x))))
8220 comparefun (if (= dcst sorting-type)
8221 'string<
8222 (lambda (a b) (and (not (string< a b))
8223 (not (string= a b)))))))
8224 ((= dcst ?t)
8225 (setq extractfun
8226 (lambda (x)
8227 (if (or (string-match org-ts-regexp x)
8228 (string-match org-ts-regexp-both x))
8229 (org-float-time
8230 (org-time-string-to-time (match-string 0 x)))
8231 0))
8232 comparefun (if (= dcst sorting-type) '< '>)))
8233 (t (error "Invalid sorting type `%c'" sorting-type)))
8235 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8236 table)
8237 (lambda (a b) (funcall comparefun (car a) (car b))))))
8240 ;;; The orgstruct minor mode
8242 ;; Define a minor mode which can be used in other modes in order to
8243 ;; integrate the org-mode structure editing commands.
8245 ;; This is really a hack, because the org-mode structure commands use
8246 ;; keys which normally belong to the major mode. Here is how it
8247 ;; works: The minor mode defines all the keys necessary to operate the
8248 ;; structure commands, but wraps the commands into a function which
8249 ;; tests if the cursor is currently at a headline or a plain list
8250 ;; item. If that is the case, the structure command is used,
8251 ;; temporarily setting many Org-mode variables like regular
8252 ;; expressions for filling etc. However, when any of those keys is
8253 ;; used at a different location, function uses `key-binding' to look
8254 ;; up if the key has an associated command in another currently active
8255 ;; keymap (minor modes, major mode, global), and executes that
8256 ;; command. There might be problems if any of the keys is otherwise
8257 ;; used as a prefix key.
8259 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8260 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8261 ;; addresses this by checking explicitly for both bindings.
8263 (defvar orgstruct-mode-map (make-sparse-keymap)
8264 "Keymap for the minor `orgstruct-mode'.")
8266 (defvar org-local-vars nil
8267 "List of local variables, for use by `orgstruct-mode'.")
8269 ;;;###autoload
8270 (define-minor-mode orgstruct-mode
8271 "Toggle the minor mode `orgstruct-mode'.
8272 This mode is for using Org-mode structure commands in other
8273 modes. The following keys behave as if Org-mode were active, if
8274 the cursor is on a headline, or on a plain list item (both as
8275 defined by Org-mode).
8277 M-up Move entry/item up
8278 M-down Move entry/item down
8279 M-left Promote
8280 M-right Demote
8281 M-S-up Move entry/item up
8282 M-S-down Move entry/item down
8283 M-S-left Promote subtree
8284 M-S-right Demote subtree
8285 M-q Fill paragraph and items like in Org-mode
8286 C-c ^ Sort entries
8287 C-c - Cycle list bullet
8288 TAB Cycle item visibility
8289 M-RET Insert new heading/item
8290 S-M-RET Insert new TODO heading / Checkbox item
8291 C-c C-c Set tags / toggle checkbox"
8292 nil " OrgStruct" nil
8293 (org-load-modules-maybe)
8294 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8296 ;;;###autoload
8297 (defun turn-on-orgstruct ()
8298 "Unconditionally turn on `orgstruct-mode'."
8299 (orgstruct-mode 1))
8301 (defun orgstruct++-mode (&optional arg)
8302 "Toggle `orgstruct-mode', the enhanced version of it.
8303 In addition to setting orgstruct-mode, this also exports all indentation
8304 and autofilling variables from org-mode into the buffer. It will also
8305 recognize item context in multiline items.
8306 Note that turning off orgstruct-mode will *not* remove the
8307 indentation/paragraph settings. This can only be done by refreshing the
8309 (interactive "P")
8310 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8311 (if (< arg 1)
8312 (orgstruct-mode -1)
8313 (orgstruct-mode 1)
8314 (let (var val)
8315 (mapc
8316 (lambda (x)
8317 (when (string-match
8319 (symbol-name (car x)))
8320 (setq var (car x) val (nth 1 x))
8321 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8322 org-local-vars)
8323 (org-set-local 'orgstruct-is-++ t))))
8325 (defvar orgstruct-is-++ nil
8326 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8327 (make-variable-buffer-local 'orgstruct-is-++)
8329 ;;;###autoload
8330 (defun turn-on-orgstruct++ ()
8331 "Unconditionally turn on `orgstruct++-mode'."
8332 (orgstruct++-mode 1))
8334 (defun orgstruct-error ()
8335 "Error when there is no default binding for a structure key."
8336 (interactive)
8337 (error "This key has no function outside structure elements"))
8339 (defun orgstruct-setup ()
8340 "Setup orgstruct keymaps."
8341 (let ((nfunc 0)
8342 (bindings
8343 (list
8344 '([(meta up)] org-metaup)
8345 '([(meta down)] org-metadown)
8346 '([(meta left)] org-metaleft)
8347 '([(meta right)] org-metaright)
8348 '([(meta shift up)] org-shiftmetaup)
8349 '([(meta shift down)] org-shiftmetadown)
8350 '([(meta shift left)] org-shiftmetaleft)
8351 '([(meta shift right)] org-shiftmetaright)
8352 '([?\e (up)] org-metaup)
8353 '([?\e (down)] org-metadown)
8354 '([?\e (left)] org-metaleft)
8355 '([?\e (right)] org-metaright)
8356 '([?\e (shift up)] org-shiftmetaup)
8357 '([?\e (shift down)] org-shiftmetadown)
8358 '([?\e (shift left)] org-shiftmetaleft)
8359 '([?\e (shift right)] org-shiftmetaright)
8360 '([(shift up)] org-shiftup)
8361 '([(shift down)] org-shiftdown)
8362 '([(shift left)] org-shiftleft)
8363 '([(shift right)] org-shiftright)
8364 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8365 '("\M-q" fill-paragraph)
8366 '("\C-c^" org-sort)
8367 '("\C-c-" org-cycle-list-bullet)))
8368 elt key fun cmd)
8369 (while (setq elt (pop bindings))
8370 (setq nfunc (1+ nfunc))
8371 (setq key (org-key (car elt))
8372 fun (nth 1 elt)
8373 cmd (orgstruct-make-binding fun nfunc key))
8374 (org-defkey orgstruct-mode-map key cmd))
8376 ;; Special treatment needed for TAB and RET
8377 (org-defkey orgstruct-mode-map [(tab)]
8378 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8379 (org-defkey orgstruct-mode-map "\C-i"
8380 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8382 (org-defkey orgstruct-mode-map "\M-\C-m"
8383 (orgstruct-make-binding 'org-insert-heading 105
8384 "\M-\C-m" [(meta return)]))
8385 (org-defkey orgstruct-mode-map [(meta return)]
8386 (orgstruct-make-binding 'org-insert-heading 106
8387 [(meta return)] "\M-\C-m"))
8389 (org-defkey orgstruct-mode-map [(shift meta return)]
8390 (orgstruct-make-binding 'org-insert-todo-heading 107
8391 [(meta return)] "\M-\C-m"))
8393 (org-defkey orgstruct-mode-map "\e\C-m"
8394 (orgstruct-make-binding 'org-insert-heading 108
8395 "\e\C-m" [?\e (return)]))
8396 (org-defkey orgstruct-mode-map [?\e (return)]
8397 (orgstruct-make-binding 'org-insert-heading 109
8398 [?\e (return)] "\e\C-m"))
8399 (org-defkey orgstruct-mode-map [?\e (shift return)]
8400 (orgstruct-make-binding 'org-insert-todo-heading 110
8401 [?\e (return)] "\e\C-m"))
8403 (unless org-local-vars
8404 (setq org-local-vars (org-get-local-variables)))
8406 t))
8408 (defun orgstruct-make-binding (fun n &rest keys)
8409 "Create a function for binding in the structure minor mode.
8410 FUN is the command to call inside a table. N is used to create a unique
8411 command name. KEYS are keys that should be checked in for a command
8412 to execute outside of tables."
8413 (eval
8414 (list 'defun
8415 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8416 '(arg)
8418 "Outside of structure, run the binding of `"
8419 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8420 "'.")
8421 '(interactive "p")
8422 (list 'if
8423 `(org-context-p 'headline 'item
8424 (and orgstruct-is-++
8425 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8426 'item-body))
8427 (list 'org-run-like-in-org-mode (list 'quote fun))
8428 (list 'let '(orgstruct-mode)
8429 (list 'call-interactively
8430 (append '(or)
8431 (mapcar (lambda (k)
8432 (list 'key-binding k))
8433 keys)
8434 '('orgstruct-error))))))))
8436 (defun org-context-p (&rest contexts)
8437 "Check if local context is any of CONTEXTS.
8438 Possible values in the list of contexts are `table', `headline', and `item'."
8439 (let ((pos (point)))
8440 (goto-char (point-at-bol))
8441 (prog1 (or (and (memq 'table contexts)
8443 (and (memq 'headline contexts)
8444 (looking-at org-outline-regexp))
8445 (and (memq 'item contexts)
8447 (and (memq 'item-body contexts)
8448 (org-in-item-p)))
8449 (goto-char pos))))
8451 (defun org-get-local-variables ()
8452 "Return a list of all local variables in an org-mode buffer."
8453 (let (varlist)
8454 (with-current-buffer (get-buffer-create "*Org tmp*")
8455 (erase-buffer)
8456 (org-mode)
8457 (setq varlist (buffer-local-variables)))
8458 (kill-buffer "*Org tmp*")
8459 (delq nil
8460 (mapcar
8461 (lambda (x)
8462 (setq x
8463 (if (symbolp x)
8464 (list x)
8465 (list (car x) (list 'quote (cdr x)))))
8466 (if (string-match
8467 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8468 (symbol-name (car x)))
8469 x nil))
8470 varlist))))
8472 (defun org-clone-local-variables (from-buffer &optional regexp)
8473 "Clone local variables from FROM-BUFFER.
8474 Optional argument REGEXP selects variables to clone."
8475 (mapc
8476 (lambda (pair)
8477 (and (symbolp (car pair))
8478 (or (null regexp)
8479 (string-match regexp (symbol-name (car pair))))
8480 (set (make-local-variable (car pair))
8481 (cdr pair))))
8482 (buffer-local-variables from-buffer)))
8484 ;;;###autoload
8485 (defun org-run-like-in-org-mode (cmd)
8486 "Run a command, pretending that the current buffer is in Org-mode.
8487 This will temporarily bind local variables that are typically bound in
8488 Org-mode to the values they have in Org-mode, and then interactively
8489 call CMD."
8490 (org-load-modules-maybe)
8491 (unless org-local-vars
8492 (setq org-local-vars (org-get-local-variables)))
8493 (eval (list 'let org-local-vars
8494 (list 'call-interactively (list 'quote cmd)))))
8496 ;;;; Archiving
8498 (defun org-get-category (&optional pos force-refresh)
8499 "Get the category applying to position POS."
8500 (save-match-data
8501 (if force-refresh (org-refresh-category-properties))
8502 (let ((pos (or pos (point))))
8503 (or (get-text-property pos 'org-category)
8504 (progn (org-refresh-category-properties)
8505 (get-text-property pos 'org-category))))))
8507 (defun org-refresh-category-properties ()
8508 "Refresh category text properties in the buffer."
8509 (let ((def-cat (cond
8510 ((null org-category)
8511 (if buffer-file-name
8512 (file-name-sans-extension
8513 (file-name-nondirectory buffer-file-name))
8514 "???"))
8515 ((symbolp org-category) (symbol-name org-category))
8516 (t org-category)))
8517 beg end cat pos optionp)
8518 (org-unmodified
8519 (save-excursion
8520 (save-restriction
8521 (widen)
8522 (goto-char (point-min))
8523 (put-text-property (point) (point-max) 'org-category def-cat)
8524 (while (re-search-forward
8526 (setq pos (match-end 0)
8527 optionp (equal (char-after (match-beginning 0)) ?#)
8528 cat (org-trim (match-string 2)))
8529 (if optionp
8530 (setq beg (point-at-bol) end (point-max))
8531 (org-back-to-heading t)
8532 (setq beg (point) end (org-end-of-subtree t t)))
8533 (put-text-property beg end 'org-category cat)
8534 (put-text-property beg end 'org-category-position beg)
8535 (goto-char pos)))))))
8538 ;;;; Link Stuff
8540 ;;; Link abbreviations
8542 (defun org-link-expand-abbrev (link)
8543 "Apply replacements as defined in `org-link-abbrev-alist."
8545 (let* ((key (match-string 1 link))
8546 (as (or (assoc key org-link-abbrev-alist-local)
8547 (assoc key org-link-abbrev-alist)))
8548 (tag (and (match-end 2) (match-string 3 link)))
8549 rpl)
8550 (if (not as)
8551 link
8552 (setq rpl (cdr as))
8553 (cond
8554 ((symbolp rpl) (funcall rpl tag))
8555 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8556 ((string-match "%h" rpl)
8557 (replace-match (url-hexify-string (or tag "")) t t rpl))
8558 (t (concat rpl tag)))))
8559 link))
8561 ;;; Storing and inserting links
8563 (defvar org-insert-link-history nil
8564 "Minibuffer history for links inserted with `org-insert-link'.")
8566 (defvar org-stored-links nil
8567 "Contains the links stored with `org-store-link'.")
8569 (defvar org-store-link-plist nil
8570 "Plist with info about the most recently link created with `org-store-link'.")
8572 (defvar org-link-protocols nil
8573 "Link protocols added to Org-mode using `org-add-link-type'.")
8575 (defvar org-store-link-functions nil
8576 "List of functions that are called to create and store a link.
8577 Each function will be called in turn until one returns a non-nil
8578 value. Each function should check if it is responsible for creating
8579 this link (for example by looking at the major mode).
8580 If not, it must exit and return nil.
8581 If yes, it should return a non-nil value after a calling
8582 `org-store-link-props' with a list of properties and values.
8583 Special properties are:
8587 This is obligatory as well.
8588 :description Optional default description for the second pair
8589 of brackets in an Org-mode link. The user can still change
8590 this when inserting this link into an Org-mode buffer.
8592 In addition to these, any additional properties can be specified
8593 and then used in remember templates.")
8595 (defun org-add-link-type (type &optional follow export)
8596 "Add TYPE to the list of `org-link-types'.
8597 Re-compute all regular expressions depending on `org-link-types'
8599 FOLLOW and EXPORT are two functions.
8601 FOLLOW should take the link path as the single argument and do whatever
8602 is necessary to follow the link, for example find a file or display
8603 a mail message.
8605 EXPORT should format the link path for export to one of the export formats.
8606 It should be a function accepting three arguments:
8609 desc the description of the link, if any, or a description added by
8610 org-export-normalize-links if there is none
8611 format the export format, a symbol like `html' or `latex' or `ascii'..
8613 The function may use the FORMAT information to return different values
8614 depending on the format. The return value will be put literally into
8615 the exported file. If the return value is nil, this means Org should
8616 do what it normally does with links which do not have EXPORT defined.
8618 Org-mode has a built-in default for exporting links. If you are happy with
8619 this default, there is no need to define an export function for the link
8620 type. For a simple example of an export function, see `org-bbdb.el'."
8621 (add-to-list 'org-link-types type t)
8622 (org-make-link-regexps)
8623 (if (assoc type org-link-protocols)
8624 (setcdr (assoc type org-link-protocols) (list follow export))
8625 (push (list type follow export) org-link-protocols)))
8627 (defvar org-agenda-buffer-name)
8629 ;;;###autoload
8630 (defun org-store-link (arg)
8632 This link is added to `org-stored-links' and can later be inserted
8635 For some link types, a prefix arg is interpreted:
8636 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8637 For file links, arg negates `org-context-in-file-links'."
8638 (interactive "P")
8639 (org-load-modules-maybe)
8640 (setq org-store-link-plist nil) ; reset
8641 (org-with-limited-levels
8642 (let (link cpltxt desc description search txt custom-id agenda-link)
8643 (cond
8645 ((run-hook-with-args-until-success 'org-store-link-functions)
8646 (setq link (plist-get org-store-link-plist :link)
8647 desc (or (plist-get org-store-link-plist :description) link)))
8649 ((org-src-edit-buffer-p)
8650 (let (label gc)
8651 (while (or (not label)
8652 (save-excursion
8653 (save-restriction
8654 (widen)
8655 (goto-char (point-min))
8656 (re-search-forward
8657 (regexp-quote (format org-coderef-label-format label))
8658 nil t))))
8659 (when label (message "Label exists already") (sit-for 2))
8660 (setq label (read-string "Code line label: " label)))
8661 (end-of-line 1)
8662 (setq link (format org-coderef-label-format label))
8663 (setq gc (- 79 (length link)))
8664 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8665 (insert link)
8666 (setq link (concat "(" label ")") desc nil)))
8668 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8669 ;; We are in the agenda, link to referenced location
8670 (let ((m (or (get-text-property (point) 'org-hd-marker)
8671 (get-text-property (point) 'org-marker))))
8672 (when m
8673 (org-with-point-at m
8674 (setq agenda-link
8675 (if (org-called-interactively-p 'any)
8676 (call-interactively 'org-store-link)
8677 (org-store-link nil)))))))
8679 ((eq major-mode 'calendar-mode)
8680 (let ((cd (calendar-cursor-to-date)))
8681 (setq link
8682 (format-time-string
8683 (car org-time-stamp-formats)
8684 (apply 'encode-time
8685 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8686 nil nil nil))))
8687 (org-store-link-props :type "calendar" :date cd)))
8689 ((eq major-mode 'w3-mode)
8690 (setq cpltxt (if (and (buffer-name)
8691 (not (string-match "Untitled" (buffer-name))))
8692 (buffer-name)
8693 (url-view-url t))
8694 link (org-make-link (url-view-url t)))
8695 (org-store-link-props :type "w3" :url (url-view-url t)))
8697 ((eq major-mode 'w3m-mode)
8698 (setq cpltxt (or w3m-current-title w3m-current-url)
8699 link (org-make-link w3m-current-url))
8700 (org-store-link-props :type "w3m" :url (url-view-url t)))
8702 ((setq search (run-hook-with-args-until-success
8703 'org-create-file-search-functions))
8704 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8705 "::" search))
8706 (setq cpltxt (or description link)))
8708 ((eq major-mode 'image-mode)
8709 (setq cpltxt (concat "file:"
8710 (abbreviate-file-name buffer-file-name))
8711 link (org-make-link cpltxt))
8712 (org-store-link-props :type "image" :file buffer-file-name))
8714 ((eq major-mode 'dired-mode)
8715 ;; link to the file in the current line
8716 (let ((file (dired-get-filename nil t)))
8717 (setq file (if file
8718 (abbreviate-file-name
8719 (expand-file-name (dired-get-filename nil t)))
8720 ;; otherwise, no file so use current directory.
8721 default-directory))
8722 (setq cpltxt (concat "file:" file)
8723 link (org-make-link cpltxt))))
8725 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8726 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8727 (cond
8729 (setq cpltxt
8730 (concat "file:"
8731 (abbreviate-file-name
8732 (buffer-file-name (buffer-base-buffer)))
8733 "::" (match-string 1))
8734 link (org-make-link cpltxt)))
8735 ((and (featurep 'org-id)
8736 (or (eq org-link-to-org-use-id t)
8737 (and (eq org-link-to-org-use-id 'create-if-interactive)
8738 (org-called-interactively-p 'any))
8739 (and (eq org-link-to-org-use-id
8740 'create-if-interactive-and-no-custom-id)
8741 (org-called-interactively-p 'any)
8742 (not custom-id))
8743 (and org-link-to-org-use-id
8744 (org-entry-get nil "ID"))))
8745 ;; We can make a link using the ID.
8746 (setq link (condition-case nil
8747 (prog1 (org-id-store-link)
8748 (setq desc (plist-get org-store-link-plist
8749 :description)))
8750 (error
8751 ;; probably before first headline, link to file only
8752 (concat "file:"
8753 (abbreviate-file-name
8754 (buffer-file-name (buffer-base-buffer))))))))
8755 (t
8756 ;; Just link to current headline
8757 (setq cpltxt (concat "file:"
8758 (abbreviate-file-name
8759 (buffer-file-name (buffer-base-buffer)))))
8760 ;; Add a context search string
8761 (when (org-xor org-context-in-file-links arg)
8762 (setq txt (cond
8763 ((org-at-heading-p) nil)
8764 ((org-region-active-p)
8765 (buffer-substring (region-beginning) (region-end)))
8766 (t nil)))
8768 (setq cpltxt
8769 (concat cpltxt "::"
8770 (condition-case nil
8771 (org-make-org-heading-search-string txt)
8772 (error "")))
8773 desc (or (nth 4 (ignore-errors
8774 (org-heading-components))) "NONE"))))
8776 (setq cpltxt (substring cpltxt 0 -2)))
8777 (setq link (org-make-link cpltxt)))))
8779 ((buffer-file-name (buffer-base-buffer))
8780 ;; Just link to this file here.
8781 (setq cpltxt (concat "file:"
8782 (abbreviate-file-name
8783 (buffer-file-name (buffer-base-buffer)))))
8784 ;; Add a context string
8785 (when (org-xor org-context-in-file-links arg)
8786 (setq txt (if (org-region-active-p)
8787 (buffer-substring (region-beginning) (region-end))
8788 (buffer-substring (point-at-bol) (point-at-eol))))
8789 ;; Only use search option if there is some text.
8791 (setq cpltxt
8792 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8793 desc "NONE")))
8794 (setq link (org-make-link cpltxt)))
8796 ((org-called-interactively-p 'interactive)
8797 (error "Cannot link to a buffer which is not visiting a file"))
8799 (t (setq link nil)))
8801 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8802 (setq link (or link cpltxt)
8803 desc (or desc cpltxt))
8804 (if (equal desc "NONE") (setq desc nil))
8806 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8807 (progn
8808 (setq org-stored-links
8809 (cons (list link desc) org-stored-links))
8810 (message "Stored: %s" (or desc link))
8811 (when custom-id
8812 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8813 "::#" custom-id))
8814 (setq org-stored-links
8815 (cons (list link desc) org-stored-links))))
8816 (or agenda-link (and link (org-make-link-string link desc)))))))
8818 (defun org-store-link-props (&rest plist)
8819 "Store link properties, extract names and addresses."
8820 (let (x adr)
8821 (when (setq x (plist-get plist :from))
8822 (setq adr (mail-extract-address-components x))
8823 (setq plist (plist-put plist :fromname (car adr)))
8824 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8825 (when (setq x (plist-get plist :to))
8826 (setq adr (mail-extract-address-components x))
8827 (setq plist (plist-put plist :toname (car adr)))
8828 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8829 (let ((from (plist-get plist :from))
8830 (to (plist-get plist :to)))
8831 (when (and from to org-from-is-user-regexp)
8832 (setq plist
8833 (plist-put plist :fromto
8834 (if (string-match org-from-is-user-regexp from)
8835 (concat "to %t")
8836 (concat "from %f"))))))
8837 (setq org-store-link-plist plist))
8839 (defun org-add-link-props (&rest plist)
8840 "Add these properties to the link property list."
8841 (let (key value)
8842 (while plist
8843 (setq key (pop plist) value (pop plist))
8844 (setq org-store-link-plist
8845 (plist-put org-store-link-plist key value)))))
8847 (defun org-email-link-description (&optional fmt)
8848 "Return the description part of an email link.
8849 This takes information from `org-store-link-plist' and formats it
8850 according to FMT (default from `org-email-link-description-format')."
8851 (setq fmt (or fmt org-email-link-description-format))
8852 (let* ((p org-store-link-plist)
8853 (to (plist-get p :toaddress))
8854 (from (plist-get p :fromaddress))
8855 (table
8856 (list
8857 (cons "%c" (plist-get p :fromto))
8858 (cons "%F" (plist-get p :from))
8859 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8860 (cons "%T" (plist-get p :to))
8861 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8862 (cons "%s" (plist-get p :subject))
8863 (cons "%d" (plist-get p :date))
8864 (cons "%m" (plist-get p :message-id)))))
8865 (when (string-match "%c" fmt)
8866 ;; Check if the user wrote this message
8867 (if (and org-from-is-user-regexp from to
8868 (save-match-data (string-match org-from-is-user-regexp from)))
8869 (setq fmt (replace-match "to %t" t t fmt))
8870 (setq fmt (replace-match "from %f" t t fmt))))
8871 (org-replace-escapes fmt table)))
8873 (defun org-make-org-heading-search-string (&optional string heading)
8874 "Make search string for STRING or current headline."
8875 (interactive)
8876 (let ((s (or string (org-get-heading)))
8877 (lines org-context-in-file-links))
8878 (unless (and string (not heading))
8879 ;; We are using a headline, clean up garbage in there.
8880 (if (string-match org-todo-regexp s)
8881 (setq s (replace-match "" t t s)))
8883 (setq s (replace-match "" t t s)))
8884 (setq s (org-trim s))
8887 (setq s (replace-match "" t t s)))
8888 (while (string-match org-ts-regexp s)
8889 (setq s (replace-match "" t t s))))
8890 (or string (setq s (concat "*" s))) ; Add * for headlines
8891 (when (and string (integerp lines) (> lines 0))
8893 (when (< lines (length slines))
8894 (setq s (mapconcat
8895 'identity
8896 (reverse (nthcdr (- (length slines) lines)
8900 (defun org-make-link (&rest strings)
8901 "Concatenate STRINGS."
8902 (apply 'concat strings))
8904 (defun org-make-link-string (link &optional description)
8905 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8907 (error "Empty link"))
8908 (when (and description
8909 (stringp description)
8911 (setq description nil))
8912 (when (stringp description)
8913 ;; Remove brackets from the description, they are fatal.
8915 (setq description (replace-match "{" t t description)))
8917 (setq description (replace-match "}" t t description))))
8918 (when (equal link description)
8919 ;; No description needed, it is identical
8920 (setq description nil))
8921 (when (and (not description)
8922 (not (string-match (org-image-file-name-regexp) link))
8923 (not (equal link (org-link-escape link))))
8924 (setq description (org-extract-attributes link)))
8925 (setq link
8926 (cond ((string-match (org-image-file-name-regexp) link) link)
8927 ((string-match org-link-types-re link)
8928 (concat (match-string 1 link)
8929 (org-link-escape (substring link (match-end 1)))))
8930 (t (org-link-escape link))))
8931 (concat "[[" link "]"
8932 (if description (concat "[" description "]") "")
8933 "]"))
8935 (defconst org-link-escape-chars
8936 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8937 "List of characters that should be escaped in link.
8938 This is the list that is used for internal purposes.")
8940 (defvar org-url-encoding-use-url-hexify nil)
8942 (defconst org-link-escape-chars-browser
8943 '(?\ )
8944 "List of escapes for characters that are problematic in links.
8945 This is the list that is used before handing over to the browser.")
8947 (defun org-link-escape (text &optional table merge)
8948 "Return percent escaped representation of TEXT.
8949 TEXT is a string with the text to escape.
8950 Optional argument TABLE is a list with characters that should be
8951 escaped. When nil, `org-link-escape-chars' is used.
8952 If optional argument MERGE is set, merge TABLE into
8953 `org-link-escape-chars'."
8954 (if (and org-url-encoding-use-url-hexify (not table))
8955 (url-hexify-string text)
8956 (cond
8957 ((and table merge)
8958 (mapc (lambda (defchr)
8959 (unless (member defchr table)
8960 (setq table (cons defchr table)))) org-link-escape-chars))
8961 ((null table)
8962 (setq table org-link-escape-chars)))
8963 (mapconcat
8964 (lambda (char)
8965 (if (or (member char table)
8966 (< char 32) (= char 37) (> char 126))
8967 (mapconcat (lambda (sequence-element)
8968 (format "%%%.2X" sequence-element))
8969 (or (encode-coding-char char 'utf-8)
8970 (error "Unable to percent escape character: %s"
8971 (char-to-string char))) "")
8972 (char-to-string char))) text "")))
8974 (defun org-link-unescape (str)
8975 "Unhex hexified Unicode strings as returned from the JavaScript function
8976 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8977 (unless (and (null str) (string= "" str))
8978 (let ((pos 0) (case-fold-search t) unhexed)
8980 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8981 (setq str (replace-match unhexed t t str))
8982 (setq pos (+ pos (length unhexed))))))
8983 str)
8985 (defun org-link-unescape-compound (hex)
8986 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8987 Note: this function also decodes single byte encodings like
8989 (save-match-data
8990 (let* ((bytes (cdr (split-string hex "%")))
8991 (ret "")
8992 (eat 0)
8993 (sum 0))
8994 (while bytes
8995 (let* ((val (string-to-number (pop bytes) 16))
8996 (shift-xor
8997 (if (= 0 eat)
8998 (cond
8999 ((>= val 252) (cons 6 252))
9000 ((>= val 248) (cons 5 248))
9001 ((>= val 240) (cons 4 240))
9002 ((>= val 224) (cons 3 224))
9003 ((>= val 192) (cons 2 192))
9004 (t (cons 0 0)))
9005 (cons 6 128))))
9006 (if (>= val 192) (setq eat (car shift-xor)))
9007 (setq val (logxor val (cdr shift-xor)))
9008 (setq sum (+ (lsh sum (car shift-xor)) val))
9009 (if (> eat 0) (setq eat (- eat 1)))
9010 (cond
9011 ((= 0 eat) ;multi byte
9012 (setq ret (concat ret (org-char-to-string sum)))
9013 (setq sum 0))
9014 ((not bytes) ; single byte(s)
9015 (setq ret (org-link-unescape-single-byte-sequence hex))))
9016 )) ;; end (while bytes
9017 ret )))
9019 (defun org-link-unescape-single-byte-sequence (hex)
9020 "Unhexify hex-encoded single byte character sequences."
9021 (mapconcat (lambda (byte)
9022 (char-to-string (string-to-number byte 16)))
9023 (cdr (split-string hex "%")) ""))
9025 (defun org-xor (a b)
9026 "Exclusive or."
9027 (if a (not b) b))
9029 (defun org-fixup-message-id-for-http (s)
9030 "Replace special characters in a message id, so it can be used in an http query."
9031 (when (string-match "%" s)
9032 (setq s (mapconcat (lambda (c)
9033 (if (eq c ?%)
9034 "%25"
9035 (char-to-string c)))
9036 s "")))
9037 (while (string-match "<" s)
9038 (setq s (replace-match "%3C" t t s)))
9039 (while (string-match ">" s)
9040 (setq s (replace-match "%3E" t t s)))
9041 (while (string-match "@" s)
9042 (setq s (replace-match "%40" t t s)))
9043 s)
9045 ;;;###autoload
9046 (defun org-insert-link-global ()
9047 "Insert a link like Org-mode does.
9048 This command can be called in any mode to insert a link in Org-mode syntax."
9049 (interactive)
9050 (org-load-modules-maybe)
9051 (org-run-like-in-org-mode 'org-insert-link))
9053 (defun org-insert-link (&optional complete-file link-location default-description)
9054 "Insert a link. At the prompt, enter the link.
9056 Completion can be used to insert any of the link protocol prefixes like
9057 http or ftp in use.
9059 The history can be used to select a link previously stored with
9060 `org-store-link'. When the empty string is entered (i.e. if you just
9061 press RET at the prompt), the link defaults to the most recently
9062 stored link. As SPC triggers completion in the minibuffer, you need to
9063 use M-SPC or C-q SPC to force the insertion of a space character.
9065 You will also be prompted for a description, and if one is given, it will
9066 be displayed in the buffer instead of the link.
9068 If there is already a link at point, this command will allow you to edit link
9069 and description parts.
9072 be selected using completion. The path to the file will be relative to the
9073 current directory if the file is in the current directory or a subdirectory.
9074 Otherwise, the link will be the absolute path as completed in the minibuffer
9075 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9076 option `org-link-file-path-type'.
9079 the current directory or below.
9082 `org-keep-stored-link-after-insertion'.
9084 If `org-make-link-description-function' is non-nil, this function will be
9085 called with the link target, and the result will be the default
9086 link description.
9088 If the LINK-LOCATION parameter is non-nil, this value will be
9089 used as the link location instead of reading one interactively.
9091 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9092 be used as the default description."
9093 (interactive "P")
9094 (let* ((wcf (current-window-configuration))
9095 (region (if (org-region-active-p)
9096 (buffer-substring (region-beginning) (region-end))))
9097 (remove (and region (list (region-beginning) (region-end))))
9098 (desc region)
9099 tmphist ; byte-compile incorrectly complains about this
9100 (link link-location)
9101 entry file all-prefixes)
9102 (cond
9103 (link-location) ; specified by arg, just use it.
9104 ((org-in-regexp org-bracket-link-regexp 1)
9105 ;; We do have a link at point, and we are going to edit it.
9106 (setq remove (list (match-beginning 0) (match-end 0)))
9107 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9108 (setq link (read-string "Link: "
9109 (org-link-unescape
9110 (org-match-string-no-properties 1)))))
9111 ((or (org-in-regexp org-angle-link-re)
9112 (org-in-regexp org-plain-link-re))
9113 ;; Convert to bracket link
9114 (setq remove (list (match-beginning 0) (match-end 0))
9115 link (read-string "Link: "
9116 (org-remove-angle-brackets (match-string 0)))))
9117 ((member complete-file '((4) (16)))
9118 ;; Completing read for file names.
9119 (setq link (org-file-complete-link complete-file)))
9120 (t
9121 ;; Read link, with completion for stored links.
9122 (with-output-to-temp-buffer "*Org Links*"
9123 (princ "Insert a link.
9125 (when org-stored-links
9127 (princ (mapconcat
9128 (lambda (x)
9129 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9131 (let ((cw (selected-window)))
9132 (select-window (get-buffer-window "*Org Links*" 'visible))
9133 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9134 (unless (pos-visible-in-window-p (point-max))
9135 (org-fit-window-to-buffer))
9136 (and (window-live-p cw) (select-window cw)))
9137 ;; Fake a link history, containing the stored links.
9138 (setq tmphist (append (mapcar 'car org-stored-links)
9139 org-insert-link-history))
9140 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9141 (mapcar 'car org-link-abbrev-alist)
9142 org-link-types))
9143 (unwind-protect
9144 (progn
9145 (setq link
9146 (let ((org-completion-use-ido nil)
9147 (org-completion-use-iswitchb nil))
9148 (org-completing-read
9149 "Link: "
9150 (append
9151 (mapcar (lambda (x) (list (concat x ":")))
9152 all-prefixes)
9153 (mapcar 'car org-stored-links))
9154 nil nil nil
9155 'tmphist
9156 (car (car org-stored-links)))))
9158 (error "No link selected"))
9159 (if (or (member link all-prefixes)
9160 (and (equal ":" (substring link -1))
9161 (member (substring link 0 -1) all-prefixes)
9162 (setq link (substring link 0 -1))))
9163 (setq link (org-link-try-special-completion link))))
9164 (set-window-configuration wcf)
9165 (kill-buffer "*Org Links*"))
9166 (setq entry (assoc link org-stored-links))
9167 (or entry (push link org-insert-link-history))
9168 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9169 (not org-keep-stored-link-after-insertion))
9170 (setq org-stored-links (delq (assoc link org-stored-links)
9171 org-stored-links)))
9172 (setq desc (or desc (nth 1 entry)))))
9174 (if (string-match org-plain-link-re link)
9175 ;; URL-like link, normalize the use of angular brackets.
9176 (setq link (org-make-link (org-remove-angle-brackets link))))
9178 ;; Check if we are linking to the current file with a search option
9179 ;; If yes, simplify the link by using only the search option.
9180 (when (and buffer-file-name
9182 (let* ((path (match-string 1 link))
9183 (case-fold-search nil)
9184 (search (match-string 2 link)))
9185 (save-match-data
9186 (if (equal (file-truename buffer-file-name) (file-truename path))
9187 ;; We are linking to this same file, with a search option
9188 (setq link search)))))
9190 ;; Check if we can/should use a relative path. If yes, simplify the link
9192 (let* ((type (match-string 1 link))
9193 (path (match-string 2 link))
9194 (origpath path)
9195 (case-fold-search nil))
9196 (cond
9197 ((or (eq org-link-file-path-type 'absolute)
9198 (equal complete-file '(16)))
9199 (setq path (abbreviate-file-name (expand-file-name path))))
9200 ((eq org-link-file-path-type 'noabbrev)
9201 (setq path (expand-file-name path)))
9202 ((eq org-link-file-path-type 'relative)
9203 (setq path (file-relative-name path)))
9204 (t
9205 (save-match-data
9206 (if (string-match (concat "^" (regexp-quote
9207 (expand-file-name
9208 (file-name-as-directory
9209 default-directory))))
9210 (expand-file-name path))
9211 ;; We are linking a file with relative path name.
9212 (setq path (substring (expand-file-name path)
9213 (match-end 0)))
9214 (setq path (abbreviate-file-name (expand-file-name path)))))))
9215 (setq link (concat type path))
9216 (if (equal desc origpath)
9217 (setq desc path))))
9219 (if org-make-link-description-function
9220 (setq desc (funcall org-make-link-description-function link desc))
9221 (if default-description (setq desc default-description)))
9223 (setq desc (read-string "Description: " desc))
9225 (if remove (apply 'delete-region remove))
9226 (insert (org-make-link-string link desc))))
9228 (defun org-link-try-special-completion (type)
9229 "If there is completion support for link type TYPE, offer it."
9230 (let ((fun (intern (concat "org-" type "-complete-link"))))
9231 (if (functionp fun)
9232 (funcall fun)
9233 (read-string "Link (no completion support): " (concat type ":")))))
9235 (defun org-file-complete-link (&optional arg)
9236 "Create a file link using completion."
9237 (let (file link)
9238 (setq file (read-file-name "File: "))
9239 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9240 (pwd1 (file-name-as-directory (abbreviate-file-name
9241 (expand-file-name ".")))))
9242 (cond
9243 ((equal arg '(16))
9244 (setq link (org-make-link
9245 "file:"
9246 (abbreviate-file-name (expand-file-name file)))))
9248 (setq link (org-make-link "file:" (match-string 1 file))))
9250 (expand-file-name file))
9251 (setq link (org-make-link
9252 "file:" (match-string 1 (expand-file-name file)))))
9253 (t (setq link (org-make-link "file:" file)))))
9254 link))
9256 (defun org-completing-read (&rest args)
9257 "Completing-read with SPACE being a normal character."
9258 (let ((enable-recursive-minibuffers t)
9259 (minibuffer-local-completion-map
9260 (copy-keymap minibuffer-local-completion-map)))
9261 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9262 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9263 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9264 (apply 'org-icompleting-read args)))
9266 (defun org-completing-read-no-i (&rest args)
9267 (let (org-completion-use-ido org-completion-use-iswitchb)
9268 (apply 'org-completing-read args)))
9270 (defun org-iswitchb-completing-read (prompt choices &rest args)
9271 "Use iswitch as a completing-read replacement to choose from choices.
9272 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9273 from."
9274 (let* ((iswitchb-use-virtual-buffers nil)
9275 (iswitchb-make-buflist-hook
9276 (lambda ()
9277 (setq iswitchb-temp-buflist choices))))
9278 (iswitchb-read-buffer prompt)))
9280 (defun org-icompleting-read (&rest args)
9281 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9282 (org-without-partial-completion
9283 (if (and org-completion-use-ido
9284 (fboundp 'ido-completing-read)
9285 (boundp 'ido-mode) ido-mode
9286 (listp (second args)))
9287 (let ((ido-enter-matching-directory nil))
9288 (apply 'ido-completing-read (concat (car args))
9289 (if (consp (car (nth 1 args)))
9290 (mapcar 'car (nth 1 args))
9291 (nth 1 args))
9292 (cddr args)))
9293 (if (and org-completion-use-iswitchb
9294 (boundp 'iswitchb-mode) iswitchb-mode
9295 (listp (second args)))
9296 (apply 'org-iswitchb-completing-read (concat (car args))
9297 (if (consp (car (nth 1 args)))
9298 (mapcar 'car (nth 1 args))
9299 (nth 1 args))
9300 (cddr args))
9301 (apply 'completing-read args)))))
9303 (defun org-extract-attributes (s)
9304 "Extract the attributes cookie from a string and set as text property."
9305 (let (a attr (start 0) key value)
9306 (save-match-data
9308 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9310 (setq key (match-string 1 a) value (match-string 2 a)
9311 start (match-end 0)
9312 attr (plist-put attr (intern key) value))))
9313 (org-add-props s nil 'org-attr attr))
9314 s))
9316 (defun org-extract-attributes-from-string (tag)
9317 (let (key value attr)
9319 (setq key (match-string 1 tag) value (match-string 2 tag)
9320 tag (replace-match "" t t tag)
9321 attr (plist-put attr (intern key) value)))
9322 (cons tag attr)))
9324 (defun org-attributes-to-string (plist)
9325 "Format a property list into an HTML attribute list."
9326 (let ((s "") key value)
9327 (while plist
9328 (setq key (pop plist) value (pop plist))
9329 (and value
9331 s))
9333 ;;; Opening/following a link
9335 (defvar org-link-search-failed nil)
9337 (defvar org-open-link-functions nil
9338 "Hook for functions finding a plain text link.
9339 These functions must take a single argument, the link content.
9340 They will be called for links that look like [[link text][description]]
9344 These functions will be called *before* Org attempts to resolve the
9345 link by doing text searches in the current buffer - so if you want a
9347 handle this as a special case.
9349 When the function does handle the link, it must return a non-nil value.
9350 If it decides that it is not responsible for this link, it must return
9351 nil to indicate that that Org-mode can continue with other options
9352 like exact and fuzzy text search.")
9354 (defun org-next-link ()
9355 "Move forward to the next link.
9356 If the link is in hidden text, expose it."
9357 (interactive)
9358 (when (and org-link-search-failed (eq this-command last-command))
9359 (goto-char (point-min))
9360 (message "Link search wrapped back to beginning of buffer"))
9361 (setq org-link-search-failed nil)
9362 (let* ((pos (point))
9363 (ct (org-context))
9364 (a (assoc :link ct)))
9365 (if a (goto-char (nth 2 a)))
9366 (if (re-search-forward org-any-link-re nil t)
9367 (progn
9368 (goto-char (match-beginning 0))
9369 (if (outline-invisible-p) (org-show-context)))
9370 (goto-char pos)
9371 (setq org-link-search-failed t)
9372 (error "No further link found"))))
9374 (defun org-previous-link ()
9375 "Move backward to the previous link.
9376 If the link is in hidden text, expose it."
9377 (interactive)
9378 (when (and org-link-search-failed (eq this-command last-command))
9379 (goto-char (point-max))
9380 (message "Link search wrapped back to end of buffer"))
9381 (setq org-link-search-failed nil)
9382 (let* ((pos (point))
9383 (ct (org-context))
9384 (a (assoc :link ct)))
9385 (if a (goto-char (nth 1 a)))
9386 (if (re-search-backward org-any-link-re nil t)
9387 (progn
9388 (goto-char (match-beginning 0))
9389 (if (outline-invisible-p) (org-show-context)))
9390 (goto-char pos)
9391 (setq org-link-search-failed t)
9392 (error "No further link found"))))
9394 (defun org-translate-link (s)
9395 "Translate a link string if a translation function has been defined."
9396 (if (and org-link-translation-function
9397 (fboundp org-link-translation-function)
9399 (progn
9400 (setq s (funcall org-link-translation-function
9401 (match-string 1) (match-string 2)))
9402 (concat (car s) ":" (cdr s)))
9403 s))
9405 (defun org-translate-link-from-planner (type path)
9406 "Translate a link from Emacs Planner syntax so that Org can follow it.
9407 This is still an experimental function, your mileage may vary."
9408 (cond
9409 ((member type '("http" "https" "news" "ftp"))
9410 ;; standard Internet links are the same.
9411 nil)
9412 ((and (equal type "irc") (string-match "^//" path))
9413 ;; Planner has two / at the beginning of an irc link, we have 1.
9414 ;; We should have zero, actually....
9415 (setq path (substring path 1)))
9416 ((and (equal type "lisp") (string-match "^/" path))
9417 ;; Planner has a slash, we do not.
9418 (setq type "elisp" path (substring path 1)))
9420 ;; A typical message link. Planner has the id after the final slash,
9421 ;; we separate it with a hash mark
9422 (setq path (concat (match-string 1 path) "#"
9423 (org-remove-angle-brackets (match-string 2 path)))))
9424 )
9425 (cons type path))
9427 (defun org-find-file-at-mouse (ev)
9428 "Open file link or URL at mouse."
9429 (interactive "e")
9430 (mouse-set-point ev)
9431 (org-open-at-point 'in-emacs))
9433 (defun org-open-at-mouse (ev)
9434 "Open file link or URL at mouse.
9435 See the docstring of `org-open-file' for details."
9436 (interactive "e")
9437 (mouse-set-point ev)
9438 (if (eq major-mode 'org-agenda-mode)
9439 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9440 (org-open-at-point))
9442 (defvar org-window-config-before-follow-link nil
9443 "The window configuration before following a link.
9444 This is saved in case the need arises to restore it.")
9446 (defvar org-open-link-marker (make-marker)
9447 "Marker pointing to the location where `org-open-at-point; was called.")
9449 ;;;###autoload
9450 (defun org-open-at-point-global ()
9451 "Follow a link like Org-mode does.
9452 This command can be called in any mode to follow a link that has
9453 Org-mode syntax."
9454 (interactive)
9455 (org-run-like-in-org-mode 'org-open-at-point))
9457 ;;;###autoload
9458 (defun org-open-link-from-string (s &optional arg reference-buffer)
9459 "Open a link in the string S, as if it was in Org-mode."
9461 (let ((reference-buffer (or reference-buffer (current-buffer))))
9462 (with-temp-buffer
9463 (let ((org-inhibit-startup (not reference-buffer)))
9464 (org-mode)
9465 (insert s)
9466 (goto-char (point-min))
9467 (when reference-buffer
9468 (setq org-link-abbrev-alist-local
9469 (with-current-buffer reference-buffer
9470 org-link-abbrev-alist-local)))
9471 (org-open-at-point arg reference-buffer)))))
9473 (defvar org-open-at-point-functions nil
9474 "Hook that is run when following a link at point.
9476 Functions in this hook must return t if they identify and follow
9477 a link at point. If they don't find anything interesting at point,
9478 they must return nil.")
9480 (defun org-open-at-point (&optional arg reference-buffer)
9481 "Open link at or after point.
9482 If there is no link at point, this function will search forward up to
9483 the end of the current line.
9484 Normally, files will be opened by an appropriate application. If the
9485 optional prefix argument ARG is non-nil, Emacs will visit the file.
9486 With a double prefix argument, try to open outside of Emacs, in the
9487 application the system uses for this file type."
9488 (interactive "P")
9489 ;; if in a code block, then open the block's results
9490 (unless (call-interactively #'org-babel-open-src-block-result)
9491 (org-load-modules-maybe)
9492 (move-marker org-open-link-marker (point))
9493 (setq org-window-config-before-follow-link (current-window-configuration))
9494 (org-remove-occur-highlights nil nil t)
9495 (cond
9496 ((and (org-at-heading-p)
9497 (not (org-in-regexp
9502 (not (get-text-property (point) 'org-linked-text)))
9503 (or (org-offer-links-in-entry arg)
9504 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9505 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9506 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9507 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9508 (not (org-in-regexp org-bracket-link-regexp)))
9509 (org-footnote-action))
9510 (t
9511 (let (type path link line search (pos (point)))
9512 (catch 'match
9513 (save-excursion
9515 (when (org-in-regexp org-bracket-link-regexp 1)
9516 (setq link (org-extract-attributes
9517 (org-link-unescape (org-match-string-no-properties 1))))
9519 (setq link (replace-match " " t t link)))
9520 (setq link (org-link-expand-abbrev link))
9521 (cond
9522 ((or (file-name-absolute-p link)
9524 (setq type "file" path link))
9525 ((string-match org-link-re-with-space3 link)
9526 (setq type (match-string 1 link) path (match-string 2 link)))
9527 (t (setq type "thisfile" path link)))
9528 (throw 'match t)))
9530 (when (get-text-property (point) 'org-linked-text)
9531 (setq type "thisfile"
9532 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9533 (1+ (point)) (point))
9534 path (buffer-substring
9535 (or (previous-single-property-change pos 'org-linked-text)
9536 (point-min))
9537 (or (next-single-property-change pos 'org-linked-text)
9538 (point-max))))
9539 (throw 'match t))
9541 (save-excursion
9542 (when (or (org-in-regexp org-angle-link-re)
9543 (org-in-regexp org-plain-link-re))
9544 (setq type (match-string 1)
9545 path (org-link-unescape (match-string 2)))
9546 (throw 'match t)))
9547 (save-excursion
9549 (setq type "tags"
9550 path (match-string 1))
9551 (while (string-match ":" path)
9552 (setq path (replace-match "+" t t path)))
9553 (throw 'match t)))
9555 (setq type "tree-match"
9556 path (match-string 1))
9557 (throw 'match t)))
9558 (unless path
9559 (error "No link found"))
9561 ;; switch back to reference buffer
9562 ;; needed when if called in a temporary buffer through
9563 ;; org-open-link-from-string
9564 (with-current-buffer (or reference-buffer (current-buffer))
9566 ;; Remove any trailing spaces in path
9568 (setq path (replace-match "" t t path)))
9569 (if (and org-link-translation-function
9570 (fboundp org-link-translation-function))
9571 ;; Check if we need to translate the link
9572 (let ((tmp (funcall org-link-translation-function type path)))
9573 (setq type (car tmp) path (cdr tmp))))
9575 (cond
9577 ((assoc type org-link-protocols)
9578 (funcall (nth 1 (assoc type org-link-protocols)) path))
9580 ((equal type "mailto")
9581 (let ((cmd (car org-link-mailto-program))
9582 (args (cdr org-link-mailto-program)) args1
9583 (address path) (subject "") a)
9585 (setq address (match-string 1 path)
9586 subject (org-link-escape (match-string 2 path))))
9587 (while args
9588 (cond
9589 ((not (stringp (car args))) (push (pop args) args1))
9590 (t (setq a (pop args))
9591 (if (string-match "%a" a)
9592 (setq a (replace-match address t t a)))
9593 (if (string-match "%s" a)
9594 (setq a (replace-match subject t t a)))
9595 (push a args1))))
9596 (apply cmd (nreverse args1))))
9598 ((member type '("http" "https" "ftp" "news"))
9599 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9600 (org-link-escape
9601 path org-link-escape-chars-browser)
9602 path))))
9604 ((string= type "doi")
9605 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9606 (org-link-escape
9607 path org-link-escape-chars-browser)
9608 path))))
9610 ((member type '("message"))
9611 (browse-url (concat type ":" path)))
9613 ((string= type "tags")
9614 (org-tags-view arg path))
9616 ((string= type "tree-match")
9619 ((string= type "file")
9621 (setq line (string-to-number (match-string 1 path))
9622 path (substring path 0 (match-beginning 0)))
9624 (setq search (match-string 1 path)
9625 path (substring path 0 (match-beginning 0)))))
9626 (if (string-match "[*?{]" (file-name-nondirectory path))
9627 (dired path)
9628 (org-open-file path arg line search)))
9630 ((string= type "shell")
9631 (let ((cmd path))
9632 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9633 (string-match org-confirm-shell-link-not-regexp cmd))
9634 (not org-confirm-shell-link-function)
9635 (funcall org-confirm-shell-link-function
9637 (org-add-props cmd nil
9638 'face 'org-warning))))
9639 (progn
9640 (message "Executing %s" cmd)
9641 (shell-command cmd))
9642 (error "Abort"))))
9644 ((string= type "elisp")
9645 (let ((cmd path))
9646 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9647 (string-match org-confirm-elisp-link-not-regexp cmd))
9648 (not org-confirm-elisp-link-function)
9649 (funcall org-confirm-elisp-link-function
9651 (org-add-props cmd nil
9652 'face 'org-warning))))
9653 (message "%s => %s" cmd
9654 (if (equal (string-to-char cmd) ?\()
9655 (eval (read cmd))
9656 (call-interactively (read cmd))))
9657 (error "Abort"))))
9659 ((and (string= type "thisfile")
9660 (run-hook-with-args-until-success
9661 'org-open-link-functions path)))
9663 ((string= type "thisfile")
9664 (if arg
9665 (switch-to-buffer-other-window
9666 (org-get-buffer-for-internal-link (current-buffer)))
9667 (org-mark-ring-push))
9668 (let ((cmd `(org-link-search
9669 ,path
9670 ,(cond ((equal arg '(4)) ''occur)
9671 ((equal arg '(16)) ''org-occur)
9672 (t nil))
9673 ,pos)))
9674 (condition-case nil (let ((org-link-search-inhibit-query t))
9675 (eval cmd))
9676 (error (progn (widen) (eval cmd))))))
9678 (t
9679 (browse-url-at-point)))))))
9680 (move-marker org-open-link-marker nil)
9681 (run-hook-with-args 'org-follow-link-hook)))
9683 (defun org-offer-links-in-entry (&optional nth zero)
9684 "Offer links in the current entry and follow the selected link.
9685 If there is only one link, follow it immediately as well.
9686 If NTH is an integer, immediately pick the NTH link found.
9687 If ZERO is a string, check also this string for a link, and if
9688 there is one, offer it as link number zero."
9692 (cnt ?0)
9693 (in-emacs (if (integerp nth) nil nth))
9694 have-zero end links link c)
9695 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9696 (push (match-string 0 zero) links)
9697 (setq cnt (1- cnt) have-zero t))
9698 (save-excursion
9699 (org-back-to-heading t)
9700 (setq end (save-excursion (outline-next-heading) (point)))
9701 (while (re-search-forward re end t)
9702 (push (match-string 0) links))
9703 (setq links (org-uniquify (reverse links))))
9705 (cond
9706 ((null links)
9707 (message "No links"))
9708 ((equal (length links) 1)
9709 (setq link (list (car links))))
9710 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9711 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9712 (t ; we have to select a link
9713 (save-excursion
9714 (save-window-excursion
9715 (delete-other-windows)
9716 (with-output-to-temp-buffer "*Select Link*"
9717 (mapc (lambda (l)
9718 (if (not (string-match org-bracket-link-regexp l))
9720 (org-remove-angle-brackets l)))
9721 (if (match-end 3)
9723 (match-string 3 l) (match-string 1 l)))
9725 (match-string 1 l))))))
9726 links))
9727 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9728 (message "Select link to open, RET to open all:")
9729 (setq c (read-char-exclusive))
9730 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9731 (when (equal c ?q) (error "Abort"))
9732 (if (equal c ?\C-m)
9733 (setq link links)
9734 (setq nth (- c ?0))
9735 (if have-zero (setq nth (1+ nth)))
9736 (unless (and (integerp nth) (>= (length links) nth))
9737 (error "Invalid link selection"))
9738 (setq link (list (nth (1- nth) links))))))
9739 (if link
9740 (let ((buf (current-buffer)))
9741 (dolist (l link)
9742 (org-open-link-from-string l in-emacs buf))
9743 t)
9744 nil)))
9746 ;; Add special file links that specify the way of opening
9748 (org-add-link-type "file+sys" 'org-open-file-with-system)
9749 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9750 (defun org-open-file-with-system (path)
9751 "Open file at PATH using the system way of opening it."
9752 (org-open-file path 'system))
9753 (defun org-open-file-with-emacs (path)
9754 "Open file at PATH in Emacs."
9755 (org-open-file path 'emacs))
9756 (defun org-remove-file-link-modifiers ()
9757 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9758 (goto-char (point-min))
9760 (org-if-unprotected
9761 (replace-match "file:" t t))))
9762 (eval-after-load "org-exp"
9763 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9764 'org-remove-file-link-modifiers))
9766 ;;;; Time estimates
9768 (defun org-get-effort (&optional pom)
9769 "Get the effort estimate for the current entry."
9770 (org-entry-get pom org-effort-property))
9772 ;;; File search
9774 (defvar org-create-file-search-functions nil
9775 "List of functions to construct the right search string for a file link.
9776 These functions are called in turn with point at the location to
9777 which the link should point.
9779 A function in the hook should first test if it would like to
9780 handle this file type, for example by checking the `major-mode'
9781 or the file extension. If it decides not to handle this file, it
9782 should just return nil to give other functions a chance. If it
9783 does handle the file, it must return the search string to be used
9784 when following the link. The search string will be part of the
9785 file link, given after a double colon, and `org-open-at-point'
9786 will automatically search for it. If special measures must be
9787 taken to make the search successful, another function should be
9788 added to the companion hook `org-execute-file-search-functions',
9789 which see.
9791 A function in this hook may also use `setq' to set the variable
9792 `description' to provide a suggestion for the descriptive text to
9793 be used for this link when it gets inserted into an Org-mode
9796 (defvar org-execute-file-search-functions nil
9797 "List of functions to execute a file search triggered by a link.
9799 Functions added to this hook must accept a single argument, the
9800 search string that was part of the file link, the part after the
9801 double colon. The function must first check if it would like to
9802 handle this search, for example by checking the `major-mode' or
9803 the file extension. If it decides not to handle this search, it
9804 should just return nil to give other functions a chance. If it
9805 does handle the search, it must return a non-nil value to keep
9806 other functions from trying.
9808 Each function can access the current prefix argument through the
9809 variable `current-prefix-argument'. Note that a single prefix is
9810 used to force opening a link in Emacs, so it may be good to only
9811 use a numeric or double prefix to guide the search function.
9813 In case this is needed, a function in this hook can also restore
9814 the window configuration before `org-open-at-point' was called using:
9816 (set-window-configuration org-window-config-before-follow-link)")
9818 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9819 (defun org-link-search (s &optional type avoid-pos stealth)
9820 "Search for a link search option.
9821 If S is surrounded by forward slashes, it is interpreted as a
9822 regular expression. In org-mode files, this will create an `org-occur'
9823 sparse tree. In ordinary files, `occur' will be used to list matches.
9824 If the current buffer is in `dired-mode', grep will be used to search
9825 in all files. If AVOID-POS is given, ignore matches near that position.
9827 When optional argument STEALTH is non-nil, do not modify
9828 visibility around point, thus ignoring
9829 `org-show-hierarchy-above', `org-show-following-heading' and
9830 `org-show-siblings' variables."
9831 (let ((case-fold-search t)
9835 org-emphasis-alist)
9837 (pos (point))
9838 (pre nil) (post nil)
9839 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9840 (cond
9841 ;; First check if there are any special search functions
9842 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9843 ;; Now try the builtin stuff
9844 ((and (equal (string-to-char s0) ?#)
9845 (> (length s0) 1)
9846 (save-excursion
9847 (goto-char (point-min))
9848 (and
9849 (re-search-forward
9851 (setq type 'dedicated
9852 pos (match-beginning 0))))
9853 ;; There is an exact target for this
9854 (goto-char pos)
9855 (org-back-to-heading t)))
9856 ((save-excursion
9857 (goto-char (point-min))
9858 (and
9859 (re-search-forward
9860 (concat "<<" (regexp-quote s0) ">>") nil t)
9861 (setq type 'dedicated
9862 pos (match-beginning 0))))
9863 ;; There is an exact target for this
9864 (goto-char pos))
9866 (save-excursion
9867 (goto-char (point-min))
9868 (and
9869 (re-search-forward
9870 (concat "[^[]" (regexp-quote
9871 (format org-coderef-label-format
9872 (match-string 1 s0))))
9873 nil t)
9874 (setq type 'dedicated
9875 pos (1+ (match-beginning 0))))))
9876 ;; There is a coderef target for this
9877 (goto-char pos))
9879 ;; A regular expression
9880 (cond
9881 ((eq major-mode 'org-mode)
9882 (org-occur (match-string 1 s)))
9883 ;;((eq major-mode 'dired-mode)
9884 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9885 (t (org-do-occur (match-string 1 s)))))
9886 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9887 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9888 (goto-char (point-min))
9889 (cond
9890 ((let (case-fold-search)
9891 (re-search-forward (format org-complex-heading-regexp-format
9892 (regexp-quote s))
9893 nil t))
9894 ;; OK, found a match
9895 (setq type 'dedicated)
9896 (goto-char (match-beginning 0)))
9897 ((and (not org-link-search-inhibit-query)
9898 (eq org-link-search-must-match-exact-headline 'query-to-create)
9899 (y-or-n-p "No match - create this as a new heading? "))
9900 (goto-char (point-max))
9901 (or (bolp) (newline))
9903 (beginning-of-line 0))
9904 (t
9905 (goto-char pos)
9906 (error "No match"))))
9907 (t
9908 ;; A normal search string
9909 (when (equal (string-to-char s) ?*)
9910 ;; Anchor on headlines, post may include tags.
9913 s (substring s 1)))
9914 (remove-text-properties
9915 0 (length s)
9916 '(face nil mouse-face nil keymap nil fontified nil) s)
9917 ;; Make a series of regular expressions to find a match
9926 re4 (concat "[^a-zA-Z_]" re4_)
9928 re1 (concat pre re2 post)
9929 re3 (concat pre (if pre re4_ re4) post)
9930 re5 (concat pre ".*" re4)
9931 re2 (concat pre re2)
9932 re2a (concat pre (if pre re2a_ re2a))
9933 re4 (concat pre (if pre re4_ re4))
9937 ))
9938 (cond
9939 ((eq type 'org-occur) (org-occur reall))
9940 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9941 (t (goto-char (point-min))
9942 (setq type 'fuzzy)
9943 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9944 (org-search-not-self 1 re1 nil t)
9945 (org-search-not-self 1 re2 nil t)
9946 (org-search-not-self 1 re2a nil t)
9947 (org-search-not-self 1 re3 nil t)
9948 (org-search-not-self 1 re4 nil t)
9949 (org-search-not-self 1 re5 nil t)
9950 )
9951 (goto-char (match-beginning 1))
9952 (goto-char pos)
9953 (error "No match"))))))
9954 (and (eq major-mode 'org-mode)
9955 (not stealth)
9956 (org-show-context 'link-search))
9957 type))
9959 (defun org-search-not-self (group &rest args)
9960 "Execute `re-search-forward', but only accept matches that do not
9961 enclose the position of `org-open-link-marker'."
9962 (let ((m org-open-link-marker))
9963 (catch 'exit
9964 (while (apply 're-search-forward args)
9965 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9966 (goto-char (match-end group))
9967 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9968 (> (match-beginning 0) (marker-position m))
9969 (< (match-end 0) (marker-position m)))
9970 (save-match-data
9971 (or (not (org-in-regexp
9972 org-bracket-link-analytic-regexp 1))
9973 (not (match-end 4)) ; no description
9974 (and (<= (match-beginning 4) (point))
9975 (>= (match-end 4) (point))))))
9976 (throw 'exit (point))))))))
9978 (defun org-get-buffer-for-internal-link (buffer)
9979 "Return a buffer to be used for displaying the link target of internal links."
9980 (cond
9981 ((not org-display-internal-link-with-indirect-buffer)
9982 buffer)
9983 ((string-match "(Clone)$" (buffer-name buffer))
9984 (message "Buffer is already a clone, not making another one")
9985 ;; we also do not modify visibility in this case
9986 buffer)
9987 (t ; make a new indirect buffer for displaying the link
9988 (let* ((bn (buffer-name buffer))
9989 (ibn (concat bn "(Clone)"))
9990 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9991 (with-current-buffer ib (org-overview))
9992 ib))))
9994 (defun org-do-occur (regexp &optional cleanup)
9995 "Call the Emacs command `occur'.
9996 If CLEANUP is non-nil, remove the printout of the regular expression
9997 in the *Occur* buffer. This is useful if the regex is long and not useful
9998 to read."
9999 (occur regexp)
10000 (when cleanup
10001 (let ((cwin (selected-window)) win beg end)
10002 (when (setq win (get-buffer-window "*Occur*"))
10003 (select-window win))
10004 (goto-char (point-min))
10005 (when (re-search-forward "match[a-z]+" nil t)
10006 (setq beg (match-end 0))
10008 (setq end (1- (match-beginning 0)))))
10009 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10010 (goto-char (point-min))
10011 (select-window cwin))))
10013 ;;; The mark ring for links jumps
10015 (defvar org-mark-ring nil
10016 "Mark ring for positions before jumps in Org-mode.")
10017 (defvar org-mark-ring-last-goto nil
10018 "Last position in the mark ring used to go back.")
10019 ;; Fill and close the ring
10020 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10021 (loop for i from 1 to org-mark-ring-length do
10022 (push (make-marker) org-mark-ring))
10023 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10024 org-mark-ring)
10026 (defun org-mark-ring-push (&optional pos buffer)
10027 "Put the current position or POS into the mark ring and rotate it."
10028 (interactive)
10029 (setq pos (or pos (point)))
10030 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10031 (move-marker (car org-mark-ring)
10032 (or pos (point))
10033 (or buffer (current-buffer)))
10034 (message "%s"
10035 (substitute-command-keys
10038 (defun org-mark-ring-goto (&optional n)
10039 "Jump to the previous position in the mark ring.
10040 With prefix arg N, jump back that many stored positions. When
10041 called several times in succession, walk through the entire ring.
10042 Org-mode commands jumping to a different position in the current file,
10043 or to another Org-mode file, automatically push the old position
10044 onto the ring."
10045 (interactive "p")
10046 (let (p m)
10047 (if (eq last-command this-command)
10048 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10049 (setq p org-mark-ring))
10050 (setq org-mark-ring-last-goto p)
10051 (setq m (car p))
10052 (org-pop-to-buffer-same-window (marker-buffer m))
10053 (goto-char m)
10054 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10056 (defun org-remove-angle-brackets (s)
10057 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10058 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10059 s)
10060 (defun org-add-angle-brackets (s)
10061 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10062 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10063 s)
10064 (defun org-remove-double-quotes (s)
10067 s)
10069 ;;; Following specific links
10071 (defun org-follow-timestamp-link ()
10072 (cond
10073 ((org-at-date-range-p t)
10074 (let ((org-agenda-start-on-weekday)
10075 (t1 (match-string 1))
10076 (t2 (match-string 2)))
10077 (setq t1 (time-to-days (org-time-string-to-time t1))
10078 t2 (time-to-days (org-time-string-to-time t2)))
10079 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10080 ((org-at-timestamp-p t)
10081 (org-agenda-list nil (time-to-days (org-time-string-to-time
10082 (substring (match-string 1) 0 10)))
10083 1))
10084 (t (error "This should not happen"))))
10087 ;;; Following file links
10088 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10089 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10090 (declare-function mailcap-mime-info
10091 "mailcap" (string &optional request no-decode))
10092 (defvar org-wait nil)
10093 (defun org-open-file (path &optional in-emacs line search)
10094 "Open the file at PATH.
10095 First, this expands any special file name abbreviations. Then the
10096 configuration variable `org-file-apps' is checked if it contains an
10097 entry for this file type, and if yes, the corresponding command is launched.
10099 If no application is found, Emacs simply visits the file.
10101 With optional prefix argument IN-EMACS, Emacs will visit the file.
10103 prefix arg, Org tries to avoid opening in Emacs
10104 and to use an external application to visit the file.
10106 Optional LINE specifies a line to go to, optional SEARCH a string
10107 to search for. If LINE or SEARCH is given, the file will be
10108 opened in Emacs, unless an entry from org-file-apps that makes
10109 use of groups in a regexp matches.
10111 If you want to change the way frames are used when following a
10112 link, please customize `org-link-frame-setup'.
10114 If the file does not exist, an error is thrown."
10115 (let* ((file (if (equal path "")
10116 buffer-file-name
10117 (substitute-in-file-name (expand-file-name path))))
10118 (file-apps (append org-file-apps (org-default-apps)))
10119 (apps (org-remove-if
10120 'org-file-apps-entry-match-against-dlink-p file-apps))
10121 (apps-dlink (org-remove-if-not
10122 'org-file-apps-entry-match-against-dlink-p file-apps))
10123 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10124 (dirp (if remp nil (file-directory-p file)))
10125 (file (if (and dirp org-open-directory-means-index-dot-org)
10126 (concat (file-name-as-directory file) "index.org")
10127 file))
10128 (a-m-a-p (assq 'auto-mode apps))
10129 (dfile (downcase file))
10130 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10131 (link (cond ((and (eq line nil)
10132 (eq search nil))
10133 file)
10134 (line
10135 (concat file "::" (number-to-string line)))
10136 (search
10137 (concat file "::" search))))
10138 (dlink (downcase link))
10139 (old-buffer (current-buffer))
10140 (old-pos (point))
10141 (old-mode major-mode)
10142 ext cmd link-match-data)
10144 (setq ext (match-string 1 dfile))
10146 (setq ext (match-string 1 dfile))))
10147 (cond
10148 ((member in-emacs '((16) system))
10149 (setq cmd (cdr (assoc 'system apps))))
10150 (in-emacs (setq cmd 'emacs))
10151 (t
10152 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10153 (and dirp (cdr (assoc 'directory apps)))
10154 ; first, try matching against apps-dlink
10155 ; if we get a match here, store the match data for later
10156 (let ((match (assoc-default dlink apps-dlink
10157 'string-match)))
10158 (if match
10159 (progn (setq link-match-data (match-data))
10160 match)
10161 (progn (setq in-emacs (or in-emacs line search))
10162 nil))) ; if we have no match in apps-dlink,
10163 ; always open the file in emacs if line or search
10164 ; is given (for backwards compatibility)
10165 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10166 'string-match)
10167 (cdr (assoc ext apps))
10168 (cdr (assoc t apps))))))
10169 (when (eq cmd 'system)
10170 (setq cmd (cdr (assoc 'system apps))))
10171 (when (eq cmd 'default)
10172 (setq cmd (cdr (assoc t apps))))
10173 (when (eq cmd 'mailcap)
10174 (require 'mailcap)
10175 (mailcap-parse-mailcaps)
10176 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10177 (command (mailcap-mime-info mime-type)))
10178 (if (stringp command)
10179 (setq cmd command)
10180 (setq cmd 'emacs))))
10181 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10182 (not (file-exists-p file))
10183 (not org-open-non-existing-files))
10184 (error "No such file: %s" file))
10185 (cond
10187 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10189 (setq cmd (replace-match "%s" t t cmd)))
10190 (while (string-match "%s" cmd)
10191 (setq cmd (replace-match
10192 (save-match-data
10193 (shell-quote-argument
10194 (convert-standard-filename file)))
10195 t t cmd)))
10197 ;; Replace "%1", "%2" etc. in command with group matches from regex
10198 (save-match-data
10199 (let ((match-index 1)
10200 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10201 (set-match-data link-match-data)
10202 (while (<= match-index number-of-groups)
10203 (let ((regex (concat "%" (number-to-string match-index)))
10204 (replace-with (match-string match-index dlink)))
10205 (while (string-match regex cmd)
10206 (setq cmd (replace-match replace-with t t cmd))))
10207 (setq match-index (+ match-index 1)))))
10209 (save-window-excursion
10210 (start-process-shell-command cmd nil cmd)
10211 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10212 ))
10213 ((or (stringp cmd)
10214 (eq cmd 'emacs))
10215 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10216 (widen)
10217 (if line (org-goto-line line)
10218 (if search (org-link-search search))))
10219 ((consp cmd)
10220 (let ((file (convert-standard-filename file)))
10221 (save-match-data
10222 (set-match-data link-match-data)
10223 (eval cmd))))
10224 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10225 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10226 (or (not (equal old-buffer (current-buffer)))
10227 (not (equal old-pos (point))))
10228 (org-mark-ring-push old-pos old-buffer))))
10230 (defun org-file-apps-entry-match-against-dlink-p (entry)
10231 "This function returns non-nil if `entry' uses a regular
10232 expression which should be matched against the whole link by
10233 org-open-file.
10235 It assumes that is the case when the entry uses a regular
10236 expression which has at least one grouping construct and the
10237 action is either a lisp form or a command string containing
10238 '%1', i.e. using at least one subexpression match as a
10239 parameter."
10240 (let ((selector (car entry))
10241 (action (cdr entry)))
10242 (if (stringp selector)
10243 (and (> (regexp-opt-depth selector) 0)
10244 (or (and (stringp action)
10245 (string-match "%[0-9]" action))
10246 (consp action)))
10247 nil)))
10249 (defun org-default-apps ()
10250 "Return the default applications for this operating system."
10251 (cond
10252 ((eq system-type 'darwin)
10253 org-file-apps-defaults-macosx)
10254 ((eq system-type 'windows-nt)
10255 org-file-apps-defaults-windowsnt)
10256 (t org-file-apps-defaults-gnu)))
10258 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10259 "Convert extensions to regular expressions in the cars of LIST.
10260 Also, weed out any non-string entries, because the return value is used
10261 only for regexp matching.
10262 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10263 point to the symbol `emacs', indicating that the file should
10264 be opened in Emacs."
10265 (append
10266 (delq nil
10267 (mapcar (lambda (x)
10268 (if (not (stringp (car x)))
10269 nil
10271 x
10273 list))
10274 (if add-auto-mode
10275 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10277 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10278 (defun org-file-remote-p (file)
10279 "Test whether FILE specifies a location on a remote system.
10280 Return non-nil if the location is indeed remote.
10284 (cond ((fboundp 'file-remote-p)
10285 (file-remote-p file))
10286 ((fboundp 'tramp-handle-file-remote-p)
10287 (tramp-handle-file-remote-p file))
10288 ((and (boundp 'ange-ftp-name-format)
10289 (string-match (car ange-ftp-name-format) file))
10290 t)
10291 (t nil)))
10294 ;;;; Refiling
10296 (defun org-get-org-file ()
10297 "Read a filename, with default directory `org-directory'."
10298 (let ((default (or org-default-notes-file remember-data-file)))
10299 (read-file-name (format "File name [%s]: " default)
10300 (file-name-as-directory org-directory)
10301 default)))
10303 (defun org-notes-order-reversed-p ()
10304 "Check if the current file should receive notes in reversed order."
10305 (cond
10306 ((not org-reverse-note-order) nil)
10307 ((eq t org-reverse-note-order) t)
10308 ((not (listp org-reverse-note-order)) nil)
10309 (t (catch 'exit
10310 (let ((all org-reverse-note-order)
10311 entry)
10312 (while (setq entry (pop all))
10313 (if (string-match (car entry) buffer-file-name)
10314 (throw 'exit (cdr entry))))
10315 nil)))))
10317 (defvar org-refile-target-table nil
10318 "The list of refile targets, created by `org-refile'.")
10320 (defvar org-agenda-new-buffers nil
10321 "Buffers created to visit agenda files.")
10323 (defvar org-refile-cache nil
10324 "Cache for refile targets.")
10326 (defvar org-refile-markers nil
10327 "All the markers used for caching refile locations.")
10329 (defun org-refile-marker (pos)
10330 "Get a new refile marker, but only if caching is in use."
10331 (if (not org-refile-use-cache)
10332 pos
10333 (let ((m (make-marker)))
10334 (move-marker m pos)
10335 (push m org-refile-markers)
10336 m)))
10338 (defun org-refile-cache-clear ()
10339 "Clear the refile cache and disable all the markers."
10340 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10341 (setq org-refile-markers nil)
10342 (setq org-refile-cache nil)
10343 (message "Refile cache has been cleared"))
10345 (defun org-refile-cache-check-set (set)
10346 "Check if all the markers in the cache still have live buffers."
10347 (let (marker)
10348 (catch 'exit
10349 (while (and set (setq marker (nth 3 (pop set))))
10350 ;; if org-refile-use-outline-path is 'file, marker may be nil
10351 (when (and marker (null (marker-buffer marker)))
10352 (message "not found") (sit-for 3)
10353 (throw 'exit nil)))
10354 t)))
10356 (defun org-refile-cache-put (set &rest identifiers)
10357 "Push the refile targets SET into the cache, under IDENTIFIERS."
10358 (let* ((key (sha1 (prin1-to-string identifiers)))
10359 (entry (assoc key org-refile-cache)))
10360 (if entry
10361 (setcdr entry set)
10362 (push (cons key set) org-refile-cache))))
10364 (defun org-refile-cache-get (&rest identifiers)
10365 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10366 (cond
10367 ((not org-refile-cache) nil)
10368 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10369 (t
10370 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10371 org-refile-cache))))
10372 (and set (org-refile-cache-check-set set) set)))))
10374 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10375 "Produce a table with refile targets."
10376 (let ((case-fold-search nil)
10377 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10378 (entries (or org-refile-targets '((nil . (:level . 1)))))
10379 targets tgs txt re files f desc descre fast-path-p level pos0)
10380 (message "Getting targets...")
10381 (with-current-buffer (or default-buffer (current-buffer))
10382 (while (setq entry (pop entries))
10383 (setq files (car entry) desc (cdr entry))
10384 (setq fast-path-p nil)
10385 (cond
10386 ((null files) (setq files (list (current-buffer))))
10387 ((eq files 'org-agenda-files)
10388 (setq files (org-agenda-files 'unrestricted)))
10389 ((and (symbolp files) (fboundp files))
10390 (setq files (funcall files)))
10391 ((and (symbolp files) (boundp files))
10392 (setq files (symbol-value files))))
10393 (if (stringp files) (setq files (list files)))
10394 (cond
10395 ((eq (car desc) :tag)
10397 ((eq (car desc) :todo)
10399 ((eq (car desc) :regexp)
10400 (setq descre (cdr desc)))
10401 ((eq (car desc) :level)
10403 (if org-odd-levels-only
10404 (1- (* 2 (cdr desc)))
10405 (cdr desc)))
10407 ((eq (car desc) :maxlevel)
10408 (setq fast-path-p t)
10410 (if org-odd-levels-only
10411 (1- (* 2 (cdr desc)))
10412 (cdr desc)))
10414 (t (error "Bad refiling target description %s" desc)))
10415 (while (setq f (pop files))
10416 (with-current-buffer
10417 (if (bufferp f) f (org-get-agenda-file-buffer f))
10418 (or
10419 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10420 (progn
10421 (if (bufferp f) (setq f (buffer-file-name
10422 (buffer-base-buffer f))))
10423 (setq f (and f (expand-file-name f)))
10424 (if (eq org-refile-use-outline-path 'file)
10425 (push (list (file-name-nondirectory f) f nil nil) tgs))
10426 (save-excursion
10427 (save-restriction
10428 (widen)
10429 (goto-char (point-min))
10430 (while (re-search-forward descre nil t)
10431 (goto-char (setq pos0 (point-at-bol)))
10432 (catch 'next
10433 (when org-refile-target-verify-function
10434 (save-match-data
10435 (or (funcall org-refile-target-verify-function)
10436 (throw 'next t))))
10437 (when (and (looking-at org-complex-heading-regexp)
10438 (not (member (match-string 4) excluded-entries))
10439 (match-string 4))
10440 (setq level (org-reduced-level
10441 (- (match-end 1) (match-beginning 1)))
10442 txt (org-link-display-format (match-string 4))
10444 re (format org-complex-heading-regexp-format
10445 (regexp-quote (match-string 4))))
10446 (when org-refile-use-outline-path
10447 (setq txt (mapconcat
10448 'org-protect-slash
10449 (append
10450 (if (eq org-refile-use-outline-path
10451 'file)
10452 (list (file-name-nondirectory
10453 (buffer-file-name
10454 (buffer-base-buffer))))
10455 (if (eq org-refile-use-outline-path
10456 'full-file-path)
10457 (list (buffer-file-name
10458 (buffer-base-buffer)))))
10459 (org-get-outline-path fast-path-p
10460 level txt)
10461 (list txt))
10462 "/")))
10463 (push (list txt f re (org-refile-marker (point)))
10464 tgs)))
10465 (when (= (point) pos0)
10466 ;; verification function has not moved point
10467 (goto-char (point-at-eol))))))))
10468 (when org-refile-use-cache
10469 (org-refile-cache-put tgs (buffer-file-name) descre))
10470 (setq targets (append tgs targets))
10471 ))))
10472 (message "Getting targets...done")
10473 (nreverse targets)))
10475 (defun org-protect-slash (s)
10476 (while (string-match "/" s)
10478 s)
10480 (defvar org-olpa (make-vector 20 nil))
10482 (defun org-get-outline-path (&optional fastp level heading)
10483 "Return the outline path to the current entry, as a list.
10485 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10486 routine which makes outline path derivations for an entire file,
10487 avoiding backtracing. Refile target collection makes use of that."
10488 (if fastp
10489 (progn
10490 (if (> level 19)
10491 (error "Outline path failure, more than 19 levels"))
10492 (loop for i from level upto 19 do
10493 (aset org-olpa i nil))
10494 (prog1
10495 (delq nil (append org-olpa nil))
10496 (aset org-olpa level heading)))
10497 (let (rtn case-fold-search)
10498 (save-excursion
10499 (save-restriction
10500 (widen)
10501 (while (org-up-heading-safe)
10502 (when (looking-at org-complex-heading-regexp)
10503 (push (org-match-string-no-properties 4) rtn)))
10504 rtn)))))
10506 (defun org-format-outline-path (path &optional width prefix)
10507 "Format the outline path PATH for display.
10508 Width is the maximum number of characters that is available.
10509 Prefix is a prefix to be included in the returned string,
10510 such as the file name."
10511 (setq width (or width 79))
10512 (if prefix (setq width (- width (length prefix))))
10513 (if (not path)
10514 (or prefix "")
10515 (let* ((nsteps (length path))
10516 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10517 (maxwidth (if (<= total-width width)
10518 10000 ;; everything fits
10519 ;; we need to shorten the level headings
10520 (/ (- width nsteps) nsteps)))
10521 (org-odd-levels-only nil)
10522 (n 0)
10523 (total (1+ (length prefix))))
10524 (setq maxwidth (max maxwidth 10))
10525 (concat prefix
10526 (mapconcat
10527 (lambda (h)
10528 (setq n (1+ n))
10529 (if (and (= n nsteps) (< maxwidth 10000))
10530 (setq maxwidth (- total-width total)))
10531 (if (< (length h) maxwidth)
10532 (progn (setq total (+ total (length h) 1)) h)
10533 (setq h (substring h 0 (- maxwidth 2))
10534 total (+ total maxwidth 1))
10536 (setq h (substring h 0 (match-beginning 0))))
10537 (setq h (concat h "..")))
10538 (org-add-props h nil 'face
10539 (nth (% (1- n) org-n-level-faces)
10540 org-level-faces))
10541 h)
10542 path "/")))))
10544 (defun org-display-outline-path (&optional file current)
10545 "Display the current outline path in the echo area."
10546 (interactive "P")
10547 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10548 (case-fold-search nil)
10549 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10550 (if current (setq path (append path
10551 (save-excursion
10552 (org-back-to-heading t)
10553 (if (looking-at org-complex-heading-regexp)
10554 (list (match-string 4)))))))
10555 (message "%s"
10556 (org-format-outline-path
10557 path
10558 (1- (frame-width))
10559 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10561 (defvar org-refile-history nil
10562 "History for refiling operations.")
10564 (defvar org-after-refile-insert-hook nil
10565 "Hook run after `org-refile' has inserted its stuff at the new location.
10566 Note that this is still *before* the stuff will be removed from
10567 the *old* location.")
10569 (defvar org-capture-last-stored-marker)
10570 (defun org-refile (&optional goto default-buffer rfloc)
10571 "Move the entry or entries at point to another heading.
10572 The list of target headings is compiled using the information in
10573 `org-refile-targets', which see.
10575 At the target location, the entry is filed as a subitem of the target
10576 heading. Depending on `org-reverse-note-order', the new subitem will
10577 either be the first or the last subitem.
10579 If there is an active region, all entries in that region will be moved.
10580 However, the region must fulfill the requirement that the first heading
10581 is the first one sets the top-level of the moved text - at most siblings
10582 below it are allowed.
10584 With prefix arg GOTO, the command will only visit the target location
10585 and not actually move anything.
10588 go to the location where the last refiling operation has put the subtree.
10589 With a prefix argument of `2', refile to the running clock.
10591 RFLOC can be a refile location obtained in a different way.
10593 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10595 If you are using target caching (see `org-refile-use-cache'),
10596 You have to clear the target cache in order to find new targets.
10597 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10598 prefix argument (`C-u C-u C-u C-c C-w')."
10600 (interactive "P")
10601 (if (member goto '(0 (64)))
10602 (org-refile-cache-clear)
10603 (let* ((cbuf (current-buffer))
10604 (regionp (org-region-active-p))
10605 (region-start (and regionp (region-beginning)))
10606 (region-end (and regionp (region-end)))
10607 (region-length (and regionp (- region-end region-start)))
10608 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10609 pos it nbuf file re level reversed)
10610 (setq last-command nil)
10611 (when regionp
10612 (goto-char region-start)
10613 (or (bolp) (goto-char (point-at-bol)))
10614 (setq region-start (point))
10615 (unless (or (org-kill-is-subtree-p
10616 (buffer-substring region-start region-end))
10617 (prog1 org-refile-active-region-within-subtree
10618 (org-toggle-heading)))
10619 (error "The region is not a (sequence of) subtree(s)")))
10620 (if (equal goto '(16))
10621 (org-refile-goto-last-stored)
10622 (when (or
10623 (and (equal goto 2)
10624 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10625 (prog1
10626 (setq it (list (or org-clock-heading "running clock")
10627 (buffer-file-name
10628 (marker-buffer org-clock-hd-marker))
10629 ""
10630 (marker-position org-clock-hd-marker)))
10631 (setq goto nil)))
10632 (setq it (or rfloc
10633 (let (heading-text)
10634 (save-excursion
10635 (unless goto
10636 (org-back-to-heading t)
10637 (setq heading-text
10638 (nth 4 (org-heading-components))))
10639 (org-refile-get-location
10640 (cond (goto "Goto")
10641 (regionp "Refile region to")
10644 default-buffer
10645 org-refile-allow-creating-parent-nodes
10646 goto))))))
10647 (setq file (nth 1 it)
10648 re (nth 2 it)
10649 pos (nth 3 it))
10650 (if (and (not goto)
10651 pos
10652 (equal (buffer-file-name) file)
10653 (if regionp
10654 (and (>= pos region-start)
10655 (<= pos region-end))
10656 (and (>= pos (point))
10657 (< pos (save-excursion
10658 (org-end-of-subtree t t))))))
10659 (error "Cannot refile to position inside the tree or region"))
10661 (setq nbuf (or (find-buffer-visiting file)
10662 (find-file-noselect file)))
10663 (if goto
10664 (progn
10665 (org-pop-to-buffer-same-window nbuf)
10666 (goto-char pos)
10667 (org-show-context 'org-goto))
10668 (if regionp
10669 (progn
10670 (org-kill-new (buffer-substring region-start region-end))
10671 (org-save-markers-in-region region-start region-end))
10672 (org-copy-subtree 1 nil t))
10673 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10674 (find-file-noselect file)))
10675 (setq reversed (org-notes-order-reversed-p))
10676 (save-excursion
10677 (save-restriction
10678 (widen)
10679 (if pos
10680 (progn
10681 (goto-char pos)
10682 (looking-at org-outline-regexp)
10683 (setq level (org-get-valid-level (funcall outline-level) 1))
10684 (goto-char
10685 (if reversed
10686 (or (outline-next-heading) (point-max))
10687 (or (save-excursion (org-get-next-sibling))
10688 (org-end-of-subtree t t)
10689 (point-max)))))
10690 (setq level 1)
10691 (if (not reversed)
10692 (goto-char (point-max))
10693 (goto-char (point-min))
10694 (or (outline-next-heading) (goto-char (point-max)))))
10695 (if (not (bolp)) (newline))
10696 (org-paste-subtree level)
10697 (when org-log-refile
10698 (org-add-log-setup 'refile nil nil 'findpos
10699 org-log-refile)
10700 (unless (eq org-log-refile 'note)
10701 (save-excursion (org-add-log-note))))
10702 (and org-auto-align-tags (org-set-tags nil t))
10703 (bookmark-set "org-refile-last-stored")
10704 ;; If we are refiling for capture, make sure that the
10705 ;; last-capture pointers point here
10706 (when (org-bound-and-true-p org-refile-for-capture)
10707 (bookmark-set "org-capture-last-stored-marker")
10708 (move-marker org-capture-last-stored-marker (point)))
10709 (if (fboundp 'deactivate-mark) (deactivate-mark))
10710 (run-hooks 'org-after-refile-insert-hook))))
10711 (if regionp
10712 (delete-region (point) (+ (point) region-length))
10713 (org-cut-subtree))
10714 (when (featurep 'org-inlinetask)
10715 (org-inlinetask-remove-END-maybe))
10716 (setq org-markers-to-move nil)
10719 (defun org-refile-goto-last-stored ()
10720 "Go to the location where the last refile was stored."
10721 (interactive)
10722 (bookmark-jump "org-refile-last-stored")
10723 (message "This is the location of the last refile"))
10725 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10726 no-exclude)
10727 "Prompt the user for a refile location, using PROMPT.
10728 PROMPT should not be suffixed with a colon and a space, because
10729 this function appends the default value from
10730 `org-refile-history' automatically, if that is not empty.
10731 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10732 this is used for the GOTO interface."
10733 (let ((org-refile-targets org-refile-targets)
10734 (org-refile-use-outline-path org-refile-use-outline-path)
10735 excluded-entries)
10736 (when (and (eq major-mode 'org-mode)
10737 (not org-refile-use-cache)
10738 (not no-exclude))
10739 (org-map-tree
10740 (lambda()
10741 (setq excluded-entries
10742 (append excluded-entries (list (org-get-heading t t)))))))
10743 (setq org-refile-target-table
10744 (org-refile-get-targets default-buffer excluded-entries)))
10745 (unless org-refile-target-table
10746 (error "No refile targets"))
10747 (let* ((prompt (concat prompt
10748 (and (car org-refile-history)
10749 (concat " (default " (car org-refile-history) ")"))
10750 ": "))
10751 (cbuf (current-buffer))
10752 (partial-completion-mode nil)
10753 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10754 (cfunc (if (and org-refile-use-outline-path
10755 org-outline-path-complete-in-steps)
10756 'org-olpath-completing-read
10757 'org-icompleting-read))
10758 (extra (if org-refile-use-outline-path "/" ""))
10759 (filename (and cfn (expand-file-name cfn)))
10760 (tbl (mapcar
10761 (lambda (x)
10762 (if (and (not (member org-refile-use-outline-path
10763 '(file full-file-path)))
10764 (not (equal filename (nth 1 x))))
10765 (cons (concat (car x) extra " ("
10766 (file-name-nondirectory (nth 1 x)) ")")
10767 (cdr x))
10768 (cons (concat (car x) extra) (cdr x))))
10769 org-refile-target-table))
10770 (completion-ignore-case t)
10771 pa answ parent-target child parent old-hist)
10772 (setq old-hist org-refile-history)
10773 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10774 nil 'org-refile-history (car org-refile-history)))
10775 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10776 (org-refile-check-position pa)
10777 (if pa
10778 (progn
10779 (when (or (not org-refile-history)
10780 (not (eq old-hist org-refile-history))
10781 (not (equal (car pa) (car org-refile-history))))
10782 (setq org-refile-history
10783 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10784 org-refile-history
10785 (cdr org-refile-history))))
10786 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10787 (pop org-refile-history)))
10788 pa)
10790 (progn
10791 (setq parent (match-string 1 answ)
10792 child (match-string 2 answ))
10793 (setq parent-target (or (assoc parent tbl)
10794 (assoc (concat parent "/") tbl)))
10795 (when (and parent-target
10796 (or (eq new-nodes t)
10797 (and (eq new-nodes 'confirm)
10799 child)))))
10800 (org-refile-new-child parent-target child)))
10801 (error "Invalid target location")))))
10803 (defun org-refile-check-position (refile-pointer)
10804 "Check if the refile pointer matches the readline to which it points."
10805 (let* ((file (nth 1 refile-pointer))
10806 (re (nth 2 refile-pointer))
10807 (pos (nth 3 refile-pointer))
10808 buffer)
10809 (when (org-string-nw-p re)
10810 (setq buffer (if (markerp pos)
10811 (marker-buffer pos)
10812 (or (find-buffer-visiting file)
10813 (find-file-noselect file))))
10814 (with-current-buffer buffer
10815 (save-excursion
10816 (save-restriction
10817 (widen)
10818 (goto-char pos)
10819 (beginning-of-line 1)
10820 (unless (org-looking-at-p re)
10821 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10823 (defun org-refile-new-child (parent-target child)
10824 "Use refile target PARENT-TARGET to add new CHILD below it."
10825 (unless parent-target
10826 (error "Cannot find parent for new node"))
10827 (let ((file (nth 1 parent-target))
10828 (pos (nth 3 parent-target))
10829 level)
10830 (with-current-buffer (or (find-buffer-visiting file)
10831 (find-file-noselect file))
10832 (save-excursion
10833 (save-restriction
10834 (widen)
10835 (if pos
10836 (goto-char pos)
10837 (goto-char (point-max))
10838 (if (not (bolp)) (newline)))
10839 (when (looking-at org-outline-regexp)
10840 (setq level (funcall outline-level))
10841 (org-end-of-subtree t t))
10842 (org-back-over-empty-lines)
10844 (if pos (org-get-valid-level level 1) 1) ?*)
10846 (beginning-of-line 0)
10847 (list (concat (car parent-target) "/" child) file "" (point)))))))
10849 (defun org-olpath-completing-read (prompt collection &rest args)
10850 "Read an outline path like a file name."
10851 (let ((thetable collection)
10852 (org-completion-use-ido nil) ; does not work with ido.
10853 (org-completion-use-iswitchb nil)) ; or iswitchb
10854 (apply
10855 'org-icompleting-read prompt
10856 (lambda (string predicate &optional flag)
10857 (let (rtn r f (l (length string)))
10858 (cond
10859 ((eq flag nil)
10860 ;; try completion
10861 (try-completion string thetable))
10862 ((eq flag t)
10863 ;; all-completions
10864 (setq rtn (all-completions string thetable predicate))
10865 (mapcar
10866 (lambda (x)
10867 (setq r (substring x l))
10868 (if (string-match " ([^)]*)$" x)
10869 (setq f (match-string 0 x))
10870 (setq f ""))
10871 (if (string-match "/" r)
10872 (concat string (substring r 0 (match-end 0)) f)
10873 x))
10874 rtn))
10875 ((eq flag 'lambda)
10876 ;; exact match?
10877 (assoc string thetable)))
10878 ))
10879 args)))
10881 ;;;; Dynamic blocks
10883 (defun org-find-dblock (name)
10884 "Find the first dynamic block with name NAME in the buffer.
10885 If not found, stay at current position and return nil."
10886 (let (pos)
10887 (save-excursion
10888 (goto-char (point-min))
10890 nil t)
10891 (match-beginning 0))))
10892 (if pos (goto-char pos))
10893 pos))
10895 (defconst org-dblock-start-re
10897 "Matches the start line of a dynamic block, with parameters.")
10900 "Matches the end of a dynamic block.")
10902 (defun org-create-dblock (plist)
10903 "Create a dynamic block section, with parameters taken from PLIST.
10904 PLIST must contain a :name entry which is used as name of the block."
10906 (end-of-line 1)
10907 (newline))
10908 (let ((col (current-column))
10909 (name (plist-get plist :name)))
10910 (insert "#+BEGIN: " name)
10911 (while plist
10912 (if (eq (car plist) :name)
10913 (setq plist (cddr plist))
10914 (insert " " (prin1-to-string (pop plist)))))
10916 (beginning-of-line -2)))
10918 (defun org-prepare-dblock ()
10919 "Prepare dynamic block for refresh.
10920 This empties the block, puts the cursor at the insert position and returns
10921 the property list including an extra property :name with the block name."
10922 (unless (looking-at org-dblock-start-re)
10923 (error "Not at a dynamic block"))
10924 (let* ((begdel (1+ (match-end 0)))
10925 (name (org-no-properties (match-string 1)))
10926 (params (append (list :name name)
10927 (read (concat "(" (match-string 3) ")")))))
10928 (save-excursion
10929 (beginning-of-line 1)
10931 (setq params (plist-put params :indentation-column (current-column))))
10932 (unless (re-search-forward org-dblock-end-re nil t)
10933 (error "Dynamic block not terminated"))
10934 (setq params
10935 (append params
10936 (list :content (buffer-substring
10937 begdel (match-beginning 0)))))
10938 (delete-region begdel (match-beginning 0))
10939 (goto-char begdel)
10940 (open-line 1)
10941 params))
10943 (defun org-map-dblocks (&optional command)
10944 "Apply COMMAND to all dynamic blocks in the current buffer.
10945 If COMMAND is not given, use `org-update-dblock'."
10946 (let ((cmd (or command 'org-update-dblock)))
10947 (save-excursion
10948 (goto-char (point-min))
10949 (while (re-search-forward org-dblock-start-re nil t)
10950 (goto-char (match-beginning 0))
10951 (save-excursion
10952 (condition-case nil
10953 (funcall cmd)
10954 (error (message "Error during update of dynamic block"))))
10955 (unless (re-search-forward org-dblock-end-re nil t)
10956 (error "Dynamic block not terminated"))))))
10958 (defun org-dblock-update (&optional arg)
10959 "User command for updating dynamic blocks.
10960 Update the dynamic block at point. With prefix ARG, update all dynamic
10961 blocks in the buffer."
10962 (interactive "P")
10963 (if arg
10964 (org-update-all-dblocks)
10965 (or (looking-at org-dblock-start-re)
10966 (org-beginning-of-dblock))
10967 (org-update-dblock)))
10969 (defun org-update-dblock ()
10970 "Update the dynamic block at point.
10971 This means to empty the block, parse for parameters and then call
10972 the correct writing function."
10973 (interactive)
10974 (save-window-excursion
10975 (let* ((pos (point))
10976 (line (org-current-line))
10977 (params (org-prepare-dblock))
10978 (name (plist-get params :name))
10979 (indent (plist-get params :indentation-column))
10980 (cmd (intern (concat "org-dblock-write:" name))))
10981 (message "Updating dynamic block `%s' at line %d..." name line)
10982 (funcall cmd params)
10983 (message "Updating dynamic block `%s' at line %d...done" name line)
10984 (goto-char pos)
10985 (when (and indent (> indent 0))
10986 (setq indent (make-string indent ?\ ))
10987 (save-excursion
10988 (org-beginning-of-dblock)
10989 (forward-line 1)
10990 (while (not (looking-at org-dblock-end-re))
10991 (insert indent)
10992 (beginning-of-line 2))
10993 (when (looking-at org-dblock-end-re)
10995 (replace-match ""))
10996 (insert indent)))))))
10998 (defun org-beginning-of-dblock ()
10999 "Find the beginning of the dynamic block at point.
11000 Error if there is no such block at point."
11001 (let ((pos (point))
11002 beg)
11003 (end-of-line 1)
11004 (if (and (re-search-backward org-dblock-start-re nil t)
11005 (setq beg (match-beginning 0))
11006 (re-search-forward org-dblock-end-re nil t)
11007 (> (match-end 0) pos))
11008 (goto-char beg)
11009 (goto-char pos)
11010 (error "Not in a dynamic block"))))
11012 (defun org-update-all-dblocks ()
11013 "Update all dynamic blocks in the buffer.
11014 This function can be used in a hook."
11015 (interactive)
11016 (when (eq major-mode 'org-mode)
11017 (org-map-dblocks 'org-update-dblock)))
11020 ;;;; Completion
11022 (defconst org-additional-option-like-keywords
11023 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11024 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11025 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11026 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11027 "BEGIN:" "END:"
11028 "ORGTBL" "TBLFM:" "TBLNAME:"
11029 "BEGIN_EXAMPLE" "END_EXAMPLE"
11030 "BEGIN_QUOTE" "END_QUOTE"
11031 "BEGIN_VERSE" "END_VERSE"
11032 "BEGIN_CENTER" "END_CENTER"
11033 "BEGIN_SRC" "END_SRC"
11034 "BEGIN_RESULT" "END_RESULT"
11035 "NAME:" "RESULTS:"
11036 "HEADER:" "HEADERS:"
11037 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11038 "CAPTION:" "LABEL:"
11039 "SETUPFILE:"
11040 "INCLUDE:"
11041 "BIND:"
11042 "MACRO:"))
11044 (defcustom org-structure-template-alist
11045 '(
11058 ("L" "#+latex: "
11062 ("H" "#+html: "
11065 ("A" "#+ascii: ")
11066 ("i" "#+index: ?"
11067 "#+index: ?")
11068 ("I" "#+include %file ?"
11070 )
11071 "Structure completion elements.
11072 This is a list of abbreviation keys and values. The value gets inserted
11073 if you type `<' followed by the key and then press the completion key,
11074 usually `M-TAB'. %file will be replaced by a file name after prompting
11075 for the file using completion. The cursor will be placed at the position
11076 of the `?` in the template.
11077 There are two templates for each key, the first uses the original Org syntax,
11078 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11079 the default when the /org-mtags.el/ module has been loaded. See also the
11080 variable `org-mtags-prefer-muse-templates'.
11081 This is an experimental feature, it is undecided if it is going to stay in."
11082 :group 'org-completion
11083 :type '(repeat
11084 (string :tag "Key")
11085 (string :tag "Template")
11086 (string :tag "Muse Template")))
11088 (defun org-try-structure-completion ()
11089 "Try to complete a structure template before point.
11091 expands them."
11092 (let ((l (buffer-substring (point-at-bol) (point)))
11093 a)
11096 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11097 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11098 (match-beginning 1)) a)
11099 t)))
11101 (defun org-complete-expand-structure-template (start cell)
11102 "Expand a structure template."
11103 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11104 (rpl (nth (if musep 2 1) cell))
11105 (ind ""))
11106 (delete-region start (point))
11108 (cond
11109 ((bolp))
11111 (setq ind (buffer-substring (point-at-bol) (point))))
11112 (t (newline))))
11113 (setq start (point))
11114 (if (string-match "%file" rpl)
11115 (setq rpl (replace-match
11116 (concat
11118 (save-match-data
11119 (abbreviate-file-name (read-file-name "Include file: ")))
11121 t t rpl)))
11124 (insert rpl)
11127 ;;;; TODO, DEADLINE, Comments
11129 (defun org-toggle-comment ()
11130 "Change the COMMENT state of an entry."
11131 (interactive)
11132 (save-excursion
11133 (org-back-to-heading)
11134 (let (case-fold-search)
11135 (cond
11136 ((looking-at (format org-heading-keyword-regexp-format
11137 org-comment-string))
11138 (goto-char (match-end 1))
11139 (looking-at (concat " +" org-comment-string))
11140 (replace-match "" t t)
11141 (when (eolp) (insert " ")))
11142 ((looking-at org-outline-regexp)
11143 (goto-char (match-end 0))
11144 (insert org-comment-string " "))))))
11146 (defvar org-last-todo-state-is-todo nil
11147 "This is non-nil when the last TODO state change led to a TODO state.
11148 If the last change removed the TODO tag or switched to DONE, then
11149 this is nil.")
11151 (defvar org-setting-tags nil) ; dynamically skipped
11153 (defvar org-todo-setup-filter-hook nil
11154 "Hook for functions that pre-filter todo specs.
11155 Each function takes a todo spec and returns either nil or the spec
11156 transformed into canonical form." )
11158 (defvar org-todo-get-default-hook nil
11159 "Hook for functions that get a default item for todo.
11160 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11161 nil or a string to be used for the todo mark." )
11163 (defvar org-agenda-headline-snapshot-before-repeat)
11165 (defun org-current-effective-time ()
11166 "Return current time adjusted for `org-extend-today-until' variable"
11167 (let* ((ct (org-current-time))
11168 (dct (decode-time ct))
11169 (ct1
11170 (if (and org-use-effective-time
11171 (< (nth 2 dct) org-extend-today-until))
11172 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11173 ct)))
11174 ct1))
11176 (defun org-todo-yesterday (&optional arg)
11177 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11178 (interactive "P")
11179 (if (eq major-mode 'org-agenda-mode)
11180 (apply 'org-agenda-todo-yesterday arg)
11181 (let* ((hour (third (decode-time
11182 (org-current-time))))
11183 (org-extend-today-until (1+ hour)))
11184 (org-todo arg))))
11186 (defun org-todo (&optional arg)
11187 "Change the TODO state of an item.
11188 The state of an item is given by a keyword at the start of the heading,
11189 like
11190 *** TODO Write paper
11191 *** DONE Call mom
11193 The different keywords are specified in the variable `org-todo-keywords'.
11195 So for this example: when the item starts with TODO, it is changed to DONE.
11196 When it starts with DONE, the DONE is removed. And when neither TODO nor
11197 DONE are present, add TODO at the beginning of the heading.
11200 state.
11201 With numeric prefix arg, switch to that state.
11203 keywords (nextset).
11205 With a numeric prefix arg of 0, inhibit note taking for the change.
11207 For calling through lisp, arg is also interpreted in the following way:
11208 'none -> empty state
11210 'done -> switch to DONE
11211 'nextset -> switch to the next set of keywords
11212 'previousset -> switch to the previous set of keywords
11214 really is a member of `org-todo-keywords'."
11215 (interactive "P")
11216 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11217 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11218 'region-start-level 'region))
11219 org-loop-over-headlines-in-active-region)
11220 (org-map-entries
11221 `(org-todo ,arg)
11222 org-loop-over-headlines-in-active-region
11223 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11224 (if (equal arg '(16)) (setq arg 'nextset))
11225 (let ((org-blocker-hook org-blocker-hook)
11226 (case-fold-search nil))
11227 (when (equal arg '(64))
11228 (setq arg nil org-blocker-hook nil))
11229 (when (and org-blocker-hook
11230 (or org-inhibit-blocking
11231 (org-entry-get nil "NOBLOCKING")))
11232 (setq org-blocker-hook nil))
11233 (save-excursion
11234 (catch 'exit
11235 (org-back-to-heading t)
11236 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11239 (let* ((match-data (match-data))
11240 (startpos (point-at-bol))
11241 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11242 (org-log-done org-log-done)
11243 (org-log-repeat org-log-repeat)
11244 (org-todo-log-states org-todo-log-states)
11245 (org-inhibit-logging
11246 (if (equal arg 0)
11247 (progn (setq arg nil) 'note) org-inhibit-logging))
11248 (this (match-string 1))
11249 (hl-pos (match-beginning 0))
11250 (head (org-get-todo-sequence-head this))
11251 (ass (assoc head org-todo-kwd-alist))
11252 (interpret (nth 1 ass))
11253 (done-word (nth 3 ass))
11254 (final-done-word (nth 4 ass))
11255 (last-state (or this ""))
11256 (completion-ignore-case t)
11257 (member (member this org-todo-keywords-1))
11258 (tail (cdr member))
11259 (state (cond
11260 ((and org-todo-key-trigger
11261 (or (and (equal arg '(4))
11262 (eq org-use-fast-todo-selection 'prefix))
11263 (and (not arg) org-use-fast-todo-selection
11264 (not (eq org-use-fast-todo-selection
11265 'prefix)))))
11266 ;; Use fast selection
11267 (org-fast-todo-selection))
11268 ((and (equal arg '(4))
11269 (or (not org-use-fast-todo-selection)
11270 (not org-todo-key-trigger)))
11271 ;; Read a state with completion
11272 (org-icompleting-read
11273 "State: " (mapcar (lambda(x) (list x))
11274 org-todo-keywords-1)
11275 nil t))
11276 ((eq arg 'right)
11277 (if this
11278 (if tail (car tail) nil)
11279 (car org-todo-keywords-1)))
11280 ((eq arg 'left)
11281 (if (equal member org-todo-keywords-1)
11282 nil
11283 (if this
11284 (nth (- (length org-todo-keywords-1)
11285 (length tail) 2)
11286 org-todo-keywords-1)
11287 (org-last org-todo-keywords-1))))
11288 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11289 (setq arg nil))) ; hack to fall back to cycling
11290 (arg
11291 ;; user or caller requests a specific state
11292 (cond
11293 ((equal arg "") nil)
11294 ((eq arg 'none) nil)
11295 ((eq arg 'done) (or done-word (car org-done-keywords)))
11296 ((eq arg 'nextset)
11297 (or (car (cdr (member head org-todo-heads)))
11298 (car org-todo-heads)))
11299 ((eq arg 'previousset)
11300 (let ((org-todo-heads (reverse org-todo-heads)))
11301 (or (car (cdr (member head org-todo-heads)))
11302 (car org-todo-heads))))
11303 ((car (member arg org-todo-keywords-1)))
11304 ((stringp arg)
11305 (error "State `%s' not valid in this file" arg))
11306 ((nth (1- (prefix-numeric-value arg))
11307 org-todo-keywords-1))))
11308 ((null member) (or head (car org-todo-keywords-1)))
11309 ((equal this final-done-word) nil) ;; -> make empty
11310 ((null tail) nil) ;; -> first entry
11311 ((memq interpret '(type priority))
11312 (if (eq this-command last-command)
11313 (car tail)
11314 (if (> (length tail) 0)
11315 (or done-word (car org-done-keywords))
11316 nil)))
11317 (t
11318 (car tail))))
11319 (state (or
11320 (run-hook-with-args-until-success
11321 'org-todo-get-default-hook state last-state)
11322 state))
11323 (next (if state (concat " " state " ") " "))
11324 (change-plist (list :type 'todo-state-change :from this :to state
11325 :position startpos))
11326 dolog now-done-p)
11327 (when org-blocker-hook
11328 (setq org-last-todo-state-is-todo
11329 (not (member this org-done-keywords)))
11330 (unless (save-excursion
11331 (save-match-data
11332 (org-with-wide-buffer
11333 (run-hook-with-args-until-failure
11334 'org-blocker-hook change-plist))))
11335 (if (org-called-interactively-p 'interactive)
11336 (error "TODO state change from %s to %s blocked" this state)
11337 ;; fail silently
11338 (message "TODO state change from %s to %s blocked" this state)
11339 (throw 'exit nil))))
11340 (store-match-data match-data)
11341 (replace-match next t t)
11342 (unless (pos-visible-in-window-p hl-pos)
11343 (message "TODO state changed to %s" (org-trim next)))
11344 (unless head
11345 (setq head (org-get-todo-sequence-head state)
11346 ass (assoc head org-todo-kwd-alist)
11347 interpret (nth 1 ass)
11348 done-word (nth 3 ass)
11349 final-done-word (nth 4 ass)))
11350 (when (memq arg '(nextset previousset))
11351 (message "Keyword-Set %d/%d: %s"
11352 (- (length org-todo-sets) -1
11353 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11354 (length org-todo-sets)
11355 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11356 (setq org-last-todo-state-is-todo
11357 (not (member state org-done-keywords)))
11358 (setq now-done-p (and (member state org-done-keywords)
11359 (not (member this org-done-keywords))))
11360 (and logging (org-local-logging logging))
11361 (when (and (or org-todo-log-states org-log-done)
11362 (not (eq org-inhibit-logging t))
11363 (not (memq arg '(nextset previousset))))
11364 ;; we need to look at recording a time and note
11365 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11366 (nth 2 (assoc this org-todo-log-states))))
11367 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11368 (setq dolog 'time))
11369 (when (and state
11370 (member state org-not-done-keywords)
11371 (not (member this org-not-done-keywords)))
11372 ;; This is now a todo state and was not one before
11373 ;; If there was a CLOSED time stamp, get rid of it.
11374 (org-add-planning-info nil nil 'closed))
11375 (when (and now-done-p org-log-done)
11376 ;; It is now done, and it was not done before
11377 (org-add-planning-info 'closed (org-current-effective-time))
11378 (if (and (not dolog) (eq 'note org-log-done))
11379 (org-add-log-setup 'done state this 'findpos 'note)))
11380 (when (and state dolog)
11381 ;; This is a non-nil state, and we need to log it
11382 (org-add-log-setup 'state state this 'findpos dolog)))
11383 ;; Fixup tag positioning
11384 (org-todo-trigger-tag-changes state)
11385 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11386 (when org-provide-todo-statistics
11387 (org-update-parent-todo-statistics))
11388 (run-hooks 'org-after-todo-state-change-hook)
11389 (if (and arg (not (member state org-done-keywords)))
11390 (setq head (org-get-todo-sequence-head state)))
11391 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11392 ;; Do we need to trigger a repeat?
11393 (when now-done-p
11394 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11395 ;; This is for the agenda, take a snapshot of the headline.
11396 (save-match-data
11397 (setq org-agenda-headline-snapshot-before-repeat
11398 (org-get-heading))))
11399 (org-auto-repeat-maybe state))
11400 ;; Fixup cursor location if close to the keyword
11401 (if (and (outline-on-heading-p)
11402 (not (bolp))
11403 (save-excursion (beginning-of-line 1)
11404 (looking-at org-todo-line-regexp))
11405 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11406 (progn
11407 (goto-char (or (match-end 2) (match-end 1)))
11408 (and (looking-at " ") (just-one-space))))
11409 (when org-trigger-hook
11410 (save-excursion
11411 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11413 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11414 "Block turning an entry into a TODO, using the hierarchy.
11415 This checks whether the current task should be blocked from state
11416 changes. Such blocking occurs when:
11418 1. The task has children which are not all in a completed state.
11420 2. A task has a parent with the property :ORDERED:, and there
11421 are siblings prior to the current task with incomplete
11422 status.
11424 3. The parent of the task is blocked because it has siblings that should
11425 be done first, or is child of a block grandparent TODO entry."
11427 (if (not org-enforce-todo-dependencies)
11428 t ; if locally turned off don't block
11429 (catch 'dont-block
11430 ;; If this is not a todo state change, or if this entry is already DONE,
11431 ;; do not block
11432 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11433 (member (plist-get change-plist :from)
11434 (cons 'done org-done-keywords))
11435 (member (plist-get change-plist :to)
11436 (cons 'todo org-not-done-keywords))
11437 (not (plist-get change-plist :to)))
11438 (throw 'dont-block t))
11439 ;; If this task has children, and any are undone, it's blocked
11440 (save-excursion
11441 (org-back-to-heading t)
11442 (let ((this-level (funcall outline-level)))
11443 (outline-next-heading)
11444 (let ((child-level (funcall outline-level)))
11445 (while (and (not (eobp))
11446 (> child-level this-level))
11447 ;; this todo has children, check whether they are all
11448 ;; completed
11449 (if (and (not (org-entry-is-done-p))
11450 (org-entry-is-todo-p))
11451 (throw 'dont-block nil))
11452 (outline-next-heading)
11453 (setq child-level (funcall outline-level))))))
11454 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11455 ;; any previous siblings are undone, it's blocked
11456 (save-excursion
11457 (org-back-to-heading t)
11458 (let* ((pos (point))
11459 (parent-pos (and (org-up-heading-safe) (point))))
11460 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11461 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11462 (forward-line 1)
11463 (re-search-forward org-not-done-heading-regexp pos t))
11464 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11465 ;; Search further up the hierarchy, to see if an ancestor is blocked
11466 (while t
11467 (goto-char parent-pos)
11468 (if (not (looking-at org-not-done-heading-regexp))
11469 (throw 'dont-block t)) ; do not block, parent is not a TODO
11470 (setq pos (point))
11471 (setq parent-pos (and (org-up-heading-safe) (point)))
11472 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11473 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11474 (forward-line 1)
11475 (re-search-forward org-not-done-heading-regexp pos t))
11476 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11478 (defcustom org-track-ordered-property-with-tag nil
11479 "Should the ORDERED property also be shown as a tag?
11480 The ORDERED property decides if an entry should require subtasks to be
11481 completed in sequence. Since a property is not very visible, setting
11482 this option means that toggling the ORDERED property with the command
11483 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11484 not relevant for the behavior, but it makes things more visible.
11486 Note that toggling the tag with tags commands will not change the property
11487 and therefore not influence behavior!
11489 This can be t, meaning the tag ORDERED should be used, It can also be a
11490 string to select a different tag for this task."
11491 :group 'org-todo
11492 :type '(choice
11493 (const :tag "No tracking" nil)
11494 (const :tag "Track with ORDERED tag" t)
11495 (string :tag "Use other tag")))
11497 (defun org-toggle-ordered-property ()
11498 "Toggle the ORDERED property of the current entry.
11499 For better visibility, you can track the value of this property with a tag.
11500 See variable `org-track-ordered-property-with-tag'."
11501 (interactive)
11502 (let* ((t1 org-track-ordered-property-with-tag)
11503 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11504 (save-excursion
11505 (org-back-to-heading)
11506 (if (org-entry-get nil "ORDERED")
11507 (progn
11508 (org-delete-property "ORDERED")
11509 (and tag (org-toggle-tag tag 'off))
11510 (message "Subtasks can be completed in arbitrary order"))
11511 (org-entry-put nil "ORDERED" "t")
11512 (and tag (org-toggle-tag tag 'on))
11513 (message "Subtasks must be completed in sequence")))))
11515 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11516 (defun org-block-todo-from-checkboxes (change-plist)
11517 "Block turning an entry into a TODO, using checkboxes.
11518 This checks whether the current task should be blocked from state
11519 changes because there are unchecked boxes in this entry."
11520 (if (not org-enforce-todo-checkbox-dependencies)
11521 t ; if locally turned off don't block
11522 (catch 'dont-block
11523 ;; If this is not a todo state change, or if this entry is already DONE,
11524 ;; do not block
11525 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11526 (member (plist-get change-plist :from)
11527 (cons 'done org-done-keywords))
11528 (member (plist-get change-plist :to)
11529 (cons 'todo org-not-done-keywords))
11530 (not (plist-get change-plist :to)))
11531 (throw 'dont-block t))
11532 ;; If this task has checkboxes that are not checked, it's blocked
11533 (save-excursion
11534 (org-back-to-heading t)
11535 (let ((beg (point)) end)
11536 (outline-next-heading)
11537 (setq end (point))
11538 (goto-char beg)
11539 (if (org-list-search-forward
11540 (concat (org-item-beginning-re)
11543 end t)
11544 (progn
11545 (if (boundp 'org-blocked-by-checkboxes)
11546 (setq org-blocked-by-checkboxes t))
11547 (throw 'dont-block nil)))))
11548 t))) ; do not block
11550 (defun org-entry-blocked-p ()
11551 "Is the current entry blocked?"
11552 (if (org-entry-get nil "NOBLOCKING")
11553 nil ;; Never block this entry
11554 (not
11555 (run-hook-with-args-until-failure
11556 'org-blocker-hook
11557 (list :type 'todo-state-change
11558 :position (point)
11559 :from 'todo
11560 :to 'done)))))
11562 (defun org-update-statistics-cookies (all)
11563 "Update the statistics cookie, either from TODO or from checkboxes.
11564 This should be called with the cursor in a line with a statistics cookie."
11565 (interactive "P")
11566 (if all
11567 (progn
11568 (org-update-checkbox-count 'all)
11569 (org-map-entries 'org-update-parent-todo-statistics))
11570 (if (not (org-at-heading-p))
11571 (org-update-checkbox-count)
11572 (let ((pos (move-marker (make-marker) (point)))
11573 end l1 l2)
11574 (ignore-errors (org-back-to-heading t))
11575 (if (not (org-at-heading-p))
11576 (org-update-checkbox-count)
11577 (setq l1 (org-outline-level))
11578 (setq end (save-excursion
11579 (outline-next-heading)
11580 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11581 (point)))
11582 (if (and (save-excursion
11583 (re-search-forward
11585 (not (save-excursion (re-search-forward
11587 (org-update-checkbox-count)
11588 (if (and l2 (> l2 l1))
11589 (progn
11590 (goto-char end)
11591 (org-update-parent-todo-statistics))
11592 (goto-char pos)
11593 (beginning-of-line 1)
11594 (while (re-search-forward
11596 (point-at-eol) t)
11597 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11598 (goto-char pos)
11599 (move-marker pos nil)))))
11601 (defvar org-entry-property-inherited-from) ;; defined below
11602 (defun org-update-parent-todo-statistics ()
11603 "Update any statistics cookie in the parent of the current headline.
11604 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11605 the entire subtree and this will travel up the hierarchy and update
11606 statistics everywhere."
11607 (let* ((prop (save-excursion (org-up-heading-safe)
11608 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11609 (recursive (or (not org-hierarchical-todo-statistics)
11611 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11612 0))
11613 (first t)
11615 level ltoggle l1 new ndel
11616 (cnt-all 0) (cnt-done 0) is-percent kwd
11617 checkbox-beg ov ovs ove cookie-present)
11618 (catch 'exit
11619 (save-excursion
11620 (beginning-of-line 1)
11621 (setq ltoggle (funcall outline-level))
11622 ;; Three situations are to consider:
11624 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11625 ;; to the top-level ancestor on the headline;
11627 ;; 2. If parent has "recursive" property, repeat up to the
11628 ;; headline setting that property, taking inheritance into
11629 ;; account;
11631 ;; 3. Else, move up to direct parent and proceed only once.
11632 (while (and (setq level (org-up-heading-safe))
11633 (or recursive first)
11634 (>= (point) lim))
11635 (setq first nil cookie-present nil)
11636 (unless (and level
11637 (not (string-match
11639 (downcase (or (org-entry-get nil "COOKIE_DATA")
11640 "")))))
11641 (throw 'exit nil))
11642 (while (re-search-forward box-re (point-at-eol) t)
11643 (setq cnt-all 0 cnt-done 0 cookie-present t)
11644 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11645 (save-match-data
11646 (unless (outline-next-heading) (throw 'exit nil))
11647 (while (and (looking-at org-complex-heading-regexp)
11648 (> (setq l1 (length (match-string 1))) level))
11649 (setq kwd (and (or recursive (= l1 ltoggle))
11650 (match-string 2)))
11651 (if (or (eq org-provide-todo-statistics 'all-headlines)
11652 (and (listp org-provide-todo-statistics)
11653 (or (member kwd org-provide-todo-statistics)
11654 (member kwd org-done-keywords))))
11655 (setq cnt-all (1+ cnt-all))
11656 (if (eq org-provide-todo-statistics t)
11657 (and kwd (setq cnt-all (1+ cnt-all)))))
11658 (and (member kwd org-done-keywords)
11659 (setq cnt-done (1+ cnt-done)))
11660 (outline-next-heading)))
11661 (setq new
11662 (if is-percent
11663 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11664 (format "[%d/%d]" cnt-done cnt-all))
11665 ndel (- (match-end 0) checkbox-beg))
11666 ;; handle overlays when updating cookie from column view
11667 (when (setq ov (car (overlays-at checkbox-beg)))
11668 (setq ovs (overlay-start ov) ove (overlay-end ov))
11669 (delete-overlay ov))
11670 (goto-char checkbox-beg)
11671 (insert new)
11672 (delete-region (point) (+ (point) ndel))
11673 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11674 (when ov (move-overlay ov ovs ove)))
11675 (when cookie-present
11676 (run-hook-with-args 'org-after-todo-statistics-hook
11677 cnt-done (- cnt-all cnt-done))))))
11678 (run-hooks 'org-todo-statistics-hook)))
11680 (defvar org-after-todo-statistics-hook nil
11681 "Hook that is called after a TODO statistics cookie has been updated.
11682 Each function is called with two arguments: the number of not-done entries
11683 and the number of done entries.
11685 For example, the following function, when added to this hook, will switch
11686 an entry to DONE when all children are done, and back to TODO when new
11687 entries are set to a TODO status. Note that this hook is only called
11688 when there is a statistics cookie in the headline!
11690 (defun org-summary-todo (n-done n-not-done)
11692 (let (org-log-done org-log-states) ; turn off logging
11694 ")
11696 (defvar org-todo-statistics-hook nil
11697 "Hook that is run whenever Org thinks TODO statistics should be updated.
11698 This hook runs even if there is no statistics cookie present, in which case
11699 `org-after-todo-statistics-hook' would not run.")
11701 (defun org-todo-trigger-tag-changes (state)
11702 "Apply the changes defined in `org-todo-state-tags-triggers'."
11703 (let ((l org-todo-state-tags-triggers)
11704 changes)
11705 (when (or (not state) (equal state ""))
11706 (setq changes (append changes (cdr (assoc "" l)))))
11707 (when (and (stringp state) (> (length state) 0))
11708 (setq changes (append changes (cdr (assoc state l)))))
11709 (when (member state org-not-done-keywords)
11710 (setq changes (append changes (cdr (assoc 'todo l)))))
11711 (when (member state org-done-keywords)
11712 (setq changes (append changes (cdr (assoc 'done l)))))
11713 (dolist (c changes)
11714 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11716 (defun org-local-logging (value)
11717 "Get logging settings from a property VALUE."
11718 (let* (words w a)
11719 ;; directly set the variables, they are already local.
11720 (setq org-log-done nil
11721 org-log-repeat nil
11722 org-todo-log-states nil)
11723 (setq words (org-split-string value))
11724 (while (setq w (pop words))
11725 (cond
11726 ((setq a (assoc w org-startup-options))
11727 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11728 (set (nth 1 a) (nth 2 a))))
11729 ((setq a (org-extract-log-state-settings w))
11730 (and (member (car a) org-todo-keywords-1)
11731 (push a org-todo-log-states)))))))
11733 (defun org-get-todo-sequence-head (kwd)
11734 "Return the head of the TODO sequence to which KWD belongs.
11735 If KWD is not set, check if there is a text property remembering the
11736 right sequence."
11737 (let (p)
11738 (cond
11739 ((not kwd)
11740 (or (get-text-property (point-at-bol) 'org-todo-head)
11741 (progn
11742 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11743 nil (point-at-eol)))
11744 (get-text-property p 'org-todo-head))))
11745 ((not (member kwd org-todo-keywords-1))
11746 (car org-todo-keywords-1))
11747 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11749 (defun org-fast-todo-selection ()
11750 "Fast TODO keyword selection with single keys.
11751 Returns the new TODO keyword, or nil if no state change should occur."
11752 (let* ((fulltable org-todo-key-alist)
11753 (done-keywords org-done-keywords) ;; needed for the faces.
11754 (maxlen (apply 'max (mapcar
11755 (lambda (x)
11756 (if (stringp (car x)) (string-width (car x)) 0))
11757 fulltable)))
11758 (expert nil)
11759 (fwidth (+ maxlen 3 1 3))
11760 (ncol (/ (- (window-width) 4) fwidth))
11761 tg cnt e c tbl
11762 groups ingroup)
11763 (save-excursion
11764 (save-window-excursion
11765 (if expert
11766 (set-buffer (get-buffer-create " *Org todo*"))
11767 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11768 (erase-buffer)
11769 (org-set-local 'org-done-keywords done-keywords)
11770 (setq tbl fulltable cnt 0)
11771 (while (setq e (pop tbl))
11772 (cond
11773 ((equal e '(:startgroup))
11774 (push '() groups) (setq ingroup t)
11775 (when (not (= cnt 0))
11776 (setq cnt 0)
11778 (insert "{ "))
11779 ((equal e '(:endgroup))
11780 (setq ingroup nil cnt 0)
11782 ((equal e '(:newline))
11783 (when (not (= cnt 0))
11784 (setq cnt 0)
11786 (setq e (car tbl))
11787 (while (equal (car tbl) '(:newline))
11789 (setq tbl (cdr tbl)))))
11790 (t
11791 (setq tg (car e) c (cdr e))
11792 (if ingroup (push tg (car groups)))
11793 (setq tg (org-add-props tg nil 'face
11794 (org-get-todo-face tg)))
11795 (if (and (= cnt 0) (not ingroup)) (insert " "))
11796 (insert "[" c "] " tg (make-string
11797 (- fwidth 4 (length tg)) ?\ ))
11798 (when (= (setq cnt (1+ cnt)) ncol)
11800 (if ingroup (insert " "))
11801 (setq cnt 0)))))
11803 (goto-char (point-min))
11804 (if (not expert) (org-fit-window-to-buffer))
11805 (message "[a-z..]:Set [SPC]:clear")
11806 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11807 (cond
11808 ((or (= c ?\C-g)
11809 (and (= c ?q) (not (rassoc c fulltable))))
11810 (setq quit-flag t))
11811 ((= c ?\ ) nil)
11812 ((setq e (rassoc c fulltable) tg (car e))
11813 tg)
11814 (t (setq quit-flag t)))))))
11816 (defun org-entry-is-todo-p ()
11817 (member (org-get-todo-state) org-not-done-keywords))
11819 (defun org-entry-is-done-p ()
11820 (member (org-get-todo-state) org-done-keywords))
11822 (defun org-get-todo-state ()
11823 (save-excursion
11824 (org-back-to-heading t)
11825 (and (looking-at org-todo-line-regexp)
11826 (match-end 2)
11827 (match-string 2))))
11829 (defun org-at-date-range-p (&optional inactive-ok)
11830 "Is the cursor inside a date range?"
11831 (interactive)
11832 (save-excursion
11833 (catch 'exit
11834 (let ((pos (point)))
11836 (skip-chars-backward "<[")
11837 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11838 (>= (match-end 0) pos)
11839 (throw 'exit t))
11841 (skip-chars-backward "<[")
11842 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11843 (>= (match-end 0) pos)
11844 (throw 'exit t)))
11845 nil)))
11847 (defun org-get-repeat (&optional tagline)
11848 "Check if there is a deadline/schedule with repeater in this entry."
11849 (save-match-data
11850 (save-excursion
11851 (org-back-to-heading t)
11852 (and (re-search-forward (if tagline
11854 org-repeat-re)
11855 (org-entry-end-position) t)
11856 (match-string-no-properties 1)))))
11858 (defvar org-last-changed-timestamp)
11859 (defvar org-last-inserted-timestamp)
11860 (defvar org-log-post-message)
11861 (defvar org-log-note-purpose)
11862 (defvar org-log-note-how)
11863 (defvar org-log-note-extra)
11864 (defun org-auto-repeat-maybe (done-word)
11865 "Check if the current headline contains a repeated deadline/schedule.
11866 If yes, set TODO state back to what it was and change the base date
11867 of repeating deadline/scheduled time stamps to new date.
11868 This function is run automatically after each state change to a DONE state."
11869 ;; last-state is dynamically scoped into this function
11870 (let* ((repeat (org-get-repeat))
11871 (aa (assoc last-state org-todo-kwd-alist))
11872 (interpret (nth 1 aa))
11873 (head (nth 2 aa))
11874 (whata '(("d" . day) ("m" . month) ("y" . year)))
11875 (msg "Entry repeats: ")
11876 (org-log-done nil)
11877 (org-todo-log-states nil)
11878 re type n what ts time to-state)
11879 (when repeat
11880 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11881 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11882 org-todo-repeat-to-state))
11883 (unless (and to-state (member to-state org-todo-keywords-1))
11884 (setq to-state (if (eq interpret 'type) last-state head)))
11885 (org-todo to-state)
11886 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11887 (org-entry-put nil "LAST_REPEAT" (format-time-string
11888 (org-time-stamp-format t t))))
11889 (when org-log-repeat
11890 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11891 (memq 'org-add-log-note post-command-hook))
11892 ;; OK, we are already setup for some record
11893 (if (eq org-log-repeat 'note)
11894 ;; make sure we take a note, not only a time stamp
11895 (setq org-log-note-how 'note))
11896 ;; Set up for taking a record
11897 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11898 last-state
11899 'findpos org-log-repeat)))
11900 (org-back-to-heading t)
11901 (org-add-planning-info nil nil 'closed)
11905 (while (re-search-forward
11906 re (save-excursion (outline-next-heading) (point)) t)
11907 (setq type (if (match-end 1) org-scheduled-string
11908 (if (match-end 3) org-deadline-string "Plain:"))
11909 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11911 (setq n (string-to-number (match-string 2 ts))
11912 what (match-string 3 ts))
11913 (if (equal what "w") (setq n (* n 7) what "d"))
11914 ;; Preparation, see if we need to modify the start date for the change
11915 (when (match-end 1)
11916 (setq time (save-match-data (org-time-string-to-time ts)))
11917 (cond
11918 ((equal (match-string 1 ts) ".")
11919 ;; Shift starting date to today
11920 (org-timestamp-change
11921 (- (org-today) (time-to-days time))
11922 'day))
11923 ((equal (match-string 1 ts) "+")
11924 (let ((nshiftmax 10) (nshift 0))
11925 (while (or (= nshift 0)
11926 (<= (time-to-days time)
11927 (time-to-days (current-time))))
11928 (when (= (incf nshift) nshiftmax)
11929 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11930 (error "Abort")))
11931 (org-timestamp-change n (cdr (assoc what whata)))
11932 (org-at-timestamp-p t)
11933 (setq ts (match-string 1))
11934 (setq time (save-match-data (org-time-string-to-time ts)))))
11935 (org-timestamp-change (- n) (cdr (assoc what whata)))
11936 ;; rematch, so that we have everything in place for the real shift
11937 (org-at-timestamp-p t)
11938 (setq ts (match-string 1))
11940 (org-timestamp-change n (cdr (assoc what whata)))
11941 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11942 (setq org-log-post-message msg)
11943 (message "%s" msg))))
11945 (defun org-show-todo-tree (arg)
11946 "Make a compact tree which shows all headlines marked with TODO.
11947 The tree will show the lines where the regexp matches, and all higher
11948 headlines above the match.
11950 With a numeric prefix N, construct a sparse tree for the Nth element
11951 of `org-todo-keywords-1'."
11952 (interactive "P")
11953 (let ((case-fold-search nil)
11954 (kwd-re
11955 (cond ((null arg) org-not-done-regexp)
11956 ((equal arg '(4))
11957 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11958 (mapcar 'list org-todo-keywords-1))))
11962 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11963 (regexp-quote (nth (1- (prefix-numeric-value arg))
11964 org-todo-keywords-1)))
11965 (t (error "Invalid prefix argument: %s" arg)))))
11966 (message "%d TODO entries found"
11967 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11969 (defun org-deadline (&optional remove time)
11971 With argument REMOVE, remove any deadline from the item.
11972 With argument TIME, set the deadline at the corresponding date. TIME
11974 (interactive "P")
11975 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11976 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11977 'region-start-level 'region))
11978 org-loop-over-headlines-in-active-region)
11979 (org-map-entries
11980 `(org-deadline ',remove ,time)
11981 org-loop-over-headlines-in-active-region
11982 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11983 (let* ((old-date (org-entry-get nil "DEADLINE"))
11984 (repeater (and old-date
11985 (string-match
11987 old-date)
11988 (match-string 1 old-date))))
11989 (if remove
11990 (progn
11991 (when (and old-date org-log-redeadline)
11992 (org-add-log-setup 'deldeadline nil old-date 'findpos
11993 org-log-redeadline))
11994 (org-remove-timestamp-with-keyword org-deadline-string)
11995 (message "Item no longer has a deadline."))
11996 (org-add-planning-info 'deadline time 'closed)
11997 (when (and old-date org-log-redeadline
11998 (not (equal old-date
11999 (substring org-last-inserted-timestamp 1 -1))))
12000 (org-add-log-setup 'redeadline nil old-date 'findpos
12001 org-log-redeadline))
12002 (when repeater
12003 (save-excursion
12004 (org-back-to-heading t)
12005 (when (re-search-forward (concat org-deadline-string " "
12006 org-last-inserted-timestamp)
12007 (save-excursion
12008 (outline-next-heading) (point)) t)
12009 (goto-char (1- (match-end 0)))
12010 (insert " " repeater)
12011 (setq org-last-inserted-timestamp
12012 (concat (substring org-last-inserted-timestamp 0 -1)
12013 " " repeater
12014 (substring org-last-inserted-timestamp -1))))))
12015 (message "Deadline on %s" org-last-inserted-timestamp)))))
12017 (defun org-schedule (&optional remove time)
12018 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12019 With argument REMOVE, remove any scheduling date from the item.
12020 With argument TIME, scheduled at the corresponding date. TIME can
12022 (interactive "P")
12023 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12024 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12025 'region-start-level 'region))
12026 org-loop-over-headlines-in-active-region)
12027 (org-map-entries
12028 `(org-schedule ',remove ,time)
12029 org-loop-over-headlines-in-active-region
12030 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12031 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12032 (repeater (and old-date
12033 (string-match
12035 old-date)
12036 (match-string 1 old-date))))
12037 (if remove
12038 (progn
12039 (when (and old-date org-log-reschedule)
12040 (org-add-log-setup 'delschedule nil old-date 'findpos
12041 org-log-reschedule))
12042 (org-remove-timestamp-with-keyword org-scheduled-string)
12043 (message "Item is no longer scheduled."))
12044 (org-add-planning-info 'scheduled time 'closed)
12045 (when (and old-date org-log-reschedule
12046 (not (equal old-date
12047 (substring org-last-inserted-timestamp 1 -1))))
12048 (org-add-log-setup 'reschedule nil old-date 'findpos
12049 org-log-reschedule))
12050 (when repeater
12051 (save-excursion
12052 (org-back-to-heading t)
12053 (when (re-search-forward (concat org-scheduled-string " "
12054 org-last-inserted-timestamp)
12055 (save-excursion
12056 (outline-next-heading) (point)) t)
12057 (goto-char (1- (match-end 0)))
12058 (insert " " repeater)
12059 (setq org-last-inserted-timestamp
12060 (concat (substring org-last-inserted-timestamp 0 -1)
12061 " " repeater
12062 (substring org-last-inserted-timestamp -1))))))
12063 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12065 (defun org-get-scheduled-time (pom &optional inherit)
12066 "Get the scheduled time as a time tuple, of a format suitable
12067 for calling org-schedule with, or if there is no scheduling,
12068 returns nil."
12069 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12070 (when time
12071 (apply 'encode-time (org-parse-time-string time)))))
12073 (defun org-get-deadline-time (pom &optional inherit)
12074 "Get the deadline as a time tuple, of a format suitable for
12075 calling org-deadline with, or if there is no scheduling, returns
12076 nil."
12077 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12078 (when time
12079 (apply 'encode-time (org-parse-time-string time)))))
12081 (defun org-remove-timestamp-with-keyword (keyword)
12082 "Remove all time stamps with KEYWORD in the current entry."
12084 beg)
12085 (save-excursion
12086 (org-back-to-heading t)
12087 (setq beg (point))
12088 (outline-next-heading)
12089 (while (re-search-backward re beg t)
12090 (replace-match "")
12092 (equal (char-before) ?\ ))
12093 (backward-delete-char 1)
12095 (point-at-bol) (point-at-eol)))
12096 (delete-region (point-at-bol)
12097 (min (point-max) (1+ (point-at-eol))))))))))
12099 (defun org-add-planning-info (what &optional time &rest remove)
12100 "Insert new timestamp with keyword in the line directly after the headline.
12101 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12102 If non is given, the user is prompted for a date.
12103 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12104 be removed."
12105 (interactive)
12106 (let (org-time-was-given org-end-time-was-given ts
12107 end default-time default-input)
12109 (catch 'exit
12110 (when (and (memq what '(scheduled deadline))
12111 (or (not time)
12112 (and (stringp time)
12113 (string-match "^[-+]+[0-9]" time))))
12114 ;; Try to get a default date/time from existing timestamp
12115 (save-excursion
12116 (org-back-to-heading t)
12117 (setq end (save-excursion (outline-next-heading) (point)))
12118 (when (re-search-forward (if (eq what 'scheduled)
12119 org-scheduled-time-regexp
12120 org-deadline-time-regexp)
12121 end t)
12122 (setq ts (match-string 1)
12123 default-time
12124 (apply 'encode-time (org-parse-time-string ts))
12125 default-input (and ts (org-get-compact-tod ts))))))
12126 (when what
12127 (setq time
12128 (if (stringp time)
12129 ;; This is a string (relative or absolute), set proper date
12130 (apply 'encode-time
12131 (org-read-date-analyze
12132 time default-time (decode-time default-time)))
12133 ;; If necessary, get the time from the user
12134 (or time (org-read-date nil 'to-time nil nil
12135 default-time default-input)))))
12137 (when (and org-insert-labeled-timestamps-at-point
12138 (member what '(scheduled deadline)))
12139 (insert
12140 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12141 (org-insert-time-stamp time org-time-was-given
12142 nil nil nil (list org-end-time-was-given))
12143 (setq what nil))
12144 (save-excursion
12145 (save-restriction
12146 (let (col list elt ts buffer-invisibility-spec)
12147 (org-back-to-heading t)
12149 (goto-char (match-end 1))
12150 (setq col (current-column))
12151 (goto-char (match-end 0))
12153 (when (and (not what)
12154 (not (looking-at
12156 org-keyword-time-not-clock-regexp))))
12157 ;; Nothing to add, nothing to remove...... :-)
12158 (throw 'exit nil))
12159 (if (and (not (looking-at org-outline-regexp))
12162 (not (equal (match-string 1) org-clock-string)))
12163 (narrow-to-region (match-beginning 0) (match-end 0))
12165 (backward-char 1)
12166 (narrow-to-region (point) (point))
12167 (and org-adapt-indentation (org-indent-to-column col)))
12168 ;; Check if we have to remove something.
12169 (setq list (cons what remove))
12170 (while list
12171 (setq elt (pop list))
12172 (when (or (and (eq elt 'scheduled)
12173 (re-search-forward org-scheduled-time-regexp nil t))
12174 (and (eq elt 'deadline)
12175 (re-search-forward org-deadline-time-regexp nil t))
12176 (and (eq elt 'closed)
12177 (re-search-forward org-closed-time-regexp nil t)))
12178 (replace-match "")
12179 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12181 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12182 (when what
12183 (insert
12184 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12185 (cond ((eq what 'scheduled) org-scheduled-string)
12186 ((eq what 'deadline) org-deadline-string)
12187 ((eq what 'closed) org-closed-string))
12188 " ")
12189 (setq ts (org-insert-time-stamp
12190 time
12191 (or org-time-was-given
12192 (and (eq what 'closed) org-log-done-with-time))
12193 (eq what 'closed)
12194 nil nil (list org-end-time-was-given)))
12195 (insert
12196 (if (not (or (bolp) (eq (char-before) ?\ )
12197 (memq (char-after) '(32 10))
12198 (eobp))) " " ""))
12199 (end-of-line 1))
12200 (goto-char (point-min))
12201 (widen)
12204 (delete-region (1- (point)) (point-at-eol)))
12205 ts))))))
12207 (defvar org-log-note-marker (make-marker))
12208 (defvar org-log-note-purpose nil)
12209 (defvar org-log-note-state nil)
12210 (defvar org-log-note-previous-state nil)
12211 (defvar org-log-note-how nil)
12212 (defvar org-log-note-extra nil)
12213 (defvar org-log-note-window-configuration nil)
12214 (defvar org-log-note-return-to (make-marker))
12215 (defvar org-log-note-effective-time nil
12216 "Remembered current time so that dynamically scoped
12217 `org-extend-today-until' affects tha timestamps in state change
12218 log")
12220 (defvar org-log-post-message nil
12221 "Message to be displayed after a log note has been stored.
12222 The auto-repeater uses this.")
12224 (defun org-add-note ()
12225 "Add a note to the current entry.
12226 This is done in the same way as adding a state change note."
12227 (interactive)
12228 (org-add-log-setup 'note nil nil 'findpos nil))
12230 (defvar org-property-end-re)
12231 (defun org-add-log-setup (&optional purpose state prev-state
12232 findpos how extra)
12233 "Set up the post command hook to take a note.
12234 If this is about to TODO state change, the new state is expected in STATE.
12235 When FINDPOS is non-nil, find the correct position for the note in
12236 the current entry. If not, assume that it can be inserted at point.
12237 HOW is an indicator what kind of note should be created.
12238 EXTRA is additional text that will be inserted into the notes buffer."
12239 (let* ((org-log-into-drawer (org-log-into-drawer))
12240 (drawer (cond ((stringp org-log-into-drawer)
12241 org-log-into-drawer)
12242 (org-log-into-drawer "LOGBOOK")
12243 (t nil))))
12244 (save-restriction
12245 (save-excursion
12246 (when findpos
12247 (org-back-to-heading t)
12248 (narrow-to-region (point) (save-excursion
12249 (outline-next-heading) (point)))
12253 (goto-char (match-end 0))
12254 (cond
12255 (drawer
12257 nil t)
12258 (progn
12259 (goto-char (match-end 0))
12260 (or org-log-states-order-reversed
12261 (and (re-search-forward org-property-end-re nil t)
12262 (goto-char (1- (match-beginning 0))))))
12264 (beginning-of-line 0)
12265 (org-indent-line-function)
12266 (beginning-of-line 2)
12267 (org-indent-line-function)
12268 (end-of-line 0)))
12269 ((and org-log-state-notes-insert-after-drawers
12270 (save-excursion
12271 (forward-line) (looking-at org-drawer-regexp)))
12272 (forward-line)
12273 (while (looking-at org-drawer-regexp)
12274 (goto-char (match-end 0))
12275 (re-search-forward org-property-end-re (point-max) t)
12276 (forward-line))
12277 (forward-line -1)))
12278 (unless org-log-states-order-reversed
12280 (org-skip-over-state-notes)
12282 (move-marker org-log-note-marker (point))
12283 (setq org-log-note-purpose purpose
12284 org-log-note-state state
12285 org-log-note-previous-state prev-state
12286 org-log-note-how how
12287 org-log-note-extra extra
12288 org-log-note-effective-time (org-current-effective-time))
12289 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12291 (defun org-skip-over-state-notes ()
12292 "Skip past the list of State notes in an entry."
12294 (when (ignore-errors (goto-char (org-in-item-p)))
12295 (let* ((struct (org-list-struct))
12296 (prevs (org-list-prevs-alist struct)))
12298 (goto-char (or (org-list-get-next-item (point) struct prevs)
12299 (org-list-get-item-end (point) struct)))))))
12301 (defun org-add-log-note (&optional purpose)
12302 "Pop up a window for taking a note, and add this note later at point."
12303 (remove-hook 'post-command-hook 'org-add-log-note)
12304 (setq org-log-note-window-configuration (current-window-configuration))
12305 (delete-other-windows)
12306 (move-marker org-log-note-return-to (point))
12307 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12308 (goto-char org-log-note-marker)
12309 (org-switch-to-buffer-other-window "*Org Note*")
12310 (erase-buffer)
12311 (if (memq org-log-note-how '(time state))
12312 (let (current-prefix-arg) (org-store-log-note))
12313 (let ((org-inhibit-startup t)) (org-mode))
12314 (insert (format "# Insert note for %s.
12316 (cond
12317 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12318 ((eq org-log-note-purpose 'done) "closed todo item")
12319 ((eq org-log-note-purpose 'state)
12321 (or org-log-note-previous-state "")
12322 (or org-log-note-state "")))
12323 ((eq org-log-note-purpose 'reschedule)
12324 "rescheduling")
12325 ((eq org-log-note-purpose 'delschedule)
12326 "no longer scheduled")
12327 ((eq org-log-note-purpose 'redeadline)
12328 "changing deadline")
12329 ((eq org-log-note-purpose 'deldeadline)
12330 "removing deadline")
12331 ((eq org-log-note-purpose 'refile)
12332 "refiling")
12333 ((eq org-log-note-purpose 'note)
12334 "this entry")
12335 (t (error "This should not happen")))))
12336 (if org-log-note-extra (insert org-log-note-extra))
12337 (org-set-local 'org-finish-function 'org-store-log-note)
12338 (run-hooks 'org-log-buffer-setup-hook)))
12340 (defvar org-note-abort nil) ; dynamically scoped
12341 (defun org-store-log-note ()
12342 "Finish taking a log note, and insert it to where it belongs."
12343 (let ((txt (buffer-string))
12344 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12345 lines ind bul)
12346 (kill-buffer (current-buffer))
12348 (setq txt (replace-match "" t t txt)))
12350 (setq txt (replace-match "" t t txt)))
12353 (setq note
12354 (org-replace-escapes
12355 note
12356 (list (cons "%u" (user-login-name))
12357 (cons "%U" user-full-name)
12358 (cons "%t" (format-time-string
12359 (org-time-stamp-format 'long 'inactive)
12360 org-log-note-effective-time))
12361 (cons "%T" (format-time-string
12362 (org-time-stamp-format 'long nil)
12363 org-log-note-effective-time))
12364 (cons "%d" (format-time-string
12365 (org-time-stamp-format nil 'inactive)
12366 org-log-note-effective-time))
12367 (cons "%D" (format-time-string
12368 (org-time-stamp-format nil nil)
12369 org-log-note-effective-time))
12370 (cons "%s" (if org-log-note-state
12372 ""))
12373 (cons "%S" (if org-log-note-previous-state
12377 (push note lines))
12378 (when (or current-prefix-arg org-note-abort)
12379 (when org-log-into-drawer
12380 (org-remove-empty-drawer-at
12381 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12382 org-log-note-marker))
12383 (setq lines nil))
12384 (when lines
12385 (with-current-buffer (marker-buffer org-log-note-marker)
12386 (save-excursion
12387 (goto-char org-log-note-marker)
12388 (move-marker org-log-note-marker nil)
12389 (end-of-line 1)
12391 (setq ind (save-excursion
12392 (if (ignore-errors (goto-char (org-in-item-p)))
12393 (let ((struct (org-list-struct)))
12394 (org-list-get-ind
12395 (org-list-get-top-point struct) struct))
12397 (cond
12398 ((and (org-at-heading-p)
12399 org-adapt-indentation)
12400 (1+ (org-current-level)))
12401 ((org-at-heading-p) 0)
12402 (t (org-get-indentation))))))
12403 (setq bul (org-list-bullet-string "-"))
12404 (org-indent-line-to ind)
12405 (insert bul (pop lines))
12406 (let ((ind-body (+ (length bul) ind)))
12407 (while lines
12409 (org-indent-line-to ind-body)
12410 (insert (pop lines))))
12411 (message "Note stored")
12412 (org-back-to-heading t)
12413 (org-cycle-hide-drawers 'children)))))
12414 (set-window-configuration org-log-note-window-configuration)
12415 (with-current-buffer (marker-buffer org-log-note-return-to)
12416 (goto-char org-log-note-return-to))
12417 (move-marker org-log-note-return-to nil)
12418 (and org-log-post-message (message "%s" org-log-post-message)))
12420 (defun org-remove-empty-drawer-at (drawer pos)
12421 "Remove an empty drawer DRAWER at position POS.
12422 POS may also be a marker."
12423 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12424 (save-excursion
12425 (save-restriction
12426 (widen)
12427 (goto-char pos)
12428 (if (org-in-regexp
12430 (replace-match ""))))))
12432 (defun org-sparse-tree (&optional arg)
12433 "Create a sparse tree, prompt for the details.
12434 This command can create sparse trees. You first need to select the type
12435 of match used to create the tree:
12437 t Show all TODO entries.
12438 T Show entries with a specific TODO keyword.
12439 m Show entries selected by a tags/property match.
12440 p Enter a property name and its value (both with completion on existing
12441 names/values) and show entries with that property.
12442 r Show entries matching a regular expression (`/' can be used as well)
12443 d Show deadlines due within `org-deadline-warning-days'.
12444 b Show deadlines and scheduled items before a date.
12445 a Show deadlines and scheduled items after a date."
12446 (interactive "P")
12447 (let (ans kwd value)
12448 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range")
12449 (setq ans (read-char-exclusive))
12450 (cond
12451 ((equal ans ?d)
12452 (call-interactively 'org-check-deadlines))
12453 ((equal ans ?b)
12454 (call-interactively 'org-check-before-date))
12455 ((equal ans ?a)
12456 (call-interactively 'org-check-after-date))
12457 ((equal ans ?D)
12458 (call-interactively 'org-check-dates-range))
12459 ((equal ans ?t)
12460 (org-show-todo-tree nil))
12461 ((equal ans ?T)
12462 (org-show-todo-tree '(4)))
12463 ((member ans '(?T ?m))
12464 (call-interactively 'org-match-sparse-tree))
12465 ((member ans '(?p ?P))
12466 (setq kwd (org-icompleting-read "Property: "
12467 (mapcar 'list (org-buffer-property-keys))))
12468 (setq value (org-icompleting-read "Value: "
12469 (mapcar 'list (org-property-values kwd))))
12472 (org-match-sparse-tree arg (concat kwd "=" value)))
12473 ((member ans '(?r ?R ?/))
12474 (call-interactively 'org-occur))
12477 (defvar org-occur-highlights nil
12478 "List of overlays used for occur matches.")
12479 (make-variable-buffer-local 'org-occur-highlights)
12480 (defvar org-occur-parameters nil
12481 "Parameters of the active org-occur calls.
12482 This is a list, each call to org-occur pushes as cons cell,
12483 containing the regular expression and the callback, onto the list.
12484 The list can contain several entries if `org-occur' has been called
12485 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12486 will only contain one set of parameters. When the highlights are
12487 removed (for example with `C-c C-c', or with the next edit (depending
12488 on `org-remove-highlights-with-change'), this variable is emptied
12489 as well.")
12490 (make-variable-buffer-local 'org-occur-parameters)
12492 (defun org-occur (regexp &optional keep-previous callback)
12493 "Make a compact tree which shows all matches of REGEXP.
12494 The tree will show the lines where the regexp matches, and all higher
12495 headlines above the match. It will also show the heading after the match,
12496 to make sure editing the matching entry is easy.
12497 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12498 call to `org-occur' will be kept, to allow stacking of calls to this
12499 command.
12500 If CALLBACK is non-nil, it is a function which is called to confirm
12501 that the match should indeed be shown."
12503 (when (equal regexp "")
12504 (error "Regexp cannot be empty"))
12505 (unless keep-previous
12506 (org-remove-occur-highlights nil nil t))
12507 (push (cons regexp callback) org-occur-parameters)
12508 (let ((cnt 0))
12509 (save-excursion
12510 (goto-char (point-min))
12511 (if (or (not keep-previous) ; do not want to keep
12512 (not org-occur-highlights)) ; no previous matches
12513 ;; hide everything
12514 (org-overview))
12515 (while (re-search-forward regexp nil t)
12516 (when (or (not callback)
12517 (save-match-data (funcall callback)))
12518 (setq cnt (1+ cnt))
12519 (when org-highlight-sparse-tree-matches
12520 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12521 (org-show-context 'occur-tree))))
12522 (when org-remove-highlights-with-change
12523 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12524 nil 'local))
12525 (unless org-sparse-tree-open-archived-trees
12526 (org-hide-archived-subtrees (point-min) (point-max)))
12527 (run-hooks 'org-occur-hook)
12528 (if (org-called-interactively-p 'interactive)
12529 (message "%d match(es) for regexp %s" cnt regexp))
12530 cnt))
12532 (defun org-occur-next-match (&optional n reset)
12533 "Function for `next-error-function' to find sparse tree matches.
12534 N is the number of matches to move, when negative move backwards.
12535 RESET is entirely ignored - this function always goes back to the
12536 starting point when no match is found."
12537 (let* ((limit (if (< n 0) (point-min) (point-max)))
12538 (search-func (if (< n 0)
12539 'previous-single-char-property-change
12540 'next-single-char-property-change))
12541 (n (abs n))
12542 (pos (point))
12543 p1)
12544 (catch 'exit
12545 (while (setq p1 (funcall search-func (point) 'org-type))
12546 (when (equal p1 limit)
12547 (goto-char pos)
12548 (error "No more matches"))
12549 (when (equal (get-char-property p1 'org-type) 'org-occur)
12550 (setq n (1- n))
12551 (when (= n 0)
12552 (goto-char p1)
12553 (throw 'exit (point))))
12554 (goto-char p1))
12555 (goto-char p1)
12556 (error "No more matches"))))
12558 (defun org-show-context (&optional key)
12559 "Make sure point and context are visible.
12560 How much context is shown depends upon the variables
12561 `org-show-hierarchy-above', `org-show-following-heading',
12562 `org-show-entry-below' and `org-show-siblings'."
12563 (let ((heading-p (org-at-heading-p t))
12564 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12565 (following-p (org-get-alist-option org-show-following-heading key))
12566 (entry-p (org-get-alist-option org-show-entry-below key))
12567 (siblings-p (org-get-alist-option org-show-siblings key)))
12568 (catch 'exit
12569 ;; Show heading or entry text
12570 (if (and heading-p (not entry-p))
12571 (org-flag-heading nil) ; only show the heading
12572 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12573 (org-show-hidden-entry))) ; show entire entry
12574 (when following-p
12575 ;; Show next sibling, or heading below text
12576 (save-excursion
12577 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12578 (org-flag-heading nil))))
12579 (when siblings-p (org-show-siblings))
12580 (when hierarchy-p
12581 ;; show all higher headings, possibly with siblings
12582 (save-excursion
12583 (while (and (condition-case nil
12584 (progn (org-up-heading-all 1) t)
12585 (error nil))
12586 (not (bobp)))
12587 (org-flag-heading nil)
12588 (when siblings-p (org-show-siblings))))))))
12590 (defvar org-reveal-start-hook nil
12591 "Hook run before revealing a location.")
12593 (defun org-reveal (&optional siblings)
12594 "Show current entry, hierarchy above it, and the following headline.
12595 This can be used to show a consistent set of context around locations
12596 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12597 not t for the search context.
12599 With optional argument SIBLINGS, on each level of the hierarchy all
12600 siblings are shown. This repairs the tree structure to what it would
12601 look like when opened with hierarchical calls to `org-cycle'.
12603 go to the parent and show the
12604 entire tree."
12605 (interactive "P")
12606 (run-hooks 'org-reveal-start-hook)
12607 (let ((org-show-hierarchy-above t)
12608 (org-show-following-heading t)
12609 (org-show-siblings (if siblings t org-show-siblings)))
12610 (org-show-context nil))
12611 (when (equal siblings '(16))
12612 (save-excursion
12613 (when (org-up-heading-safe)
12614 (org-show-subtree)
12615 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12617 (defun org-highlight-new-match (beg end)
12618 "Highlight from BEG to END and mark the highlight is an occur headline."
12619 (let ((ov (make-overlay beg end)))
12620 (overlay-put ov 'face 'secondary-selection)
12621 (overlay-put ov 'org-type 'org-occur)
12622 (push ov org-occur-highlights)))
12624 (defun org-remove-occur-highlights (&optional beg end noremove)
12625 "Remove the occur highlights from the buffer.
12626 BEG and END are ignored. If NOREMOVE is nil, remove this function
12627 from the `before-change-functions' in the current buffer."
12628 (interactive)
12629 (unless org-inhibit-highlight-removal
12630 (mapc 'delete-overlay org-occur-highlights)
12631 (setq org-occur-highlights nil)
12632 (setq org-occur-parameters nil)
12633 (unless noremove
12634 (remove-hook 'before-change-functions
12635 'org-remove-occur-highlights 'local))))
12637 ;;;; Priorities
12640 "Regular expression matching the priority indicator.")
12642 (defvar org-remove-priority-next-time nil)
12644 (defun org-priority-up ()
12645 "Increase the priority of the current item."
12646 (interactive)
12647 (org-priority 'up))
12649 (defun org-priority-down ()
12650 "Decrease the priority of the current item."
12651 (interactive)
12652 (org-priority 'down))
12654 (defun org-priority (&optional action)
12655 "Change the priority of an item by ARG.
12656 ACTION can be `set', `up', `down', or a character."
12657 (interactive)
12658 (unless org-enable-priority-commands
12659 (error "Priority commands are disabled"))
12660 (setq action (or action 'set))
12661 (let (current new news have remove)
12662 (save-excursion
12663 (org-back-to-heading t)
12664 (if (looking-at org-priority-regexp)
12665 (setq current (string-to-char (match-string 2))
12666 have t))
12667 (cond
12668 ((eq action 'remove)
12669 (setq remove t new ?\ ))
12670 ((or (eq action 'set)
12671 (if (featurep 'xemacs) (characterp action) (integerp action)))
12672 (if (not (eq action 'set))
12673 (setq new action)
12674 (message "Priority %c-%c, SPC to remove: "
12675 org-highest-priority org-lowest-priority)
12676 (save-match-data
12677 (setq new (read-char-exclusive))))
12678 (if (and (= (upcase org-highest-priority) org-highest-priority)
12679 (= (upcase org-lowest-priority) org-lowest-priority))
12680 (setq new (upcase new)))
12681 (cond ((equal new ?\ ) (setq remove t))
12682 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12683 (error "Priority must be between `%c' and `%c'"
12684 org-highest-priority org-lowest-priority))))
12685 ((eq action 'up)
12686 (setq new (if have
12687 (1- current) ; normal cycling
12688 ;; last priority was empty
12689 (if (eq last-command this-command)
12690 org-lowest-priority ; wrap around empty to lowest
12691 ;; default
12692 (if org-priority-start-cycle-with-default
12693 org-default-priority
12694 (1- org-default-priority))))))
12695 ((eq action 'down)
12696 (setq new (if have
12697 (1+ current) ; normal cycling
12698 ;; last priority was empty
12699 (if (eq last-command this-command)
12700 org-highest-priority ; wrap around empty to highest
12701 ;; default
12702 (if org-priority-start-cycle-with-default
12703 org-default-priority
12704 (1+ org-default-priority))))))
12705 (t (error "Invalid action")))
12706 (if (or (< (upcase new) org-highest-priority)
12707 (> (upcase new) org-lowest-priority))
12708 (if (and (memq action '(up down))
12709 (not have) (not (eq last-command this-command)))
12710 ;; `new' is from default priority
12711 (error
12712 "The default can not be set, see `org-default-priority' why")
12713 ;; normal cycling: `new' is beyond highest/lowest priority
12714 ;; and is wrapped around to the empty priority
12715 (setq remove t)))
12716 (setq news (format "%c" new))
12717 (if have
12718 (if remove
12719 (replace-match "" t t nil 1)
12720 (replace-match news t t nil 2))
12721 (if remove
12722 (error "No priority cookie found in line")
12723 (let ((case-fold-search nil))
12724 (looking-at org-todo-line-regexp))
12725 (if (match-end 2)
12726 (progn
12727 (goto-char (match-end 2))
12728 (insert " [#" news "]"))
12729 (goto-char (match-beginning 3))
12730 (insert "[#" news "] "))))
12731 (org-preserve-lc (org-set-tags nil 'align)))
12732 (if remove
12733 (message "Priority removed")
12734 (message "Priority of current item set to %s" news))))
12736 (defun org-get-priority (s)
12737 "Find priority cookie and return priority."
12738 (if (functionp org-get-priority-function)
12739 (funcall org-get-priority-function)
12740 (save-match-data
12741 (if (not (string-match org-priority-regexp s))
12742 (* 1000 (- org-lowest-priority org-default-priority))
12743 (* 1000 (- org-lowest-priority
12744 (string-to-char (match-string 2 s))))))))
12746 ;;;; Tags
12748 (defvar org-agenda-archives-mode)
12749 (defvar org-map-continue-from nil
12750 "Position from where mapping should continue.
12751 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12753 (defvar org-scanner-tags nil
12754 "The current tag list while the tags scanner is running.")
12755 (defvar org-trust-scanner-tags nil
12756 "Should `org-get-tags-at' use the tags for the scanner.
12757 This is for internal dynamical scoping only.
12758 When this is non-nil, the function `org-get-tags-at' will return the value
12759 of `org-scanner-tags' instead of building the list by itself. This
12760 can lead to large speed-ups when the tags scanner is used in a file with
12761 many entries, and when the list of tags is retrieved, for example to
12762 obtain a list of properties. Building the tags list for each entry in such
12763 a file becomes an N^2 operation - but with this variable set, it scales
12764 as N.")
12766 (defun org-scan-tags (action matcher &optional todo-only start-level)
12767 "Scan headline tags with inheritance and produce output ACTION.
12769 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12770 or `agenda' to produce an entry list for an agenda view. It can also be
12771 a Lisp form or a function that should be called at each matched headline, in
12772 this case the return value is a list of all return values from these calls.
12774 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12775 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12776 only lines with a TODO keyword are included in the output.
12778 START-LEVEL can be a string with asterisks, reducing the scope to
12779 headlines matching this string."
12780 (require 'org-agenda)
12781 (let* ((re (concat "^"
12782 (if start-level
12783 ;; Get the correct level to match
12785 org-outline-regexp)
12788 (org-re
12790 (props (list 'face 'default
12791 'done-face 'org-agenda-done
12792 'undone-face 'default
12793 'mouse-face 'highlight
12794 'org-not-done-regexp org-not-done-regexp
12795 'org-todo-regexp org-todo-regexp
12796 'org-complex-heading-regexp org-complex-heading-regexp
12797 'help-echo
12798 (format "mouse-2 or RET jump to org file %s"
12799 (abbreviate-file-name
12800 (or (buffer-file-name (buffer-base-buffer))
12801 (buffer-name (buffer-base-buffer)))))))
12802 (case-fold-search nil)
12803 (org-map-continue-from nil)
12804 lspos tags tags-list
12805 (tags-alist (list (cons 0 org-file-tags)))
12806 (llast 0) rtn rtn1 level category i txt
12807 todo marker entry priority)
12808 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12809 (setq action (list 'lambda nil action)))
12810 (save-excursion
12811 (goto-char (point-min))
12812 (when (eq action 'sparse-tree)
12813 (org-overview)
12814 (org-remove-occur-highlights))
12815 (while (re-search-forward re nil t)
12816 (setq org-map-continue-from nil)
12817 (catch :skip
12818 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12819 tags (if (match-end 4) (org-match-string-no-properties 4)))
12820 (goto-char (setq lspos (match-beginning 0)))
12821 (setq level (org-reduced-level (funcall outline-level))
12822 category (org-get-category))
12823 (setq i llast llast level)
12824 ;; remove tag lists from same and sublevels
12825 (while (>= i level)
12826 (when (setq entry (assoc i tags-alist))
12827 (setq tags-alist (delete entry tags-alist)))
12828 (setq i (1- i)))
12829 ;; add the next tags
12830 (when tags
12831 (setq tags (org-split-string tags ":")
12832 tags-alist
12833 (cons (cons level tags) tags-alist)))
12834 ;; compile tags for current headline
12835 (setq tags-list
12836 (if org-use-tag-inheritance
12837 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12838 tags)
12839 org-scanner-tags tags-list)
12840 (when org-use-tag-inheritance
12841 (setcdr (car tags-alist)
12842 (mapcar (lambda (x)
12843 (setq x (copy-sequence x))
12844 (org-add-prop-inherited x))
12845 (cdar tags-alist))))
12846 (when (and tags org-use-tag-inheritance
12847 (or (not (eq t org-use-tag-inheritance))
12848 org-tags-exclude-from-inheritance))
12849 ;; selective inheritance, remove uninherited ones
12850 (setcdr (car tags-alist)
12851 (org-remove-uninherited-tags (cdar tags-alist))))
12852 (when (and
12854 ;; eval matcher only when the todo condition is OK
12855 (and (or (not todo-only) (member todo org-not-done-keywords))
12856 (let ((case-fold-search t)) (eval matcher)))
12858 ;; Call the skipper, but return t if it does not skip,
12859 ;; so that the `and' form continues evaluating
12860 (progn
12861 (unless (eq action 'sparse-tree) (org-agenda-skip))
12862 t)
12864 ;; Check if timestamps are deselecting this entry
12865 (or (not todo-only)
12866 (and (member todo org-not-done-keywords)
12867 (or (not org-agenda-tags-todo-honor-ignore-options)
12868 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12870 ;; Extra check for the archive tag
12871 ;; FIXME: Does the skipper already do this????
12872 (or
12873 (not (member org-archive-tag tags-list))
12874 ;; we have an archive tag, should we use this anyway?
12875 (or (not org-agenda-skip-archived-trees)
12876 (and (eq action 'agenda) org-agenda-archives-mode))))
12878 ;; select this headline
12880 (cond
12881 ((eq action 'sparse-tree)
12882 (and org-highlight-sparse-tree-matches
12883 (org-get-heading) (match-end 0)
12884 (org-highlight-new-match
12885 (match-beginning 1) (match-end 1)))
12886 (org-show-context 'tags-tree))
12887 ((eq action 'agenda)
12888 (setq txt (org-agenda-format-item
12889 ""
12890 (concat
12891 (if (eq org-tags-match-list-sublevels 'indented)
12892 (make-string (1- level) ?.) "")
12893 (org-get-heading))
12894 category
12895 tags-list
12896 )
12897 priority (org-get-priority txt))
12898 (goto-char lspos)
12899 (setq marker (org-agenda-new-marker))
12900 (org-add-props txt props
12901 'org-marker marker 'org-hd-marker marker 'org-category category
12902 'todo-state todo
12903 'priority priority 'type "tagsmatch")
12904 (push txt rtn))
12905 ((functionp action)
12906 (setq org-map-continue-from nil)
12907 (save-excursion
12908 (setq rtn1 (funcall action))
12909 (push rtn1 rtn)))
12910 (t (error "Invalid action")))
12912 ;; if we are to skip sublevels, jump to end of subtree
12913 (unless org-tags-match-list-sublevels
12914 (org-end-of-subtree t)
12915 (backward-char 1))))
12916 ;; Get the correct position from where to continue
12917 (if org-map-continue-from
12918 (goto-char org-map-continue-from)
12919 (and (= (point) lspos) (end-of-line 1)))))
12920 (when (and (eq action 'sparse-tree)
12921 (not org-sparse-tree-open-archived-trees))
12922 (org-hide-archived-subtrees (point-min) (point-max)))
12923 (nreverse rtn)))
12925 (defun org-remove-uninherited-tags (tags)
12926 "Remove all tags that are not inherited from the list TAGS."
12927 (cond
12928 ((eq org-use-tag-inheritance t)
12929 (if org-tags-exclude-from-inheritance
12930 (org-delete-all org-tags-exclude-from-inheritance tags)
12931 tags))
12932 ((not org-use-tag-inheritance) nil)
12933 ((stringp org-use-tag-inheritance)
12934 (delq nil (mapcar
12935 (lambda (x)
12936 (if (and (string-match org-use-tag-inheritance x)
12937 (not (member x org-tags-exclude-from-inheritance)))
12938 x nil))
12939 tags)))
12940 ((listp org-use-tag-inheritance)
12941 (delq nil (mapcar
12942 (lambda (x)
12943 (if (member x org-use-tag-inheritance) x nil))
12944 tags)))))
12946 (defvar todo-only) ;; dynamically scoped
12948 (defun org-match-sparse-tree (&optional todo-only match)
12949 "Create a sparse tree according to tags string MATCH.
12950 MATCH can contain positive and negative selection of tags, like
12952 If optional argument TODO-ONLY is non-nil, only select lines that are
12953 also TODO lines."
12954 (interactive "P")
12955 (org-prepare-agenda-buffers (list (current-buffer)))
12956 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12958 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12960 (defvar org-cached-props nil)
12961 (defun org-cached-entry-get (pom property)
12962 (if (or (eq t org-use-property-inheritance)
12963 (and (stringp org-use-property-inheritance)
12964 (string-match org-use-property-inheritance property))
12965 (and (listp org-use-property-inheritance)
12966 (member property org-use-property-inheritance)))
12967 ;; Caching is not possible, check it directly
12968 (org-entry-get pom property 'inherit)
12969 ;; Get all properties, so that we can do complicated checks easily
12970 (cdr (assoc property (or org-cached-props
12971 (setq org-cached-props
12972 (org-entry-properties pom)))))))
12974 (defun org-global-tags-completion-table (&optional files)
12975 "Return the list of all tags in all agenda buffer/files.
12976 Optional FILES argument is a list of files to which can be used
12977 instead of the agenda files."
12978 (save-excursion
12979 (org-uniquify
12980 (delq nil
12981 (apply 'append
12982 (mapcar
12983 (lambda (file)
12984 (set-buffer (find-file-noselect file))
12985 (append (org-get-buffer-tags)
12986 (mapcar (lambda (x) (if (stringp (car-safe x))
12987 (list (car-safe x)) nil))
12988 org-tag-alist)))
12989 (if (and files (car files))
12990 files
12991 (org-agenda-files))))))))
12993 (defun org-make-tags-matcher (match)
12994 "Create the TAGS/TODO matcher form for the selection string MATCH."
12995 ;; todo-only is scoped dynamically into this function, and the function
12996 ;; may change it if the matcher asks for it.
12997 (unless match
12998 ;; Get a new match request, with completion
12999 (let ((org-last-tags-completion-table
13000 (org-global-tags-completion-table)))
13001 (setq match (org-completing-read-no-i
13002 "Match: " 'org-tags-completion-function nil nil nil
13003 'org-tags-history))))
13005 ;; Parse the string and create a lisp form
13006 (let ((match0 match)
13007 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13008 minus tag mm
13009 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13010 orterms term orlist re-p str-p level-p level-op time-p
13011 prop-p pn pv po gv rest)
13012 (if (string-match "/+" match)
13013 ;; match contains also a todo-matching request
13014 (progn
13015 (setq tagsmatch (substring match 0 (match-beginning 0))
13016 todomatch (substring match (match-end 0)))
13017 (if (string-match "^!" todomatch)
13018 (setq todo-only t todomatch (substring todomatch 1)))
13020 (setq todomatch nil)))
13021 ;; only matching tags
13022 (setq tagsmatch match todomatch nil))
13024 ;; Make the tags matcher
13026 (setq tagsmatcher t)
13027 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13028 (while (setq term (pop orterms))
13030 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13031 (while (string-match re term)
13032 (setq rest (substring term (match-end 0))
13033 minus (and (match-end 1)
13034 (equal (match-string 1 term) "-"))
13035 tag (save-match-data (replace-regexp-in-string
13037 (match-string 2 term)))
13038 re-p (equal (string-to-char tag) ?{)
13039 level-p (match-end 4)
13040 prop-p (match-end 5)
13041 mm (cond
13042 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13043 (level-p
13044 (setq level-op (org-op-to-function (match-string 3 term)))
13045 `(,level-op level ,(string-to-number
13046 (match-string 4 term))))
13047 (prop-p
13048 (setq pn (match-string 5 term)
13049 po (match-string 6 term)
13050 pv (match-string 7 term)
13051 re-p (equal (string-to-char pv) ?{)
13053 time-p (save-match-data
13055 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13056 (if time-p (setq pv (org-matcher-time pv)))
13057 (setq po (org-op-to-function po (if time-p 'time str-p)))
13058 (cond
13059 ((equal pn "CATEGORY")
13060 (setq gv '(get-text-property (point) 'org-category)))
13061 ((equal pn "TODO")
13062 (setq gv 'todo))
13063 (t
13064 (setq gv `(org-cached-entry-get nil ,pn))))
13065 (if re-p
13066 (if (eq po 'org<>)
13067 `(not (string-match ,pv (or ,gv "")))
13068 `(string-match ,pv (or ,gv "")))
13069 (if str-p
13070 `(,po (or ,gv "") ,pv)
13071 `(,po (string-to-number (or ,gv ""))
13072 ,(string-to-number pv) ))))
13073 (t `(member ,tag tags-list)))
13074 mm (if minus (list 'not mm) mm)
13075 term rest)
13076 (push mm tagsmatcher))
13077 (push (if (> (length tagsmatcher) 1)
13078 (cons 'and tagsmatcher)
13079 (car tagsmatcher))
13080 orlist)
13081 (setq tagsmatcher nil))
13082 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13083 (setq tagsmatcher
13084 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13085 ;; Make the todo matcher
13087 (setq todomatcher t)
13088 (setq orterms (org-split-string todomatch "|") orlist nil)
13089 (while (setq term (pop orterms))
13090 (while (string-match re term)
13091 (setq minus (and (match-end 1)
13092 (equal (match-string 1 term) "-"))
13093 kwd (match-string 2 term)
13094 re-p (equal (string-to-char kwd) ?{)
13095 term (substring term (match-end 0))
13096 mm (if re-p
13097 `(string-match ,(substring kwd 1 -1) todo)
13098 (list 'equal 'todo kwd))
13099 mm (if minus (list 'not mm) mm))
13100 (push mm todomatcher))
13101 (push (if (> (length todomatcher) 1)
13102 (cons 'and todomatcher)
13103 (car todomatcher))
13104 orlist)
13105 (setq todomatcher nil))
13106 (setq todomatcher (if (> (length orlist) 1)
13107 (cons 'or orlist) (car orlist))))
13109 ;; Return the string and lisp forms of the matcher
13110 (setq matcher (if todomatcher
13111 (list 'and tagsmatcher todomatcher)
13112 tagsmatcher))
13113 (cons match0 matcher)))
13115 (defun org-op-to-function (op &optional stringp)
13116 "Turn an operator into the appropriate function."
13117 (setq op
13118 (cond
13119 ((equal op "<" ) '(< string< org-time<))
13120 ((equal op ">" ) '(> org-string> org-time>))
13121 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13122 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13123 ((member op '("=" "==")) '(= string= org-time=))
13124 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13125 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13127 (defun org<> (a b) (not (= a b)))
13128 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13129 (defun org-string>= (a b) (not (string< a b)))
13130 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13131 (defun org-string<> (a b) (not (string= a b)))
13132 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13133 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13134 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13135 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13136 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13137 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13138 (defun org-2ft (s)
13139 "Convert S to a floating point time.
13140 If S is already a number, just return it. If it is a string, parse
13141 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13142 (cond
13143 ((numberp s) s)
13144 ((stringp s)
13145 (condition-case nil
13146 (float-time (apply 'encode-time (org-parse-time-string s)))
13147 (error 0.)))
13148 (t 0.)))
13150 (defun org-time-today ()
13151 "Time in seconds today at 0:00.
13152 Returns the float number of seconds since the beginning of the
13153 epoch to the beginning of today (00:00)."
13154 (float-time (apply 'encode-time
13155 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13157 (defun org-matcher-time (s)
13158 "Interpret a time comparison value."
13159 (save-match-data
13160 (cond
13161 ((string= s "<now>") (float-time))
13162 ((string= s "<today>") (org-time-today))
13163 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13164 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13166 (+ (org-time-today)
13167 (* (string-to-number (match-string 1 s))
13168 (cdr (assoc (match-string 2 s)
13169 '(("d" . 86400.0) ("w" . 604800.0)
13170 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13171 (t (org-2ft s)))))
13173 (defun org-match-any-p (re list)
13174 "Does re match any element of list?"
13175 (setq list (mapcar (lambda (x) (string-match re x)) list))
13176 (delq nil list))
13178 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13179 (defvar org-tags-overlay (make-overlay 1 1))
13180 (org-detach-overlay org-tags-overlay)
13182 (defun org-get-local-tags-at (&optional pos)
13183 "Get a list of tags defined in the current headline."
13184 (org-get-tags-at pos 'local))
13186 (defun org-get-local-tags ()
13187 "Get a list of tags defined in the current headline."
13188 (org-get-tags-at nil 'local))
13190 (defun org-get-tags-at (&optional pos local)
13191 "Get a list of all headline tags applicable at POS.
13192 POS defaults to point. If tags are inherited, the list contains
13193 the targets in the same sequence as the headlines appear, i.e.
13194 the tags of the current headline come last.
13195 When LOCAL is non-nil, only return tags from the current headline,
13196 ignore inherited ones."
13197 (interactive)
13198 (if (and org-trust-scanner-tags
13199 (or (not pos) (equal pos (point)))
13200 (not local))
13201 org-scanner-tags
13202 (let (tags ltags lastpos parent)
13203 (save-excursion
13204 (save-restriction
13205 (widen)
13206 (goto-char (or pos (point)))
13207 (save-match-data
13208 (catch 'done
13209 (condition-case nil
13210 (progn
13211 (org-back-to-heading t)
13212 (while (not (equal lastpos (point)))
13213 (setq lastpos (point))
13214 (when (looking-at
13216 (setq ltags (org-split-string
13217 (org-match-string-no-properties 1) ":"))
13218 (when parent
13219 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13220 (setq tags (append
13221 (if parent
13222 (org-remove-uninherited-tags ltags)
13223 ltags)
13224 tags)))
13225 (or org-use-tag-inheritance (throw 'done t))
13226 (if local (throw 'done t))
13227 (or (org-up-heading-safe) (error nil))
13228 (setq parent t)))
13229 (error nil)))))
13230 (if local
13231 tags
13232 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13234 (defun org-add-prop-inherited (s)
13235 (add-text-properties 0 (length s) '(inherited t) s)
13236 s)
13238 (defun org-toggle-tag (tag &optional onoff)
13239 "Toggle the tag TAG for the current line.
13240 If ONOFF is `on' or `off', don't toggle but set to this state."
13241 (let (res current)
13242 (save-excursion
13243 (org-back-to-heading t)
13245 (point-at-eol) t)
13246 (progn
13247 (setq current (match-string 1))
13248 (replace-match ""))
13249 (setq current ""))
13250 (setq current (nreverse (org-split-string current ":")))
13251 (cond
13252 ((eq onoff 'on)
13253 (setq res t)
13254 (or (member tag current) (push tag current)))
13255 ((eq onoff 'off)
13256 (or (not (member tag current)) (setq current (delete tag current))))
13257 (t (if (member tag current)
13258 (setq current (delete tag current))
13259 (setq res t)
13260 (push tag current))))
13261 (end-of-line 1)
13262 (if current
13263 (progn
13264 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13265 (org-set-tags nil t))
13266 (delete-horizontal-space))
13267 (run-hooks 'org-after-tags-change-hook))
13268 res))
13270 (defun org-align-tags-here (to-col)
13271 ;; Assumes that this is a headline
13272 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13273 (beginning-of-line 1)
13275 (< pos (match-beginning 2)))
13276 (progn
13277 (setq tags-l (- (match-end 2) (match-beginning 2)))
13278 (goto-char (match-beginning 1))
13279 (insert " ")
13280 (delete-region (point) (1+ (match-beginning 2)))
13281 (setq ncol (max (current-column)
13282 (1+ col)
13283 (if (> to-col 0)
13284 to-col
13285 (- (abs to-col) tags-l))))
13286 (setq p (point))
13287 (insert (make-string (- ncol (current-column)) ?\ ))
13288 (setq ncol (current-column))
13289 (when indent-tabs-mode (tabify p (point-at-eol)))
13290 (org-move-to-column (min ncol col) t))
13291 (goto-char pos))))
13293 (defun org-set-tags-command (&optional arg just-align)
13294 "Call the set-tags command for the current entry."
13295 (interactive "P")
13296 (if (org-at-heading-p)
13297 (org-set-tags arg just-align)
13298 (save-excursion
13299 (org-back-to-heading t)
13300 (org-set-tags arg just-align))))
13302 (defun org-set-tags-to (data)
13303 "Set the tags of the current entry to DATA, replacing the current tags.
13304 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13305 If DATA is nil or the empty string, any tags will be removed."
13306 (interactive "sTags: ")
13307 (setq data
13308 (cond
13309 ((eq data nil) "")
13310 ((equal data "") "")
13311 ((stringp data)
13312 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13313 ":"))
13314 ((listp data)
13315 (concat ":" (mapconcat 'identity data ":") ":"))
13316 (t nil)))
13317 (when data
13318 (save-excursion
13319 (org-back-to-heading t)
13320 (when (looking-at org-complex-heading-regexp)
13321 (if (match-end 5)
13322 (progn
13323 (goto-char (match-beginning 5))
13324 (insert data)
13325 (delete-region (point) (point-at-eol))
13326 (org-set-tags nil 'align))
13327 (goto-char (point-at-eol))
13328 (insert " " data)
13329 (org-set-tags nil 'align)))
13330 (beginning-of-line 1)
13332 (delete-region (match-beginning 1) (match-end 1))))))
13334 (defun org-align-all-tags ()
13335 "Align the tags i all headings."
13336 (interactive)
13337 (save-excursion
13338 (or (ignore-errors (org-back-to-heading t))
13339 (outline-next-heading))
13340 (if (org-at-heading-p)
13341 (org-set-tags t)
13342 (message "No headings"))))
13344 (defvar org-indent-indentation-per-level)
13345 (defun org-set-tags (&optional arg just-align)
13346 "Set the tags for the current headline.
13347 With prefix ARG, realign all tags in headings in the current buffer."
13348 (interactive "P")
13349 (let* ((re org-outline-regexp-bol)
13350 (current (org-get-tags-string))
13351 (col (current-column))
13352 (org-setting-tags t)
13353 table current-tags inherited-tags ; computed below when needed
13354 tags p0 c0 c1 rpl di tc level)
13355 (if arg
13356 (save-excursion
13357 (goto-char (point-min))
13358 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13359 (while (re-search-forward re nil t)
13360 (org-set-tags nil t)
13361 (end-of-line 1)))
13362 (message "All tags realigned to column %d" org-tags-column))
13363 (if just-align
13364 (setq tags current)
13365 ;; Get a new set of tags from the user
13366 (save-excursion
13367 (setq table (append org-tag-persistent-alist
13368 (or org-tag-alist (org-get-buffer-tags))
13369 (and
13370 org-complete-tags-always-offer-all-agenda-tags
13371 (org-global-tags-completion-table
13372 (org-agenda-files))))
13373 org-last-tags-completion-table table
13374 current-tags (org-split-string current ":")
13375 inherited-tags (nreverse
13376 (nthcdr (length current-tags)
13377 (nreverse (org-get-tags-at))))
13378 tags
13379 (if (or (eq t org-use-fast-tag-selection)
13380 (and org-use-fast-tag-selection
13381 (delq nil (mapcar 'cdr table))))
13382 (org-fast-tag-selection
13383 current-tags inherited-tags table
13384 (if org-fast-tag-selection-include-todo
13385 org-todo-key-alist))
13386 (let ((org-add-colon-after-tag-completion t))
13387 (org-trim
13388 (org-icompleting-read "Tags: "
13389 'org-tags-completion-function
13390 nil nil current 'org-tags-history))))))
13391 (while (string-match "[-+&]+" tags)
13392 ;; No boolean logic, just a list
13393 (setq tags (replace-match ":" t t tags))))
13395 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13397 (if org-tags-sort-function
13398 (setq tags (mapconcat 'identity
13399 (sort (org-split-string
13400 tags (org-re "[^[:alnum:]_@#%]+"))
13401 org-tags-sort-function) ":")))
13404 (setq tags "")
13405 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13406 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13408 ;; Insert new tags at the correct column
13409 (beginning-of-line 1)
13410 (setq level (or (and (looking-at org-outline-regexp)
13411 (- (match-end 0) (point) 1))
13412 1))
13413 (cond
13414 ((and (equal current "") (equal tags "")))
13415 ((re-search-forward
13417 (point-at-eol) t)
13418 (if (equal tags "")
13419 (setq rpl "")
13420 (goto-char (match-beginning 0))
13421 (setq c0 (current-column)
13422 ;; compute offset for the case of org-indent-mode active
13423 di (if org-indent-mode
13424 (* (1- org-indent-indentation-per-level) (1- level))
13425 0)
13426 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13427 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13428 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13429 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13430 (replace-match rpl t t)
13431 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13432 tags)
13433 (t (error "Tags alignment failed")))
13434 (org-move-to-column col)
13435 (unless just-align
13436 (run-hooks 'org-after-tags-change-hook)))))
13438 (defun org-change-tag-in-region (beg end tag off)
13439 "Add or remove TAG for each entry in the region.
13440 This works in the agenda, and also in an org-mode buffer."
13441 (interactive
13442 (list (region-beginning) (region-end)
13443 (let ((org-last-tags-completion-table
13444 (if (eq major-mode 'org-mode)
13445 (org-get-buffer-tags)
13446 (org-global-tags-completion-table))))
13447 (org-icompleting-read
13448 "Tag: " 'org-tags-completion-function nil nil nil
13449 'org-tags-history))
13450 (progn
13452 (equal (read-char-exclusive) ?r))))
13453 (if (fboundp 'deactivate-mark) (deactivate-mark))
13454 (let ((agendap (equal major-mode 'org-agenda-mode))
13455 l1 l2 m buf pos newhead (cnt 0))
13456 (goto-char end)
13457 (setq l2 (1- (org-current-line)))
13458 (goto-char beg)
13459 (setq l1 (org-current-line))
13460 (loop for l from l1 to l2 do
13461 (org-goto-line l)
13462 (setq m (get-text-property (point) 'org-hd-marker))
13463 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13464 (and agendap m))
13465 (setq buf (if agendap (marker-buffer m) (current-buffer))
13466 pos (if agendap m (point)))
13467 (with-current-buffer buf
13468 (save-excursion
13469 (save-restriction
13470 (goto-char pos)
13471 (setq cnt (1+ cnt))
13472 (org-toggle-tag tag (if off 'off 'on))
13473 (setq newhead (org-get-heading)))))
13474 (and agendap (org-agenda-change-all-lines newhead m))))
13475 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13477 (defun org-tags-completion-function (string predicate &optional flag)
13478 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13479 (confirm (lambda (x) (stringp (car x)))))
13481 (setq s1 (match-string 1 string)
13482 s2 (match-string 2 string))
13483 (setq s1 "" s2 string))
13484 (cond
13485 ((eq flag nil)
13486 ;; try completion
13487 (setq rtn (try-completion s2 ctable confirm))
13488 (if (stringp rtn)
13489 (setq rtn
13490 (concat s1 s2 (substring rtn (length s2))
13491 (if (and org-add-colon-after-tag-completion
13492 (assoc rtn ctable))
13493 ":" ""))))
13494 rtn)
13495 ((eq flag t)
13496 ;; all-completions
13497 (all-completions s2 ctable confirm)
13498 )
13499 ((eq flag 'lambda)
13500 ;; exact match?
13501 (assoc s2 ctable)))
13502 ))
13504 (defun org-fast-tag-insert (kwd tags face &optional end)
13505 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13506 (insert (format "%-12s" (concat kwd ":"))
13507 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13508 (or end "")))
13510 (defun org-fast-tag-show-exit (flag)
13511 (save-excursion
13512 (org-goto-line 3)
13514 (replace-match ""))
13515 (when flag
13516 (end-of-line 1)
13517 (org-move-to-column (- (window-width) 19) t)
13518 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13520 (defun org-set-current-tags-overlay (current prefix)
13521 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13522 (if (featurep 'xemacs)
13523 (org-overlay-display org-tags-overlay (concat prefix s)
13524 'secondary-selection)
13525 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13526 (org-overlay-display org-tags-overlay (concat prefix s)))))
13528 (defvar org-last-tag-selection-key nil)
13529 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13530 "Fast tag selection with single keys.
13531 CURRENT is the current list of tags in the headline, INHERITED is the
13532 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13533 possibly with grouping information. TODO-TABLE is a similar table with
13534 TODO keywords, should these have keys assigned to them.
13535 If the keys are nil, a-z are automatically assigned.
13536 Returns the new tags string, or nil to not change the current settings."
13537 (let* ((fulltable (append table todo-table))
13538 (maxlen (apply 'max (mapcar
13539 (lambda (x)
13540 (if (stringp (car x)) (string-width (car x)) 0))
13541 fulltable)))
13542 (buf (current-buffer))
13543 (expert (eq org-fast-tag-selection-single-key 'expert))
13544 (buffer-tags nil)
13545 (fwidth (+ maxlen 3 1 3))
13546 (ncol (/ (- (window-width) 4) fwidth))
13547 (i-face 'org-done)
13548 (c-face 'org-todo)
13549 tg cnt e c char c1 c2 ntable tbl rtn
13550 ov-start ov-end ov-prefix
13551 (exit-after-next org-fast-tag-selection-single-key)
13552 (done-keywords org-done-keywords)
13553 groups ingroup)
13554 (save-excursion
13555 (beginning-of-line 1)
13556 (if (looking-at
13558 (setq ov-start (match-beginning 1)
13559 ov-end (match-end 1)
13560 ov-prefix "")
13561 (setq ov-start (1- (point-at-eol))
13562 ov-end (1+ ov-start))
13564 (setq ov-prefix
13565 (concat
13566 (buffer-substring (1- (point)) (point))
13567 (if (> (current-column) org-tags-column)
13568 " "
13569 (make-string (- org-tags-column (current-column)) ?\ ))))))
13570 (move-overlay org-tags-overlay ov-start ov-end)
13571 (save-window-excursion
13572 (if expert
13573 (set-buffer (get-buffer-create " *Org tags*"))
13574 (delete-other-windows)
13575 (split-window-vertically)
13576 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13577 (erase-buffer)
13578 (org-set-local 'org-done-keywords done-keywords)
13581 (org-fast-tag-show-exit exit-after-next)
13582 (org-set-current-tags-overlay current ov-prefix)
13583 (setq tbl fulltable char ?a cnt 0)
13584 (while (setq e (pop tbl))
13585 (cond
13586 ((equal (car e) :startgroup)
13587 (push '() groups) (setq ingroup t)
13588 (when (not (= cnt 0))
13589 (setq cnt 0)
13591 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13592 ((equal (car e) :endgroup)
13593 (setq ingroup nil cnt 0)
13595 ((equal e '(:newline))
13596 (when (not (= cnt 0))
13597 (setq cnt 0)
13599 (setq e (car tbl))
13600 (while (equal (car tbl) '(:newline))
13602 (setq tbl (cdr tbl)))))
13603 (t
13604 (setq tg (copy-sequence (car e)) c2 nil)
13605 (if (cdr e)
13606 (setq c (cdr e))
13607 ;; automatically assign a character.
13608 (setq c1 (string-to-char
13609 (downcase (substring
13610 tg (if (= (string-to-char tg) ?@) 1 0)))))
13611 (if (or (rassoc c1 ntable) (rassoc c1 table))
13612 (while (or (rassoc char ntable) (rassoc char table))
13613 (setq char (1+ char)))
13614 (setq c2 c1))
13615 (setq c (or c2 char)))
13616 (if ingroup (push tg (car groups)))
13617 (setq tg (org-add-props tg nil 'face
13618 (cond
13619 ((not (assoc tg table))
13620 (org-get-todo-face tg))
13621 ((member tg current) c-face)
13622 ((member tg inherited) i-face)
13623 (t nil))))
13624 (if (and (= cnt 0) (not ingroup)) (insert " "))
13625 (insert "[" c "] " tg (make-string
13626 (- fwidth 4 (length tg)) ?\ ))
13627 (push (cons tg c) ntable)
13628 (when (= (setq cnt (1+ cnt)) ncol)
13630 (if ingroup (insert " "))
13631 (setq cnt 0)))))
13632 (setq ntable (nreverse ntable))
13634 (goto-char (point-min))
13635 (if (not expert) (org-fit-window-to-buffer))
13636 (setq rtn
13637 (catch 'exit
13638 (while t
13639 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13640 (if (not groups) "no " "")
13641 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13642 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13643 (setq org-last-tag-selection-key c)
13644 (cond
13646 ((= c ?!)
13647 (setq groups (not groups))
13648 (goto-char (point-min))
13649 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13650 ((= c ?\C-c)
13651 (if (not expert)
13652 (org-fast-tag-show-exit
13653 (setq exit-after-next (not exit-after-next)))
13654 (setq expert nil)
13655 (delete-other-windows)
13656 (set-window-buffer (split-window-vertically) " *Org tags*")
13657 (org-switch-to-buffer-other-window " *Org tags*")
13658 (org-fit-window-to-buffer)))
13659 ((or (= c ?\C-g)
13660 (and (= c ?q) (not (rassoc c ntable))))
13661 (org-detach-overlay org-tags-overlay)
13662 (setq quit-flag t))
13663 ((= c ?\ )
13664 (setq current nil)
13665 (if exit-after-next (setq exit-after-next 'now)))
13667 (condition-case nil
13668 (setq tg (org-icompleting-read
13669 "Tag: "
13670 (or buffer-tags
13671 (with-current-buffer buf
13672 (org-get-buffer-tags)))))
13673 (quit (setq tg "")))
13675 (add-to-list 'buffer-tags (list tg))
13676 (if (member tg current)
13677 (setq current (delete tg current))
13678 (push tg current)))
13679 (if exit-after-next (setq exit-after-next 'now)))
13680 ((setq e (rassoc c todo-table) tg (car e))
13681 (with-current-buffer buf
13682 (save-excursion (org-todo tg)))
13683 (if exit-after-next (setq exit-after-next 'now)))
13684 ((setq e (rassoc c ntable) tg (car e))
13685 (if (member tg current)
13686 (setq current (delete tg current))
13687 (loop for g in groups do
13688 (if (member tg g)
13689 (mapc (lambda (x)
13690 (setq current (delete x current)))
13691 g)))
13692 (push tg current))
13693 (if exit-after-next (setq exit-after-next 'now))))
13695 ;; Create a sorted list
13696 (setq current
13697 (sort current
13698 (lambda (a b)
13699 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13700 (if (eq exit-after-next 'now) (throw 'exit t))
13701 (goto-char (point-min))
13702 (beginning-of-line 2)
13703 (delete-region (point) (point-at-eol))
13704 (org-fast-tag-insert "Current" current c-face)
13705 (org-set-current-tags-overlay current ov-prefix)
13706 (while (re-search-forward
13708 (setq tg (match-string 1))
13709 (add-text-properties
13710 (match-beginning 1) (match-end 1)
13711 (list 'face
13712 (cond
13713 ((member tg current) c-face)
13714 ((member tg inherited) i-face)
13715 (t (get-text-property (match-beginning 1) 'face))))))
13716 (goto-char (point-min)))))
13717 (org-detach-overlay org-tags-overlay)
13718 (if rtn
13719 (mapconcat 'identity current ":")
13720 nil))))
13722 (defun org-get-tags-string ()
13723 "Get the TAGS string in the current headline."
13724 (unless (org-at-heading-p t)
13725 (error "Not on a heading"))
13726 (save-excursion
13727 (beginning-of-line 1)
13729 (org-match-string-no-properties 1)
13730 "")))
13732 (defun org-get-tags ()
13733 "Get the list of tags specified in the current headline."
13734 (org-split-string (org-get-tags-string) ":"))
13736 (defun org-get-buffer-tags ()
13737 "Get a table of all tags used in the buffer, for completion."
13738 (let (tags)
13739 (save-excursion
13740 (goto-char (point-min))
13741 (while (re-search-forward
13743 (when (equal (char-after (point-at-bol 0)) ?*)
13744 (mapc (lambda (x) (add-to-list 'tags x))
13745 (org-split-string (org-match-string-no-properties 1) ":")))))
13746 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13747 (mapcar 'list tags)))
13749 ;;;; The mapping API
13751 ;;;###autoload
13752 (defun org-map-entries (func &optional match scope &rest skip)
13753 "Call FUNC at each headline selected by MATCH in SCOPE.
13755 FUNC is a function or a lisp form. The function will be called without
13756 arguments, with the cursor positioned at the beginning of the headline.
13757 The return values of all calls to the function will be collected and
13758 returned as a list.
13760 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13761 does not need to preserve point. After evaluation, the cursor will be
13762 moved to the end of the line (presumably of the headline of the
13763 processed entry) and search continues from there. Under some
13764 circumstances, this may not produce the wanted results. For example,
13765 if you have removed (e.g. archived) the current (sub)tree it could
13766 mean that the next entry will be skipped entirely. In such cases, you
13767 can specify the position from where search should continue by making
13768 FUNC set the variable `org-map-continue-from' to the desired buffer
13769 position.
13771 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13772 Only headlines that are matched by this query will be considered during
13773 the iteration. When MATCH is nil or t, all headlines will be
13774 visited by the iteration.
13776 SCOPE determines the scope of this command. It can be any of:
13778 nil The current buffer, respecting the restriction if any
13779 tree The subtree started with the entry at point
13780 region The entries within the active region, if any
13781 region-start-level
13782 The entries within the active region, but only those at
13783 the same level than the first one.
13784 file The current buffer, without restriction
13785 file-with-archives
13786 The current buffer, and any archives associated with it
13787 agenda All agenda files
13788 agenda-with-archives
13789 All agenda files with any archive files associated with them
13790 \(file1 file2 ...)
13791 If this is a list, all files in the list will be scanned
13793 The remaining args are treated as settings for the skipping facilities of
13794 the scanner. The following items can be given here:
13796 archive skip trees with the archive tag.
13797 comment skip trees with the COMMENT keyword
13798 function or Emacs Lisp form:
13799 will be used as value for `org-agenda-skip-function', so whenever
13800 the function returns t, FUNC will not be called for that
13801 entry and search will continue from the point where the
13802 function leaves it.
13804 If your function needs to retrieve the tags including inherited tags
13805 at the *current* entry, you can use the value of the variable
13806 `org-scanner-tags' which will be much faster than getting the value
13807 with `org-get-tags-at'. If your function gets properties with
13808 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13809 to t around the call to `org-entry-properties' to get the same speedup.
13810 Note that if your function moves around to retrieve tags and properties at
13811 a *different* entry, you cannot use these techniques."
13812 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13813 (not (org-region-active-p)))
13814 (let* ((org-agenda-archives-mode nil) ; just to make sure
13815 (org-agenda-skip-archived-trees (memq 'archive skip))
13816 (org-agenda-skip-comment-trees (memq 'comment skip))
13817 (org-agenda-skip-function
13818 (car (org-delete-all '(comment archive) skip)))
13819 (org-tags-match-list-sublevels t)
13820 (start-level (eq scope 'region-start-level))
13821 matcher file res
13822 org-todo-keywords-for-agenda
13823 org-done-keywords-for-agenda
13824 org-todo-keyword-alist-for-agenda
13825 org-drawers-for-agenda
13826 org-tag-alist-for-agenda)
13828 (cond
13829 ((eq match t) (setq matcher t))
13830 ((eq match nil) (setq matcher t))
13831 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13833 (save-excursion
13834 (save-restriction
13835 (cond ((eq scope 'tree)
13836 (org-back-to-heading t)
13837 (org-narrow-to-subtree)
13838 (setq scope nil))
13839 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13840 (org-region-active-p))
13841 ;; If needed, set start-level to a string like "2"
13842 (when start-level
13843 (save-excursion
13844 (goto-char (region-beginning))
13845 (unless (org-at-heading-p) (outline-next-heading))
13846 (setq start-level (org-current-level))))
13847 (narrow-to-region (region-beginning)
13848 (save-excursion
13849 (goto-char (region-end))
13850 (unless (and (bolp) (org-at-heading-p))
13851 (outline-next-heading))
13852 (point)))
13853 (setq scope nil)))
13855 (if (not scope)
13856 (progn
13857 (org-prepare-agenda-buffers
13858 (list (buffer-file-name (current-buffer))))
13859 (setq res (org-scan-tags func matcher nil start-level)))
13860 ;; Get the right scope
13861 (cond
13862 ((and scope (listp scope) (symbolp (car scope)))
13863 (setq scope (eval scope)))
13864 ((eq scope 'agenda)
13865 (setq scope (org-agenda-files t)))
13866 ((eq scope 'agenda-with-archives)
13867 (setq scope (org-agenda-files t))
13868 (setq scope (org-add-archive-files scope)))
13869 ((eq scope 'file)
13870 (setq scope (list (buffer-file-name))))
13871 ((eq scope 'file-with-archives)
13872 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13873 (org-prepare-agenda-buffers scope)
13874 (while (setq file (pop scope))
13875 (with-current-buffer (org-find-base-buffer-visiting file)
13876 (save-excursion
13877 (save-restriction
13878 (widen)
13879 (goto-char (point-min))
13880 (setq res (append res (org-scan-tags func matcher))))))))))
13881 res)))
13883 ;;;; Properties
13885 ;;; Setting and retrieving properties
13887 (defconst org-special-properties
13888 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13889 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13890 "The special properties valid in Org-mode.
13892 These are properties that are not defined in the property drawer,
13893 but in some other way.")
13895 (defconst org-default-properties
13896 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13897 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13898 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13899 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13900 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13901 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13902 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13903 "Some properties that are used by Org-mode for various purposes.
13904 Being in this list makes sure that they are offered for completion.")
13907 "Regular expression matching the first line of a property drawer.")
13910 "Regular expression matching the last line of a property drawer.")
13913 "Regular expression matching the first line of a property drawer.")
13916 "Regular expression matching the first line of a property drawer.")
13918 (defconst org-property-drawer-re
13921 "Matches an entire property drawer.")
13923 (defconst org-clock-drawer-re
13926 "Matches an entire clock drawer.")
13928 (defsubst org-re-property (property)
13929 "Return a regexp matching PROPERTY.
13930 Match group 1 will be set to the value "
13933 (defun org-property-action ()
13934 "Do an action on properties."
13935 (interactive)
13936 (let (c)
13937 (org-at-property-p)
13938 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13939 (setq c (read-char-exclusive))
13940 (cond
13941 ((equal c ?s)
13942 (call-interactively 'org-set-property))
13943 ((equal c ?d)
13944 (call-interactively 'org-delete-property))
13945 ((equal c ?D)
13946 (call-interactively 'org-delete-property-globally))
13947 ((equal c ?c)
13948 (call-interactively 'org-compute-property-at-point))
13949 (t (error "No such property action %c" c)))))
13951 (defun org-set-effort (&optional value)
13952 "Set the effort property of the current entry.
13953 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13954 allowed value."
13955 (interactive "P")
13956 (if (equal value 0) (setq value 10))
13957 (let* ((completion-ignore-case t)
13958 (prop org-effort-property)
13959 (cur (org-entry-get nil prop))
13960 (allowed (org-property-get-allowed-values nil prop 'table))
13961 (existing (mapcar 'list (org-property-values prop)))
13962 rpl
13963 (val (cond
13964 ((stringp value) value)
13965 ((and allowed (integerp value))
13966 (or (car (nth (1- value) allowed))
13967 (car (org-last allowed))))
13968 (allowed
13969 (message "Select 1-9,0, [RET%s]: %s"
13970 (if cur (concat "=" cur) "")
13971 (mapconcat 'car allowed " "))
13972 (setq rpl (read-char-exclusive))
13974 cur
13975 (setq rpl (- rpl ?0))
13976 (if (equal rpl 0) (setq rpl 10))
13977 (if (and (> rpl 0) (<= rpl (length allowed)))
13978 (car (nth (1- rpl) allowed))
13979 (org-completing-read "Effort: " allowed nil))))
13980 (t
13981 (let (org-completion-use-ido org-completion-use-iswitchb)
13982 (org-completing-read
13984 (concat "[" cur "]") "")
13985 ": ")
13986 existing nil nil "" nil cur))))))
13987 (unless (equal (org-entry-get nil prop) val)
13988 (org-entry-put nil prop val))
13989 (message "%s is now %s" prop val)))
13991 (defun org-at-property-p ()
13992 "Is cursor inside a property drawer?"
13993 (save-excursion
13994 (beginning-of-line 1)
13996 (save-match-data ;; Used by calling procedures
13997 (let ((p (point))
13998 (range (unless (org-before-first-heading-p)
13999 (org-get-property-block))))
14000 (and range (<= (car range) p) (< p (cdr range))))))))
14002 (defun org-get-property-block (&optional beg end force)
14003 "Return the (beg . end) range of the body of the property drawer.
14004 BEG and END can be beginning and end of subtree, if not given
14005 they will be found.
14006 If the drawer does not exist and FORCE is non-nil, create the drawer."
14007 (catch 'exit
14008 (save-excursion
14009 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14010 (end (or end (progn (outline-next-heading) (point)))))
14011 (goto-char beg)
14012 (if (re-search-forward org-property-start-re end t)
14013 (setq beg (1+ (match-end 0)))
14014 (if force
14015 (save-excursion
14016 (org-insert-property-drawer)
14017 (setq end (progn (outline-next-heading) (point))))
14018 (throw 'exit nil))
14019 (goto-char beg)
14020 (if (re-search-forward org-property-start-re end t)
14021 (setq beg (1+ (match-end 0)))))
14022 (if (re-search-forward org-property-end-re end t)
14023 (setq end (match-beginning 0))
14024 (or force (throw 'exit nil))
14025 (goto-char beg)
14026 (setq end beg)
14027 (org-indent-line-function)
14029 (cons beg end)))))
14031 (defun org-entry-properties (&optional pom which specific)
14032 "Get all properties of the entry at point-or-marker POM.
14033 This includes the TODO keyword, the tags, time strings for deadline,
14034 scheduled, and clocking, and any additional properties defined in the
14035 entry. The return value is an alist, keys may occur multiple times
14036 if the property key was used several times.
14037 POM may also be nil, in which case the current entry is used.
14038 If WHICH is nil or `all', get all properties. If WHICH is
14039 `special' or `standard', only get that subclass. If WHICH
14040 is a string only get exactly this property. SPECIFIC can be a string, the
14041 specific property we are interested in. Specifying it can speed
14042 things up because then unnecessary parsing is avoided."
14043 (setq which (or which 'all))
14044 (org-with-point-at pom
14045 (let ((clockstr (substring org-clock-string 0 -1))
14046 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14047 (case-fold-search nil)
14048 beg end range props sum-props key key1 value string clocksum)
14049 (save-excursion
14050 (when (condition-case nil
14051 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14052 (error nil))
14053 (setq beg (point))
14054 (setq sum-props (get-text-property (point) 'org-summaries))
14055 (setq clocksum (get-text-property (point) :org-clock-minutes))
14056 (outline-next-heading)
14057 (setq end (point))
14058 (when (memq which '(all special))
14059 ;; Get the special properties, like TODO and tags
14060 (goto-char beg)
14061 (when (and (or (not specific) (string= specific "TODO"))
14062 (looking-at org-todo-line-regexp) (match-end 2))
14063 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14064 (when (and (or (not specific) (string= specific "PRIORITY"))
14065 (looking-at org-priority-regexp))
14066 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14067 (when (or (not specific) (string= specific "FILE"))
14068 (push (cons "FILE" buffer-file-name) props))
14069 (when (and (or (not specific) (string= specific "TAGS"))
14070 (setq value (org-get-tags-string))
14072 (push (cons "TAGS" value) props))
14073 (when (and (or (not specific) (string= specific "ALLTAGS"))
14074 (setq value (org-get-tags-at)))
14075 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14076 ":"))
14077 props))
14078 (when (or (not specific) (string= specific "BLOCKED"))
14079 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14080 (when (or (not specific)
14081 (member specific
14082 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14083 "TIMESTAMP" "TIMESTAMP_IA")))
14084 (catch 'match
14085 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14086 (setq key (if (match-end 1)
14087 (substring (org-match-string-no-properties 1)
14088 0 -1))
14089 string (if (equal key clockstr)
14090 (org-no-properties
14091 (org-trim
14092 (buffer-substring
14093 (match-beginning 3) (goto-char
14094 (point-at-eol)))))
14095 (substring (org-match-string-no-properties 3)
14096 1 -1)))
14097 ;; Get the correct property name from the key. This is
14098 ;; necessary if the user has configured time keywords.
14099 (setq key1 (concat key ":"))
14100 (cond
14101 ((not key)
14102 (setq key
14103 (if (= (char-after (match-beginning 3)) ?\[)
14104 "TIMESTAMP_IA" "TIMESTAMP")))
14105 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14106 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14107 ((equal key1 org-closed-string) (setq key "CLOSED"))
14108 ((equal key1 org-clock-string) (setq key "CLOCK")))
14109 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14110 (progn
14111 (push (cons key string) props)
14112 ;; no need to search further if match is found
14113 (throw 'match t))
14114 (when (or (equal key "CLOCK") (not (assoc key props)))
14115 (push (cons key string) props))))))
14116 )
14118 (when (memq which '(all standard))
14119 ;; Get the standard properties, like :PROP: ...
14120 (setq range (org-get-property-block beg end))
14121 (when range
14122 (goto-char (car range))
14123 (while (re-search-forward
14125 (cdr range) t)
14126 (setq key (org-match-string-no-properties 1)
14127 value (org-trim (or (org-match-string-no-properties 2) "")))
14128 (unless (member key excluded)
14129 (push (cons key (or value "")) props)))))
14130 (if clocksum
14131 (push (cons "CLOCKSUM"
14132 (org-columns-number-to-string (/ (float clocksum) 60.)
14133 'add_times))
14134 props))
14135 (unless (assoc "CATEGORY" props)
14136 (push (cons "CATEGORY" (org-get-category)) props))
14137 (append sum-props (nreverse props)))))))
14139 (defun org-entry-get (pom property &optional inherit literal-nil)
14140 "Get value of PROPERTY for entry at point-or-marker POM.
14141 If INHERIT is non-nil and the entry does not have the property,
14142 then also check higher levels of the hierarchy.
14143 If INHERIT is the symbol `selective', use inheritance only if the setting
14144 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14145 If the property is present but empty, the return value is the empty string.
14146 If the property is not present at all, nil is returned.
14149 do not interpret it as the list atom nil. This is used for inheritance
14151 (org-with-point-at pom
14152 (if (and inherit (if (eq inherit 'selective)
14153 (org-property-inherit-p property)
14154 t))
14155 (org-entry-get-with-inheritance property literal-nil)
14156 (if (member property org-special-properties)
14157 ;; We need a special property. Use `org-entry-properties' to
14158 ;; retrieve it, but specify the wanted property
14159 (cdr (assoc property (org-entry-properties nil 'special property)))
14160 (let ((range (unless (org-before-first-heading-p)
14161 (org-get-property-block)))
14162 (props (list (or (assoc property org-file-properties)
14163 (assoc property org-global-properties)
14164 (assoc property org-global-properties-fixed))))
14165 val)
14166 (flet ((ap (key)
14167 (when (re-search-forward
14168 (org-re-property key) (cdr range) t)
14169 (setq props
14170 (org-update-property-plist
14171 key
14172 (if (match-end 1)
14173 (org-match-string-no-properties 1) "")
14174 props)))))
14175 (when (and range (goto-char (car range)))
14176 (ap property)
14177 (goto-char (car range))
14178 (while (ap (concat property "+")))
14179 (setq val (cdr (assoc property props)))
14180 (when val (if literal-nil val (org-not-nil val))))))))))
14182 (defun org-property-or-variable-value (var &optional inherit)
14183 "Check if there is a property fixing the value of VAR.
14184 If yes, return this value. If not, return the current value of the variable."
14185 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14187 (read prop)
14188 (symbol-value var))))
14190 (defun org-entry-delete (pom property)
14191 "Delete the property PROPERTY from entry at point-or-marker POM."
14192 (org-with-point-at pom
14193 (if (member property org-special-properties)
14194 nil ; cannot delete these properties.
14195 (let ((range (org-get-property-block)))
14196 (if (and range
14197 (goto-char (car range))
14198 (re-search-forward
14199 (org-re-property property)
14200 (cdr range) t))
14201 (progn
14202 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14203 t)
14204 nil)))))
14206 ;; Multi-values properties are properties that contain multiple values
14207 ;; These values are assumed to be single words, separated by whitespace.
14208 (defun org-entry-add-to-multivalued-property (pom property value)
14209 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14210 (let* ((old (org-entry-get pom property))
14212 (setq value (org-entry-protect-space value))
14213 (unless (member value values)
14214 (setq values (cons value values))
14215 (org-entry-put pom property
14216 (mapconcat 'identity values " ")))))
14218 (defun org-entry-remove-from-multivalued-property (pom property value)
14219 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14220 (let* ((old (org-entry-get pom property))
14222 (setq value (org-entry-protect-space value))
14223 (when (member value values)
14224 (setq values (delete value values))
14225 (org-entry-put pom property
14226 (mapconcat 'identity values " ")))))
14228 (defun org-entry-member-in-multivalued-property (pom property value)
14229 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14230 (let* ((old (org-entry-get pom property))
14232 (setq value (org-entry-protect-space value))
14233 (member value values)))
14235 (defun org-entry-get-multivalued-property (pom property)
14236 "Return a list of values in a multivalued property."
14237 (let* ((value (org-entry-get pom property))
14239 (mapcar 'org-entry-restore-space values)))
14241 (defun org-entry-put-multivalued-property (pom property &rest values)
14242 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14243 VALUES should be a list of strings. Spaces will be protected."
14244 (org-entry-put pom property
14245 (mapconcat 'org-entry-protect-space values " "))
14246 (let* ((value (org-entry-get pom property))
14248 (mapcar 'org-entry-restore-space values)))
14250 (defun org-entry-protect-space (s)
14251 "Protect spaces and newline in string S."
14252 (while (string-match " " s)
14253 (setq s (replace-match "%20" t t s)))
14255 (setq s (replace-match "%0A" t t s)))
14256 s)
14258 (defun org-entry-restore-space (s)
14259 "Restore spaces and newline in string S."
14260 (while (string-match "%20" s)
14261 (setq s (replace-match " " t t s)))
14262 (while (string-match "%0A" s)
14264 s)
14266 (defvar org-entry-property-inherited-from (make-marker)
14267 "Marker pointing to the entry from where a property was inherited.
14268 Each call to `org-entry-get-with-inheritance' will set this marker to the
14269 location of the entry where the inheritance search matched. If there was
14270 no match, the marker will point nowhere.
14271 Note that also `org-entry-get' calls this function, if the INHERIT flag
14272 is set.")
14274 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14275 "Get entry property, and search higher levels if not present.
14276 The search will stop at the first ancestor which has the property defined.
14278 should be considered as undefined (this is the meaning of nil here).
14280 (move-marker org-entry-property-inherited-from nil)
14281 (let (tmp)
14282 (unless (org-before-first-heading-p)
14283 (save-excursion
14284 (save-restriction
14285 (widen)
14286 (catch 'ex
14287 (while t
14288 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14289 (org-back-to-heading t)
14290 (move-marker org-entry-property-inherited-from (point))
14291 (throw 'ex tmp))
14292 (or (org-up-heading-safe) (throw 'ex nil)))))))
14293 (setq tmp (or tmp
14294 (cdr (assoc property org-file-properties))
14295 (cdr (assoc property org-global-properties))
14296 (cdr (assoc property org-global-properties-fixed))))
14297 (if literal-nil tmp (org-not-nil tmp))))
14299 (defvar org-property-changed-functions nil
14300 "Hook called when the value of a property has changed.
14301 Each hook function should accept two arguments, the name of the property
14302 and the new value.")
14304 (defun org-entry-put (pom property value)
14305 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14306 (org-with-point-at pom
14307 (org-back-to-heading t)
14308 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14309 range)
14310 (cond
14311 ((equal property "TODO")
14313 (not (member value org-todo-keywords-1)))
14315 (if (or (not value)
14317 (setq value 'none))
14318 (org-todo value)
14319 (org-set-tags nil 'align))
14320 ((equal property "PRIORITY")
14322 (string-to-char value) ?\ ))
14323 (org-set-tags nil 'align))
14324 ((equal property "SCHEDULED")
14325 (if (re-search-forward org-scheduled-time-regexp end t)
14326 (cond
14327 ((eq value 'earlier) (org-timestamp-change -1 'day))
14328 ((eq value 'later) (org-timestamp-change 1 'day))
14329 (t (call-interactively 'org-schedule)))
14330 (call-interactively 'org-schedule)))
14331 ((equal property "DEADLINE")
14332 (if (re-search-forward org-deadline-time-regexp end t)
14333 (cond
14334 ((eq value 'earlier) (org-timestamp-change -1 'day))
14335 ((eq value 'later) (org-timestamp-change 1 'day))
14336 (t (call-interactively 'org-deadline)))
14337 (call-interactively 'org-deadline)))
14338 ((member property org-special-properties)
14339 (error "The %s property can not yet be set with `org-entry-put'"
14340 property))
14341 (t ; a non-special property
14342 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14343 (setq range (org-get-property-block beg end 'force))
14344 (goto-char (car range))
14345 (if (re-search-forward
14346 (org-re-property property) (cdr range) t)
14347 (progn
14348 (delete-region (match-beginning 0) (match-end 0))
14349 (goto-char (match-beginning 0)))
14350 (goto-char (cdr range))
14352 (backward-char 1)
14353 (org-indent-line-function))
14354 (insert ":" property ":")
14355 (and value (insert " " value))
14356 (org-indent-line-function)))))
14357 (run-hook-with-args 'org-property-changed-functions property value)))
14359 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14360 "Get all property keys in the current buffer.
14361 With INCLUDE-SPECIALS, also list the special properties that reflect things
14362 like tags and TODO state.
14363 With INCLUDE-DEFAULTS, also include properties that has special meaning
14364 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14365 and others.
14366 With INCLUDE-COLUMNS, also include property names given in COLUMN
14367 formats in the current buffer."
14368 (let (rtn range cfmt s p)
14369 (save-excursion
14370 (save-restriction
14371 (widen)
14372 (goto-char (point-min))
14373 (while (re-search-forward org-property-start-re nil t)
14374 (setq range (org-get-property-block))
14375 (goto-char (car range))
14376 (while (re-search-forward
14378 (cdr range) t)
14379 (add-to-list 'rtn (org-match-string-no-properties 1)))
14380 (outline-next-heading))))
14382 (when include-specials
14383 (setq rtn (append org-special-properties rtn)))
14385 (when include-defaults
14386 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14387 (add-to-list 'rtn org-effort-property))
14389 (when include-columns
14390 (save-excursion
14391 (save-restriction
14392 (widen)
14393 (goto-char (point-min))
14394 (while (re-search-forward
14396 nil t)
14397 (setq cfmt (match-string 2) s 0)
14399 cfmt s)
14400 (setq s (match-end 0)
14401 p (match-string 1 cfmt))
14402 (unless (or (equal p "ITEM")
14403 (member p org-special-properties))
14404 (add-to-list 'rtn (match-string 1 cfmt))))))))
14406 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14408 (defun org-property-values (key)
14409 "Return a list of all values of property KEY in the current buffer."
14410 (save-excursion
14411 (save-restriction
14412 (widen)
14413 (goto-char (point-min))
14414 (let ((re (org-re-property key))
14415 values)
14416 (while (re-search-forward re nil t)
14417 (add-to-list 'values (org-trim (match-string 1))))
14418 (delete "" values)))))
14420 (defun org-insert-property-drawer ()
14421 "Insert a property drawer into the current entry."
14422 (interactive)
14423 (org-back-to-heading t)
14424 (looking-at org-outline-regexp)
14425 (let ((indent (if org-adapt-indentation
14426 (- (match-end 0)(match-beginning 0))
14427 0))
14428 (beg (point))
14430 end hiddenp)
14431 (outline-next-heading)
14432 (setq end (point))
14433 (goto-char beg)
14434 (while (re-search-forward re end t))
14435 (setq hiddenp (outline-invisible-p))
14436 (end-of-line 1)
14439 (if (member (match-string 1) '("CLOCK:" ":END:"))
14440 ;; just skip this line
14441 (beginning-of-line 2)
14442 ;; Drawer start, find the end
14444 (beginning-of-line 1)))
14445 (org-skip-over-state-notes)
14447 (if (eq (char-before) ?*) (forward-char 1))
14449 (beginning-of-line 0)
14450 (org-indent-to-column indent)
14451 (beginning-of-line 2)
14452 (org-indent-to-column indent)
14453 (beginning-of-line 0)
14454 (if hiddenp
14455 (save-excursion
14456 (org-back-to-heading t)
14457 (hide-entry))
14458 (org-flag-drawer t))))
14460 (defvar org-property-set-functions-alist nil
14461 "Property set function alist.
14462 Each entry should have the following format:
14464 (PROPERTY . READ-FUNCTION)
14466 The read function will be called with the same argument as
14467 `org-completing-read'.")
14469 (defun org-set-property-function (property)
14470 "Get the function that should be used to set PROPERTY.
14471 This is computed according to `org-property-set-functions-alist'."
14472 (or (cdr (assoc property org-property-set-functions-alist))
14473 'org-completing-read))
14475 (defun org-read-property-value (property)
14476 "Read PROPERTY value from user."
14477 (let* ((completion-ignore-case t)
14478 (allowed (org-property-get-allowed-values nil property 'table))
14479 (cur (org-entry-get nil property))
14480 (prompt (concat property " value"
14482 (concat " [" cur "]") "") ": "))
14483 (set-function (org-set-property-function property))
14484 (val (if allowed
14485 (funcall set-function prompt allowed nil
14486 (not (get-text-property 0 'org-unrestricted
14487 (caar allowed))))
14488 (let (org-completion-use-ido org-completion-use-iswitchb)
14489 (funcall set-function prompt
14490 (mapcar 'list (org-property-values property))
14491 nil nil "" nil cur)))))
14492 (if (equal val "")
14493 cur
14494 val)))
14496 (defvar org-last-set-property nil)
14497 (defun org-read-property-name ()
14498 "Read a property name."
14499 (let* ((completion-ignore-case t)
14500 (keys (org-buffer-property-keys nil t t))
14501 (default-prop (or (save-excursion
14502 (save-match-data
14503 (beginning-of-line)
14505 (null (string= (match-string 1) "END"))
14506 (match-string 1))))
14507 org-last-set-property))
14508 (property (org-icompleting-read
14509 (concat "Property"
14510 (if default-prop (concat " [" default-prop "]") "")
14511 ": ")
14512 (mapcar 'list keys)
14513 nil nil nil nil
14514 default-prop
14515 )))
14516 (if (member property keys)
14517 property
14518 (or (cdr (assoc (downcase property)
14519 (mapcar (lambda (x) (cons (downcase x) x))
14520 keys)))
14521 property))))
14523 (defun org-set-property (property value)
14524 "In the current entry, set PROPERTY to VALUE.
14525 When called interactively, this will prompt for a property name, offering
14526 completion on existing and default properties. And then it will prompt
14527 for a value, offering completion either on allowed values (via an inherited
14528 xxx_ALL property) or on existing values in other instances of this property
14529 in the current file."
14530 (interactive (list nil nil))
14531 (let* ((property (or property (org-read-property-name)))
14532 (value (or value (org-read-property-value property)))
14533 (fn (assoc property org-properties-postprocess-alist)))
14534 (setq org-last-set-property property)
14535 ;; Possibly postprocess the inserted value:
14536 (when fn (setq value (funcall (cadr fn) value)))
14537 (unless (equal (org-entry-get nil property) value)
14538 (org-entry-put nil property value))))
14540 (defun org-delete-property (property)
14541 "In the current entry, delete PROPERTY."
14542 (interactive
14543 (let* ((completion-ignore-case t)
14544 (prop (org-icompleting-read "Property: "
14545 (org-entry-properties nil 'standard))))
14546 (list prop)))
14547 (message "Property %s %s" property
14548 (if (org-entry-delete nil property)
14549 "deleted"
14550 "was not present in the entry")))
14552 (defun org-delete-property-globally (property)
14553 "Remove PROPERTY globally, from all entries."
14554 (interactive
14555 (let* ((completion-ignore-case t)
14556 (prop (org-icompleting-read
14557 "Globally remove property: "
14558 (mapcar 'list (org-buffer-property-keys)))))
14559 (list prop)))
14560 (save-excursion
14561 (save-restriction
14562 (widen)
14563 (goto-char (point-min))
14564 (let ((cnt 0))
14565 (while (re-search-forward
14566 (org-re-property property)
14567 nil t)
14568 (setq cnt (1+ cnt))
14569 (replace-match ""))
14572 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14574 (defun org-compute-property-at-point ()
14575 "Compute the property at point.
14576 This looks for an enclosing column format, extracts the operator and
14577 then applies it to the property in the column format's scope."
14578 (interactive)
14579 (unless (org-at-property-p)
14580 (error "Not at a property"))
14581 (let ((prop (org-match-string-no-properties 2)))
14582 (org-columns-get-format-and-top-level)
14583 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14584 (error "No operator defined for property %s" prop))
14585 (org-columns-compute prop)))
14587 (defvar org-property-allowed-value-functions nil
14588 "Hook for functions supplying allowed values for a specific property.
14589 The functions must take a single argument, the name of the property, and
14591 the values, this means that these values are intended as defaults for
14592 completion, but that other values should be allowed too.
14593 The functions must return nil if they are not responsible for this
14594 property.")
14596 (defun org-property-get-allowed-values (pom property &optional table)
14597 "Get allowed values for the property PROPERTY.
14598 When TABLE is non-nil, return an alist that can directly be used for
14599 completion."
14600 (let (vals)
14601 (cond
14602 ((equal property "TODO")
14603 (setq vals (org-with-point-at pom
14604 (append org-todo-keywords-1 '("")))))
14605 ((equal property "PRIORITY")
14606 (let ((n org-lowest-priority))
14607 (while (>= n org-highest-priority)
14608 (push (char-to-string n) vals)
14609 (setq n (1- n)))))
14610 ((member property org-special-properties))
14611 ((setq vals (run-hook-with-args-until-success
14612 'org-property-allowed-value-functions property)))
14613 (t
14614 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14616 (setq vals (car (read-from-string (concat "(" vals ")"))))
14617 (setq vals (mapcar (lambda (x)
14618 (cond ((stringp x) x)
14619 ((numberp x) (number-to-string x))
14620 ((symbolp x) (symbol-name x))
14621 (t "???")))
14622 vals)))))
14623 (when (member ":ETC" vals)
14624 (setq vals (remove ":ETC" vals))
14625 (org-add-props (car vals) '(org-unrestricted t)))
14626 (if table (mapcar 'list vals) vals)))
14628 (defun org-property-previous-allowed-value (&optional previous)
14629 "Switch to the next allowed value for this property."
14630 (interactive)
14631 (org-property-next-allowed-value t))
14633 (defun org-property-next-allowed-value (&optional previous)
14634 "Switch to the next allowed value for this property."
14635 (interactive)
14636 (unless (org-at-property-p)
14637 (error "Not at a property"))
14638 (let* ((key (match-string 2))
14639 (value (match-string 3))
14640 (allowed (or (org-property-get-allowed-values (point) key)
14641 (and (member value '("[ ]" "[-]" "[X]"))
14642 '("[ ]" "[X]"))))
14643 nval)
14644 (unless allowed
14645 (error "Allowed values for this property have not been defined"))
14646 (if previous (setq allowed (reverse allowed)))
14647 (if (member value allowed)
14648 (setq nval (car (cdr (member value allowed)))))
14649 (setq nval (or nval (car allowed)))
14650 (if (equal nval value)
14651 (error "Only one allowed value for this property"))
14652 (org-at-property-p)
14653 (replace-match (concat " :" key ": " nval) t t)
14654 (org-indent-line-function)
14655 (beginning-of-line 1)
14657 (run-hook-with-args 'org-property-changed-functions key nval)))
14659 (defun org-find-olp (path &optional this-buffer)
14660 "Return a marker pointing to the entry at outline path OLP.
14661 If anything goes wrong, throw an error.
14662 You can wrap this call to catch the error like this:
14664 (condition-case msg
14665 (org-mobile-locate-entry (match-string 4))
14666 (error (nth 1 msg)))
14668 The return value will then be either a string with the error message,
14669 or a marker if everything is OK.
14671 If THIS-BUFFER is set, the outline path does not contain a file,
14672 only headings."
14673 (let* ((file (if this-buffer buffer-file-name (pop path)))
14674 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14675 (level 1)
14676 (lmin 1)
14677 (lmax 1)
14678 limit re end found pos heading cnt flevel)
14679 (unless buffer (error "File not found :%s" file))
14680 (with-current-buffer buffer
14681 (save-excursion
14682 (save-restriction
14683 (widen)
14684 (setq limit (point-max))
14685 (goto-char (point-min))
14686 (while (setq heading (pop path))
14687 (setq re (format org-complex-heading-regexp-format
14688 (regexp-quote heading)))
14689 (setq cnt 0 pos (point))
14690 (while (re-search-forward re end t)
14691 (setq level (- (match-end 1) (match-beginning 1)))
14692 (if (and (>= level lmin) (<= level lmax))
14693 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14694 (when (= cnt 0) (error "Heading not found on level %d: %s"
14695 lmax heading))
14696 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14697 lmax heading))
14698 (goto-char found)
14699 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14700 (setq end (save-excursion (org-end-of-subtree t t))))
14701 (when (org-at-heading-p)
14702 (move-marker (make-marker) (point))))))))
14704 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14705 "Find node HEADING in BUFFER.
14706 Return a marker to the heading if it was found, or nil if not.
14707 If POS-ONLY is set, return just the position instead of a marker.
14709 The heading text must match exact, but it may have a TODO keyword,
14710 a priority cookie and tags in the standard locations."
14711 (with-current-buffer (or buffer (current-buffer))
14712 (save-excursion
14713 (save-restriction
14714 (widen)
14715 (goto-char (point-min))
14716 (let (case-fold-search)
14717 (if (re-search-forward
14718 (format org-complex-heading-regexp-format
14719 (regexp-quote heading)) nil t)
14720 (if pos-only
14721 (match-beginning 0)
14722 (move-marker (make-marker) (match-beginning 0)))))))))
14724 (defun org-find-exact-heading-in-directory (heading &optional dir)
14725 "Find Org node headline HEADING in all .org files in directory DIR.
14726 When the target headline is found, return a marker to this location."
14727 (let ((files (directory-files (or dir default-directory)
14729 file visiting m buffer)
14730 (catch 'found
14731 (while (setq file (pop files))
14732 (message "trying %s" file)
14733 (setq visiting (org-find-base-buffer-visiting file))
14734 (setq buffer (or visiting (find-file-noselect file)))
14735 (setq m (org-find-exact-headline-in-buffer
14736 heading buffer))
14737 (when (and (not m) (not visiting)) (kill-buffer buffer))
14738 (and m (throw 'found m))))))
14740 (defun org-find-entry-with-id (ident)
14741 "Locate the entry that contains the ID property with exact value IDENT.
14742 IDENT can be a string, a symbol or a number, this function will search for
14743 the string representation of it.
14744 Return the position where this entry starts, or nil if there is no such entry."
14745 (interactive "sID: ")
14746 (let ((id (cond
14747 ((stringp ident) ident)
14748 ((symbol-name ident) (symbol-name ident))
14749 ((numberp ident) (number-to-string ident))
14750 (t (error "IDENT %s must be a string, symbol or number" ident))))
14751 (case-fold-search nil))
14752 (save-excursion
14753 (save-restriction
14754 (widen)
14755 (goto-char (point-min))
14756 (when (re-search-forward
14758 nil t)
14759 (org-back-to-heading t)
14760 (point))))))
14762 ;;;; Timestamps
14764 (defvar org-last-changed-timestamp nil)
14765 (defvar org-last-inserted-timestamp nil
14766 "The last time stamp inserted with `org-insert-time-stamp'.")
14767 (defvar org-time-was-given) ; dynamically scoped parameter
14768 (defvar org-end-time-was-given) ; dynamically scoped parameter
14769 (defvar org-ts-what) ; dynamically scoped parameter
14771 (defun org-time-stamp (arg &optional inactive)
14772 "Prompt for a date/time and insert a time stamp.
14773 If the user specifies a time like HH:MM, or if this command is called
14774 with a prefix argument, the time stamp will contain date and time.
14775 Otherwise, only the date will be included. All parts of a date not
14776 specified by the user will be filled in from the current date/time.
14777 So if you press just return without typing anything, the time stamp
14778 will represent the current date/time. If there is already a timestamp
14779 at the cursor, it will be modified."
14780 (interactive "P")
14781 (let* ((ts nil)
14782 (default-time
14783 ;; Default time is either today, or, when entering a range,
14784 ;; the range start.
14785 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14786 (save-excursion
14787 (re-search-backward
14789 (- (point) 20) t)))
14790 (apply 'encode-time (org-parse-time-string (match-string 1)))
14791 (current-time)))
14792 (default-input (and ts (org-get-compact-tod ts)))
14793 (repeater (save-excursion
14794 (save-match-data
14795 (beginning-of-line)
14796 (when (re-search-forward
14798 (save-excursion (progn (end-of-line) (point))) t)
14799 (match-string 0)))))
14800 org-time-was-given org-end-time-was-given time)
14801 (cond
14802 ((and (org-at-timestamp-p t)
14803 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14804 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14805 (insert "--")
14806 (setq time (let ((this-command this-command))
14807 (org-read-date arg 'totime nil nil
14808 default-time default-input)))
14809 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14810 ((org-at-timestamp-p t)
14811 (setq time (let ((this-command this-command))
14812 (org-read-date arg 'totime nil nil default-time default-input)))
14813 (when (org-at-timestamp-p t) ; just to get the match data
14814 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14815 (replace-match "")
14816 (setq org-last-changed-timestamp
14817 (org-insert-time-stamp
14818 time (or org-time-was-given arg)
14819 inactive nil nil (list org-end-time-was-given)))
14820 (when repeater (goto-char (1- (point))) (insert " " repeater)
14821 (setq org-last-changed-timestamp
14822 (concat (substring org-last-inserted-timestamp 0 -1)
14823 " " repeater ">"))))
14824 (message "Timestamp updated"))
14825 (t
14826 (setq time (let ((this-command this-command))
14827 (org-read-date arg 'totime nil nil default-time default-input)))
14828 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14829 nil nil (list org-end-time-was-given))))))
14831 ;; FIXME: can we use this for something else, like computing time differences?
14832 (defun org-get-compact-tod (s)
14833 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14834 (let* ((t1 (match-string 1 s))
14835 (h1 (string-to-number (match-string 2 s)))
14836 (m1 (string-to-number (match-string 3 s)))
14837 (t2 (and (match-end 4) (match-string 5 s)))
14838 (h2 (and t2 (string-to-number (match-string 6 s))))
14839 (m2 (and t2 (string-to-number (match-string 7 s))))
14840 dh dm)
14841 (if (not t2)
14842 t1
14843 (setq dh (- h2 h1) dm (- m2 m1))
14844 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14845 (concat t1 "+" (number-to-string dh)
14846 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14848 (defun org-time-stamp-inactive (&optional arg)
14849 "Insert an inactive time stamp.
14850 An inactive time stamp is enclosed in square brackets instead of angle
14851 brackets. It is inactive in the sense that it does not trigger agenda entries,
14852 does not link to the calendar and cannot be changed with the S-cursor keys.
14853 So these are more for recording a certain time/date."
14854 (interactive "P")
14855 (org-time-stamp arg 'inactive))
14857 (defvar org-date-ovl (make-overlay 1 1))
14858 (overlay-put org-date-ovl 'face 'org-warning)
14859 (org-detach-overlay org-date-ovl)
14861 (defvar org-ans1) ; dynamically scoped parameter
14862 (defvar org-ans2) ; dynamically scoped parameter
14864 (defvar org-plain-time-of-day-regexp) ; defined below
14866 (defvar org-overriding-default-time nil) ; dynamically scoped
14867 (defvar org-read-date-overlay nil)
14868 (defvar org-dcst nil) ; dynamically scoped
14869 (defvar org-read-date-history nil)
14870 (defvar org-read-date-final-answer nil)
14871 (defvar org-read-date-analyze-futurep nil)
14872 (defvar org-read-date-analyze-forced-year nil)
14874 (defun org-read-date (&optional with-time to-time from-string prompt
14875 default-time default-input)
14876 "Read a date, possibly a time, and make things smooth for the user.
14877 The prompt will suggest to enter an ISO date, but you can also enter anything
14878 which will at least partially be understood by `parse-time-string'.
14879 Unrecognized parts of the date will default to the current day, month, year,
14880 hour and minute. If this command is called to replace a timestamp at point,
14881 or to enter the second timestamp of a range, the default time is taken
14882 from the existing stamp. Furthermore, the command prefers the future,
14883 so if you are giving a date where the year is not given, and the day-month
14884 combination is already past in the current year, it will assume you
14885 mean next year. For details, see the manual. A few examples:
14887 3-2-5 --> 2003-02-05
14888 feb 15 --> currentyear-02-15
14889 2/15 --> currentyear-02-15
14890 sep 12 9 --> 2009-09-12
14891 12:45 --> today 12:45
14892 22 sept 0:34 --> currentyear-09-22 0:34
14893 12 --> currentyear-currentmonth-12
14894 Fri --> nearest Friday (today or later)
14895 etc.
14897 Furthermore you can specify a relative date by giving, as the *first* thing
14898 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14899 change in days weeks, months, years.
14900 With a single plus or minus, the date is relative to today. With a double
14901 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14902 +4d --> four days from today
14903 +4 --> same as above
14904 +2w --> two weeks from today
14905 ++5 --> five days from default date
14907 The function understands only English month and weekday abbreviations,
14908 but this can be configured with the variables `parse-time-months' and
14909 `parse-time-weekdays'.
14911 While prompting, a calendar is popped up - you can also select the
14912 date with the mouse (button 1). The calendar shows a period of three
14913 months. To scroll it to other months, use the keys `>' and `<'.
14914 If you don't like the calendar, turn it off with
14915 \(setq org-read-date-popup-calendar nil)
14917 With optional argument TO-TIME, the date will immediately be converted
14918 to an internal time.
14919 With an optional argument WITH-TIME, the prompt will suggest to also
14920 insert a time. Note that when WITH-TIME is not set, you can still
14921 enter a time, and this function will inform the calling routine about
14922 this change. The calling routine may then choose to change the format
14923 used to insert the time stamp into the buffer to include the time.
14924 With optional argument FROM-STRING, read from this string instead from
14925 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14926 the time/date that is used for everything that is not specified by the
14927 user."
14928 (require 'parse-time)
14929 (let* ((org-time-stamp-rounding-minutes
14930 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14931 (org-dcst org-display-custom-times)
14932 (ct (org-current-time))
14933 (def (or org-overriding-default-time default-time ct))
14934 (defdecode (decode-time def))
14935 (dummy (progn
14936 (when (< (nth 2 defdecode) org-extend-today-until)
14937 (setcar (nthcdr 2 defdecode) -1)
14938 (setcar (nthcdr 1 defdecode) 59)
14939 (setq def (apply 'encode-time defdecode)
14940 defdecode (decode-time def)))))
14941 (calendar-frame-setup nil)
14942 (calendar-setup nil)
14943 (calendar-move-hook nil)
14944 (calendar-view-diary-initially-flag nil)
14945 (calendar-view-holidays-initially-flag nil)
14946 (timestr (format-time-string
14947 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14948 (prompt (concat (if prompt (concat prompt " ") "")
14949 (format "Date+time [%s]: " timestr)))
14950 ans (org-ans0 "") org-ans1 org-ans2 final)
14952 (cond
14953 (from-string (setq ans from-string))
14954 (org-read-date-popup-calendar
14955 (save-excursion
14956 (save-window-excursion
14957 (calendar)
14958 (unwind-protect
14959 (progn
14960 (calendar-forward-day (- (time-to-days def)
14961 (calendar-absolute-from-gregorian
14962 (calendar-current-date))))
14963 (org-eval-in-calendar nil t)
14964 (let* ((old-map (current-local-map))
14965 (map (copy-keymap calendar-mode-map))
14966 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14967 (org-defkey map (kbd "RET") 'org-calendar-select)
14968 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14969 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14970 (org-defkey minibuffer-local-map [(meta shift left)]
14971 (lambda () (interactive)
14972 (org-eval-in-calendar '(calendar-backward-month 1))))
14973 (org-defkey minibuffer-local-map [(meta shift right)]
14974 (lambda () (interactive)
14975 (org-eval-in-calendar '(calendar-forward-month 1))))
14976 (org-defkey minibuffer-local-map [(meta shift up)]
14977 (lambda () (interactive)
14978 (org-eval-in-calendar '(calendar-backward-year 1))))
14979 (org-defkey minibuffer-local-map [(meta shift down)]
14980 (lambda () (interactive)
14981 (org-eval-in-calendar '(calendar-forward-year 1))))
14982 (org-defkey minibuffer-local-map [?\e (shift left)]
14983 (lambda () (interactive)
14984 (org-eval-in-calendar '(calendar-backward-month 1))))
14985 (org-defkey minibuffer-local-map [?\e (shift right)]
14986 (lambda () (interactive)
14987 (org-eval-in-calendar '(calendar-forward-month 1))))
14988 (org-defkey minibuffer-local-map [?\e (shift up)]
14989 (lambda () (interactive)
14990 (org-eval-in-calendar '(calendar-backward-year 1))))
14991 (org-defkey minibuffer-local-map [?\e (shift down)]
14992 (lambda () (interactive)
14993 (org-eval-in-calendar '(calendar-forward-year 1))))
14994 (org-defkey minibuffer-local-map [(shift up)]
14995 (lambda () (interactive)
14996 (org-eval-in-calendar '(calendar-backward-week 1))))
14997 (org-defkey minibuffer-local-map [(shift down)]
14998 (lambda () (interactive)
14999 (org-eval-in-calendar '(calendar-forward-week 1))))
15000 (org-defkey minibuffer-local-map [(shift left)]
15001 (lambda () (interactive)
15002 (org-eval-in-calendar '(calendar-backward-day 1))))
15003 (org-defkey minibuffer-local-map [(shift right)]
15004 (lambda () (interactive)
15005 (org-eval-in-calendar '(calendar-forward-day 1))))
15006 (org-defkey minibuffer-local-map ">"
15007 (lambda () (interactive)
15008 (org-eval-in-calendar '(scroll-calendar-left 1))))
15009 (org-defkey minibuffer-local-map "<"
15010 (lambda () (interactive)
15011 (org-eval-in-calendar '(scroll-calendar-right 1))))
15012 (org-defkey minibuffer-local-map "\C-v"
15013 (lambda () (interactive)
15014 (org-eval-in-calendar
15015 '(calendar-scroll-left-three-months 1))))
15016 (org-defkey minibuffer-local-map "\M-v"
15017 (lambda () (interactive)
15018 (org-eval-in-calendar
15019 '(calendar-scroll-right-three-months 1))))
15020 (run-hooks 'org-read-date-minibuffer-setup-hook)
15021 (unwind-protect
15022 (progn
15023 (use-local-map map)
15024 (add-hook 'post-command-hook 'org-read-date-display)
15025 (setq org-ans0 (read-string prompt default-input
15026 'org-read-date-history nil))
15027 ;; org-ans0: from prompt
15028 ;; org-ans1: from mouse click
15029 ;; org-ans2: from calendar motion
15030 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15031 (remove-hook 'post-command-hook 'org-read-date-display)
15032 (use-local-map old-map)
15033 (when org-read-date-overlay
15034 (delete-overlay org-read-date-overlay)
15035 (setq org-read-date-overlay nil)))))
15036 (bury-buffer "*Calendar*")))))
15038 (t ; Naked prompt only
15039 (unwind-protect
15040 (setq ans (read-string prompt default-input
15041 'org-read-date-history timestr))
15042 (when org-read-date-overlay
15043 (delete-overlay org-read-date-overlay)
15044 (setq org-read-date-overlay nil)))))
15046 (setq final (org-read-date-analyze ans def defdecode))
15048 (when org-read-date-analyze-forced-year
15049 (message "Year was forced into %s"
15050 (if org-read-date-force-compatible-dates
15051 "compatible range (1970-2037)"
15052 "range representable on this machine"))
15053 (ding))
15055 ;; One round trip to get rid of 34th of August and stuff like that....
15056 (setq final (decode-time (apply 'encode-time final)))
15058 (setq org-read-date-final-answer ans)
15060 (if to-time
15061 (apply 'encode-time final)
15062 (if (and (boundp 'org-time-was-given) org-time-was-given)
15063 (format "%04d-%02d-%02d %02d:%02d"
15064 (nth 5 final) (nth 4 final) (nth 3 final)
15065 (nth 2 final) (nth 1 final))
15066 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15068 (defvar def)
15069 (defvar defdecode)
15070 (defvar with-time)
15071 (defun org-read-date-display ()
15072 "Display the current date prompt interpretation in the minibuffer."
15073 (when org-read-date-display-live
15074 (when org-read-date-overlay
15075 (delete-overlay org-read-date-overlay))
15076 (let ((p (point)))
15077 (end-of-line 1)
15078 (while (not (equal (buffer-substring
15079 (max (point-min) (- (point) 4)) (point))
15080 " "))
15081 (insert " "))
15082 (goto-char p))
15083 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15084 " " (or org-ans1 org-ans2)))
15085 (org-end-time-was-given nil)
15086 (f (org-read-date-analyze ans def defdecode))
15087 (fmts (if org-dcst
15088 org-time-stamp-custom-formats
15089 org-time-stamp-formats))
15090 (fmt (if (or with-time
15091 (and (boundp 'org-time-was-given) org-time-was-given))
15092 (cdr fmts)
15093 (car fmts)))
15094 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15095 (when (and org-end-time-was-given
15096 (string-match org-plain-time-of-day-regexp txt))
15097 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15098 org-end-time-was-given
15099 (substring txt (match-end 0)))))
15100 (when org-read-date-analyze-futurep
15101 (setq txt (concat txt " (=>F)")))
15102 (setq org-read-date-overlay
15103 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15104 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15106 (defun org-read-date-analyze (ans def defdecode)
15107 "Analyze the combined answer of the date prompt."
15108 ;; FIXME: cleanup and comment
15109 (let ((nowdecode (decode-time (current-time)))
15110 delta deltan deltaw deltadef year month day
15111 hour minute second wday pm h2 m2 tl wday1
15112 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15113 (setq org-read-date-analyze-futurep nil
15114 org-read-date-analyze-forced-year nil)
15116 (setq ans "+0"))
15118 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15119 (setq ans (replace-match "" t t ans)
15120 deltan (car delta)
15121 deltaw (nth 1 delta)
15122 deltadef (nth 2 delta)))
15124 ;; Check if there is an iso week date in there
15125 ;; If yes, store the info and postpone interpreting it until the rest
15126 ;; of the parsing is done
15127 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15128 (setq iso-year (if (match-end 1)
15129 (org-small-year-to-year
15130 (string-to-number (match-string 1 ans))))
15131 iso-weekday (if (match-end 3)
15132 (string-to-number (match-string 3 ans)))
15133 iso-week (string-to-number (match-string 2 ans)))
15134 (setq ans (replace-match "" t t ans)))
15136 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15137 (when (string-match
15139 (setq year (if (match-end 2)
15140 (string-to-number (match-string 2 ans))
15141 (progn (setq kill-year t)
15142 (string-to-number (format-time-string "%Y"))))
15143 month (string-to-number (match-string 3 ans))
15144 day (string-to-number (match-string 4 ans)))
15145 (if (< year 100) (setq year (+ 2000 year)))
15147 t nil ans)))
15149 ;; Help matching dotted european dates
15150 (when (string-match
15151 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15152 (setq year (if (match-end 3)
15153 (string-to-number (match-string 3 ans))
15154 (progn (setq kill-year t)
15155 (string-to-number (format-time-string "%Y"))))
15156 day (string-to-number (match-string 1 ans))
15157 month (string-to-number (match-string 2 ans))
15159 t nil ans)))
15161 ;; Help matching american dates, like 5/30 or 5/30/7
15162 (when (string-match
15163 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15164 (setq year (if (match-end 4)
15165 (string-to-number (match-string 4 ans))
15166 (progn (setq kill-year t)
15167 (string-to-number (format-time-string "%Y"))))
15168 month (string-to-number (match-string 1 ans))
15169 day (string-to-number (match-string 2 ans)))
15170 (if (< year 100) (setq year (+ 2000 year)))
15172 t nil ans)))
15173 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15174 ;; If there is a time with am/pm, and *no* time without it, we convert
15175 ;; so that matching will be successful.
15176 (loop for i from 1 to 2 do ; twice, for end time as well
15179 (setq hour (string-to-number (match-string 1 ans))
15180 minute (if (match-end 3)
15181 (string-to-number (match-string 3 ans))
15182 0)
15183 pm (equal ?p
15184 (string-to-char (downcase (match-string 4 ans)))))
15185 (if (and (= hour 12) (not pm))
15186 (setq hour 0)
15187 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15188 (setq ans (replace-match (format "%02d:%02d" hour minute)
15189 t t ans))))
15191 ;; Check if a time range is given as a duration
15192 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15193 (setq hour (string-to-number (match-string 1 ans))
15194 h2 (+ hour (string-to-number (match-string 3 ans)))
15195 minute (string-to-number (match-string 2 ans))
15196 m2 (+ minute (if (match-end 5) (string-to-number
15197 (match-string 5 ans))0)))
15198 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15199 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15200 t t ans)))
15202 ;; Check if there is a time range
15203 (when (boundp 'org-end-time-was-given)
15204 (setq org-time-was-given nil)
15205 (when (and (string-match org-plain-time-of-day-regexp ans)
15206 (match-end 8))
15207 (setq org-end-time-was-given (match-string 8 ans))
15208 (setq ans (concat (substring ans 0 (match-beginning 7))
15209 (substring ans (match-end 7))))))
15211 (setq tl (parse-time-string ans)
15212 day (or (nth 3 tl) (nth 3 defdecode))
15213 month (or (nth 4 tl)
15214 (if (and org-read-date-prefer-future
15215 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15216 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15217 (nth 4 defdecode)))
15218 year (or (and (not kill-year) (nth 5 tl))
15219 (if (and org-read-date-prefer-future
15220 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15221 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15222 (nth 5 defdecode)))
15223 hour (or (nth 2 tl) (nth 2 defdecode))
15224 minute (or (nth 1 tl) (nth 1 defdecode))
15225 second (or (nth 0 tl) 0)
15226 wday (nth 6 tl))
15228 (when (and (eq org-read-date-prefer-future 'time)
15229 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15230 (equal day (nth 3 nowdecode))
15231 (equal month (nth 4 nowdecode))
15232 (equal year (nth 5 nowdecode))
15233 (nth 2 tl)
15234 (or (< (nth 2 tl) (nth 2 nowdecode))
15235 (and (= (nth 2 tl) (nth 2 nowdecode))
15236 (nth 1 tl)
15237 (< (nth 1 tl) (nth 1 nowdecode)))))
15238 (setq day (1+ day)
15239 futurep t))
15241 ;; Special date definitions below
15242 (cond
15243 (iso-week
15244 ;; There was an iso week
15245 (require 'cal-iso)
15246 (setq futurep nil)
15247 (setq year (or iso-year year)
15248 day (or iso-weekday wday 1)
15249 wday nil ; to make sure that the trigger below does not match
15250 iso-date (calendar-gregorian-from-absolute
15251 (calendar-absolute-from-iso
15252 (list iso-week day year))))
15253 ; FIXME: Should we also push ISO weeks into the future?
15254 ; (when (and org-read-date-prefer-future
15255 ; (not iso-year)
15256 ; (< (calendar-absolute-from-gregorian iso-date)
15257 ; (time-to-days (current-time))))
15258 ; (setq year (1+ year)
15259 ; iso-date (calendar-gregorian-from-absolute
15260 ; (calendar-absolute-from-iso
15261 ; (list iso-week day year)))))
15262 (setq month (car iso-date)
15263 year (nth 2 iso-date)
15264 day (nth 1 iso-date)))
15265 (deltan
15266 (setq futurep nil)
15267 (unless deltadef
15268 (let ((now (decode-time (current-time))))
15269 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15270 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15271 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15272 ((equal deltaw "m") (setq month (+ month deltan)))
15273 ((equal deltaw "y") (setq year (+ year deltan)))))
15274 ((and wday (not (nth 3 tl)))
15275 (setq futurep nil)
15276 ;; Weekday was given, but no day, so pick that day in the week
15277 ;; on or after the derived date.
15278 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15279 (unless (equal wday wday1)
15280 (setq day (+ day (% (- wday wday1 -7) 7))))))
15281 (if (and (boundp 'org-time-was-given)
15282 (nth 2 tl))
15283 (setq org-time-was-given t))
15284 (if (< year 100) (setq year (+ 2000 year)))
15285 ;; Check of the date is representable
15286 (if org-read-date-force-compatible-dates
15287 (progn
15288 (if (< year 1970)
15289 (setq year 1970 org-read-date-analyze-forced-year t))
15290 (if (> year 2037)
15291 (setq year 2037 org-read-date-analyze-forced-year t)))
15292 (condition-case nil
15293 (ignore (encode-time second minute hour day month year))
15294 (error
15295 (setq year (nth 5 defdecode))
15296 (setq org-read-date-analyze-forced-year t))))
15297 (setq org-read-date-analyze-futurep futurep)
15298 (list second minute hour day month year)))
15300 (defvar parse-time-weekdays)
15302 (defun org-read-date-get-relative (s today default)
15303 "Check string S for special relative date string.
15304 TODAY and DEFAULT are internal times, for today and for a default.
15305 Return shift list (N what def-flag)
15307 N is the number of WHATs to shift.
15308 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15309 the DEFAULT date rather than TODAY."
15310 (require 'parse-time)
15311 (when (and
15312 (string-match
15313 (concat
15318 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15319 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15320 (string-to-char (substring (match-string 1 s) -1))
15321 ?+))
15322 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15323 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15324 (what (if (match-end 3) (match-string 3 s) "d"))
15325 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15326 (date (if rel default today))
15327 (wday (nth 6 (decode-time date)))
15328 delta)
15329 (if wday1
15330 (progn
15331 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15332 (if (= dir ?-) (setq delta (- delta 7)))
15333 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15334 (list delta "d" rel))
15335 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15337 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15338 "Turn a user-specified date into the internal representation.
15339 The internal representation needed by the calendar is (month day year).
15340 This is a wrapper to handle the brain-dead convention in calendar that
15341 user function argument order change dependent on argument order."
15342 (if (boundp 'calendar-date-style)
15343 (cond
15344 ((eq calendar-date-style 'american)
15345 (list arg1 arg2 arg3))
15346 ((eq calendar-date-style 'european)
15347 (list arg2 arg1 arg3))
15348 ((eq calendar-date-style 'iso)
15349 (list arg2 arg3 arg1)))
15350 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15351 (if (org-bound-and-true-p european-calendar-style)
15352 (list arg2 arg1 arg3)
15353 (list arg1 arg2 arg3)))))
15355 (defun org-eval-in-calendar (form &optional keepdate)
15356 "Eval FORM in the calendar window and return to current window.
15357 Also, store the cursor date in variable org-ans2."
15358 (let ((sf (selected-frame))
15359 (sw (selected-window)))
15360 (select-window (get-buffer-window "*Calendar*" t))
15361 (eval form)
15362 (when (and (not keepdate) (calendar-cursor-to-date))
15363 (let* ((date (calendar-cursor-to-date))
15364 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15365 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15366 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15367 (select-window sw)
15368 (org-select-frame-set-input-focus sf)))
15370 (defun org-calendar-select ()
15371 "Return to `org-read-date' with the date currently selected.
15372 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15373 (interactive)
15374 (when (calendar-cursor-to-date)
15375 (let* ((date (calendar-cursor-to-date))
15376 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15377 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15378 (if (active-minibuffer-window) (exit-minibuffer))))
15380 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15381 "Insert a date stamp for the date given by the internal TIME.
15382 WITH-HM means use the stamp format that includes the time of the day.
15383 INACTIVE means use square brackets instead of angular ones, so that the
15384 stamp will not contribute to the agenda.
15385 PRE and POST are optional strings to be inserted before and after the
15386 stamp.
15387 The command returns the inserted time stamp."
15388 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15389 stamp)
15390 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15391 (insert-before-markers (or pre ""))
15392 (when (listp extra)
15393 (setq extra (car extra))
15394 (if (and (stringp extra)
15396 (setq extra (format "-%02d:%02d"
15397 (string-to-number (match-string 1 extra))
15398 (string-to-number (match-string 2 extra))))
15399 (setq extra nil)))
15400 (when extra
15401 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15402 (insert-before-markers (setq stamp (format-time-string fmt time)))
15403 (insert-before-markers (or post ""))
15404 (setq org-last-inserted-timestamp stamp)))
15406 (defun org-toggle-time-stamp-overlays ()
15407 "Toggle the use of custom time stamp formats."
15408 (interactive)
15409 (setq org-display-custom-times (not org-display-custom-times))
15410 (unless org-display-custom-times
15411 (let ((p (point-min)) (bmp (buffer-modified-p)))
15412 (while (setq p (next-single-property-change p 'display))
15413 (if (and (get-text-property p 'display)
15414 (eq (get-text-property p 'face) 'org-date))
15415 (remove-text-properties
15416 p (setq p (next-single-property-change p 'display))
15417 '(display t))))
15418 (set-buffer-modified-p bmp)))
15419 (if (featurep 'xemacs)
15420 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15421 (org-restart-font-lock)
15422 (setq org-table-may-need-update t)
15423 (if org-display-custom-times
15424 (message "Time stamps are overlaid with custom format")
15425 (message "Time stamp overlays removed")))
15427 (defun org-display-custom-time (beg end)
15428 "Overlay modified time stamp format over timestamp between BEG and END."
15429 (let* ((ts (buffer-substring beg end))
15430 t1 w1 with-hm tf time str w2 (off 0))
15431 (save-match-data
15432 (setq t1 (org-parse-time-string ts t))
15433 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15434 (setq off (- (match-end 0) (match-beginning 0)))))
15435 (setq end (- end off))
15436 (setq w1 (- end beg)
15437 with-hm (and (nth 1 t1) (nth 2 t1))
15438 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15439 time (org-fix-decoded-time t1)
15440 str (org-add-props
15441 (format-time-string
15442 (substring tf 1 -1) (apply 'encode-time time))
15443 nil 'mouse-face 'highlight)
15444 w2 (length str))
15445 (if (not (= w2 w1))
15446 (add-text-properties (1+ beg) (+ 2 beg)
15447 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15448 (if (featurep 'xemacs)
15449 (progn
15450 (put-text-property beg end 'invisible t)
15451 (put-text-property beg end 'end-glyph (make-glyph str)))
15452 (put-text-property beg end 'display str))))
15454 (defun org-translate-time (string)
15455 "Translate all timestamps in STRING to custom format.
15456 But do this only if the variable `org-display-custom-times' is set."
15457 (when org-display-custom-times
15458 (save-match-data
15459 (let* ((start 0)
15460 (re org-ts-regexp-both)
15461 t1 with-hm inactive tf time str beg end)
15462 (while (setq start (string-match re string start))
15463 (setq beg (match-beginning 0)
15464 end (match-end 0)
15465 t1 (save-match-data
15466 (org-parse-time-string (substring string beg end) t))
15467 with-hm (and (nth 1 t1) (nth 2 t1))
15468 inactive (equal (substring string beg (1+ beg)) "[")
15469 tf (funcall (if with-hm 'cdr 'car)
15470 org-time-stamp-custom-formats)
15471 time (org-fix-decoded-time t1)
15472 str (format-time-string
15473 (concat
15474 (if inactive "[" "<") (substring tf 1 -1)
15475 (if inactive "]" ">"))
15476 (apply 'encode-time time))
15477 string (replace-match str t t string)
15478 start (+ start (length str)))))))
15479 string)
15481 (defun org-fix-decoded-time (time)
15482 "Set 0 instead of nil for the first 6 elements of time.
15483 Don't touch the rest."
15484 (let ((n 0))
15485 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15487 (defun org-days-to-time (timestamp-string)
15488 "Difference between TIMESTAMP-STRING and now in days."
15489 (- (time-to-days (org-time-string-to-time timestamp-string))
15490 (time-to-days (current-time))))
15492 (defun org-deadline-close (timestamp-string &optional ndays)
15493 "Is the time in TIMESTAMP-STRING close to the current date?"
15494 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15495 (and (< (org-days-to-time timestamp-string) ndays)
15496 (not (org-entry-is-done-p))))
15498 (defun org-get-wdays (ts)
15499 "Get the deadline lead time appropriate for timestring TS."
15500 (cond
15501 ((<= org-deadline-warning-days 0)
15502 ;; 0 or negative, enforce this value no matter what
15503 (- org-deadline-warning-days))
15505 ;; lead time is specified.
15506 (floor (* (string-to-number (match-string 1 ts))
15507 (cdr (assoc (match-string 2 ts)
15508 '(("d" . 1) ("w" . 7)
15509 ("m" . 30.4) ("y" . 365.25)))))))
15510 ;; go for the default.
15511 (t org-deadline-warning-days)))
15513 (defun org-calendar-select-mouse (ev)
15514 "Return to `org-read-date' with the date currently selected.
15515 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15516 (interactive "e")
15517 (mouse-set-point ev)
15518 (when (calendar-cursor-to-date)
15519 (let* ((date (calendar-cursor-to-date))
15520 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15521 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15522 (if (active-minibuffer-window) (exit-minibuffer))))
15524 (defun org-check-deadlines (ndays)
15525 "Check if there are any deadlines due or past due.
15526 A deadline is considered due if it happens within `org-deadline-warning-days'
15527 days from today's date. If the deadline appears in an entry marked DONE,
15528 it is not shown. The prefix arg NDAYS can be used to test that many
15530 (interactive "P")
15531 (let* ((org-warn-days
15532 (cond
15533 ((equal ndays '(4)) 100000)
15534 (ndays (prefix-numeric-value ndays))
15535 (t (abs org-deadline-warning-days))))
15536 (case-fold-search nil)
15538 (callback
15539 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15541 (message "%d deadlines past-due or due within %d days"
15542 (org-occur regexp nil callback)
15543 org-warn-days)))
15545 (defun org-check-before-date (date)
15546 "Check if there are deadlines or scheduled entries before DATE."
15547 (interactive (list (org-read-date)))
15548 (let ((case-fold-search nil)
15552 (callback
15553 (lambda () (time-less-p
15554 (org-time-string-to-time (match-string 2))
15555 (org-time-string-to-time date)))))
15556 (message "%d entries before %s"
15557 (org-occur regexp nil callback) date)))
15559 (defun org-check-after-date (date)
15560 "Check if there are deadlines or scheduled entries after DATE."
15561 (interactive (list (org-read-date)))
15562 (let ((case-fold-search nil)
15566 (callback
15567 (lambda () (not
15568 (time-less-p
15569 (org-time-string-to-time (match-string 2))
15570 (org-time-string-to-time date))))))
15571 (message "%d entries after %s"
15572 (org-occur regexp nil callback) date)))
15574 (defun org-check-dates-range (start-date end-date)
15575 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15576 (interactive (list (org-read-date nil nil nil "Range starts")
15577 (org-read-date nil nil nil "Range end")))
15578 (let ((case-fold-search nil)
15582 (callback
15583 (lambda ()
15584 (let ((match (match-string 2)))
15585 (and
15586 (not (time-less-p
15587 (org-time-string-to-time match)
15588 (org-time-string-to-time start-date)))
15589 (time-less-p
15590 (org-time-string-to-time match)
15591 (org-time-string-to-time end-date)))))))
15592 (message "%d entries between %s and %s"
15593 (org-occur regexp nil callback) start-date end-date)))
15595 (defun org-evaluate-time-range (&optional to-buffer)
15596 "Evaluate a time range by computing the difference between start and end.
15597 Normally the result is just printed in the echo area, but with prefix arg
15598 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15599 If the time range is actually in a table, the result is inserted into the
15600 next column.
15601 For time difference computation, a year is assumed to be exactly 365
15602 days in order to avoid rounding problems."
15603 (interactive "P")
15604 (or
15605 (org-clock-update-time-maybe)
15606 (save-excursion
15607 (unless (org-at-date-range-p t)
15608 (goto-char (point-at-bol))
15609 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15610 (if (not (org-at-date-range-p t))
15611 (error "Not at a time-stamp range, and none found in current line")))
15612 (let* ((ts1 (match-string 1))
15613 (ts2 (match-string 2))
15614 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15615 (match-end (match-end 0))
15616 (time1 (org-time-string-to-time ts1))
15617 (time2 (org-time-string-to-time ts2))
15618 (t1 (org-float-time time1))
15619 (t2 (org-float-time time2))
15620 (diff (abs (- t2 t1)))
15621 (negative (< (- t2 t1) 0))
15622 ;; (ys (floor (* 365 24 60 60)))
15623 (ds (* 24 60 60))
15624 (hs (* 60 60))
15625 (fy "%dy %dd %02d:%02d")
15626 (fy1 "%dy %dd")
15627 (fd "%dd %02d:%02d")
15628 (fd1 "%dd")
15629 (fh "%02d:%02d")
15630 y d h m align)
15631 (if havetime
15632 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15633 y 0
15634 d (floor (/ diff ds)) diff (mod diff ds)
15635 h (floor (/ diff hs)) diff (mod diff hs)
15636 m (floor (/ diff 60)))
15637 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15638 y 0
15639 d (floor (+ (/ diff ds) 0.5))
15640 h 0 m 0))
15641 (if (not to-buffer)
15642 (message "%s" (org-make-tdiff-string y d h m))
15643 (if (org-at-table-p)
15644 (progn
15645 (goto-char match-end)
15646 (setq align t)
15647 (and (looking-at " *|") (goto-char (match-end 0))))
15648 (goto-char match-end))
15649 (if (looking-at
15651 (replace-match ""))
15652 (if negative (insert " -"))
15653 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15654 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15655 (insert " " (format fh h m))))
15656 (if align (org-table-align))
15657 (message "Time difference inserted")))))
15659 (defun org-make-tdiff-string (y d h m)
15660 (let ((fmt "")
15661 (l nil))
15662 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15663 l (push y l)))
15664 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15665 l (push d l)))
15666 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15667 l (push h l)))
15668 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15669 l (push m l)))
15670 (apply 'format fmt (nreverse l))))
15672 (defun org-time-string-to-time (s &optional buffer pos)
15673 (condition-case errdata
15674 (apply 'encode-time (org-parse-time-string s))
15676 s (if (not (and buffer pos))
15677 ""
15678 (format " at %d in buffer `%s'" pos buffer))
15679 (cdr errdata)))))
15681 (defun org-time-string-to-seconds (s)
15682 (org-float-time (org-time-string-to-time s)))
15684 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15685 "Convert a time stamp to an absolute day number.
15686 If there is a specifier for a cyclic time stamp, get the closest date to
15687 DAYNR.
15688 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15689 The variable date is bound by the calendar when this is called."
15690 (cond
15692 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15693 daynr
15694 (+ daynr 1000)))
15696 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15697 (time-to-days (current-time))) (match-string 0 s)
15698 prefer show-all))
15699 (t (time-to-days
15700 (condition-case errdata
15701 (apply 'encode-time (org-parse-time-string s))
15703 s (if (not (and buffer pos))
15704 ""
15705 (format " at %d in buffer `%s'" pos buffer))
15706 (cdr errdata))))))))
15708 (defun org-days-to-iso-week (days)
15709 "Return the iso week number."
15710 (require 'cal-iso)
15711 (car (calendar-iso-from-absolute days)))
15713 (defun org-small-year-to-year (year)
15714 "Convert 2-digit years into 4-digit years.
15715 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15716 The year 2000 cannot be abbreviated. Any year larger than 99
15717 is returned unchanged."
15718 (if (< year 38)
15719 (setq year (+ 2000 year))
15720 (if (< year 100)
15721 (setq year (+ 1900 year))))
15722 year)
15724 (defun org-time-from-absolute (d)
15725 "Return the time corresponding to date D.
15726 D may be an absolute day number, or a calendar-type list (month day year)."
15727 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15728 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15730 (defun org-calendar-holiday ()
15731 "List of holidays, for Diary display in Org-mode."
15732 (require 'holidays)
15733 (let ((hl (funcall
15734 (if (fboundp 'calendar-check-holidays)
15735 'calendar-check-holidays 'check-calendar-holidays) date)))
15736 (if hl (mapconcat 'identity hl "; "))))
15738 (defun org-diary-sexp-entry (sexp entry date)
15739 "Process a SEXP diary ENTRY for DATE."
15740 (require 'diary-lib)
15741 (let ((result (if calendar-debug-sexp
15742 (let ((stack-trace-on-error t))
15743 (eval (car (read-from-string sexp))))
15744 (condition-case nil
15745 (eval (car (read-from-string sexp)))
15746 (error
15747 (beep)
15748 (message "Bad sexp at line %d in %s: %s"
15749 (org-current-line)
15750 (buffer-file-name) sexp)
15751 (sleep-for 2))))))
15752 (cond ((stringp result) (split-string result "; "))
15753 ((and (consp result)
15754 (not (consp (cdr result)))
15755 (stringp (cdr result))) (cdr result))
15756 ((and (consp result)
15757 (stringp (car result))) result)
15758 (result entry)
15759 (t nil))))
15761 (defun org-diary-to-ical-string (frombuf)
15762 "Get iCalendar entries from diary entries in buffer FROMBUF.
15763 This uses the icalendar.el library."
15764 (let* ((tmpdir (if (featurep 'xemacs)
15765 (temp-directory)
15766 temporary-file-directory))
15767 (tmpfile (make-temp-name
15768 (expand-file-name "orgics" tmpdir)))
15769 buf rtn b e)
15770 (with-current-buffer frombuf
15771 (icalendar-export-region (point-min) (point-max) tmpfile)
15772 (setq buf (find-buffer-visiting tmpfile))
15773 (set-buffer buf)
15774 (goto-char (point-min))
15775 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15776 (setq b (match-beginning 0)))
15777 (goto-char (point-max))
15778 (if (re-search-backward "^END:VEVENT" nil t)
15779 (setq e (match-end 0)))
15781 (kill-buffer buf)
15782 (delete-file tmpfile)
15783 rtn))
15785 (defun org-closest-date (start current change prefer show-all)
15786 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15787 When PREFER is `past', return a date that is either CURRENT or past.
15788 When PREFER is `future', return a date that is either CURRENT or future.
15789 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15790 ;; Make the proper lists from the dates
15791 (catch 'exit
15792 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15793 dn dw sday cday n1 n2 n0
15794 d m y y1 y2 date1 date2 nmonths nm ny m2)
15796 (setq start (org-date-to-gregorian start)
15797 current (org-date-to-gregorian
15798 (if show-all
15799 current
15800 (time-to-days (current-time))))
15801 sday (calendar-absolute-from-gregorian start)
15802 cday (calendar-absolute-from-gregorian current))
15804 (if (<= cday sday) (throw 'exit sday))
15807 (setq dn (string-to-number (match-string 1 change))
15808 dw (cdr (assoc (match-string 2 change) a1)))
15809 (error "Invalid change specifier: %s" change))
15810 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15811 (cond
15812 ((eq dw 'day)
15813 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15814 n2 (+ n1 dn)))
15815 ((eq dw 'year)
15816 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15817 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15818 (setq date1 (list m d y1)
15819 n1 (calendar-absolute-from-gregorian date1)
15820 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15821 n2 (calendar-absolute-from-gregorian date2)))
15822 ((eq dw 'month)
15823 ;; approx number of month between the two dates
15824 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15825 ;; How often does dn fit in there?
15826 (setq d (nth 1 start) m (car start) y (nth 2 start)
15827 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15828 m (+ m nm)
15829 ny (floor (/ m 12))
15830 y (+ y ny)
15831 m (- m (* ny 12)))
15832 (while (> m 12) (setq m (- m 12) y (1+ y)))
15833 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15834 (setq m2 (+ m dn) y2 y)
15835 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15836 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15837 (while (<= n2 cday)
15838 (setq n1 n2 m m2 y y2)
15839 (setq m2 (+ m dn) y2 y)
15840 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15841 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15842 ;; Make sure n1 is the earlier date
15843 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15844 (if show-all
15845 (cond
15846 ((eq prefer 'past) (if (= cday n2) n2 n1))
15847 ((eq prefer 'future) (if (= cday n1) n1 n2))
15848 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15849 (cond
15850 ((eq prefer 'past) (if (= cday n2) n2 n1))
15851 ((eq prefer 'future) (if (= cday n1) n1 n2))
15852 (t (if (= cday n1) n1 n2)))))))
15854 (defun org-date-to-gregorian (date)
15855 "Turn any specification of DATE into a Gregorian date for the calendar."
15856 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15857 ((and (listp date) (= (length date) 3)) date)
15858 ((stringp date)
15859 (setq date (org-parse-time-string date))
15860 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15861 ((listp date)
15862 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15864 (defun org-parse-time-string (s &optional nodefault)
15865 "Parse the standard Org-mode time string.
15866 This should be a lot faster than the normal `parse-time-string'.
15867 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15868 hour and minute fields will be nil if not given."
15869 (if (string-match org-ts-regexp0 s)
15870 (list 0
15871 (if (or (match-beginning 8) (not nodefault))
15872 (string-to-number (or (match-string 8 s) "0")))
15873 (if (or (match-beginning 7) (not nodefault))
15874 (string-to-number (or (match-string 7 s) "0")))
15875 (string-to-number (match-string 4 s))
15876 (string-to-number (match-string 3 s))
15877 (string-to-number (match-string 2 s))
15878 nil nil nil)
15879 (error "Not a standard Org-mode time string: %s" s)))
15881 (defun org-timestamp-up (&optional arg)
15882 "Increase the date item at the cursor by one.
15883 If the cursor is on the year, change the year. If it is on the month,
15884 the day or the time, change that.
15885 With prefix ARG, change by that many units."
15886 (interactive "p")
15887 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15889 (defun org-timestamp-down (&optional arg)
15890 "Decrease the date item at the cursor by one.
15891 If the cursor is on the year, change the year. If it is on the month,
15892 the day or the time, change that.
15893 With prefix ARG, change by that many units."
15894 (interactive "p")
15895 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15897 (defun org-timestamp-up-day (&optional arg)
15898 "Increase the date in the time stamp by one day.
15899 With prefix ARG, change that many days."
15900 (interactive "p")
15901 (if (and (not (org-at-timestamp-p t))
15902 (org-at-heading-p))
15903 (org-todo 'up)
15904 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15906 (defun org-timestamp-down-day (&optional arg)
15907 "Decrease the date in the time stamp by one day.
15908 With prefix ARG, change that many days."
15909 (interactive "p")
15910 (if (and (not (org-at-timestamp-p t))
15911 (org-at-heading-p))
15912 (org-todo 'down)
15913 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15915 (defun org-at-timestamp-p (&optional inactive-ok)
15916 "Determine if the cursor is in or at a timestamp."
15917 (interactive)
15918 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15919 (pos (point))
15920 (ans (or (looking-at tsr)
15921 (save-excursion
15923 (if (> (point) (point-min)) (backward-char 1))
15924 (and (looking-at tsr)
15925 (> (- (match-end 0) pos) -1))))))
15926 (and ans
15927 (boundp 'org-ts-what)
15928 (setq org-ts-what
15929 (cond
15930 ((= pos (match-beginning 0)) 'bracket)
15931 ;; Point is considered to be "on the bracket" whether
15932 ;; it's really on it or right after it.
15933 ((or (= pos (1- (match-end 0)))
15934 (= pos (match-end 0))) 'bracket)
15935 ((org-pos-in-match-range pos 2) 'year)
15936 ((org-pos-in-match-range pos 3) 'month)
15937 ((org-pos-in-match-range pos 7) 'hour)
15938 ((org-pos-in-match-range pos 8) 'minute)
15939 ((or (org-pos-in-match-range pos 4)
15940 (org-pos-in-match-range pos 5)) 'day)
15941 ((and (> pos (or (match-end 8) (match-end 5)))
15942 (< pos (match-end 0)))
15943 (- pos (or (match-end 8) (match-end 5))))
15944 (t 'day))))
15945 ans))
15947 (defun org-toggle-timestamp-type ()
15948 "Toggle the type (<active> or [inactive]) of a time stamp."
15949 (interactive)
15950 (when (org-at-timestamp-p t)
15951 (let ((beg (match-beginning 0)) (end (match-end 0))
15952 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15953 (save-excursion
15954 (goto-char beg)
15955 (while (re-search-forward "[][<>]" end t)
15956 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15957 t t)))
15958 (message "Timestamp is now %sactive"
15959 (if (equal (char-after beg) ?<) "" "in")))))
15961 (defun org-timestamp-change (n &optional what updown)
15962 "Change the date in the time stamp at point.
15963 The date will be changed by N times WHAT. WHAT can be `day', `month',
15964 `year', `minute', `second'. If WHAT is not given, the cursor position
15965 in the timestamp determines what will be changed."
15966 (let ((origin (point)) origin-cat
15967 with-hm inactive
15968 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15969 org-ts-what
15970 extra rem
15971 ts time time0)
15972 (if (not (org-at-timestamp-p t))
15973 (error "Not at a timestamp"))
15974 (if (and (not what) (eq org-ts-what 'bracket))
15975 (org-toggle-timestamp-type)
15976 ;; Point isn't on brackets. Remember the part of the time-stamp
15977 ;; the point was in. Indeed, size of time-stamps may change,
15978 ;; but point must be kept in the same category nonetheless.
15979 (setq origin-cat org-ts-what)
15980 (if (and (not what) (not (eq org-ts-what 'day))
15981 org-display-custom-times
15982 (get-text-property (point) 'display)
15983 (not (get-text-property (1- (point)) 'display)))
15984 (setq org-ts-what 'day))
15985 (setq org-ts-what (or what org-ts-what)
15986 inactive (= (char-after (match-beginning 0)) ?\[)
15987 ts (match-string 0))
15988 (replace-match "")
15989 (if (string-match
15991 ts)
15992 (setq extra (match-string 1 ts)))
15994 (setq with-hm t))
15995 (setq time0 (org-parse-time-string ts))
15996 (when (and updown
15997 (eq org-ts-what 'minute)
15998 (not current-prefix-arg))
15999 ;; This looks like s-up and s-down. Change by one rounding step.
16000 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16001 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16002 (setcar (cdr time0) (+ (nth 1 time0)
16003 (if (> n 0) (- rem) (- dm rem))))))
16004 (setq time
16005 (encode-time (or (car time0) 0)
16006 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16007 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16008 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16009 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16010 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16011 (nthcdr 6 time0)))
16012 (when (and (member org-ts-what '(hour minute))
16013 extra
16015 (setq extra (org-modify-ts-extra
16016 extra
16017 (if (eq org-ts-what 'hour) 2 5)
16018 n dm)))
16019 (when (integerp org-ts-what)
16020 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16021 (if (eq what 'calendar)
16022 (let ((cal-date (org-get-date-from-calendar)))
16023 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16024 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16025 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16026 (setcar time0 (or (car time0) 0))
16027 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16028 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16029 (setq time (apply 'encode-time time0))))
16030 ;; Insert the new time-stamp, and ensure point stays in the same
16031 ;; category as before (i.e. not after the last position in that
16032 ;; category).
16033 (let ((pos (point)))
16034 ;; Stay before inserted string. `save-excursion' is of no use.
16035 (setq org-last-changed-timestamp
16036 (org-insert-time-stamp time with-hm inactive nil nil extra))
16037 (goto-char pos))
16038 (save-match-data
16039 (looking-at org-ts-regexp3)
16040 (goto-char (cond
16041 ;; `day' category ends before `hour' if any, or at
16042 ;; the end of the day name.
16043 ((eq origin-cat 'day)
16044 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16045 ((eq origin-cat 'hour) (min (match-end 7) origin))
16046 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16047 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16048 ;; `year' and `month' have both fixed size: point
16049 ;; couldn't have moved into another part.
16050 (t origin))))
16051 ;; Update clock if on a CLOCK line.
16052 (org-clock-update-time-maybe)
16053 ;; Try to recenter the calendar window, if any.
16054 (if (and org-calendar-follow-timestamp-change
16055 (get-buffer-window "*Calendar*" t)
16056 (memq org-ts-what '(day month year)))
16057 (org-recenter-calendar (time-to-days time))))))
16059 (defun org-modify-ts-extra (s pos n dm)
16060 "Change the different parts of the lead-time and repeat fields in timestamp."
16061 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16062 ng h m new rem)
16063 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16064 (cond
16065 ((or (org-pos-in-match-range pos 2)
16066 (org-pos-in-match-range pos 3))
16067 (setq m (string-to-number (match-string 3 s))
16068 h (string-to-number (match-string 2 s)))
16069 (if (org-pos-in-match-range pos 2)
16070 (setq h (+ h n))
16071 (setq n (* dm (org-no-warnings (signum n))))
16072 (when (not (= 0 (setq rem (% m dm))))
16073 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16074 (setq m (+ m n)))
16075 (if (< m 0) (setq m (+ m 60) h (1- h)))
16076 (if (> m 59) (setq m (- m 60) h (1+ h)))
16077 (setq h (min 24 (max 0 h)))
16078 (setq ng 1 new (format "-%02d:%02d" h m)))
16079 ((org-pos-in-match-range pos 6)
16080 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16081 ((org-pos-in-match-range pos 5)
16082 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16084 ((org-pos-in-match-range pos 9)
16085 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16086 ((org-pos-in-match-range pos 8)
16087 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16089 (when ng
16090 (setq s (concat
16091 (substring s 0 (match-beginning ng))
16092 new
16093 (substring s (match-end ng))))))
16094 s))
16096 (defun org-recenter-calendar (date)
16097 "If the calendar is visible, recenter it to DATE."
16098 (let ((cwin (get-buffer-window "*Calendar*" t)))
16099 (when cwin
16100 (let ((calendar-move-hook nil))
16101 (with-selected-window cwin
16102 (calendar-goto-date (if (listp date) date
16103 (calendar-gregorian-from-absolute date))))))))
16105 (defun org-goto-calendar (&optional arg)
16106 "Go to the Emacs calendar at the current date.
16107 If there is a time stamp in the current line, go to that date.
16108 A prefix ARG can be used to force the current date."
16109 (interactive "P")
16110 (let ((tsr org-ts-regexp) diff
16111 (calendar-move-hook nil)
16112 (calendar-view-holidays-initially-flag nil)
16113 (calendar-view-diary-initially-flag nil))
16114 (if (or (org-at-timestamp-p)
16115 (save-excursion
16116 (beginning-of-line 1)
16117 (looking-at (concat ".*" tsr))))
16118 (let ((d1 (time-to-days (current-time)))
16119 (d2 (time-to-days
16120 (org-time-string-to-time (match-string 1)))))
16121 (setq diff (- d2 d1))))
16122 (calendar)
16123 (calendar-goto-today)
16124 (if (and diff (not arg)) (calendar-forward-day diff))))
16126 (defun org-get-date-from-calendar ()
16127 "Return a list (month day year) of date at point in calendar."
16128 (with-current-buffer "*Calendar*"
16129 (save-match-data
16130 (calendar-cursor-to-date))))
16132 (defun org-date-from-calendar ()
16133 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16134 If there is already a time stamp at the cursor position, update it."
16135 (interactive)
16136 (if (org-at-timestamp-p t)
16137 (org-timestamp-change 0 'calendar)
16138 (let ((cal-date (org-get-date-from-calendar)))
16139 (org-insert-time-stamp
16140 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16142 (defun org-minutes-to-hh:mm-string (m)
16143 "Compute H:MM from a number of minutes."
16144 (let ((h (/ m 60)))
16145 (setq m (- m (* 60 h)))
16146 (format org-time-clocksum-format h m)))
16148 (defun org-hh:mm-string-to-minutes (s)
16149 "Convert a string H:MM to a number of minutes.
16150 If the string is just a number, interpret it as minutes.
16151 In fact, the first hh:mm or number in the string will be taken,
16152 there can be extra stuff in the string.
16153 If no number is found, the return value is 0."
16154 (cond
16155 ((integerp s) s)
16157 (+ (* (string-to-number (match-string 1 s)) 60)
16158 (string-to-number (match-string 2 s))))
16160 (string-to-number (match-string 1 s)))
16161 (t 0)))
16163 (defcustom org-effort-durations
16164 `(("h" . 60)
16165 ("d" . ,(* 60 8))
16166 ("w" . ,(* 60 8 5))
16167 ("m" . ,(* 60 8 5 4))
16168 ("y" . ,(* 60 8 5 40)))
16169 "Conversion factor to minutes for an effort modifier.
16171 Each entry has the form (MODIFIER . MINUTES).
16173 In an effort string, a number followed by MODIFIER is multiplied
16174 by the specified number of MINUTES to obtain an effort in
16175 minutes.
16179 :group 'org-agenda
16180 :type '(alist :key-type (string :tag "Modifier")
16181 :value-type (number :tag "Minutes")))
16183 (defun org-duration-string-to-minutes (s)
16184 "Convert a duration string S to minutes.
16186 A bare number is interpreted as minutes, modifiers can be set by
16187 customizing `org-effort-durations' (which see).
16189 Entries containing a colon are interpreted as H:MM by
16190 `org-hh:mm-string-to-minutes'."
16191 (let ((result 0)
16193 (regexp-opt (mapcar 'car org-effort-durations))
16195 (while (string-match re s)
16196 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16197 (string-to-number (match-string 1 s))))
16198 (setq s (replace-match "" nil t s)))
16199 (incf result (org-hh:mm-string-to-minutes s))
16200 result))
16202 ;;;; Files
16204 (defun org-save-all-org-buffers ()
16205 "Save all Org-mode buffers without user confirmation."
16206 (interactive)
16207 (message "Saving all Org-mode buffers...")
16208 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16209 (when (featurep 'org-id) (org-id-locations-save))
16210 (message "Saving all Org-mode buffers... done"))
16212 (defun org-revert-all-org-buffers ()
16213 "Revert all Org-mode buffers.
16214 Prompt for confirmation when there are unsaved changes.
16215 Be sure you know what you are doing before letting this function
16216 overwrite your changes.
16218 This function is useful in a setup where one tracks org files
16219 with a version control system, to revert on one machine after pulling
16220 changes from another. I believe the procedure must be like this:
16222 1. M-x org-save-all-org-buffers
16223 2. Pull changes from the other machine, resolve conflicts
16224 3. M-x org-revert-all-org-buffers"
16225 (interactive)
16226 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16227 (error "Abort"))
16228 (save-excursion
16229 (save-window-excursion
16230 (mapc
16231 (lambda (b)
16232 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16233 (with-current-buffer b buffer-file-name))
16234 (org-pop-to-buffer-same-window b)
16235 (revert-buffer t 'no-confirm)))
16236 (buffer-list))
16237 (when (and (featurep 'org-id) org-id-track-globally)
16238 (org-id-locations-load)))))
16240 ;;;; Agenda files
16242 ;;;###autoload
16243 (defun org-switchb (&optional arg)
16244 "Switch between Org buffers.
16245 With one prefix argument, restrict available buffers to files.
16246 With two prefix arguments, restrict available buffers to agenda files.
16248 Defaults to `iswitchb' for buffer name completion.
16249 Set `org-completion-use-ido' to make it use ido instead."
16250 (interactive "P")
16251 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16252 ((equal arg '(16)) (org-buffer-list 'agenda))
16253 (t (org-buffer-list))))
16254 (org-completion-use-iswitchb org-completion-use-iswitchb)
16255 (org-completion-use-ido org-completion-use-ido))
16256 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16257 (setq org-completion-use-iswitchb t))
16258 (org-pop-to-buffer-same-window
16259 (org-icompleting-read "Org buffer: "
16260 (mapcar 'list (mapcar 'buffer-name blist))
16261 nil t))))
16263 ;;; Define some older names previously used for this functionality
16264 ;;;###autoload
16265 (defalias 'org-ido-switchb 'org-switchb)
16266 ;;;###autoload
16267 (defalias 'org-iswitchb 'org-switchb)
16269 (defun org-buffer-list (&optional predicate exclude-tmp)
16270 "Return a list of Org buffers.
16271 PREDICATE can be `export', `files' or `agenda'.
16273 export restrict the list to Export buffers.
16274 files restrict the list to buffers visiting Org files.
16275 agenda restrict the list to buffers visiting agenda files.
16277 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16278 (let* ((bfn nil)
16279 (agenda-files (and (eq predicate 'agenda)
16280 (mapcar 'file-truename (org-agenda-files t))))
16281 (filter
16282 (cond
16283 ((eq predicate 'files)
16284 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16285 ((eq predicate 'export)
16286 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16287 ((eq predicate 'agenda)
16288 (lambda (b)
16289 (with-current-buffer b
16290 (and (eq major-mode 'org-mode)
16291 (setq bfn (buffer-file-name b))
16292 (member (file-truename bfn) agenda-files)))))
16293 (t (lambda (b) (with-current-buffer b
16294 (or (eq major-mode 'org-mode)
16295 (string-match "\*Org .*Export"
16296 (buffer-name b)))))))))
16297 (delq nil
16298 (mapcar
16299 (lambda(b)
16300 (if (and (funcall filter b)
16301 (or (not exclude-tmp)
16302 (not (string-match "tmp" (buffer-name b)))))
16303 b
16304 nil))
16305 (buffer-list)))))
16307 (defun org-agenda-files (&optional unrestricted archives)
16308 "Get the list of agenda files.
16309 Optional UNRESTRICTED means return the full list even if a restriction
16310 is currently in place.
16311 When ARCHIVES is t, include all archive files that are really being
16312 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16313 `org-agenda-archives-mode' is t."
16314 (let ((files
16315 (cond
16316 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16317 ((stringp org-agenda-files) (org-read-agenda-file-list))
16318 ((listp org-agenda-files) org-agenda-files)
16319 (t (error "Invalid value of `org-agenda-files'")))))
16320 (setq files (apply 'append
16321 (mapcar (lambda (f)
16322 (if (file-directory-p f)
16323 (directory-files
16324 f t org-agenda-file-regexp)
16325 (list f)))
16326 files)))
16327 (when org-agenda-skip-unavailable-files
16328 (setq files (delq nil
16329 (mapcar (function
16330 (lambda (file)
16331 (and (file-readable-p file) file)))
16332 files))))
16333 (when (or (eq archives t)
16334 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16335 (setq files (org-add-archive-files files)))
16336 files))
16338 (defun org-agenda-file-p (&optional file)
16339 "Return non-nil, if FILE is an agenda file.
16340 If FILE is omitted, use the file associated with the current
16341 buffer."
16342 (member (or file (buffer-file-name))
16343 (org-agenda-files t)))
16345 (defun org-edit-agenda-file-list ()
16346 "Edit the list of agenda files.
16347 Depending on setup, this either uses customize to edit the variable
16348 `org-agenda-files', or it visits the file that is holding the list. In the
16349 latter case, the buffer is set up in a way that saving it automatically kills
16350 the buffer and restores the previous window configuration."
16351 (interactive)
16352 (if (stringp org-agenda-files)
16353 (let ((cw (current-window-configuration)))
16354 (find-file org-agenda-files)
16355 (org-set-local 'org-window-configuration cw)
16356 (org-add-hook 'after-save-hook
16357 (lambda ()
16358 (set-window-configuration
16359 (prog1 org-window-configuration
16360 (kill-buffer (current-buffer))))
16361 (org-install-agenda-files-menu)
16362 (message "New agenda file list installed"))
16363 nil 'local)
16364 (message "%s" (substitute-command-keys
16366 (customize-variable 'org-agenda-files)))
16368 (defun org-store-new-agenda-file-list (list)
16369 "Set new value for the agenda file list and save it correctly."
16370 (if (stringp org-agenda-files)
16371 (let ((fe (org-read-agenda-file-list t)) b u)
16372 (while (setq b (find-buffer-visiting org-agenda-files))
16373 (kill-buffer b))
16374 (with-temp-file org-agenda-files
16375 (insert
16376 (mapconcat
16377 (lambda (f) ;; Keep un-expanded entries.
16378 (if (setq u (assoc f fe))
16379 (cdr u)
16380 f))
16383 (let ((org-mode-hook nil) (org-inhibit-startup t)
16384 (org-insert-mode-line-in-empty-file nil))
16385 (setq org-agenda-files list)
16386 (customize-save-variable 'org-agenda-files org-agenda-files))))
16388 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16389 "Read the list of agenda files from a file.
16390 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16391 filenames, used by `org-store-new-agenda-file-list' to write back
16392 un-expanded file names."
16393 (when (file-directory-p org-agenda-files)
16394 (error "`org-agenda-files' cannot be a single directory"))
16395 (when (stringp org-agenda-files)
16396 (with-temp-buffer
16397 (insert-file-contents org-agenda-files)
16398 (mapcar
16399 (lambda (f)
16400 (let ((e (expand-file-name (substitute-in-file-name f)
16401 org-directory)))
16402 (if pair-with-expansion
16403 (cons e f)
16404 e)))
16407 ;;;###autoload
16408 (defun org-cycle-agenda-files ()
16409 "Cycle through the files in `org-agenda-files'.
16410 If the current buffer visits an agenda file, find the next one in the list.
16411 If the current buffer does not, find the first agenda file."
16412 (interactive)
16413 (let* ((fs (org-agenda-files t))
16414 (files (append fs (list (car fs))))
16415 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16416 file)
16417 (unless files (error "No agenda files"))
16418 (catch 'exit
16419 (while (setq file (pop files))
16420 (if (equal (file-truename file) tcf)
16421 (when (car files)
16422 (find-file (car files))
16423 (throw 'exit t))))
16424 (find-file (car fs)))
16425 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16427 (defun org-agenda-file-to-front (&optional to-end)
16428 "Move/add the current file to the top of the agenda file list.
16429 If the file is not present in the list, it is added to the front. If it is
16430 present, it is moved there. With optional argument TO-END, add/move to the
16431 end of the list."
16432 (interactive "P")
16433 (let ((org-agenda-skip-unavailable-files nil)
16434 (file-alist (mapcar (lambda (x)
16435 (cons (file-truename x) x))
16436 (org-agenda-files t)))
16437 (ctf (file-truename buffer-file-name))
16438 x had)
16439 (setq x (assoc ctf file-alist) had x)
16441 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16442 (if to-end
16443 (setq file-alist (append (delq x file-alist) (list x)))
16444 (setq file-alist (cons x (delq x file-alist))))
16445 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16446 (org-install-agenda-files-menu)
16447 (message "File %s to %s of agenda file list"
16448 (if had "moved" "added") (if to-end "end" "front"))))
16450 (defun org-remove-file (&optional file)
16451 "Remove current file from the list of files in variable `org-agenda-files'.
16452 These are the files which are being checked for agenda entries.
16453 Optional argument FILE means use this file instead of the current."
16454 (interactive)
16455 (let* ((org-agenda-skip-unavailable-files nil)
16456 (file (or file buffer-file-name))
16457 (true-file (file-truename file))
16458 (afile (abbreviate-file-name file))
16459 (files (delq nil (mapcar
16460 (lambda (x)
16461 (if (equal true-file
16462 (file-truename x))
16463 nil x))
16464 (org-agenda-files t)))))
16465 (if (not (= (length files) (length (org-agenda-files t))))
16466 (progn
16467 (org-store-new-agenda-file-list files)
16468 (org-install-agenda-files-menu)
16469 (message "Removed file: %s" afile))
16470 (message "File was not in list: %s (not removed)" afile))))
16472 (defun org-file-menu-entry (file)
16473 (vector file (list 'find-file file) t))
16475 (defun org-check-agenda-file (file)
16476 "Make sure FILE exists. If not, ask user what to do."
16477 (when (not (file-exists-p file))
16478 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16479 (abbreviate-file-name file))
16480 (let ((r (downcase (read-char-exclusive))))
16481 (cond
16482 ((equal r ?r)
16483 (org-remove-file file)
16484 (throw 'nextfile t))
16485 (t (error "Abort"))))))
16487 (defun org-get-agenda-file-buffer (file)
16488 "Get a buffer visiting FILE. If the buffer needs to be created, add
16489 it to the list of buffers which might be released later."
16490 (let ((buf (org-find-base-buffer-visiting file)))
16491 (if buf
16492 buf ; just return it
16493 ;; Make a new buffer and remember it
16494 (setq buf (find-file-noselect file))
16495 (if buf (push buf org-agenda-new-buffers))
16496 buf)))
16498 (defun org-release-buffers (blist)
16499 "Release all buffers in list, asking the user for confirmation when needed.
16500 When a buffer is unmodified, it is just killed. When modified, it is saved
16501 \(if the user agrees) and then killed."
16502 (let (buf file)
16503 (while (setq buf (pop blist))
16504 (setq file (buffer-file-name buf))
16505 (when (and (buffer-modified-p buf)
16506 file
16507 (y-or-n-p (format "Save file %s? " file)))
16508 (with-current-buffer buf (save-buffer)))
16509 (kill-buffer buf))))
16511 (defun org-prepare-agenda-buffers (files)
16512 "Create buffers for all agenda files, protect archived trees and comments."
16513 (interactive)
16514 (let ((pa '(:org-archived t))
16515 (pc '(:org-comment t))
16516 (pall '(:org-archived t :org-comment t))
16517 (inhibit-read-only t)
16518 (rea (concat ":" org-archive-tag ":"))
16519 bmp file re)
16520 (save-excursion
16521 (save-restriction
16522 (while (setq file (pop files))
16523 (catch 'nextfile
16524 (if (bufferp file)
16525 (set-buffer file)
16526 (org-check-agenda-file file)
16527 (set-buffer (org-get-agenda-file-buffer file)))
16528 (widen)
16529 (setq bmp (buffer-modified-p))
16530 (org-refresh-category-properties)
16531 (setq org-todo-keywords-for-agenda
16532 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16533 (setq org-done-keywords-for-agenda
16534 (append org-done-keywords-for-agenda org-done-keywords))
16535 (setq org-todo-keyword-alist-for-agenda
16536 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16537 (setq org-drawers-for-agenda
16538 (append org-drawers-for-agenda org-drawers))
16539 (setq org-tag-alist-for-agenda
16540 (append org-tag-alist-for-agenda org-tag-alist))
16542 (save-excursion
16543 (remove-text-properties (point-min) (point-max) pall)
16544 (when org-agenda-skip-archived-trees
16545 (goto-char (point-min))
16546 (while (re-search-forward rea nil t)
16547 (if (org-at-heading-p t)
16548 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16549 (goto-char (point-min))
16550 (setq re (format org-heading-keyword-regexp-format
16551 org-comment-string))
16552 (while (re-search-forward re nil t)
16553 (add-text-properties
16554 (match-beginning 0) (org-end-of-subtree t) pc)))
16555 (set-buffer-modified-p bmp)))))
16556 (setq org-todo-keywords-for-agenda
16557 (org-uniquify org-todo-keywords-for-agenda))
16558 (setq org-todo-keyword-alist-for-agenda
16559 (org-uniquify org-todo-keyword-alist-for-agenda)
16560 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16562 ;;;; Embedded LaTeX
16564 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16565 "Keymap for the minor `org-cdlatex-mode'.")
16567 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16568 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16569 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16570 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16571 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16573 (defvar org-cdlatex-texmathp-advice-is-done nil
16574 "Flag remembering if we have applied the advice to texmathp already.")
16576 (define-minor-mode org-cdlatex-mode
16577 "Toggle the minor `org-cdlatex-mode'.
16578 This mode supports entering LaTeX environment and math in LaTeX fragments
16579 in Org-mode.
16581 nil " OCDL" nil
16582 (when org-cdlatex-mode
16583 (require 'cdlatex)
16584 (run-hooks 'cdlatex-mode-hook)
16585 (cdlatex-compute-tables))
16586 (unless org-cdlatex-texmathp-advice-is-done
16587 (setq org-cdlatex-texmathp-advice-is-done t)
16588 (defadvice texmathp (around org-math-always-on activate)
16589 "Always return t in org-mode buffers.
16590 This is because we want to insert math symbols without dollars even outside
16591 the LaTeX math segments. If Orgmode thinks that point is actually inside
16592 an embedded LaTeX fragment, let texmathp do its job.
16594 (interactive)
16595 (let (p)
16596 (cond
16597 ((not (eq major-mode 'org-mode)) ad-do-it)
16598 ((eq this-command 'cdlatex-math-symbol)
16599 (setq ad-return-value t
16600 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16601 (t
16602 (let ((p (org-inside-LaTeX-fragment-p)))
16603 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16604 (setq ad-return-value t
16605 texmathp-why '("Org-mode embedded math" . 0))
16606 (if p ad-do-it)))))))))
16608 (defun turn-on-org-cdlatex ()
16609 "Unconditionally turn on `org-cdlatex-mode'."
16610 (org-cdlatex-mode 1))
16612 (defun org-inside-LaTeX-fragment-p ()
16613 "Test if point is inside a LaTeX fragment.
16615 sequence appearing also before point.
16616 Even though the matchers for math are configurable, this function assumes
16618 delimiters are skipped when they have been removed by customization.
16619 The return value is nil, or a cons cell with the delimiter and the
16620 position of this delimiter.
16622 This function does a reasonably good job, but can locally be fooled by
16623 for example currency specifications. For example it will assume being in
16625 fragments that are properly closed, but during editing, we have to live
16626 with the uncertainty caused by missing closing delimiters. This function
16627 looks only before point, not after."
16628 (catch 'exit
16629 (let ((pos (point))
16630 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16631 (lim (progn
16633 (point)))
16634 dd-on str (start 0) m re)
16635 (goto-char pos)
16636 (when dodollar
16638 re (nth 1 (assoc "$" org-latex-regexps)))
16639 (while (string-match re str start)
16640 (cond
16641 ((= (match-end 0) (length str))
16642 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16643 ((= (match-end 0) (- (length str) 5))
16644 (throw 'exit nil))
16645 (t (setq start (match-end 0))))))
16646 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16647 (goto-char pos)
16648 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16649 (and (match-beginning 2) (throw 'exit nil))
16650 ;; count $$
16652 (setq dd-on (not dd-on)))
16653 (goto-char pos)
16654 (if dd-on (cons "$$" m))))))
16656 (defun org-inside-latex-macro-p ()
16657 "Is point inside a LaTeX macro or its arguments?"
16658 (save-match-data
16659 (org-in-regexp
16662 (defun org-try-cdlatex-tab ()
16663 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16664 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16665 - inside a LaTeX fragment, or
16666 - after the first word in a line, where an abbreviation expansion could
16667 insert a LaTeX environment."
16668 (when org-cdlatex-mode
16669 (cond
16670 ;; Before any word on the line: No expansion possible.
16672 ;; Just after first word on the line: Expand it. Make sure it
16673 ;; cannot happen on headlines, though.
16674 ((save-excursion
16675 (skip-chars-backward "a-zA-Z0-9*")
16677 (and (bolp) (not (org-at-heading-p))))
16678 (cdlatex-tab) t)
16679 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16681 (defun org-cdlatex-underscore-caret (&optional arg)
16682 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16683 Revert to the normal definition outside of these fragments."
16684 (interactive "P")
16685 (if (org-inside-LaTeX-fragment-p)
16686 (call-interactively 'cdlatex-sub-superscript)
16687 (let (org-cdlatex-mode)
16688 (call-interactively (key-binding (vector last-input-event))))))
16690 (defun org-cdlatex-math-modify (&optional arg)
16691 "Execute `cdlatex-math-modify' in LaTeX fragments.
16692 Revert to the normal definition outside of these fragments."
16693 (interactive "P")
16694 (if (org-inside-LaTeX-fragment-p)
16695 (call-interactively 'cdlatex-math-modify)
16696 (let (org-cdlatex-mode)
16697 (call-interactively (key-binding (vector last-input-event))))))
16699 (defvar org-latex-fragment-image-overlays nil
16700 "List of overlays carrying the images of latex fragments.")
16701 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16703 (defun org-remove-latex-fragment-image-overlays ()
16704 "Remove all overlays with LaTeX fragment images in current buffer."
16705 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16706 (setq org-latex-fragment-image-overlays nil))
16708 (defun org-preview-latex-fragment (&optional subtree)
16709 "Preview the LaTeX fragment at point, or all locally or globally.
16710 If the cursor is in a LaTeX fragment, create the image and overlay
16711 it over the source code. If there is no fragment at point, display
16712 all fragments in the current text, from one headline to the next. With
16713 prefix SUBTREE, display all fragments in the current subtree. With a
16715 the cursor is before the first headline,
16716 display all fragments in the buffer.
16718 (interactive "P")
16719 (unless buffer-file-name
16720 (error "Can't preview LaTeX fragment in a non-file buffer"))
16721 (org-remove-latex-fragment-image-overlays)
16722 (save-excursion
16723 (save-restriction
16724 (let (beg end at msg)
16725 (cond
16726 ((or (equal subtree '(16))
16727 (not (save-excursion
16728 (re-search-backward org-outline-regexp-bol nil t))))
16729 (setq beg (point-min) end (point-max)
16730 msg "Creating images for buffer...%s"))
16731 ((equal subtree '(4))
16732 (org-back-to-heading)
16733 (setq beg (point) end (org-end-of-subtree t)
16734 msg "Creating images for subtree...%s"))
16735 (t
16736 (if (setq at (org-inside-LaTeX-fragment-p))
16737 (goto-char (max (point-min) (- (cdr at) 2)))
16738 (org-back-to-heading))
16739 (setq beg (point) end (progn (outline-next-heading) (point))
16740 msg (if at "Creating image...%s"
16741 "Creating images for entry...%s"))))
16742 (message msg "")
16743 (narrow-to-region beg end)
16744 (goto-char beg)
16745 (org-format-latex
16746 (concat "ltxpng/" (file-name-sans-extension
16747 (file-name-nondirectory
16748 buffer-file-name)))
16749 default-directory 'overlays msg at 'forbuffer 'dvipng)
16750 (message msg "done. Use `C-c C-c' to remove images.")))))
16752 (defvar org-latex-regexps
16754 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16757 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16761 "Regular expressions for matching embedded LaTeX.")
16763 (defvar org-export-have-math nil) ;; dynamic scoping
16764 (defun org-format-latex (prefix &optional dir overlays msg at
16765 forbuffer processing-type)
16766 "Replace LaTeX fragments with links to an image, and produce images.
16767 Some of the options can be changed using the variable
16768 `org-format-latex-options'."
16769 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16770 (let* ((prefixnodir (file-name-nondirectory prefix))
16771 (absprefix (expand-file-name prefix dir))
16772 (todir (file-name-directory absprefix))
16773 (opt org-format-latex-options)
16774 (matchers (plist-get opt :matchers))
16775 (re-list org-latex-regexps)
16776 (org-format-latex-header-extra
16777 (plist-get (org-infile-export-plist) :latex-header-extra))
16778 (cnt 0) txt hash link beg end re e checkdir
16779 executables-checked string
16780 m n block-type block linkfile movefile ov)
16781 ;; Check the different regular expressions
16782 (while (setq e (pop re-list))
16783 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16785 (when (member m matchers)
16786 (goto-char (point-min))
16787 (while (re-search-forward re nil t)
16788 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16789 (not (get-text-property (match-beginning n)
16790 'org-protected))
16791 (or (not overlays)
16792 (not (eq (get-char-property (match-beginning n)
16793 'org-overlay-type)
16794 'org-latex-overlay))))
16795 (setq org-export-have-math t)
16796 (cond
16797 ((eq processing-type 'verbatim)
16798 ;; Leave the text verbatim, just protect it
16799 (add-text-properties (match-beginning n) (match-end n)
16800 '(org-protected t)))
16801 ((eq processing-type 'mathjax)
16802 ;; Prepare for MathJax processing
16803 (setq string (match-string n))
16804 (if (member m '("$" "$1"))
16805 (save-excursion
16806 (delete-region (match-beginning n) (match-end n))
16807 (goto-char (match-beginning n))
16810 '(org-protected t))))
16811 (add-text-properties (match-beginning n) (match-end n)
16812 '(org-protected t))))
16813 ((eq processing-type 'dvipng)
16814 ;; Process to an image
16815 (setq txt (match-string n)
16816 beg (match-beginning n) end (match-end n)
16817 cnt (1+ cnt))
16818 (let (print-length print-level) ; make sure full list is printed
16819 (setq hash (sha1 (prin1-to-string
16820 (list org-format-latex-header
16821 org-format-latex-header-extra
16822 org-export-latex-default-packages-alist
16823 org-export-latex-packages-alist
16824 org-format-latex-options
16825 forbuffer txt)))
16826 linkfile (format "%s_%s.png" prefix hash)
16827 movefile (format "%s_%s.png" absprefix hash)))
16828 (setq link (concat block "[[file:" linkfile "]]" block))
16829 (if msg (message msg cnt))
16830 (goto-char beg)
16831 (unless checkdir ; make sure the directory exists
16832 (setq checkdir t)
16833 (or (file-directory-p todir) (make-directory todir t)))
16835 (unless executables-checked
16836 (org-check-external-command
16837 "latex" "needed to convert LaTeX fragments to images")
16838 (org-check-external-command
16839 "dvipng" "needed to convert LaTeX fragments to images")
16840 (setq executables-checked t))
16842 (unless (file-exists-p movefile)
16843 (org-create-formula-image
16844 txt movefile opt forbuffer))
16845 (if overlays
16846 (progn
16847 (mapc (lambda (o)
16848 (if (eq (overlay-get o 'org-overlay-type)
16849 'org-latex-overlay)
16850 (delete-overlay o)))
16851 (overlays-in beg end))
16852 (setq ov (make-overlay beg end))
16853 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16854 (if (featurep 'xemacs)
16855 (progn
16856 (overlay-put ov 'invisible t)
16857 (overlay-put
16858 ov 'end-glyph
16859 (make-glyph (vector 'png :file movefile))))
16860 (overlay-put
16861 ov 'display
16862 (list 'image :type 'png :file movefile :ascent 'center)))
16863 (push ov org-latex-fragment-image-overlays)
16864 (goto-char end))
16865 (delete-region beg end)
16866 (insert (org-add-props link
16867 (list 'org-latex-src
16868 (replace-regexp-in-string
16870 'org-latex-src-embed-type
16871 (if block-type 'paragraph 'character))))))
16872 ((eq processing-type 'mathml)
16873 ;; Process to MathML
16874 (unless executables-checked
16875 (unless (save-match-data (org-format-latex-mathml-available-p))
16876 (error "LaTeX to MathML converter not configured"))
16877 (setq executables-checked t))
16878 (setq txt (match-string n)
16879 beg (match-beginning n) end (match-end n)
16880 cnt (1+ cnt))
16881 (if msg (message msg cnt))
16882 (goto-char beg)
16883 (delete-region beg end)
16884 (insert (org-format-latex-as-mathml
16885 txt block-type prefix dir)))
16886 (t
16887 (error "Unknown conversion type %s for latex fragments"
16888 processing-type)))))))))
16890 (defun org-create-math-formula (latex-frag &optional mathml-file)
16891 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16892 Use `org-latex-to-mathml-convert-command'. If the conversion is
16894 elements otherwise return nil. When MATHML-FILE is specified,
16895 write the results in to that file. When invoked as an
16896 interactive command, prompt for LATEX-FRAG, with initial value
16897 set to the current active region and echo the results for user
16898 inspection."
16899 (interactive (list (let ((frag (when (region-active-p)
16900 (buffer-substring-no-properties
16901 (region-beginning) (region-end)))))
16902 (read-string "LaTeX Fragment: " frag nil frag))))
16903 (unless latex-frag (error "Invalid latex-frag"))
16904 (let* ((tmp-in-file (file-relative-name
16905 (make-temp-name (expand-file-name "ltxmathml-in"))))
16906 (ignore (write-region latex-frag nil tmp-in-file))
16907 (tmp-out-file (file-relative-name
16908 (make-temp-name (expand-file-name "ltxmathml-out"))))
16909 (cmd (format-spec
16910 org-latex-to-mathml-convert-command
16911 `((?j . ,(shell-quote-argument
16912 (expand-file-name org-latex-to-mathml-jar-file)))
16913 (?I . ,(shell-quote-argument tmp-in-file))
16914 (?o . ,(shell-quote-argument tmp-out-file)))))
16915 mathml shell-command-output)
16916 (when (org-called-interactively-p 'any)
16917 (unless (org-format-latex-mathml-available-p)
16918 (error "LaTeX to MathML converter not configured")))
16919 (message "Running %s" cmd)
16920 (setq shell-command-output (shell-command-to-string cmd))
16921 (setq mathml
16922 (when (file-readable-p tmp-out-file)
16923 (with-current-buffer (find-file-noselect tmp-out-file t)
16924 (goto-char (point-min))
16925 (when (re-search-forward
16926 (concat
16927 (regexp-quote
16930 (regexp-quote "</math>")) nil t)
16931 (prog1 (match-string 0) (kill-buffer))))))
16932 (cond
16933 (mathml
16934 (setq mathml
16936 (when mathml-file
16937 (write-region mathml nil mathml-file))
16938 (when (org-called-interactively-p 'any)
16939 (message mathml)))
16940 ((message "LaTeX to MathML conversion failed")
16941 (message shell-command-output)))
16942 (delete-file tmp-in-file)
16943 (when (file-exists-p tmp-out-file)
16944 (delete-file tmp-out-file))
16945 mathml))
16947 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16948 prefix &optional dir)
16949 "Use `org-create-math-formula' but check local cache first."
16950 (let* ((absprefix (expand-file-name prefix dir))
16951 (print-length nil) (print-level nil)
16952 (formula-id (concat
16953 "formula-"
16954 (sha1
16955 (prin1-to-string
16956 (list latex-frag
16957 org-latex-to-mathml-convert-command)))))
16958 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16959 (formula-cache-dir (file-name-directory formula-cache)))
16961 (unless (file-directory-p formula-cache-dir)
16962 (make-directory formula-cache-dir t))
16964 (unless (file-exists-p formula-cache)
16965 (org-create-math-formula latex-frag formula-cache))
16967 (if (file-exists-p formula-cache)
16968 ;; Successful conversion. Return the link to MathML file.
16969 (org-add-props
16970 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16972 'org-latex-src-embed-type (if latex-frag-type
16973 'paragraph 'character)))
16974 ;; Failed conversion. Return the LaTeX fragment verbatim
16975 (add-text-properties
16976 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16977 latex-frag)))
16979 ;; This function borrows from Ganesh Swami's latex2png.el
16980 (defun org-create-formula-image (string tofile options buffer)
16981 "This calls dvipng."
16982 (require 'org-latex)
16983 (let* ((tmpdir (if (featurep 'xemacs)
16984 (temp-directory)
16985 temporary-file-directory))
16986 (texfilebase (make-temp-name
16987 (expand-file-name "orgtex" tmpdir)))
16988 (texfile (concat texfilebase ".tex"))
16989 (dvifile (concat texfilebase ".dvi"))
16990 (pngfile (concat texfilebase ".png"))
16991 (fnh (if (featurep 'xemacs)
16992 (font-height (face-font 'default))
16993 (face-attribute 'default :height nil)))
16994 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16995 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16996 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16997 "Black"))
16998 (bg (or (plist-get options (if buffer :background :html-background))
16999 "Transparent")))
17000 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17001 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17002 (with-temp-file texfile
17003 (insert (org-splice-latex-header
17004 org-format-latex-header
17005 org-export-latex-default-packages-alist
17006 org-export-latex-packages-alist t
17007 org-format-latex-header-extra))
17009 (require 'org-latex)
17010 (org-export-latex-fix-inputenc))
17011 (let ((dir default-directory))
17012 (condition-case nil
17013 (progn
17014 (cd tmpdir)
17015 (call-process "latex" nil nil nil texfile))
17016 (error nil))
17017 (cd dir))
17018 (if (not (file-exists-p dvifile))
17019 (progn (message "Failed to create dvi file from %s" texfile) nil)
17020 (condition-case nil
17021 (if (featurep 'xemacs)
17022 (call-process "dvipng" nil nil nil
17023 "-fg" fg "-bg" bg
17024 "-T" "tight"
17025 "-o" pngfile
17026 dvifile)
17027 (call-process "dvipng" nil nil nil
17028 "-fg" fg "-bg" bg
17029 "-D" dpi
17030 ;;"-x" scale "-y" scale
17031 "-T" "tight"
17032 "-o" pngfile
17033 dvifile))
17034 (error nil))
17035 (if (not (file-exists-p pngfile))
17036 (if org-format-latex-signal-error
17037 (error "Failed to create png file from %s" texfile)
17038 (message "Failed to create png file from %s" texfile)
17039 nil)
17040 ;; Use the requested file name and clean up
17041 (copy-file pngfile tofile 'replace)
17042 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17043 (delete-file (concat texfilebase e)))
17044 pngfile))))
17046 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17047 "Fill a LaTeX header template TPL.
17048 In the template, the following place holders will be recognized:
17051 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17053 [NO-PACKAGES] do not include PKG
17054 [EXTRA] the string EXTRA
17055 [NO-EXTRA] do not include EXTRA
17057 For backward compatibility, if both the positive and the negative place
17059 assumed to be present at the end of the template.
17060 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17061 EXTRA is a string.
17062 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17063 (let (rpl (end ""))
17065 (setq rpl (if (or (match-end 1) (not def-pkg))
17066 "" (org-latex-packages-to-string def-pkg snippets-p t))
17067 tpl (replace-match rpl t t tpl))
17068 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17071 (setq rpl (if (or (match-end 1) (not pkg))
17072 "" (org-latex-packages-to-string pkg snippets-p t))
17073 tpl (replace-match rpl t t tpl))
17074 (if pkg (setq end
17076 (org-latex-packages-to-string pkg snippets-p)))))
17079 (setq rpl (if (or (match-end 1) (not extra))
17081 tpl (replace-match rpl t t tpl))
17087 tpl)))
17089 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17091 (setq pkg (mapconcat (lambda(p)
17092 (cond
17093 ((stringp p) p)
17094 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17095 (format "%% Package %s omitted" (cadr p)))
17096 ((equal "" (car p))
17098 (t
17100 (car p) (cadr p)))))
17101 pkg
17105 (defun org-dvipng-color (attr)
17106 "Return an rgb color specification for dvipng."
17107 (apply 'format "rgb %s %s %s"
17108 (mapcar 'org-normalize-color
17109 (if (featurep 'xemacs)
17110 (color-rgb-components
17111 (face-property 'default
17112 (cond ((eq attr :foreground) 'foreground)
17113 ((eq attr :background) 'background))))
17114 (color-values (face-attribute 'default attr nil))))))
17116 (defun org-normalize-color (value)
17117 "Return string to be used as color value for an RGB component."
17118 (format "%g" (/ value 65535.0)))
17120 ;; Image display
17123 (defvar org-inline-image-overlays nil)
17124 (make-variable-buffer-local 'org-inline-image-overlays)
17126 (defun org-toggle-inline-images (&optional include-linked)
17127 "Toggle the display of inline images.
17128 INCLUDE-LINKED is passed to `org-display-inline-images'."
17129 (interactive "P")
17130 (if org-inline-image-overlays
17131 (progn
17132 (org-remove-inline-images)
17133 (message "Inline image display turned off"))
17134 (org-display-inline-images include-linked)
17135 (if org-inline-image-overlays
17136 (message "%d images displayed inline"
17137 (length org-inline-image-overlays))
17138 (message "No images to display inline"))))
17140 (defun org-display-inline-images (&optional include-linked refresh beg end)
17141 "Display inline images.
17142 Normally only links without a description part are inlined, because this
17143 is how it will work for export. When INCLUDE-LINKED is set, also links
17144 with a description part will be inlined. This can be nice for a quick
17145 look at those images, but it does not reflect what exported files will look
17146 like.
17147 When REFRESH is set, refresh existing images between BEG and END.
17148 This will create new image displays only if necessary.
17149 BEG and END default to the buffer boundaries."
17150 (interactive "P")
17151 (unless refresh
17152 (org-remove-inline-images)
17153 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17154 (save-excursion
17155 (save-restriction
17156 (widen)
17157 (setq beg (or beg (point-min)) end (or end (point-max)))
17158 (goto-char (point-min))
17160 (substring (org-image-file-name-regexp) 0 -2)
17162 old file ov img)
17163 (while (re-search-forward re end t)
17164 (setq old (get-char-property-and-overlay (match-beginning 1)
17165 'org-image-overlay))
17166 (setq file (expand-file-name
17167 (concat (or (match-string 3) "") (match-string 4))))
17168 (when (file-exists-p file)
17169 (if (and (car-safe old) refresh)
17170 (image-refresh (overlay-get (cdr old) 'display))
17171 (setq img (save-match-data (create-image file)))
17172 (when img
17173 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17174 (overlay-put ov 'display img)
17175 (overlay-put ov 'face 'default)
17176 (overlay-put ov 'org-image-overlay t)
17177 (overlay-put ov 'modification-hooks
17178 (list 'org-display-inline-modification-hook))
17179 (push ov org-inline-image-overlays)))))))))
17181 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17182 "Remove inline-display overlay if a corresponding region is modified."
17183 (let ((inhibit-modification-hooks t))
17184 (when (and ov after)
17185 (delete ov org-inline-image-overlays)
17186 (delete-overlay ov))))
17188 (defun org-remove-inline-images ()
17189 "Remove inline display of images."
17190 (interactive)
17191 (mapc 'delete-overlay org-inline-image-overlays)
17192 (setq org-inline-image-overlays nil))
17194 ;;;; Key bindings
17196 ;; Outline functions from `outline-mode-prefix-map'
17197 ;; that can be remapped in Org:
17198 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17199 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17200 (define-key org-mode-map [remap outline-forward-same-level]
17201 'org-forward-same-level)
17202 (define-key org-mode-map [remap outline-backward-same-level]
17203 'org-backward-same-level)
17204 (define-key org-mode-map [remap show-branches]
17205 'org-kill-note-or-show-branches)
17206 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17207 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17208 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17210 ;; Outline functions from `outline-mode-prefix-map'
17211 ;; that can not be remapped in Org:
17212 ;; - the column "key binding" shows whether the Outline function is still
17213 ;; available in Org mode on the same key that it has been bound to in
17214 ;; Outline mode:
17215 ;; - "overridden": key used for a different functionality in Org mode
17216 ;; - else: key still bound to the same Outline function in Org mode
17217 ;; | Outline function | key binding | Org replacement |
17218 ;; |------------------------------------+-------------+-----------------------|
17219 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17220 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17221 ;; | `show-children' | `C-c C-i' | visibility cycling |
17222 ;; | `hide-subtree' | overridden | visibility cycling |
17223 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17224 ;; | `hide-body' | overridden | no replacement |
17225 ;; | `show-all' | overridden | no replacement |
17226 ;; | `hide-entry' | overridden | visibility cycling |
17227 ;; | `show-entry' | overridden | no replacement |
17228 ;; | `hide-leaves' | overridden | no replacement |
17229 ;; | `hide-sublevels' | overridden | no replacement |
17230 ;; | `hide-other' | overridden | no replacement |
17231 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17232 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17234 ;; Make `C-c C-x' a prefix key
17235 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17237 ;; TAB key with modifiers
17238 (org-defkey org-mode-map "\C-i" 'org-cycle)
17239 (org-defkey org-mode-map [(tab)] 'org-cycle)
17240 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17241 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17243 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17244 ;; The following line is necessary under Suse GNU/Linux
17245 (unless (featurep 'xemacs)
17246 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17247 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17248 (define-key org-mode-map [backtab] 'org-shifttab)
17250 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17251 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17252 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17254 ;; Cursor keys with modifiers
17255 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17256 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17257 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17258 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17260 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17261 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17262 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17263 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17265 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17266 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17267 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17268 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17270 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17271 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17272 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17273 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17275 ;; Babel keys
17276 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17277 (mapc (lambda (pair)
17278 (define-key org-babel-map (car pair) (cdr pair)))
17279 org-babel-key-bindings)
17281 ;;; Extra keys for tty access.
17282 ;; We only set them when really needed because otherwise the
17283 ;; menus don't show the simple keys
17285 (when (or org-use-extra-keys
17286 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17287 (not window-system))
17288 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17289 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17290 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17291 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17292 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17293 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17294 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17295 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17296 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17297 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17298 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17299 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17300 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17301 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17302 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17303 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17304 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17305 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17306 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17307 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17308 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17309 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17310 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17311 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17312 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17313 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17314 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17315 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17317 ;; All the other keys
17319 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17320 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17321 (if (boundp 'narrow-map)
17322 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17323 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17324 (if (boundp 'narrow-map)
17325 (org-defkey narrow-map "b" 'org-narrow-to-block)
17326 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17327 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17328 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17329 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17330 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17331 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17332 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17333 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17334 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17335 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17336 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17337 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17338 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17339 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17340 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17341 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17342 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17344 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17345 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17346 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17347 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17348 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17349 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17350 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17351 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17352 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17353 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17354 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17355 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17356 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17357 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17358 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17359 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17360 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17361 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17362 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17363 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17365 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17366 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17367 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17368 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17369 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17370 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17371 (org-defkey org-mode-map "\C-c^" 'org-sort)
17372 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17373 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17374 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17375 (org-defkey org-mode-map "\C-m" 'org-return)
17376 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17377 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17378 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17379 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17380 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17381 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17382 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17383 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17384 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17385 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17386 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17387 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17388 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17389 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17390 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17391 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17392 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17393 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17394 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17395 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17396 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17397 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17399 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17400 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17401 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17402 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17404 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17405 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17406 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17407 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17408 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17409 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17410 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17411 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17412 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17413 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17415 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17416 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17417 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17418 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17419 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17420 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17421 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17423 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17424 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17425 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17426 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17427 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17429 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17431 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17433 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17434 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17436 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17439 (when (featurep 'xemacs)
17440 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17443 (defconst org-speed-commands-default
17444 '(
17445 ("Outline Navigation")
17446 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17447 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17448 ("f" . (org-speed-move-safe 'org-forward-same-level))
17449 ("b" . (org-speed-move-safe 'org-backward-same-level))
17450 ("u" . (org-speed-move-safe 'outline-up-heading))
17451 ("j" . org-goto)
17452 ("g" . (org-refile t))
17453 ("Outline Visibility")
17454 ("c" . org-cycle)
17455 ("C" . org-shifttab)
17456 (" " . org-display-outline-path)
17457 ("Outline Structure Editing")
17458 ("U" . org-shiftmetaup)
17459 ("D" . org-shiftmetadown)
17460 ("r" . org-metaright)
17461 ("l" . org-metaleft)
17462 ("R" . org-shiftmetaright)
17463 ("L" . org-shiftmetaleft)
17464 ("i" . (progn (forward-char 1) (call-interactively
17465 'org-insert-heading-respect-content)))
17466 ("^" . org-sort)
17467 ("w" . org-refile)
17468 ("a" . org-archive-subtree-default-with-confirmation)
17469 ("." . org-mark-subtree)
17470 ("Clock Commands")
17471 ("I" . org-clock-in)
17472 ("O" . org-clock-out)
17473 ("Meta Data Editing")
17474 ("t" . org-todo)
17475 ("0" . (org-priority ?\ ))
17476 ("1" . (org-priority ?A))
17477 ("2" . (org-priority ?B))
17478 ("3" . (org-priority ?C))
17479 (";" . org-set-tags-command)
17480 ("e" . org-set-effort)
17481 ("Agenda Views etc")
17482 ("v" . org-agenda)
17483 ("/" . org-sparse-tree)
17484 ("Misc")
17485 ("o" . org-open-at-point)
17486 ("?" . org-speed-command-help)
17487 ("<" . (org-agenda-set-restriction-lock 'subtree))
17488 (">" . (org-agenda-remove-restriction-lock))
17489 )
17490 "The default speed commands.")
17492 (defun org-print-speed-command (e)
17493 (if (> (length (car e)) 1)
17494 (progn
17496 (princ (car e))
17498 (princ (make-string (length (car e)) ?-))
17500 (princ (car e))
17501 (princ " ")
17502 (if (symbolp (cdr e))
17503 (princ (symbol-name (cdr e)))
17504 (prin1 (cdr e)))
17507 (defun org-speed-command-help ()
17508 "Show the available speed commands."
17509 (interactive)
17510 (if (not org-use-speed-commands)
17511 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17512 (with-output-to-temp-buffer "*Help*"
17514 (mapc 'org-print-speed-command org-speed-commands-user)
17517 (mapc 'org-print-speed-command org-speed-commands-default))
17518 (with-current-buffer "*Help*"
17519 (setq truncate-lines t))))
17521 (defun org-speed-move-safe (cmd)
17522 "Execute CMD, but make sure that the cursor always ends up in a headline.
17523 If not, return to the original position and throw an error."
17524 (interactive)
17525 (let ((pos (point)))
17526 (call-interactively cmd)
17527 (unless (and (bolp) (org-at-heading-p))
17528 (goto-char pos)
17529 (error "Boundary reached while executing %s" cmd))))
17531 (defvar org-self-insert-command-undo-counter 0)
17533 (defvar org-table-auto-blank-field) ; defined in org-table.el
17534 (defvar org-speed-command nil)
17536 (defun org-speed-command-default-hook (keys)
17537 "Hook for activating single-letter speed commands.
17538 `org-speed-commands-default' specifies a minimal command set.
17539 Use `org-speed-commands-user' for further customization."
17540 (when (or (and (bolp) (looking-at org-outline-regexp))
17541 (and (functionp org-use-speed-commands)
17542 (funcall org-use-speed-commands)))
17543 (cdr (assoc keys (append org-speed-commands-user
17544 org-speed-commands-default)))))
17546 (defun org-babel-speed-command-hook (keys)
17547 "Hook for activating single-letter code block commands."
17548 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17549 (cdr (assoc keys org-babel-key-bindings))))
17551 (defcustom org-speed-command-hook
17552 '(org-speed-command-default-hook org-babel-speed-command-hook)
17553 "Hook for activating speed commands at strategic locations.
17554 Hook functions are called in sequence until a valid handler is
17555 found.
17557 Each hook takes a single argument, a user-pressed command key
17558 which is also a `self-insert-command' from the global map.
17560 Within the hook, examine the cursor position and the command key
17561 and return nil or a valid handler as appropriate. Handler could
17562 be one of an interactive command, a function, or a form.
17564 Set `org-use-speed-commands' to non-nil value to enable this
17565 hook. The default setting is `org-speed-command-default-hook'."
17566 :group 'org-structure
17567 :type 'hook)
17569 (defun org-self-insert-command (N)
17570 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17571 If the cursor is in a table looking at whitespace, the whitespace is
17572 overwritten, and the table is not marked as requiring realignment."
17573 (interactive "p")
17574 (org-check-before-invisible-edit 'insert)
17575 (cond
17576 ((and org-use-speed-commands
17577 (setq org-speed-command
17578 (run-hook-with-args-until-success
17579 'org-speed-command-hook (this-command-keys))))
17580 (cond
17581 ((commandp org-speed-command)
17582 (setq this-command org-speed-command)
17583 (call-interactively org-speed-command))
17584 ((functionp org-speed-command)
17585 (funcall org-speed-command))
17586 ((and org-speed-command (listp org-speed-command))
17587 (eval org-speed-command))
17588 (t (let (org-use-speed-commands)
17589 (call-interactively 'org-self-insert-command)))))
17590 ((and
17591 (org-table-p)
17592 (progn
17593 ;; check if we blank the field, and if that triggers align
17594 (and (featurep 'org-table) org-table-auto-blank-field
17595 (member last-command
17596 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17598 ;; got extra space, this field does not determine column width
17599 (let (org-table-may-need-update) (org-table-blank-field))
17600 ;; no extra space, this field may determine column width
17601 (org-table-blank-field)))
17602 t)
17603 (eq N 1)
17605 (let (org-table-may-need-update)
17606 (goto-char (1- (match-end 0)))
17607 (delete-char -1)
17608 (goto-char (match-beginning 0))
17609 (self-insert-command N)))
17610 (t
17611 (setq org-table-may-need-update t)
17612 (self-insert-command N)
17613 (org-fix-tags-on-the-fly)
17614 (if org-self-insert-cluster-for-undo
17615 (if (not (eq last-command 'org-self-insert-command))
17616 (setq org-self-insert-command-undo-counter 1)
17617 (if (>= org-self-insert-command-undo-counter 20)
17618 (setq org-self-insert-command-undo-counter 1)
17619 (and (> org-self-insert-command-undo-counter 0)
17620 buffer-undo-list (listp buffer-undo-list)
17621 (not (cadr buffer-undo-list)) ; remove nil entry
17622 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17623 (setq org-self-insert-command-undo-counter
17624 (1+ org-self-insert-command-undo-counter))))))))
17626 (defun org-check-before-invisible-edit (kind)
17627 "Check is editing if kind KIND would be dangerous with invisible text around.
17628 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17629 ;; First, try to get out of here as quickly as possible, to reduce overhead
17630 (if (and org-catch-invisible-edits
17631 (or (not (boundp 'visible-mode)) (not visible-mode))
17632 (or (get-char-property (point) 'invisible)
17633 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17634 ;; OK, we need to take a closer look
17635 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17636 (invisible-before-point (if (bobp) nil (get-char-property
17637 (1- (point)) 'invisible)))
17638 (border-and-ok-direction
17639 (or
17640 ;; Check if we are acting predictably before invisible text
17641 (and invisible-at-point (not invisible-before-point)
17642 (memq kind '(insert delete-backward)))
17643 ;; Check if we are acting predictably after invisible text
17644 ;; This works not well, and I have turned it off. It seems
17645 ;; better to always show and stop after invisible text.
17646 ;; (and (not invisible-at-point) invisible-before-point
17647 ;; (memq kind '(insert delete)))
17648 )))
17650 (when (or (memq invisible-at-point '(outline org-hide-block))
17651 (memq invisible-before-point '(outline org-hide-block)))
17652 (if (eq org-catch-invisible-edits 'error)
17653 (error "Editing in invisible areas is prohibited - make visible first"))
17654 ;; Make the area visible
17655 (save-excursion
17656 (if invisible-before-point
17657 (goto-char (previous-single-char-property-change
17658 (point) 'invisible)))
17659 (org-cycle))
17660 (cond
17661 ((eq org-catch-invisible-edits 'show)
17662 ;; That's it, we do the edit after showing
17663 (message
17664 "Unfolding invisible region around point before editing")
17665 (sit-for 1))
17666 ((and (eq org-catch-invisible-edits 'smart)
17667 border-and-ok-direction)
17668 (message "Unfolding invisible region around point before editing"))
17669 (t
17670 ;; Don't do the edit, make the user repeat it in full visibility
17671 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17673 (defun org-fix-tags-on-the-fly ()
17674 (when (and (equal (char-after (point-at-bol)) ?*)
17675 (org-at-heading-p))
17676 (org-align-tags-here org-tags-column)))
17678 (defun org-delete-backward-char (N)
17679 "Like `delete-backward-char', insert whitespace at field end in tables.
17680 When deleting backwards, in tables this function will insert whitespace in
17682 still be marked for re-alignment if the field did fill the entire column,
17683 because, in this case the deletion might narrow the column."
17684 (interactive "p")
17685 (org-check-before-invisible-edit 'delete-backward)
17686 (if (and (org-table-p)
17687 (eq N 1)
17688 (string-match "|" (buffer-substring (point-at-bol) (point)))
17689 (looking-at ".*?|"))
17690 (let ((pos (point))
17692 (c org-table-may-need-update))
17693 (backward-delete-char N)
17694 (if (not overwrite-mode)
17695 (progn
17696 (skip-chars-forward "^|")
17697 (insert " ")
17698 (goto-char (1- pos))))
17699 ;; noalign: if there were two spaces at the end, this field
17700 ;; does not determine the width of the column.
17701 (if noalign (setq org-table-may-need-update c)))
17702 (backward-delete-char N)
17703 (org-fix-tags-on-the-fly)))
17705 (defun org-delete-char (N)
17706 "Like `delete-char', but insert whitespace at field end in tables.
17707 When deleting characters, in tables this function will insert whitespace in
17709 still be marked for re-alignment if the field did fill the entire column,
17710 because, in this case the deletion might narrow the column."
17711 (interactive "p")
17712 (org-check-before-invisible-edit 'delete)
17713 (if (and (org-table-p)
17714 (not (bolp))
17715 (not (= (char-after) ?|))
17716 (eq N 1))
17717 (if (looking-at ".*?|")
17718 (let ((pos (point))
17720 (c org-table-may-need-update))
17721 (replace-match (concat
17722 (substring (match-string 0) 1 -1)
17723 " |"))
17724 (goto-char pos)
17725 ;; noalign: if there were two spaces at the end, this field
17726 ;; does not determine the width of the column.
17727 (if noalign (setq org-table-may-need-update c)))
17728 (delete-char N))
17729 (delete-char N)
17730 (org-fix-tags-on-the-fly)))
17732 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17733 (put 'org-self-insert-command 'delete-selection t)
17734 (put 'orgtbl-self-insert-command 'delete-selection t)
17735 (put 'org-delete-char 'delete-selection 'supersede)
17736 (put 'org-delete-backward-char 'delete-selection 'supersede)
17737 (put 'org-yank 'delete-selection 'yank)
17739 ;; Make `flyspell-mode' delay after some commands
17740 (put 'org-self-insert-command 'flyspell-delayed t)
17741 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17742 (put 'org-delete-char 'flyspell-delayed t)
17743 (put 'org-delete-backward-char 'flyspell-delayed t)
17745 ;; Make pabbrev-mode expand after org-mode commands
17746 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17747 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17749 ;; How to do this: Measure non-white length of current string
17750 ;; If equal to column width, we should realign.
17752 (defun org-remap (map &rest commands)
17753 "In MAP, remap the functions given in COMMANDS.
17754 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17755 (let (new old)
17756 (while commands
17757 (setq old (pop commands) new (pop commands))
17758 (if (fboundp 'command-remapping)
17759 (org-defkey map (vector 'remap old) new)
17760 (substitute-key-definition old new map global-map)))))
17762 (when (eq org-enable-table-editor 'optimized)
17763 ;; If the user wants maximum table support, we need to hijack
17764 ;; some standard editing functions
17765 (org-remap org-mode-map
17766 'self-insert-command 'org-self-insert-command
17767 'delete-char 'org-delete-char
17768 'delete-backward-char 'org-delete-backward-char)
17769 (org-defkey org-mode-map "|" 'org-force-self-insert))
17771 (defvar org-ctrl-c-ctrl-c-hook nil
17772 "Hook for functions attaching themselves to `C-c C-c'.
17774 This can be used to add additional functionality to the C-c C-c
17775 key which executes context-dependent commands. This hook is run
17776 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17777 run after the last test.
17779 Each function will be called with no arguments. The function
17780 must check if the context is appropriate for it to act. If yes,
17781 it should do its thing and then return a non-nil value. If the
17782 context is wrong, just do nothing and return nil.")
17784 (defvar org-ctrl-c-ctrl-c-final-hook nil
17785 "Hook for functions attaching themselves to `C-c C-c'.
17787 This can be used to add additional functionality to the C-c C-c
17788 key which executes context-dependent commands. This hook is run
17789 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17790 before the first test.
17792 Each function will be called with no arguments. The function
17793 must check if the context is appropriate for it to act. If yes,
17794 it should do its thing and then return a non-nil value. If the
17795 context is wrong, just do nothing and return nil.")
17797 (defvar org-tab-first-hook nil
17798 "Hook for functions to attach themselves to TAB.
17799 See `org-ctrl-c-ctrl-c-hook' for more information.
17800 This hook runs as the first action when TAB is pressed, even before
17801 `org-cycle' messes around with the `outline-regexp' to cater for
17802 inline tasks and plain list item folding.
17803 If any function in this hook returns t, any other actions that
17804 would have been caused by TAB (such as table field motion or visibility
17805 cycling) will not occur.")
17807 (defvar org-tab-after-check-for-table-hook nil
17808 "Hook for functions to attach themselves to TAB.
17809 See `org-ctrl-c-ctrl-c-hook' for more information.
17810 This hook runs after it has been established that the cursor is not in a
17811 table, but before checking if the cursor is in a headline or if global cycling
17812 should be done.
17813 If any function in this hook returns t, not other actions like visibility
17814 cycling will be done.")
17816 (defvar org-tab-after-check-for-cycling-hook nil
17817 "Hook for functions to attach themselves to TAB.
17818 See `org-ctrl-c-ctrl-c-hook' for more information.
17819 This hook runs after it has been established that not table field motion and
17820 not visibility should be done because of current context. This is probably
17821 the place where a package like yasnippets can hook in.")
17823 (defvar org-tab-before-tab-emulation-hook nil
17824 "Hook for functions to attach themselves to TAB.
17825 See `org-ctrl-c-ctrl-c-hook' for more information.
17826 This hook runs after every other options for TAB have been exhausted, but
17829 (defvar org-metaleft-hook nil
17830 "Hook for functions attaching themselves to `M-left'.
17831 See `org-ctrl-c-ctrl-c-hook' for more information.")
17832 (defvar org-metaright-hook nil
17833 "Hook for functions attaching themselves to `M-right'.
17834 See `org-ctrl-c-ctrl-c-hook' for more information.")
17835 (defvar org-metaup-hook nil
17836 "Hook for functions attaching themselves to `M-up'.
17837 See `org-ctrl-c-ctrl-c-hook' for more information.")
17838 (defvar org-metadown-hook nil
17839 "Hook for functions attaching themselves to `M-down'.
17840 See `org-ctrl-c-ctrl-c-hook' for more information.")
17841 (defvar org-shiftmetaleft-hook nil
17842 "Hook for functions attaching themselves to `M-S-left'.
17843 See `org-ctrl-c-ctrl-c-hook' for more information.")
17844 (defvar org-shiftmetaright-hook nil
17845 "Hook for functions attaching themselves to `M-S-right'.
17846 See `org-ctrl-c-ctrl-c-hook' for more information.")
17847 (defvar org-shiftmetaup-hook nil
17848 "Hook for functions attaching themselves to `M-S-up'.
17849 See `org-ctrl-c-ctrl-c-hook' for more information.")
17850 (defvar org-shiftmetadown-hook nil
17851 "Hook for functions attaching themselves to `M-S-down'.
17852 See `org-ctrl-c-ctrl-c-hook' for more information.")
17853 (defvar org-metareturn-hook nil
17854 "Hook for functions attaching themselves to `M-RET'.
17855 See `org-ctrl-c-ctrl-c-hook' for more information.")
17856 (defvar org-shiftup-hook nil
17857 "Hook for functions attaching themselves to `S-up'.
17858 See `org-ctrl-c-ctrl-c-hook' for more information.")
17859 (defvar org-shiftup-final-hook nil
17860 "Hook for functions attaching themselves to `S-up'.
17861 This one runs after all other options except shift-select have been excluded.
17862 See `org-ctrl-c-ctrl-c-hook' for more information.")
17863 (defvar org-shiftdown-hook nil
17864 "Hook for functions attaching themselves to `S-down'.
17865 See `org-ctrl-c-ctrl-c-hook' for more information.")
17866 (defvar org-shiftdown-final-hook nil
17867 "Hook for functions attaching themselves to `S-down'.
17868 This one runs after all other options except shift-select have been excluded.
17869 See `org-ctrl-c-ctrl-c-hook' for more information.")
17870 (defvar org-shiftleft-hook nil
17871 "Hook for functions attaching themselves to `S-left'.
17872 See `org-ctrl-c-ctrl-c-hook' for more information.")
17873 (defvar org-shiftleft-final-hook nil
17874 "Hook for functions attaching themselves to `S-left'.
17875 This one runs after all other options except shift-select have been excluded.
17876 See `org-ctrl-c-ctrl-c-hook' for more information.")
17877 (defvar org-shiftright-hook nil
17878 "Hook for functions attaching themselves to `S-right'.
17879 See `org-ctrl-c-ctrl-c-hook' for more information.")
17880 (defvar org-shiftright-final-hook nil
17881 "Hook for functions attaching themselves to `S-right'.
17882 This one runs after all other options except shift-select have been excluded.
17883 See `org-ctrl-c-ctrl-c-hook' for more information.")
17885 (defun org-modifier-cursor-error ()
17886 "Throw an error, a modified cursor command was applied in wrong context."
17887 (error "This command is active in special context like tables, headlines or items"))
17889 (defun org-shiftselect-error ()
17890 "Throw an error because Shift-Cursor command was applied in wrong context."
17891 (if (and (boundp 'shift-select-mode) shift-select-mode)
17892 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17893 (error "This command works only in special context like headlines or timestamps")))
17895 (defun org-call-for-shift-select (cmd)
17896 (let ((this-command-keys-shift-translated t))
17897 (call-interactively cmd)))
17899 (defun org-shifttab (&optional arg)
17900 "Global visibility cycling or move to previous table field.
17901 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17902 on context.
17903 See the individual commands for more information."
17904 (interactive "P")
17905 (cond
17906 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17907 ((integerp arg)
17908 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17909 (message "Content view to level: %d" arg)
17910 (org-content (prefix-numeric-value arg2))
17911 (setq org-cycle-global-status 'overview)))
17912 (t (call-interactively 'org-global-cycle))))
17914 (defun org-shiftmetaleft ()
17915 "Promote subtree or delete table column.
17916 Calls `org-promote-subtree', `org-outdent-item',
17917 or `org-table-delete-column', depending on context.
17918 See the individual commands for more information."
17919 (interactive)
17920 (cond
17921 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17922 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17923 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17924 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17925 (t (org-modifier-cursor-error))))
17927 (defun org-shiftmetaright ()
17928 "Demote subtree or insert table column.
17929 Calls `org-demote-subtree', `org-indent-item',
17930 or `org-table-insert-column', depending on context.
17931 See the individual commands for more information."
17932 (interactive)
17933 (cond
17934 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17935 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17936 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17937 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17938 (t (org-modifier-cursor-error))))
17940 (defun org-shiftmetaup (&optional arg)
17941 "Move subtree up or kill table row.
17942 Calls `org-move-subtree-up' or `org-table-kill-row' or
17943 `org-move-item-up' depending on context. See the individual commands
17944 for more information."
17945 (interactive "P")
17946 (cond
17947 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17948 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17949 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17950 ((org-at-item-p) (call-interactively 'org-move-item-up))
17951 (t (org-modifier-cursor-error))))
17953 (defun org-shiftmetadown (&optional arg)
17954 "Move subtree down or insert table row.
17955 Calls `org-move-subtree-down' or `org-table-insert-row' or
17956 `org-move-item-down', depending on context. See the individual
17957 commands for more information."
17958 (interactive "P")
17959 (cond
17960 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17961 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17962 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17963 ((org-at-item-p) (call-interactively 'org-move-item-down))
17964 (t (org-modifier-cursor-error))))
17966 (defsubst org-hidden-tree-error ()
17967 (error
17968 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17970 (defun org-metaleft (&optional arg)
17971 "Promote heading or move table column to left.
17972 Calls `org-do-promote' or `org-table-move-column', depending on context.
17973 With no specific context, calls the Emacs default `backward-word'.
17974 See the individual commands for more information."
17975 (interactive "P")
17976 (cond
17977 ((run-hook-with-args-until-success 'org-metaleft-hook))
17978 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17979 ((org-with-limited-levels
17980 (or (org-at-heading-p)
17981 (and (org-region-active-p)
17982 (save-excursion
17983 (goto-char (region-beginning))
17984 (org-at-heading-p)))))
17985 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17986 (call-interactively 'org-do-promote))
17987 ;; At an inline task.
17988 ((org-at-heading-p)
17989 (call-interactively 'org-inlinetask-promote))
17990 ((or (org-at-item-p)
17991 (and (org-region-active-p)
17992 (save-excursion
17993 (goto-char (region-beginning))
17994 (org-at-item-p))))
17995 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17996 (call-interactively 'org-outdent-item))
17997 (t (call-interactively 'backward-word))))
17999 (defun org-metaright (&optional arg)
18000 "Demote subtree or move table column to right.
18001 Calls `org-do-demote' or `org-table-move-column', depending on context.
18002 With no specific context, calls the Emacs default `forward-word'.
18003 See the individual commands for more information."
18004 (interactive "P")
18005 (cond
18006 ((run-hook-with-args-until-success 'org-metaright-hook))
18007 ((org-at-table-p) (call-interactively 'org-table-move-column))
18008 ((org-with-limited-levels
18009 (or (org-at-heading-p)
18010 (and (org-region-active-p)
18011 (save-excursion
18012 (goto-char (region-beginning))
18013 (org-at-heading-p)))))
18014 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18015 (call-interactively 'org-do-demote))
18016 ;; At an inline task.
18017 ((org-at-heading-p)
18018 (call-interactively 'org-inlinetask-demote))
18019 ((or (org-at-item-p)
18020 (and (org-region-active-p)
18021 (save-excursion
18022 (goto-char (region-beginning))
18023 (org-at-item-p))))
18024 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18025 (call-interactively 'org-indent-item))
18026 (t (call-interactively 'forward-word))))
18028 (defun org-check-for-hidden (what)
18029 "Check if there are hidden headlines/items in the current visual line.
18030 WHAT can be either `headlines' or `items'. If the current line is
18031 an outline or item heading and it has a folded subtree below it,
18032 this function returns t, nil otherwise."
18033 (let ((re (cond
18034 ((eq what 'headlines) org-outline-regexp-bol)
18035 ((eq what 'items) (org-item-beginning-re))
18036 (t (error "This should not happen"))))
18037 beg end)
18038 (save-excursion
18039 (catch 'exit
18040 (unless (org-region-active-p)
18041 (setq beg (point-at-bol))
18042 (beginning-of-line 2)
18043 (while (and (not (eobp)) ;; this is like `next-line'
18044 (get-char-property (1- (point)) 'invisible))
18045 (beginning-of-line 2))
18046 (setq end (point))
18047 (goto-char beg)
18048 (goto-char (point-at-eol))
18049 (setq end (max end (point)))
18050 (while (re-search-forward re end t)
18051 (if (get-char-property (match-beginning 0) 'invisible)
18052 (throw 'exit t))))
18053 nil))))
18055 (defun org-metaup (&optional arg)
18056 "Move subtree up or move table row up.
18057 Calls `org-move-subtree-up' or `org-table-move-row' or
18058 `org-move-item-up', depending on context. See the individual commands
18059 for more information."
18060 (interactive "P")
18061 (cond
18062 ((run-hook-with-args-until-success 'org-metaup-hook))
18063 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18064 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18065 ((org-at-item-p) (call-interactively 'org-move-item-up))
18066 (t (transpose-lines 1) (beginning-of-line -1))))
18068 (defun org-metadown (&optional arg)
18069 "Move subtree down or move table row down.
18070 Calls `org-move-subtree-down' or `org-table-move-row' or
18071 `org-move-item-down', depending on context. See the individual
18072 commands for more information."
18073 (interactive "P")
18074 (cond
18075 ((run-hook-with-args-until-success 'org-metadown-hook))
18076 ((org-at-table-p) (call-interactively 'org-table-move-row))
18077 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18078 ((org-at-item-p) (call-interactively 'org-move-item-down))
18079 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18081 (defun org-shiftup (&optional arg)
18082 "Increase item in timestamp or increase priority of current headline.
18083 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18084 depending on context. See the individual commands for more information."
18085 (interactive "P")
18086 (cond
18087 ((run-hook-with-args-until-success 'org-shiftup-hook))
18088 ((and org-support-shift-select (org-region-active-p))
18089 (org-call-for-shift-select 'previous-line))
18090 ((org-at-timestamp-p t)
18091 (call-interactively (if org-edit-timestamp-down-means-later
18092 'org-timestamp-down 'org-timestamp-up)))
18093 ((and (not (eq org-support-shift-select 'always))
18094 org-enable-priority-commands
18095 (org-at-heading-p))
18096 (call-interactively 'org-priority-up))
18097 ((and (not org-support-shift-select) (org-at-item-p))
18098 (call-interactively 'org-previous-item))
18099 ((org-clocktable-try-shift 'up arg))
18100 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18101 (org-support-shift-select
18102 (org-call-for-shift-select 'previous-line))
18103 (t (org-shiftselect-error))))
18105 (defun org-shiftdown (&optional arg)
18106 "Decrease item in timestamp or decrease priority of current headline.
18107 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18108 depending on context. See the individual commands for more information."
18109 (interactive "P")
18110 (cond
18111 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18112 ((and org-support-shift-select (org-region-active-p))
18113 (org-call-for-shift-select 'next-line))
18114 ((org-at-timestamp-p t)
18115 (call-interactively (if org-edit-timestamp-down-means-later
18116 'org-timestamp-up 'org-timestamp-down)))
18117 ((and (not (eq org-support-shift-select 'always))
18118 org-enable-priority-commands
18119 (org-at-heading-p))
18120 (call-interactively 'org-priority-down))
18121 ((and (not org-support-shift-select) (org-at-item-p))
18122 (call-interactively 'org-next-item))
18123 ((org-clocktable-try-shift 'down arg))
18124 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18125 (org-support-shift-select
18126 (org-call-for-shift-select 'next-line))
18127 (t (org-shiftselect-error))))
18129 (defun org-shiftright (&optional arg)
18130 "Cycle the thing at point or in the current line, depending on context.
18131 Depending on context, this does one of the following:
18133 - switch a timestamp at point one day into the future
18134 - on a headline, switch to the next TODO keyword.
18135 - on an item, switch entire list to the next bullet type
18136 - on a property line, switch to the next allowed value
18137 - on a clocktable definition line, move time block into the future"
18138 (interactive "P")
18139 (cond
18140 ((run-hook-with-args-until-success 'org-shiftright-hook))
18141 ((and org-support-shift-select (org-region-active-p))
18142 (org-call-for-shift-select 'forward-char))
18143 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18144 ((and (not (eq org-support-shift-select 'always))
18145 (org-at-heading-p))
18146 (let ((org-inhibit-logging
18147 (not org-treat-S-cursor-todo-selection-as-state-change))
18148 (org-inhibit-blocking
18149 (not org-treat-S-cursor-todo-selection-as-state-change)))
18150 (org-call-with-arg 'org-todo 'right)))
18151 ((or (and org-support-shift-select
18152 (not (eq org-support-shift-select 'always))
18153 (org-at-item-bullet-p))
18154 (and (not org-support-shift-select) (org-at-item-p)))
18155 (org-call-with-arg 'org-cycle-list-bullet nil))
18156 ((and (not (eq org-support-shift-select 'always))
18157 (org-at-property-p))
18158 (call-interactively 'org-property-next-allowed-value))
18159 ((org-clocktable-try-shift 'right arg))
18160 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18161 (org-support-shift-select
18162 (org-call-for-shift-select 'forward-char))
18163 (t (org-shiftselect-error))))
18165 (defun org-shiftleft (&optional arg)
18166 "Cycle the thing at point or in the current line, depending on context.
18167 Depending on context, this does one of the following:
18169 - switch a timestamp at point one day into the past
18170 - on a headline, switch to the previous TODO keyword.
18171 - on an item, switch entire list to the previous bullet type
18172 - on a property line, switch to the previous allowed value
18173 - on a clocktable definition line, move time block into the past"
18174 (interactive "P")
18175 (cond
18176 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18177 ((and org-support-shift-select (org-region-active-p))
18178 (org-call-for-shift-select 'backward-char))
18179 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18180 ((and (not (eq org-support-shift-select 'always))
18181 (org-at-heading-p))
18182 (let ((org-inhibit-logging
18183 (not org-treat-S-cursor-todo-selection-as-state-change))
18184 (org-inhibit-blocking
18185 (not org-treat-S-cursor-todo-selection-as-state-change)))
18186 (org-call-with-arg 'org-todo 'left)))
18187 ((or (and org-support-shift-select
18188 (not (eq org-support-shift-select 'always))
18189 (org-at-item-bullet-p))
18190 (and (not org-support-shift-select) (org-at-item-p)))
18191 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18192 ((and (not (eq org-support-shift-select 'always))
18193 (org-at-property-p))
18194 (call-interactively 'org-property-previous-allowed-value))
18195 ((org-clocktable-try-shift 'left arg))
18196 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18197 (org-support-shift-select
18198 (org-call-for-shift-select 'backward-char))
18199 (t (org-shiftselect-error))))
18201 (defun org-shiftcontrolright ()
18202 "Switch to next TODO set."
18203 (interactive)
18204 (cond
18205 ((and org-support-shift-select (org-region-active-p))
18206 (org-call-for-shift-select 'forward-word))
18207 ((and (not (eq org-support-shift-select 'always))
18208 (org-at-heading-p))
18209 (org-call-with-arg 'org-todo 'nextset))
18210 (org-support-shift-select
18211 (org-call-for-shift-select 'forward-word))
18212 (t (org-shiftselect-error))))
18214 (defun org-shiftcontrolleft ()
18215 "Switch to previous TODO set."
18216 (interactive)
18217 (cond
18218 ((and org-support-shift-select (org-region-active-p))
18219 (org-call-for-shift-select 'backward-word))
18220 ((and (not (eq org-support-shift-select 'always))
18221 (org-at-heading-p))
18222 (org-call-with-arg 'org-todo 'previousset))
18223 (org-support-shift-select
18224 (org-call-for-shift-select 'backward-word))
18225 (t (org-shiftselect-error))))
18227 (defun org-shiftcontrolup ()
18228 "Change timestamps synchronously up in CLOCK log lines."
18229 (interactive)
18230 (cond ((and (not org-support-shift-select)
18231 (org-at-clock-log-p)
18232 (org-at-timestamp-p t))
18233 (org-clock-timestamps-up))
18234 (t (org-shiftselect-error))))
18236 (defun org-shiftcontroldown ()
18237 "Change timestamps synchronously down in CLOCK log lines."
18238 (interactive)
18239 (cond ((and (not org-support-shift-select)
18240 (org-at-clock-log-p)
18241 (org-at-timestamp-p t))
18242 (org-clock-timestamps-down))
18243 (t (org-shiftselect-error))))
18245 (defun org-ctrl-c-ret ()
18246 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18247 (interactive)
18248 (cond
18249 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18250 (t (call-interactively 'org-insert-heading))))
18252 (defun org-find-visible ()
18253 (let ((s (point)))
18254 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18255 (get-char-property s 'invisible)))
18256 s))
18257 (defun org-find-invisible ()
18258 (let ((s (point)))
18259 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18260 (not (get-char-property s 'invisible))))
18261 s))
18263 (defun org-copy-visible (beg end)
18264 "Copy the visible parts of the region."
18265 (interactive "r")
18266 (let (snippets s)
18267 (save-excursion
18268 (save-restriction
18269 (narrow-to-region beg end)
18270 (setq s (goto-char (point-min)))
18271 (while (not (= (point) (point-max)))
18272 (goto-char (org-find-invisible))
18273 (push (buffer-substring s (point)) snippets)
18274 (setq s (goto-char (org-find-visible))))))
18275 (kill-new (apply 'concat (nreverse snippets)))))
18277 (defun org-copy-special ()
18278 "Copy region in table or copy current subtree.
18279 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18280 See the individual commands for more information."
18281 (interactive)
18282 (call-interactively
18283 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18285 (defun org-cut-special ()
18286 "Cut region in table or cut current subtree.
18287 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18288 See the individual commands for more information."
18289 (interactive)
18290 (call-interactively
18291 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18293 (defun org-paste-special (arg)
18294 "Paste rectangular region into table, or past subtree relative to level.
18295 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18296 See the individual commands for more information."
18297 (interactive "P")
18298 (if (org-at-table-p)
18299 (org-table-paste-rectangle)
18300 (org-paste-subtree arg)))
18302 (defun org-edit-special (&optional arg)
18303 "Call a special editor for the stuff at point.
18304 When at a table, call the formula editor with `org-table-edit-formulas'.
18305 When at the first line of an src example, call `org-edit-src-code'.
18306 When in an #+include line, visit the include file. Otherwise call
18307 `ffap' to visit the file at point."
18308 (interactive)
18309 ;; possibly prep session before editing source
18310 (when arg
18311 (let* ((info (org-babel-get-src-block-info))
18312 (lang (nth 0 info))
18313 (params (nth 2 info))
18314 (session (cdr (assoc :session params))))
18315 (when (and info session) ;; we are in a source-code block with a session
18316 (funcall
18317 (intern (concat "org-babel-prep-session:" lang)) session params))))
18318 (cond ;; proceed with `org-edit-special'
18319 ((save-excursion
18320 (beginning-of-line 1)
18321 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18322 (find-file (org-trim (match-string 1))))
18323 ((org-edit-src-code))
18324 ((org-edit-fixed-width-region))
18325 ((org-at-table.el-p)
18326 (org-edit-src-code))
18327 ((or (org-at-table-p)
18328 (save-excursion
18329 (beginning-of-line 1)
18331 (call-interactively 'org-table-edit-formulas))
18332 (t (call-interactively 'ffap))))
18334 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18335 (defun org-ctrl-c-ctrl-c (&optional arg)
18336 "Set tags in headline, or update according to changed information at point.
18338 This command does many different things, depending on context:
18340 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18341 this is what we do.
18343 - If the cursor is on a statistics cookie, update it.
18345 - If the cursor is in a headline, prompt for tags and insert them
18346 into the current line, aligned to `org-tags-column'. When called
18347 with prefix arg, realign all tags in the current buffer.
18349 - If the cursor is in one of the special #+KEYWORD lines, this
18350 triggers scanning the buffer for these lines and updating the
18351 information.
18353 - If the cursor is inside a table, realign the table. This command
18354 works even if the automatic table editor has been turned off.
18356 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18357 the entire table.
18359 - If the cursor is at a footnote reference or definition, jump to
18360 the corresponding definition or references, respectively.
18362 - If the cursor is a the beginning of a dynamic block, update it.
18364 - If the current buffer is a capture buffer, close note and file it.
18366 - If the cursor is on a <<<target>>>, update radio targets and
18367 corresponding links in this buffer.
18369 - If the cursor is on a numbered item in a plain list, renumber the
18370 ordered list.
18372 - If the cursor is on a checkbox, toggle it.
18374 - If the cursor is on a code block, evaluate it. The variable
18375 `org-confirm-babel-evaluate' can be used to control prompting
18376 before code block evaluation, by default every code block
18377 evaluation requires confirmation. Code block evaluation can be
18378 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18379 (interactive "P")
18380 (let ((org-enable-table-editor t))
18381 (cond
18382 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18383 org-occur-highlights
18384 org-latex-fragment-image-overlays)
18385 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18386 (org-remove-occur-highlights)
18387 (org-remove-latex-fragment-image-overlays)
18388 (message "Temporary highlights/overlays removed from current buffer"))
18389 ((and (local-variable-p 'org-finish-function (current-buffer))
18390 (fboundp org-finish-function))
18391 (funcall org-finish-function))
18392 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18393 ((org-in-regexp org-ts-regexp-both)
18394 (org-timestamp-change 0 'day))
18395 ((or (looking-at org-property-start-re)
18396 (org-at-property-p))
18397 (call-interactively 'org-property-action))
18398 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18400 (or (org-at-heading-p) (org-at-item-p)))
18401 (call-interactively 'org-update-statistics-cookies))
18402 ((org-at-heading-p) (call-interactively 'org-set-tags))
18403 ((org-at-table.el-p)
18404 (message "Use C-c ' to edit table.el tables"))
18405 ((org-at-table-p)
18406 (org-table-maybe-eval-formula)
18407 (if arg
18408 (call-interactively 'org-table-recalculate)
18409 (org-table-maybe-recalculate-line))
18410 (call-interactively 'org-table-align)
18411 (orgtbl-send-table 'maybe))
18412 ((or (org-footnote-at-reference-p)
18413 (org-footnote-at-definition-p))
18414 (call-interactively 'org-footnote-action))
18415 ((org-at-item-checkbox-p)
18416 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18417 ;; list only if at top item.
18418 (let* ((cbox (match-string 1))
18419 (struct (org-list-struct))
18420 (old-struct (copy-tree struct))
18421 (parents (org-list-parents-alist struct))
18422 (orderedp (org-entry-get nil "ORDERED"))
18423 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18424 block-item)
18425 ;; Use a light version of `org-toggle-checkbox' to avoid
18426 ;; computing list structure twice.
18427 (let ((new-box (cond
18428 ((equal arg '(16)) "[-]")
18429 ((equal arg '(4)) nil)
18430 ((equal "[X]" cbox) "[ ]")
18431 (t "[X]"))))
18432 (if (and firstp arg)
18433 ;; If at first item of sub-list, remove check-box from
18434 ;; every item at the same level.
18435 (mapc
18436 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18437 (org-list-get-all-items
18438 (point-at-bol) struct (org-list-prevs-alist struct)))
18439 (org-list-set-checkbox (point-at-bol) struct new-box)))
18440 ;; Replicate `org-list-write-struct', while grabbing a return
18441 ;; value from `org-list-struct-fix-box'.
18442 (org-list-struct-fix-ind struct parents 2)
18443 (org-list-struct-fix-item-end struct)
18444 (let ((prevs (org-list-prevs-alist struct)))
18445 (org-list-struct-fix-bul struct prevs)
18446 (org-list-struct-fix-ind struct parents)
18447 (setq block-item
18448 (org-list-struct-fix-box struct parents prevs orderedp)))
18449 (org-list-struct-apply-struct struct old-struct)
18450 (org-update-checkbox-count-maybe)
18451 (when block-item
18452 (message
18453 "Checkboxes were removed due to unchecked box at line %d"
18454 (org-current-line block-item)))
18455 (when firstp (org-list-send-list 'maybe))))
18456 ((org-at-item-p)
18457 ;; Cursor at an item: repair list. Do checkbox related actions
18458 ;; only if function was called with an argument. Send list only
18459 ;; if at top item.
18460 (let* ((struct (org-list-struct))
18461 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18462 old-struct)
18463 (when arg
18464 (setq old-struct (copy-tree struct))
18465 (if firstp
18466 ;; If at first item of sub-list, add check-box to every
18467 ;; item at the same level.
18468 (mapc
18469 (lambda (pos)
18470 (unless (org-list-get-checkbox pos struct)
18471 (org-list-set-checkbox pos struct "[ ]")))
18472 (org-list-get-all-items
18473 (point-at-bol) struct (org-list-prevs-alist struct)))
18474 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18475 (org-list-write-struct
18476 struct (org-list-parents-alist struct) old-struct)
18477 (when arg (org-update-checkbox-count-maybe))
18478 (when firstp (org-list-send-list 'maybe))))
18479 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18480 ;; Dynamic block
18481 (beginning-of-line 1)
18482 (save-excursion (org-update-dblock)))
18483 ((save-excursion
18484 (beginning-of-line 1)
18486 (cond
18487 ((equal (match-string 1) "TBLFM")
18488 ;; Recalculate the table before this line
18489 (save-excursion
18490 (beginning-of-line 1)
18492 (if (org-at-table-p)
18493 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18494 (t
18495 (let ((org-inhibit-startup-visibility-stuff t)
18496 (org-startup-align-all-tables nil))
18497 (when (boundp 'org-table-coordinate-overlays)
18498 (mapc 'delete-overlay org-table-coordinate-overlays)
18499 (setq org-table-coordinate-overlays nil))
18500 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18501 (message "Local setup has been refreshed"))))
18502 ((org-clock-update-time-maybe))
18503 (t
18504 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18505 (error "C-c C-c can do nothing useful at this location"))))))
18507 (defun org-mode-restart ()
18508 "Restart Org-mode, to scan again for special lines.
18509 Also updates the keyword regular expressions."
18510 (interactive)
18511 (org-mode)
18512 (message "Org-mode restarted"))
18514 (defun org-kill-note-or-show-branches ()
18515 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18516 (interactive)
18517 (if (not org-finish-function)
18518 (progn
18519 (hide-subtree)
18520 (call-interactively 'show-branches))
18521 (let ((org-note-abort t))
18522 (funcall org-finish-function))))
18524 (defun org-return (&optional indent)
18525 "Goto next table row or insert a newline.
18526 Calls `org-table-next-row' or `newline', depending on context.
18527 See the individual commands for more information."
18528 (interactive)
18529 (cond
18530 ((bobp) (if indent (newline-and-indent) (newline)))
18531 ((org-at-table-p)
18532 (org-table-justify-field-maybe)
18533 (call-interactively 'org-table-next-row))
18534 ;; when `newline-and-indent' is called within a list, make sure
18535 ;; text moved stays inside the item.
18536 ((and (org-in-item-p) indent)
18537 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18538 (progn
18539 (save-match-data (newline))
18540 (org-indent-line-to (length (match-string 0))))
18541 (let ((ind (org-get-indentation)))
18542 (newline)
18543 (if (org-looking-back org-list-end-re)
18544 (org-indent-line-function)
18545 (org-indent-line-to ind)))))
18546 ((and org-return-follows-link
18547 (let ((tprop (get-text-property (point) 'face)))
18548 (or (eq tprop 'org-link)
18549 (and (listp tprop) (memq 'org-link tprop)))))
18550 (call-interactively 'org-open-at-point))
18551 ((and (org-at-heading-p)
18552 (looking-at
18554 (org-show-entry)
18555 (end-of-line 1)
18556 (newline))
18557 (t (if indent (newline-and-indent) (newline)))))
18559 (defun org-return-indent ()
18560 "Goto next table row or insert a newline and indent.
18561 Calls `org-table-next-row' or `newline-and-indent', depending on
18562 context. See the individual commands for more information."
18563 (interactive)
18564 (org-return t))
18566 (defun org-ctrl-c-star ()
18567 "Compute table, or change heading status of lines.
18568 Calls `org-table-recalculate' or `org-toggle-heading',
18569 depending on context."
18570 (interactive)
18571 (cond
18572 ((org-at-table-p)
18573 (call-interactively 'org-table-recalculate))
18574 (t
18575 ;; Convert all lines in region to list items
18576 (call-interactively 'org-toggle-heading))))
18578 (defun org-ctrl-c-minus ()
18579 "Insert separator line in table or modify bullet status of line.
18580 Also turns a plain line or a region of lines into list items.
18581 Calls `org-table-insert-hline', `org-toggle-item', or
18582 `org-cycle-list-bullet', depending on context."
18583 (interactive)
18584 (cond
18585 ((org-at-table-p)
18586 (call-interactively 'org-table-insert-hline))
18587 ((org-region-active-p)
18588 (call-interactively 'org-toggle-item))
18589 ((org-in-item-p)
18590 (call-interactively 'org-cycle-list-bullet))
18591 (t
18592 (call-interactively 'org-toggle-item))))
18594 (defun org-toggle-item (arg)
18595 "Convert headings or normal lines to items, items to normal lines.
18596 If there is no active region, only the current line is considered.
18598 If the first non blank line in the region is an headline, convert
18599 all headlines to items, shifting text accordingly.
18601 If it is an item, convert all items to normal lines.
18603 If it is normal text, change region into an item. With a prefix
18604 argument ARG, change each line in region into an item."
18605 (interactive "P")
18606 (let ((shift-text
18607 (function
18608 ;; Shift text in current section to IND, from point to END.
18609 ;; The function leaves point to END line.
18610 (lambda (ind end)
18611 (let ((min-i 1000) (end (copy-marker end)))
18612 ;; First determine the minimum indentation (MIN-I) of
18613 ;; the text.
18614 (save-excursion
18615 (catch 'exit
18616 (while (< (point) end)
18617 (let ((i (org-get-indentation)))
18618 (cond
18619 ;; Skip blank lines and inline tasks.
18621 ((looking-at org-outline-regexp-bol))
18622 ;; We can't find less than 0 indentation.
18623 ((zerop i) (throw 'exit (setq min-i 0)))
18624 ((< i min-i) (setq min-i i))))
18625 (forward-line))))
18626 ;; Then indent each line so that a line indented to
18627 ;; MIN-I becomes indented to IND. Ignore blank lines
18628 ;; and inline tasks in the process.
18629 (let ((delta (- ind min-i)))
18630 (while (< (point) end)
18632 (looking-at org-outline-regexp-bol))
18633 (org-indent-line-to (+ (org-get-indentation) delta)))
18634 (forward-line)))))))
18635 (skip-blanks
18636 (function
18637 ;; Return beginning of first non-blank line, starting from
18638 ;; line at POS.
18639 (lambda (pos)
18640 (save-excursion
18641 (goto-char pos)
18643 (point-at-bol)))))
18644 beg end)
18645 ;; Determine boundaries of changes.
18646 (if (org-region-active-p)
18647 (setq beg (funcall skip-blanks (region-beginning))
18648 end (copy-marker (region-end)))
18649 (setq beg (funcall skip-blanks (point-at-bol))
18650 end (copy-marker (point-at-eol))))
18651 ;; Depending on the starting line, choose an action on the text
18652 ;; between BEG and END.
18653 (org-with-limited-levels
18654 (save-excursion
18655 (goto-char beg)
18656 (cond
18657 ;; Case 1. Start at an item: de-itemize. Note that it only
18658 ;; happens when a region is active: `org-ctrl-c-minus'
18659 ;; would call `org-cycle-list-bullet' otherwise.
18660 ((org-at-item-p)
18661 (while (< (point) end)
18662 (when (org-at-item-p)
18664 (delete-region (point) (match-end 0)))
18665 (forward-line)))
18666 ;; Case 2. Start at an heading: convert to items.
18667 ((org-at-heading-p)
18668 (let* ((bul (org-list-bullet-string "-"))
18669 (bul-len (length bul))
18670 ;; Indentation of the first heading. It should be
18671 ;; relative to the indentation of its parent, if any.
18672 (start-ind (save-excursion
18673 (cond
18674 ((not org-adapt-indentation) 0)
18675 ((not (outline-previous-heading)) 0)
18676 (t (length (match-string 0))))))
18677 ;; Level of first heading. Further headings will be
18678 ;; compared to it to determine hierarchy in the list.
18679 (ref-level (org-reduced-level (org-outline-level))))
18680 (while (< (point) end)
18681 (let* ((level (org-reduced-level (org-outline-level)))
18682 (delta (max 0 (- level ref-level))))
18683 ;; If current headline is less indented than the first
18684 ;; one, set it as reference, in order to preserve
18685 ;; subtrees.
18686 (when (< level ref-level) (setq ref-level level))
18687 (replace-match bul t t)
18688 (org-indent-line-to (+ start-ind (* delta bul-len)))
18689 ;; Ensure all text down to END (or SECTION-END) belongs
18690 ;; to the newly created item.
18691 (let ((section-end (save-excursion
18692 (or (outline-next-heading) (point)))))
18693 (forward-line)
18694 (funcall shift-text
18695 (+ start-ind (* (1+ delta) bul-len))
18696 (min end section-end)))))))
18697 ;; Case 3. Normal line with ARG: turn each non-item line into
18698 ;; an item.
18699 (arg
18700 (while (< (point) end)
18701 (unless (or (org-at-heading-p) (org-at-item-p))
18703 (replace-match
18705 (forward-line)))
18706 ;; Case 4. Normal line without ARG: make the first line of
18707 ;; region an item, and shift indentation of others
18708 ;; lines to set them as item's body.
18709 (t (let* ((bul (org-list-bullet-string "-"))
18710 (bul-len (length bul))
18711 (ref-ind (org-get-indentation)))
18713 (insert bul)
18714 (forward-line)
18715 (while (< (point) end)
18716 ;; Ensure that lines less indented than first one
18717 ;; still get included in item body.
18718 (funcall shift-text
18719 (+ ref-ind bul-len)
18720 (min end (save-excursion (or (outline-next-heading)
18721 (point)))))
18722 (forward-line)))))))))
18724 (defun org-toggle-heading (&optional nstars)
18725 "Convert headings to normal text, or items or text to headings.
18726 If there is no active region, only the current line is considered.
18728 If the first non blank line is an headline, remove the stars from
18729 all headlines in the region.
18731 If it is a plain list item, turn all plain list items into headings.
18733 If it is a normal line, turn each and every normal line (i.e. not
18734 an heading or an item) in the region into a heading.
18736 When converting a line into a heading, the number of stars is chosen
18737 such that the lines become children of the current entry. However,
18738 when a prefix argument is given, its value determines the number of
18739 stars to add."
18740 (interactive "P")
18741 (let ((skip-blanks
18742 (function
18743 ;; Return beginning of first non-blank line, starting from
18744 ;; line at POS.
18745 (lambda (pos)
18746 (save-excursion
18747 (goto-char pos)
18749 (point-at-bol)))))
18750 beg end)
18751 ;; Determine boundaries of changes. If region ends at a bol, do
18752 ;; not consider the last line to be in the region.
18753 (if (org-region-active-p)
18754 (setq beg (funcall skip-blanks (region-beginning))
18755 end (copy-marker (save-excursion
18756 (goto-char (region-end))
18757 (if (bolp) (point) (point-at-eol)))))
18758 (setq beg (funcall skip-blanks (point-at-bol))
18759 end (copy-marker (point-at-eol))))
18760 ;; Ensure inline tasks don't count as headings.
18761 (org-with-limited-levels
18762 (save-excursion
18763 (goto-char beg)
18764 (cond
18765 ;; Case 1. Started at an heading: de-star headings.
18766 ((org-at-heading-p)
18767 (while (< (point) end)
18768 (when (org-at-heading-p t)
18769 (looking-at org-outline-regexp) (replace-match ""))
18770 (forward-line)))
18771 ;; Case 2. Started at an item: change items into headlines.
18772 ;; One star will be added by `org-list-to-subtree'.
18773 ((org-at-item-p)
18774 (let* ((stars (make-string
18775 (if nstars
18776 ;; subtract the star that will be added again by
18777 ;; `org-list-to-subtree'
18778 (1- (prefix-numeric-value current-prefix-arg))
18779 (or (org-current-level) 0))
18780 ?*))
18781 (add-stars
18782 (cond (nstars "") ; stars from prefix only
18783 ((equal stars "") "") ; before first heading
18784 (org-odd-levels-only "*") ; inside heading, odd
18785 (t "")))) ; inside heading, oddeven
18786 (while (< (point) end)
18787 (when (org-at-item-p)
18788 ;; Pay attention to cases when region ends before list.
18789 (let* ((struct (org-list-struct))
18790 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18791 (save-restriction
18792 (narrow-to-region (point) list-end)
18793 (insert
18794 (org-list-to-subtree
18795 (org-list-parse-list t)
18796 '(:istart (concat stars add-stars (funcall get-stars depth))
18797 :icount (concat stars add-stars (funcall get-stars depth))))))))
18798 (forward-line))))
18799 ;; Case 3. Started at normal text: make every line an heading,
18800 ;; skipping headlines and items.
18801 (t (let* ((stars (make-string
18802 (if nstars
18803 (prefix-numeric-value current-prefix-arg)
18804 (or (org-current-level) 0))
18805 ?*))
18806 (add-stars
18807 (cond (nstars "") ; stars from prefix only
18808 ((equal stars "") "*") ; before first heading
18809 (org-odd-levels-only "**") ; inside heading, odd
18810 (t "*"))) ; inside heading, oddeven
18811 (rpl (concat stars add-stars " ")))
18812 (while (< (point) end)
18813 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18815 (replace-match (concat rpl (match-string 2))))
18816 (forward-line)))))))))
18818 (defun org-meta-return (&optional arg)
18819 "Insert a new heading or wrap a region in a table.
18820 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18821 See the individual commands for more information."
18822 (interactive "P")
18823 (cond
18824 ((run-hook-with-args-until-success 'org-metareturn-hook))
18825 ((org-at-table-p)
18826 (call-interactively 'org-table-wrap-region))
18827 (t (call-interactively 'org-insert-heading))))
18829 ;;; Menu entries
18831 ;; Define the Org-mode menus
18832 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18833 '("Tbl"
18834 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18835 ["Next Field" org-cycle (org-at-table-p)]
18836 ["Previous Field" org-shifttab (org-at-table-p)]
18837 ["Next Row" org-return (org-at-table-p)]
18838 "--"
18839 ["Blank Field" org-table-blank-field (org-at-table-p)]
18840 ["Edit Field" org-table-edit-field (org-at-table-p)]
18841 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18842 "--"
18843 ("Column"
18844 ["Move Column Left" org-metaleft (org-at-table-p)]
18845 ["Move Column Right" org-metaright (org-at-table-p)]
18846 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18847 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18848 ("Row"
18849 ["Move Row Up" org-metaup (org-at-table-p)]
18850 ["Move Row Down" org-metadown (org-at-table-p)]
18851 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18852 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18853 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18854 "--"
18855 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18856 ("Rectangle"
18857 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18858 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18859 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18860 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18861 "--"
18862 ("Calculate"
18863 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18864 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18865 ["Edit Formulas" org-edit-special (org-at-table-p)]
18866 "--"
18867 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18868 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18869 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18870 "--"
18871 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18872 "--"
18873 ["Sum Column/Rectangle" org-table-sum
18874 (or (org-at-table-p) (org-region-active-p))]
18875 ["Which Column?" org-table-current-column (org-at-table-p)])
18876 ["Debug Formulas"
18877 org-table-toggle-formula-debugger
18878 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18879 ["Show Col/Row Numbers"
18880 org-table-toggle-coordinate-overlays
18881 :style toggle
18882 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18883 "--"
18884 ["Create" org-table-create (and (not (org-at-table-p))
18885 org-enable-table-editor)]
18886 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18887 ["Import from File" org-table-import (not (org-at-table-p))]
18888 ["Export to File" org-table-export (org-at-table-p)]
18889 "--"
18890 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18892 (easy-menu-define org-org-menu org-mode-map "Org menu"
18893 '("Org"
18894 ("Show/Hide"
18895 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18896 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18897 ["Sparse Tree..." org-sparse-tree t]
18898 ["Reveal Context" org-reveal t]
18899 ["Show All" show-all t]
18900 "--"
18901 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18902 "--"
18903 ["New Heading" org-insert-heading t]
18904 ("Navigate Headings"
18905 ["Up" outline-up-heading t]
18906 ["Next" outline-next-visible-heading t]
18907 ["Previous" outline-previous-visible-heading t]
18908 ["Next Same Level" outline-forward-same-level t]
18909 ["Previous Same Level" outline-backward-same-level t]
18910 "--"
18911 ["Jump" org-goto t])
18912 ("Edit Structure"
18913 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18914 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18915 "--"
18916 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18917 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18918 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18919 "--"
18920 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18921 "--"
18922 ["Copy visible text" org-copy-visible t]
18923 "--"
18924 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18925 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18926 ["Demote Heading" org-metaright (not (org-at-table-p))]
18927 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18928 "--"
18929 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18930 "--"
18931 ["Convert to odd levels" org-convert-to-odd-levels t]
18932 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18933 ("Editing"
18934 ["Emphasis..." org-emphasize t]
18935 ["Edit Source Example" org-edit-special t]
18936 "--"
18937 ["Footnote new/jump" org-footnote-action t]
18938 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18939 ("Archive"
18940 ["Archive (default method)" org-archive-subtree-default t]
18941 "--"
18942 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18943 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18944 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18945 )
18946 "--"
18947 ("Hyperlinks"
18948 ["Store Link (Global)" org-store-link t]
18949 ["Find existing link to here" org-occur-link-in-agenda-files t]
18950 ["Insert Link" org-insert-link t]
18951 ["Follow Link" org-open-at-point t]
18952 "--"
18953 ["Next link" org-next-link t]
18954 ["Previous link" org-previous-link t]
18955 "--"
18956 ["Descriptive Links"
18957 org-toggle-link-display
18958 :style radio
18959 :selected org-descriptive-links
18960 ]
18961 ["Literal Links"
18962 org-toggle-link-display
18963 :style radio
18964 :selected (not org-descriptive-links)])
18965 "--"
18966 ("TODO Lists"
18967 ["TODO/DONE/-" org-todo t]
18968 ("Select keyword"
18969 ["Next keyword" org-shiftright (org-at-heading-p)]
18970 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18971 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18972 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18973 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18974 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18975 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18976 "--"
18977 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18978 :selected org-enforce-todo-dependencies :style toggle :active t]
18979 "Settings for tree at point"
18980 ["Do Children sequentially" org-toggle-ordered-property :style radio
18981 :selected (org-entry-get nil "ORDERED")
18982 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18983 ["Do Children parallel" org-toggle-ordered-property :style radio
18984 :selected (not (org-entry-get nil "ORDERED"))
18985 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18986 "--"
18987 ["Set Priority" org-priority t]
18988 ["Priority Up" org-shiftup t]
18989 ["Priority Down" org-shiftdown t]
18990 "--"
18991 ["Get news from all feeds" org-feed-update-all t]
18992 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18993 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18994 ("TAGS and Properties"
18995 ["Set Tags" org-set-tags-command t]
18996 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18997 "--"
18998 ["Set property" org-set-property t]
18999 ["Column view of properties" org-columns t]
19000 ["Insert Column View DBlock" org-insert-columns-dblock t])
19001 ("Dates and Scheduling"
19002 ["Timestamp" org-time-stamp t]
19003 ["Timestamp (inactive)" org-time-stamp-inactive t]
19004 ("Change Date"
19005 ["1 Day Later" org-shiftright t]
19006 ["1 Day Earlier" org-shiftleft t]
19007 ["1 ... Later" org-shiftup t]
19008 ["1 ... Earlier" org-shiftdown t])
19009 ["Compute Time Range" org-evaluate-time-range t]
19010 ["Schedule Item" org-schedule t]
19011 ["Deadline" org-deadline t]
19012 "--"
19013 ["Custom time format" org-toggle-time-stamp-overlays
19014 :style radio :selected org-display-custom-times]
19015 "--"
19016 ["Goto Calendar" org-goto-calendar t]
19017 ["Date from Calendar" org-date-from-calendar t]
19018 "--"
19019 ["Start/Restart Timer" org-timer-start t]
19020 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19021 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19022 ["Insert Timer String" org-timer t]
19023 ["Insert Timer Item" org-timer-item t])
19024 ("Logging work"
19025 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19026 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19027 ["Clock out" org-clock-out t]
19028 ["Clock cancel" org-clock-cancel t]
19029 "--"
19030 ["Mark as default task" org-clock-mark-default-task t]
19031 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19032 ["Goto running clock" org-clock-goto t]
19033 "--"
19034 ["Display times" org-clock-display t]
19035 ["Create clock table" org-clock-report t]
19036 "--"
19037 ["Record DONE time"
19038 (progn (setq org-log-done (not org-log-done))
19039 (message "Switching to %s will %s record a timestamp"
19040 (car org-done-keywords)
19041 (if org-log-done "automatically" "not")))
19042 :style toggle :selected org-log-done])
19043 "--"
19044 ["Agenda Command..." org-agenda t]
19045 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19046 ("File List for Agenda")
19047 ("Special views current file"
19048 ["TODO Tree" org-show-todo-tree t]
19049 ["Check Deadlines" org-check-deadlines t]
19050 ["Timeline" org-timeline t]
19051 ["Tags/Property tree" org-match-sparse-tree t])
19052 "--"
19053 ["Export/Publish..." org-export t]
19054 ("LaTeX"
19055 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19056 :selected org-cdlatex-mode]
19057 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19058 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19059 ["Modify math symbol" org-cdlatex-math-modify
19060 (org-inside-LaTeX-fragment-p)]
19061 ["Insert citation" org-reftex-citation t]
19062 "--"
19063 ["Template for BEAMER" org-insert-beamer-options-template t])
19064 "--"
19065 ("MobileOrg"
19066 ["Push Files and Views" org-mobile-push t]
19067 ["Get Captured and Flagged" org-mobile-pull t]
19068 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19069 "--"
19070 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19071 "--"
19072 ("Documentation"
19073 ["Show Version" org-version t]
19074 ["Info Documentation" org-info t])
19075 ("Customize"
19076 ["Browse Org Group" org-customize t]
19077 "--"
19078 ["Expand This Menu" org-create-customize-menu
19079 (fboundp 'customize-menu-create)])
19080 ["Send bug report" org-submit-bug-report t]
19081 "--"
19082 ("Refresh/Reload"
19083 ["Refresh setup current buffer" org-mode-restart t]
19084 ["Reload Org (after update)" org-reload t]
19085 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19086 ))
19088 (defun org-info (&optional node)
19089 "Read documentation for Org-mode in the info system.
19090 With optional NODE, go directly to that node."
19091 (interactive)
19092 (info (format "(org)%s" (or node ""))))
19094 ;;;###autoload
19095 (defun org-submit-bug-report ()
19096 "Submit a bug report on Org-mode via mail.
19098 Don't hesitate to report any problems or inaccurate documentation.
19100 If you don't have setup sending mail from (X)Emacs, please copy the
19101 output buffer into your mail program, as it gives us important
19102 information about your Org-mode version and configuration."
19103 (interactive)
19104 (require 'reporter)
19105 (org-load-modules-maybe)
19106 (org-require-autoloaded-modules)
19107 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19108 (reporter-submit-bug-report
19109 "emacs-orgmode@gnu.org"
19110 (org-version)
19111 (let (list)
19112 (save-window-excursion
19113 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19114 (delete-other-windows)
19115 (erase-buffer)
19116 (insert "You are about to submit a bug report to the Org-mode mailing list.
19118 We would like to add your full Org-mode and Outline configuration to the
19119 bug report. This greatly simplifies the work of the maintainer and
19120 other experts on the mailing list.
19122 HOWEVER, some variables you have customized may contain private
19123 information. The names of customers, colleagues, or friends, might
19124 appear in the form of file names, tags, todo states, or search strings.
19125 If you answer yes to the prompt, you might want to check and remove
19126 such private information before sending the email.")
19127 (add-text-properties (point-min) (point-max) '(face org-warning))
19128 (when (yes-or-no-p "Include your Org-mode configuration ")
19129 (mapatoms
19130 (lambda (v)
19131 (and (boundp v)
19133 (or (and (symbol-value v)
19135 (and
19136 (get v 'custom-type) (get v 'standard-value)
19137 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19138 (push v list)))))
19139 (kill-buffer (get-buffer "*Warn about privacy*"))
19140 list))
19141 nil nil
19142 "Remember to cover the basics, that is, what you expected to happen and
19143 what in fact did happen. You don't know how to make a good report? See
19145 http://orgmode.org/manual/Feedback.html#Feedback
19147 Your bug report will be posted to the Org-mode mailing list.
19148 ------------------------------------------------------------------------")
19149 (save-excursion
19154 (defun org-install-agenda-files-menu ()
19155 (let ((bl (buffer-list)))
19156 (save-excursion
19157 (while bl
19158 (set-buffer (pop bl))
19159 (if (eq major-mode 'org-mode) (setq bl nil)))
19160 (when (eq major-mode 'org-mode)
19161 (easy-menu-change
19162 '("Org") "File List for Agenda"
19163 (append
19164 (list
19165 ["Edit File List" (org-edit-agenda-file-list) t]
19166 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19167 ["Remove Current File from List" org-remove-file t]
19168 ["Cycle through agenda files" org-cycle-agenda-files t]
19169 ["Occur in all agenda files" org-occur-in-agenda-files t]
19170 "--")
19171 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19173 ;;;; Documentation
19175 ;;;###autoload
19176 (defun org-require-autoloaded-modules ()
19177 (interactive)
19178 (mapc 'require
19179 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19180 org-docbook org-exp org-html org-icalendar
19181 org-id org-latex
19182 org-publish org-remember org-table
19183 org-timer org-xoxo)))
19185 ;;;###autoload
19186 (defun org-reload (&optional uncompiled)
19187 "Reload all org lisp files.
19188 With prefix arg UNCOMPILED, load the uncompiled versions."
19189 (interactive "P")
19190 (require 'find-func)
19192 (dir-org (file-name-directory (org-find-library-name "org")))
19193 (dir-org-contrib (ignore-errors
19194 (file-name-directory
19195 (org-find-library-name "org-contribdir"))))
19196 (babel-files
19197 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19198 (append (list nil "comint" "eval" "exp" "keys"
19199 "lob" "ref" "table" "tangle")
19200 (delq nil
19201 (mapcar
19202 (lambda (lang)
19203 (when (cdr lang) (symbol-name (car lang))))
19204 org-babel-load-languages)))))
19205 (files
19206 (append (directory-files dir-org t file-re)
19207 babel-files
19208 (and dir-org-contrib
19209 (directory-files dir-org-contrib t file-re))))
19210 (remove-re (concat (if (featurep 'xemacs)
19211 "org-colview" "org-colview-xemacs")
19213 (setq files (mapcar 'file-name-sans-extension files))
19214 (setq files (mapcar
19215 (lambda (x) (if (string-match remove-re x) nil x))
19216 files))
19217 (setq files (delq nil files))
19218 (mapc
19219 (lambda (f)
19220 (when (featurep (intern (file-name-nondirectory f)))
19221 (if (and (not uncompiled)
19222 (file-exists-p (concat f ".elc")))
19223 (load (concat f ".elc") nil nil t)
19224 (load (concat f ".el") nil nil t))))
19225 files))
19226 (org-version))
19228 ;;;###autoload
19229 (defun org-customize ()
19230 "Call the customize function with org as argument."
19231 (interactive)
19232 (org-load-modules-maybe)
19233 (org-require-autoloaded-modules)
19234 (customize-browse 'org))
19236 (defun org-create-customize-menu ()
19237 "Create a full customization menu for Org-mode, insert it into the menu."
19238 (interactive)
19239 (org-load-modules-maybe)
19240 (org-require-autoloaded-modules)
19241 (if (fboundp 'customize-menu-create)
19242 (progn
19243 (easy-menu-change
19244 '("Org") "Customize"
19245 `(["Browse Org group" org-customize t]
19246 "--"
19247 ,(customize-menu-create 'org)
19248 ["Set" Custom-set t]
19249 ["Save" Custom-save t]
19250 ["Reset to Current" Custom-reset-current t]
19251 ["Reset to Saved" Custom-reset-saved t]
19252 ["Reset to Standard Settings" Custom-reset-standard t]))
19254 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19256 ;;;; Miscellaneous stuff
19258 ;;; Generally useful functions
19260 (defun org-get-at-bol (property)
19261 "Get text property PROPERTY at beginning of line."
19262 (get-text-property (point-at-bol) property))
19264 (defun org-find-text-property-in-string (prop s)
19265 "Return the first non-nil value of property PROP in string S."
19266 (or (get-text-property 0 prop s)
19267 (get-text-property (or (next-single-property-change 0 prop s) 0)
19268 prop s)))
19270 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19271 "Display the given MESSAGE as a warning."
19272 (if (fboundp 'display-warning)
19273 (display-warning 'org message
19274 (if (featurep 'xemacs) 'warning :warning))
19275 (let ((buf (get-buffer-create "*Org warnings*")))
19276 (with-current-buffer buf
19277 (goto-char (point-max))
19278 (insert "Warning (Org): " message)
19279 (unless (bolp)
19280 (newline)))
19281 (display-buffer buf)
19282 (sit-for 0))))
19284 (defun org-eval (form)
19285 "Eval FORM and return result."
19286 (condition-case error
19287 (eval form)
19288 (error (format "%%![Error: %s]" error))))
19290 (defun org-in-clocktable-p ()
19291 "Check if the cursor is in a clocktable."
19292 (let ((pos (point)) start)
19293 (save-excursion
19294 (end-of-line 1)
19296 (setq start (match-beginning 0))
19298 (>= (match-end 0) pos)
19299 start))))
19301 (defun org-in-commented-line ()
19302 "Is point in a line starting with `#'?"
19303 (equal (char-after (point-at-bol)) ?#))
19305 (defun org-in-indented-comment-line ()
19306 "Is point in a line starting with `#' after some white space?"
19307 (save-excursion
19308 (save-match-data
19309 (goto-char (point-at-bol))
19312 (defun org-in-verbatim-emphasis ()
19313 (save-match-data
19314 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19316 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19317 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19318 (if (and marker (marker-buffer marker)
19319 (buffer-live-p (marker-buffer marker)))
19320 (progn
19321 (org-pop-to-buffer-same-window (marker-buffer marker))
19322 (if (or (> marker (point-max)) (< marker (point-min)))
19323 (widen))
19324 (goto-char marker)
19325 (org-show-context 'org-goto))
19326 (if bookmark
19327 (bookmark-jump bookmark)
19328 (error "Cannot find location"))))
19330 (defun org-quote-csv-field (s)
19331 "Quote field for inclusion in CSV material."
19334 s))
19336 (defun org-force-self-insert (N)
19337 "Needed to enforce self-insert under remapping."
19338 (interactive "p")
19339 (self-insert-command N))
19341 (defun org-string-width (s)
19342 "Compute width of string, ignoring invisible characters.
19343 This ignores character with invisibility property `org-link', and also
19344 characters with property `org-cwidth', because these will become invisible
19345 upon the next fontification round."
19346 (let (b l)
19347 (when (or (eq t buffer-invisibility-spec)
19348 (assq 'org-link buffer-invisibility-spec))
19349 (while (setq b (text-property-any 0 (length s)
19350 'invisible 'org-link s))
19351 (setq s (concat (substring s 0 b)
19352 (substring s (or (next-single-property-change
19353 b 'invisible s) (length s)))))))
19354 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19355 (setq s (concat (substring s 0 b)
19356 (substring s (or (next-single-property-change
19357 b 'org-cwidth s) (length s))))))
19358 (setq l (string-width s) b -1)
19359 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19360 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19361 l))
19363 (defun org-shorten-string (s maxlength)
19364 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19365 If the string is shorter or has length MAXLENGTH, just return the
19366 original string. If it is longer, the functions finds a space in the
19367 string, breaks this string off at that locations and adds three dots
19368 as ellipsis. Including the ellipsis, the string will not be longer
19369 than MAXLENGTH. If finding a good breaking point in the string does
19370 not work, the string is just chopped off in the middle of a word
19371 if necessary."
19372 (if (<= (length s) maxlength)
19373 s
19374 (let* ((n (max (- maxlength 4) 1))
19376 (if (string-match re s)
19377 (concat (match-string 1 s) "...")
19378 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19380 (defun org-get-indentation (&optional line)
19381 "Get the indentation of the current line, interpreting tabs.
19382 When LINE is given, assume it represents a line and compute its indentation."
19383 (if line
19384 (if (string-match "^ *" (org-remove-tabs line))
19385 (match-end 0))
19386 (save-excursion
19387 (beginning-of-line 1)
19389 (current-column))))
19391 (defun org-get-string-indentation (s)
19392 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19393 (let ((n -1) (i 0) (w tab-width) c)
19394 (catch 'exit
19395 (while (< (setq n (1+ n)) (length s))
19396 (setq c (aref s n))
19397 (cond ((= c ?\ ) (setq i (1+ i)))
19399 (t (throw 'exit t)))))
19400 i))
19402 (defun org-remove-tabs (s &optional width)
19403 "Replace tabulators in S with spaces.
19404 Assumes that s is a single line, starting in column 0."
19405 (setq width (or width tab-width))
19407 (setq s (replace-match
19408 (make-string
19409 (- (* width (/ (+ (match-beginning 0) width) width))
19410 (match-beginning 0)) ?\ )
19411 t t s)))
19412 s)
19414 (defun org-fix-indentation (line ind)
19415 "Fix indentation in LINE.
19416 IND is a cons cell with target and minimum indentation.
19417 If the current indentation in LINE is smaller than the minimum,
19418 leave it alone. If it is larger than ind, set it to the target."
19419 (let* ((l (org-remove-tabs line))
19420 (i (org-get-indentation l))
19421 (i1 (car ind)) (i2 (cdr ind)))
19422 (if (>= i i2) (setq l (substring line i2)))
19423 (if (> i1 0)
19424 (concat (make-string i1 ?\ ) l)
19425 l)))
19427 (defun org-remove-indentation (code &optional n)
19428 "Remove the maximum common indentation from the lines in CODE.
19429 N may optionally be the number of spaces to remove."
19430 (with-temp-buffer
19431 (insert code)
19432 (org-do-remove-indentation n)
19433 (buffer-string)))
19435 (defun org-do-remove-indentation (&optional n)
19436 "Remove the maximum common indentation from the buffer."
19437 (untabify (point-min) (point-max))
19438 (let ((min 10000) re)
19439 (if n
19440 (setq min n)
19441 (goto-char (point-min))
19443 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19444 (unless (or (= min 0) (= min 10000))
19446 (goto-char (point-min))
19447 (while (re-search-forward re nil t)
19448 (replace-match "")
19449 (end-of-line 1))
19450 min)))
19452 (defun org-fill-template (template alist)
19453 "Find each %key of ALIST in TEMPLATE and replace it."
19454 (let ((case-fold-search nil)
19455 entry key value)
19456 (setq alist (sort (copy-sequence alist)
19457 (lambda (a b) (< (length (car a)) (length (car b))))))
19458 (while (setq entry (pop alist))
19459 (setq template
19460 (replace-regexp-in-string
19461 (concat "%" (regexp-quote (car entry)))
19462 (cdr entry) template t t)))
19463 template))
19465 (defun org-base-buffer (buffer)
19466 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19467 (if (not buffer)
19468 buffer
19469 (or (buffer-base-buffer buffer)
19470 buffer)))
19472 (defun org-trim (s)
19473 "Remove whitespace at beginning and end of string."
19476 s)
19478 (defun org-wrap (string &optional width lines)
19479 "Wrap string to either a number of lines, or a width in characters.
19480 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19481 that costs. If there is a word longer than WIDTH, the text is actually
19482 wrapped to the length of that word.
19483 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19484 many lines, whatever width that takes.
19485 The return value is a list of lines, without newlines at the end."
19487 (maxword (apply 'max (mapcar 'org-string-width words)))
19488 w ll)
19489 (cond (width
19490 (org-do-wrap words (max maxword width)))
19491 (lines
19492 (setq w maxword)
19493 (setq ll (org-do-wrap words maxword))
19494 (if (<= (length ll) lines)
19495 ll
19496 (setq ll words)
19497 (while (> (length ll) lines)
19498 (setq w (1+ w))
19499 (setq ll (org-do-wrap words w)))
19500 ll))
19501 (t (error "Cannot wrap this")))))
19503 (defun org-do-wrap (words width)
19504 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19505 (let (lines line)
19506 (while words
19507 (setq line (pop words))
19508 (while (and words (< (+ (length line) (length (car words))) width))
19509 (setq line (concat line " " (pop words))))
19510 (setq lines (push line lines)))
19511 (nreverse lines)))
19513 (defun org-split-string (string &optional separators)
19514 "Splits STRING into substrings at SEPARATORS.
19515 No empty strings are returned if there are matches at the beginning
19516 and end of string."
19518 (start 0)
19519 notfirst
19520 (list nil))
19521 (while (and (string-match rexp string
19522 (if (and notfirst
19523 (= start (match-beginning 0))
19524 (< start (length string)))
19525 (1+ start) start))
19526 (< (match-beginning 0) (length string)))
19527 (setq notfirst t)
19528 (or (eq (match-beginning 0) 0)
19529 (and (eq (match-beginning 0) (match-end 0))
19530 (eq (match-beginning 0) start))
19531 (setq list
19532 (cons (substring string start (match-beginning 0))
19533 list)))
19534 (setq start (match-end 0)))
19535 (or (eq start (length string))
19536 (setq list
19537 (cons (substring string start)
19538 list)))
19539 (nreverse list)))
19541 (defun org-quote-vert (s)
19543 (while (string-match "|" s)
19545 s)
19547 (defun org-uuidgen-p (s)
19548 "Is S an ID created by UUIDGEN?"
19549 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19551 (defun org-context ()
19552 "Return a list of contexts of the current cursor position.
19553 If several contexts apply, all are returned.
19554 Each context entry is a list with a symbol naming the context, and
19555 two positions indicating start and end of the context. Possible
19556 contexts are:
19558 :headline anywhere in a headline
19559 :headline-stars on the leading stars in a headline
19560 :todo-keyword on a TODO keyword (including DONE) in a headline
19561 :tags on the TAGS in a headline
19562 :priority on the priority cookie in a headline
19563 :item on the first line of a plain list item
19564 :item-bullet on the bullet/number of a plain list item
19565 :checkbox on the checkbox in a plain list item
19566 :table in an org-mode table
19567 :table-special on a special filed in a table
19568 :table-table in a table.el table
19569 :link on a hyperlink
19570 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19571 :target on a <<target>>
19572 :radio-target on a <<<radio-target>>>
19573 :latex-fragment on a LaTeX fragment
19574 :latex-preview on a LaTeX fragment with overlaid preview image
19576 This function expects the position to be visible because it uses font-lock
19577 faces as a help to recognize the following contexts: :table-special, :link,
19578 and :keyword."
19579 (let* ((f (get-text-property (point) 'face))
19580 (faces (if (listp f) f (list f)))
19581 (p (point)) clist o)
19582 ;; First the large context
19583 (cond
19584 ((org-at-heading-p t)
19585 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19586 (when (progn
19587 (beginning-of-line 1)
19588 (looking-at org-todo-line-tags-regexp))
19589 (push (org-point-in-group p 1 :headline-stars) clist)
19590 (push (org-point-in-group p 2 :todo-keyword) clist)
19591 (push (org-point-in-group p 4 :tags) clist))
19592 (goto-char p)
19595 (push (org-point-in-group p 0 :priority) clist)))
19597 ((org-at-item-p)
19598 (push (org-point-in-group p 2 :item-bullet) clist)
19599 (push (list :item (point-at-bol)
19600 (save-excursion (org-end-of-item) (point)))
19601 clist)
19602 (and (org-at-item-checkbox-p)
19603 (push (org-point-in-group p 0 :checkbox) clist)))
19605 ((org-at-table-p)
19606 (push (list :table (org-table-begin) (org-table-end)) clist)
19607 (if (memq 'org-formula faces)
19608 (push (list :table-special
19609 (previous-single-property-change p 'face)
19610 (next-single-property-change p 'face)) clist)))
19611 ((org-at-table-p 'any)
19612 (push (list :table-table) clist)))
19613 (goto-char p)
19615 ;; Now the small context
19616 (cond
19617 ((org-at-timestamp-p)
19618 (push (org-point-in-group p 0 :timestamp) clist))
19619 ((memq 'org-link faces)
19620 (push (list :link
19621 (previous-single-property-change p 'face)
19622 (next-single-property-change p 'face)) clist))
19623 ((memq 'org-special-keyword faces)
19624 (push (list :keyword
19625 (previous-single-property-change p 'face)
19626 (next-single-property-change p 'face)) clist))
19627 ((org-at-target-p)
19628 (push (org-point-in-group p 0 :target) clist)
19629 (goto-char (1- (match-beginning 0)))
19630 (if (looking-at org-radio-target-regexp)
19631 (push (org-point-in-group p 0 :radio-target) clist))
19632 (goto-char p))
19633 ((setq o (car (delq nil
19634 (mapcar
19635 (lambda (x)
19636 (if (memq x org-latex-fragment-image-overlays) x))
19637 (overlays-at (point))))))
19638 (push (list :latex-fragment
19639 (overlay-start o) (overlay-end o)) clist)
19640 (push (list :latex-preview
19641 (overlay-start o) (overlay-end o)) clist))
19642 ((org-inside-LaTeX-fragment-p)
19643 ;; FIXME: positions wrong.
19644 (push (list :latex-fragment (point) (point)) clist)))
19646 (setq clist (nreverse (delq nil clist)))
19647 clist))
19649 ;; FIXME: Compare with at-regexp-p Do we need both?
19650 (defun org-in-regexp (re &optional nlines visually)
19651 "Check if point is inside a match of regexp.
19652 Normally only the current line is checked, but you can include NLINES extra
19653 lines both before and after point into the search.
19654 If VISUALLY is set, require that the cursor is not after the match but
19655 really on, so that the block visually is on the match."
19656 (catch 'exit
19657 (let ((pos (point))
19658 (eol (point-at-eol (+ 1 (or nlines 0))))
19659 (inc (if visually 1 0)))
19660 (save-excursion
19661 (beginning-of-line (- 1 (or nlines 0)))
19662 (while (re-search-forward re eol t)
19663 (if (and (<= (match-beginning 0) pos)
19664 (>= (+ inc (match-end 0)) pos))
19665 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19667 (defun org-at-regexp-p (regexp)
19668 "Is point inside a match of REGEXP in the current line?"
19669 (catch 'exit
19670 (save-excursion
19671 (let ((pos (point)) (end (point-at-eol)))
19672 (beginning-of-line 1)
19673 (while (re-search-forward regexp end t)
19674 (if (and (<= (match-beginning 0) pos)
19675 (>= (match-end 0) pos))
19676 (throw 'exit t)))
19677 nil))))
19679 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19680 "Non-nil when point is between matches of START-RE and END-RE.
19682 Also return a non-nil value when point is on one of the matches.
19684 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19685 buffer positions. Default values are the positions of headlines
19686 surrounding the point.
19688 The functions returns a cons cell whose car (resp. cdr) is the
19689 position before START-RE (resp. after END-RE)."
19690 (save-match-data
19691 (let ((pos (point))
19692 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19693 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19694 beg end)
19695 (save-excursion
19696 ;; Point is on a block when on START-RE or if START-RE can be
19697 ;; found before it...
19698 (and (or (org-at-regexp-p start-re)
19699 (re-search-backward start-re limit-up t))
19700 (setq beg (match-beginning 0))
19701 ;; ... and END-RE after it...
19702 (goto-char (match-end 0))
19703 (re-search-forward end-re limit-down t)
19704 (> (setq end (match-end 0)) pos)
19705 ;; ... without another START-RE in-between.
19706 (goto-char (match-beginning 0))
19707 (not (re-search-backward start-re (1+ beg) t))
19708 ;; Return value.
19709 (cons beg end))))))
19711 (defun org-in-block-p (names)
19712 "Non-nil when point belongs to a block whose name belongs to NAMES.
19714 NAMES is a list of strings containing names of blocks.
19716 Return first block name matched, or nil. Beware that in case of
19717 nested blocks, the returned name may not belong to the closest
19718 block from point."
19719 (save-match-data
19720 (catch 'exit
19721 (let ((case-fold-search t)
19722 (lim-up (save-excursion (outline-previous-heading)))
19723 (lim-down (save-excursion (outline-next-heading))))
19724 (mapc (lambda (name)
19725 (let ((n (regexp-quote name)))
19726 (when (org-between-regexps-p
19729 lim-up lim-down)
19730 (throw 'exit n))))
19731 names))
19732 nil)))
19734 (defun org-occur-in-agenda-files (regexp &optional nlines)
19735 "Call `multi-occur' with buffers for all agenda files."
19737 (let* ((files (org-agenda-files))
19738 (tnames (mapcar 'file-truename files))
19739 (extra org-agenda-text-search-extra-files)
19740 f)
19741 (when (eq (car extra) 'agenda-archives)
19742 (setq extra (cdr extra))
19743 (setq files (org-add-archive-files files)))
19744 (while (setq f (pop extra))
19745 (unless (member (file-truename f) tnames)
19746 (add-to-list 'files f 'append)
19747 (add-to-list 'tnames (file-truename f) 'append)))
19748 (multi-occur
19749 (mapcar (lambda (x)
19750 (with-current-buffer
19751 (or (get-file-buffer x) (find-file-noselect x))
19752 (widen)
19753 (current-buffer)))
19754 files)
19755 regexp)))
19757 (if (boundp 'occur-mode-find-occurrence-hook)
19758 ;; Emacs 23
19759 (add-hook 'occur-mode-find-occurrence-hook
19760 (lambda ()
19761 (when (eq major-mode 'org-mode)
19762 (org-reveal))))
19763 ;; Emacs 22
19764 (defadvice occur-mode-goto-occurrence
19765 (after org-occur-reveal activate)
19766 (and (eq major-mode 'org-mode) (org-reveal)))
19767 (defadvice occur-mode-goto-occurrence-other-window
19768 (after org-occur-reveal activate)
19769 (and (eq major-mode 'org-mode) (org-reveal)))
19770 (defadvice occur-mode-display-occurrence
19771 (after org-occur-reveal activate)
19772 (when (eq major-mode 'org-mode)
19773 (let ((pos (occur-mode-find-occurrence)))
19774 (with-current-buffer (marker-buffer pos)
19775 (save-excursion
19776 (goto-char pos)
19777 (org-reveal)))))))
19779 (defun org-occur-link-in-agenda-files ()
19780 "Create a link and search for it in the agendas.
19781 The link is not stored in `org-stored-links', it is just created
19782 for the search purpose."
19783 (interactive)
19784 (let ((link (condition-case nil
19785 (org-store-link nil)
19786 (error "Unable to create a link to here"))))
19787 (org-occur-in-agenda-files (regexp-quote link))))
19789 (defun org-uniquify (list)
19790 "Remove duplicate elements from LIST."
19791 (let (res)
19792 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19793 res))
19795 (defun org-delete-all (elts list)
19796 "Remove all elements in ELTS from LIST."
19797 (while elts
19798 (setq list (delete (pop elts) list)))
19799 list)
19801 (defun org-count (cl-item cl-seq)
19802 "Count the number of occurrences of ITEM in SEQ.
19803 Taken from `count' in cl-seq.el with all keyword arguments removed."
19804 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19805 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19806 (while (< cl-start cl-end)
19807 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19808 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19809 (setq cl-start (1+ cl-start)))
19810 cl-count))
19812 (defun org-remove-if (predicate seq)
19813 "Remove everything from SEQ that fulfills PREDICATE."
19814 (let (res e)
19815 (while seq
19816 (setq e (pop seq))
19817 (if (not (funcall predicate e)) (push e res)))
19818 (nreverse res)))
19820 (defun org-remove-if-not (predicate seq)
19821 "Remove everything from SEQ that does not fulfill PREDICATE."
19822 (let (res e)
19823 (while seq
19824 (setq e (pop seq))
19825 (if (funcall predicate e) (push e res)))
19826 (nreverse res)))
19828 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19829 "Reduce two-argument FUNCTION across SEQ.
19830 Taken from `reduce' in cl-seq.el with all keyword arguments but
19832 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19833 (cadr (memq :initial-value cl-keys)))
19834 (cl-seq (pop cl-seq))
19835 (t (funcall cl-func)))))
19836 (while cl-seq
19837 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19838 cl-accum))
19840 (defun org-back-over-empty-lines ()
19841 "Move backwards over whitespace, to the beginning of the first empty line.
19842 Returns the number of empty lines passed."
19843 (let ((pos (point)))
19844 (if (cdr (assoc 'heading org-blank-before-new-entry))
19846 (unless (eobp)
19847 (forward-line -1)))
19848 (beginning-of-line 2)
19849 (goto-char (min (point) pos))
19850 (count-lines (point) pos)))
19852 (defun org-skip-whitespace ()
19855 (defun org-point-in-group (point group &optional context)
19856 "Check if POINT is in match-group GROUP.
19857 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19858 match. If the match group does not exist or point is not inside it,
19859 return nil."
19860 (and (match-beginning group)
19861 (>= point (match-beginning group))
19862 (<= point (match-end group))
19863 (if context
19864 (list context (match-beginning group) (match-end group))
19865 t)))
19867 (defun org-switch-to-buffer-other-window (&rest args)
19868 "Switch to buffer in a second window on the current frame.
19869 In particular, do not allow pop-up frames.
19870 Returns the newly created buffer."
19871 (let (pop-up-frames special-display-buffer-names special-display-regexps
19872 special-display-function)
19873 (apply 'switch-to-buffer-other-window args)))
19875 (defun org-combine-plists (&rest plists)
19876 "Create a single property list from all plists in PLISTS.
19877 The process starts by copying the first list, and then setting properties
19878 from the other lists. Settings in the last list are the most significant
19879 ones and overrule settings in the other lists."
19880 (let ((rtn (copy-sequence (pop plists)))
19881 p v ls)
19882 (while plists
19883 (setq ls (pop plists))
19884 (while ls
19885 (setq p (pop ls) v (pop ls))
19886 (setq rtn (plist-put rtn p v))))
19887 rtn))
19889 (defun org-move-line-down (arg)
19890 "Move the current line down. With prefix argument, move it past ARG lines."
19891 (interactive "p")
19892 (let ((col (current-column))
19893 beg end pos)
19894 (beginning-of-line 1) (setq beg (point))
19895 (beginning-of-line 2) (setq end (point))
19896 (beginning-of-line (+ 1 arg))
19897 (setq pos (move-marker (make-marker) (point)))
19898 (insert (delete-and-extract-region beg end))
19899 (goto-char pos)
19900 (org-move-to-column col)))
19902 (defun org-move-line-up (arg)
19903 "Move the current line up. With prefix argument, move it past ARG lines."
19904 (interactive "p")
19905 (let ((col (current-column))
19906 beg end pos)
19907 (beginning-of-line 1) (setq beg (point))
19908 (beginning-of-line 2) (setq end (point))
19909 (beginning-of-line (- arg))
19910 (setq pos (move-marker (make-marker) (point)))
19911 (insert (delete-and-extract-region beg end))
19912 (goto-char pos)
19913 (org-move-to-column col)))
19915 (defun org-replace-escapes (string table)
19916 "Replace %-escapes in STRING with values in TABLE.
19918 The sequences in STRING may contain normal field width and padding information,
19920 so values can contain further %-escapes if they are define later in TABLE."
19921 (let ((tbl (copy-alist table))
19922 (case-fold-search nil)
19923 (pchg 0)
19924 e re rpl)
19925 (while (setq e (pop tbl))
19926 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19927 (when (and (cdr e) (string-match re (cdr e)))
19928 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19929 (safe "SREF"))
19930 (add-text-properties 0 3 (list 'sref sref) safe)
19931 (setcdr e (replace-match safe t t (cdr e)))))
19932 (while (string-match re string)
19933 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19934 (cdr e)))
19935 (setq string (replace-match rpl t t string))))
19936 (while (setq pchg (next-property-change pchg string))
19937 (let ((sref (get-text-property pchg 'sref string)))
19938 (when (and sref (string-match "SREF" string pchg))
19939 (setq string (replace-match sref t t string)))))
19940 string))
19942 (defun org-sublist (list start end)
19943 "Return a section of LIST, from START to END.
19944 Counting starts at 1."
19945 (let (rtn (c start))
19946 (setq list (nthcdr (1- start) list))
19947 (while (and list (<= c end))
19948 (push (pop list) rtn)
19949 (setq c (1+ c)))
19950 (nreverse rtn)))
19952 (defun org-find-base-buffer-visiting (file)
19953 "Like `find-buffer-visiting' but always return the base buffer and
19954 not an indirect buffer."
19955 (let ((buf (or (get-file-buffer file)
19956 (find-buffer-visiting file))))
19957 (if buf
19958 (or (buffer-base-buffer buf) buf)
19959 nil)))
19961 (defun org-image-file-name-regexp (&optional extensions)
19962 "Return regexp matching the file names of images.
19963 If EXTENSIONS is given, only match these."
19964 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19965 (image-file-name-regexp)
19966 (let ((image-file-name-extensions
19967 (or extensions
19968 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19969 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19971 (regexp-opt (nconc (mapcar 'upcase
19972 image-file-name-extensions)
19973 image-file-name-extensions)
19974 t)
19977 (defun org-file-image-p (file &optional extensions)
19978 "Return non-nil if FILE is an image."
19979 (save-match-data
19980 (string-match (org-image-file-name-regexp extensions) file)))
19982 (defun org-get-cursor-date ()
19983 "Return the date at cursor in as a time.
19984 This works in the calendar and in the agenda, anywhere else it just
19985 returns the current time."
19986 (let (date day defd)
19987 (cond
19988 ((eq major-mode 'calendar-mode)
19989 (setq date (calendar-cursor-to-date)
19990 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19991 ((eq major-mode 'org-agenda-mode)
19992 (setq day (get-text-property (point) 'day))
19993 (if day
19994 (setq date (calendar-gregorian-from-absolute day)
19995 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19996 (nth 2 date))))))
19997 (or defd (current-time))))
19999 (defvar org-agenda-action-marker (make-marker)
20000 "Marker pointing to the entry for the next agenda action.")
20002 (defun org-mark-entry-for-agenda-action ()
20003 "Mark the current entry as target of an agenda action.
20004 Agenda actions are actions executed from the agenda with the key `k',
20005 which make use of the date at the cursor."
20006 (interactive)
20007 (move-marker org-agenda-action-marker
20008 (save-excursion (org-back-to-heading t) (point))
20009 (current-buffer))
20010 (message
20011 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20013 (defun org-mark-subtree ()
20014 "Mark the current subtree.
20015 This puts point at the start of the current subtree, and mark at the end.
20017 If point is in an inline task, mark that task instead."
20018 (interactive)
20019 (let ((inline-task-p
20020 (and (featurep 'org-inlinetask)
20021 (org-inlinetask-in-task-p)))
20022 (beg))
20023 ;; Get beginning of subtree
20024 (cond
20025 (inline-task-p (org-inlinetask-goto-beginning))
20026 ((org-at-heading-p) (beginning-of-line))
20027 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20028 (setq beg (point))
20029 ;; Get end of it
20030 (if inline-task-p
20031 (org-inlinetask-goto-end)
20032 (org-end-of-subtree))
20033 ;; Mark zone
20034 (push-mark (point) nil t)
20035 (goto-char beg)))
20037 ;;; Paragraph filling stuff.
20038 ;; We want this to be just right, so use the full arsenal.
20040 (defun org-indent-line-function ()
20041 "Indent line depending on context."
20042 (interactive)
20043 (let* ((pos (point))
20044 (itemp (org-at-item-p))
20045 (case-fold-search t)
20047 (inline-task-p (and (featurep 'org-inlinetask)
20048 (org-inlinetask-in-task-p)))
20049 (inline-re (and inline-task-p
20050 (org-inlinetask-outline-regexp)))
20051 column)
20052 (beginning-of-line 1)
20053 (cond
20054 ;; Comments
20055 ((looking-at "# ") (setq column 0))
20056 ;; Headings
20057 ((looking-at org-outline-regexp) (setq column 0))
20058 ;; Included files
20060 ;; Footnote definition
20061 ((looking-at org-footnote-definition-re) (setq column 0))
20062 ;; Literal examples
20064 (setq column (org-get-indentation))) ; do nothing
20065 ;; Lists
20066 ((ignore-errors (goto-char (org-in-item-p)))
20067 (setq column (if itemp
20068 (org-get-indentation)
20069 (org-list-item-body-column (point))))
20070 (goto-char pos))
20071 ;; Drawers
20073 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20074 (save-excursion
20075 (goto-char (1- (match-beginning 1)))
20076 (setq column (current-column))))
20077 ;; Special blocks
20079 (save-excursion
20080 (re-search-backward
20082 (setq column (org-get-indentation (match-string 0))))
20085 (save-excursion
20087 (setq column
20088 (cond ((equal (downcase (match-string 1)) "src")
20089 ;; src blocks: let `org-edit-src-exit' handle them
20090 (org-get-indentation))
20091 ((equal (downcase (match-string 1)) "example")
20092 (max (org-get-indentation)
20093 (org-get-indentation (match-string 0))))
20094 (t
20095 (org-get-indentation (match-string 0))))))
20096 ;; This line has nothing special, look at the previous relevant
20097 ;; line to compute indentation
20098 (t
20099 (beginning-of-line 0)
20100 (while (and (not (bobp))
20101 (not (looking-at org-drawer-regexp))
20102 ;; When point started in an inline task, do not move
20103 ;; above task starting line.
20104 (not (and inline-task-p (looking-at inline-re)))
20105 ;; Skip drawers, blocks, empty lines, verbatim,
20106 ;; comments, tables, footnotes definitions, lists,
20107 ;; inline tasks.
20109 (re-search-backward org-drawer-regexp nil t))
20113 (looking-at org-footnote-definition-re)
20114 (and (ignore-errors (goto-char (org-in-item-p)))
20115 (goto-char
20116 (org-list-get-top-point (org-list-struct))))
20117 (and (not inline-task-p)
20118 (featurep 'org-inlinetask)
20119 (org-inlinetask-in-task-p)
20120 (or (org-inlinetask-goto-beginning) t))))
20121 (beginning-of-line 0))
20122 (cond
20123 ;; There was an heading above.
20125 (if (not org-adapt-indentation)
20126 (setq column 0)
20127 (goto-char (match-end 0))
20128 (setq column (current-column))))
20129 ;; A drawer had started and is unfinished
20130 ((looking-at org-drawer-regexp)
20131 (goto-char (1- (match-beginning 1)))
20132 (setq column (current-column)))
20133 ;; Else, nothing noticeable found: get indentation and go on.
20134 (t (setq column (org-get-indentation))))))
20135 ;; Now apply indentation and move cursor accordingly
20136 (goto-char pos)
20137 (if (<= (current-column) (current-indentation))
20138 (org-indent-line-to column)
20139 (save-excursion (org-indent-line-to column)))
20140 ;; Special polishing for properties, see `org-property-format'
20141 (setq column (current-column))
20142 (beginning-of-line 1)
20143 (if (looking-at
20145 (replace-match (concat (match-string 1)
20146 (format org-property-format
20147 (match-string 2) (match-string 3)))
20148 t t))
20149 (org-move-to-column column)))
20151 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20152 "Variable to store copy of `adaptive-fill-regexp'.
20153 Since `adaptive-fill-regexp' is set to never match, we need to
20154 store a backup of its value before entering `org-mode' so that
20155 the functionality can be provided as a fall-back.")
20157 (defun org-set-autofill-regexps ()
20158 (interactive)
20159 ;; In the paragraph separator we include headlines, because filling
20160 ;; text in a line directly attached to a headline would otherwise
20161 ;; fill the headline as well.
20164 ;; The paragraph starter includes hand-formatted lists.
20165 (org-set-local
20166 'paragraph-start
20167 (concat
20176 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20177 ;; But only if the user has not turned off tables or fixed-width regions
20178 (org-set-local
20179 'auto-fill-inhibit-regexp
20180 (concat org-outline-regexp
20183 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20184 (concat
20186 (if org-enable-table-editor "|" "")
20187 (if org-enable-fixed-width-editor ":" "")
20188 "]"))))
20189 ;; We use our own fill-paragraph function, to make sure that tables
20190 ;; and fixed-width regions are not wrapped. That function will pass
20191 ;; through to `fill-paragraph' when appropriate.
20192 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20193 ;; Prevent auto-fill from inserting unwanted new items.
20194 (if (boundp 'fill-nobreak-predicate)
20195 (org-set-local 'fill-nobreak-predicate
20196 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20197 fill-nobreak-predicate
20198 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20199 ;; Adaptive filling: To get full control, first make sure that
20200 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20201 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20202 (org-set-local 'org-adaptive-fill-regexp-backup
20203 adaptive-fill-regexp))
20205 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20206 (org-set-local 'adaptive-fill-function
20207 'org-adaptive-fill-function)
20208 (org-set-local
20209 'align-mode-rules-list
20210 '((org-in-buffer-settings
20212 (modes . '(org-mode))))))
20214 (defun org-fill-item-nobreak-p ()
20215 "Non-nil when a line break at point would insert a new item."
20216 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20218 (defun org-fill-paragraph (&optional justify)
20219 "Re-align a table, pass through to fill-paragraph if no table."
20220 (let ((table-p (org-at-table-p))
20221 (table.el-p (org-at-table.el-p))
20222 (itemp (org-in-item-p)))
20223 (cond ((and (equal (char-after (point-at-bol)) ?*)
20224 (save-excursion (goto-char (point-at-bol))
20225 (looking-at org-outline-regexp)))
20226 t) ; skip headlines
20227 (table.el-p t) ; skip table.el tables
20228 (table-p (org-table-align) t) ; align Org tables
20229 (itemp ; align text in items
20230 (let* ((struct (save-excursion (goto-char itemp)
20231 (org-list-struct)))
20232 (parents (org-list-parents-alist struct))
20233 (children (org-list-get-children itemp struct parents))
20234 beg end prev next prefix)
20235 ;; Determine in which part of item point is: before
20236 ;; first child, after last child, between two
20237 ;; sub-lists, or simply in item if there's no child.
20238 (cond
20239 ((not children)
20240 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20241 beg itemp
20242 end (org-list-get-item-end itemp struct)))
20243 ((< (point) (setq next (car children)))
20244 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20245 beg itemp
20246 end next))
20247 ((> (point) (setq prev (car (last children))))
20248 (setq beg (org-list-get-item-end prev struct)
20249 end (org-list-get-item-end itemp struct)
20250 prefix (save-excursion
20251 (goto-char beg)
20253 (make-string (current-column) ?\ ))))
20254 (t (catch 'exit
20255 (while (setq next (pop children))
20256 (if (> (point) next)
20257 (setq prev next)
20258 (setq beg (org-list-get-item-end prev struct)
20259 end next
20260 prefix (save-excursion
20261 (goto-char beg)
20263 (make-string (current-column) ?\ )))
20264 (throw 'exit nil))))))
20265 ;; Use `fill-paragraph' with buffer narrowed to item
20266 ;; without any child, and with our computed PREFIX.
20267 (flet ((fill-context-prefix (from to &optional flr) prefix))
20268 (save-restriction
20269 (narrow-to-region beg end)
20270 (save-excursion (fill-paragraph justify)))) t))
20271 ;; Special case where point is not in a list but is on
20272 ;; a paragraph adjacent to a list: make sure this paragraph
20273 ;; doesn't get merged with the end of the list by narrowing
20274 ;; buffer first.
20275 ((save-excursion (forward-paragraph -1)
20276 (setq itemp (org-in-item-p)))
20277 (let ((struct (save-excursion (goto-char itemp)
20278 (org-list-struct))))
20279 (save-restriction
20280 (narrow-to-region (org-list-get-bottom-point struct)
20281 (save-excursion (forward-paragraph 1)
20282 (point)))
20283 (fill-paragraph justify) t)))
20284 ;; Else simply call `fill-paragraph'.
20285 (t nil))))
20287 ;; For reference, this is the default value of adaptive-fill-regexp
20290 (defun org-adaptive-fill-function ()
20291 "Return a fill prefix for org-mode files."
20292 (let (itemp)
20293 (save-excursion
20294 (cond
20295 ;; Comment line
20297 (match-string-no-properties 0))
20298 ;; Plain list item
20299 ((org-at-item-p)
20300 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20301 ;; Point is in a list after `backward-paragraph': original
20302 ;; point wasn't in the list, or filling would have been taken
20303 ;; care of by `org-auto-fill-function', but the list and the
20304 ;; real paragraph are not separated by a blank line. Thus, move
20305 ;; point after the list to go back to real paragraph and
20306 ;; determine fill-prefix.
20307 ((setq itemp (org-in-item-p))
20308 (goto-char itemp)
20309 (let* ((struct (org-list-struct))
20310 (bottom (org-list-get-bottom-point struct)))
20311 (goto-char bottom)
20312 (make-string (org-get-indentation) ?\ )))
20313 ;; Other text
20314 ((looking-at org-adaptive-fill-regexp-backup)
20315 (match-string-no-properties 0))))))
20317 (defun org-auto-fill-function ()
20318 "Auto-fill function."
20319 (let (itemp prefix)
20320 ;; When in a list, compute an appropriate fill-prefix and make
20321 ;; sure it will be used by `do-auto-fill'.
20322 (if (setq itemp (org-in-item-p))
20323 (progn
20324 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20325 (flet ((fill-context-prefix (from to &optional flr) prefix))
20326 (do-auto-fill)))
20327 ;; Else just use `do-auto-fill'.
20328 (do-auto-fill))))
20330 ;;; Other stuff.
20332 (defun org-toggle-fixed-width-section (arg)
20333 "Toggle the fixed-width export.
20334 If there is no active region, the QUOTE keyword at the current headline is
20335 inserted or removed. When present, it causes the text between this headline
20336 and the next to be exported as fixed-width text, and unmodified.
20337 If there is an active region, this command adds or removes a colon as the
20338 first character of this line. If the first character of a line is a colon,
20339 this line is also exported in fixed-width font."
20340 (interactive "P")
20341 (let* ((cc 0)
20342 (regionp (org-region-active-p))
20343 (beg (if regionp (region-beginning) (point)))
20344 (end (if regionp (region-end)))
20345 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20346 (case-fold-search nil)
20348 off)
20349 (if regionp
20350 (save-excursion
20351 (goto-char beg)
20352 (setq cc (current-column))
20353 (beginning-of-line 1)
20354 (setq off (looking-at re))
20355 (while (> nlines 0)
20356 (setq nlines (1- nlines))
20357 (beginning-of-line 1)
20358 (cond
20359 (arg
20360 (org-move-to-column cc t)
20362 (forward-line -1))
20363 ((and off (looking-at re))
20364 (replace-match "" t t nil 1))
20365 ((not off) (org-move-to-column cc t) (insert ": ")))
20366 (forward-line 1)))
20367 (save-excursion
20368 (org-back-to-heading)
20369 (cond
20370 ((looking-at (format org-heading-keyword-regexp-format
20371 org-quote-string))
20372 (goto-char (match-end 1))
20373 (looking-at (concat " +" org-quote-string))
20374 (replace-match "" t t)
20375 (when (eolp) (insert " ")))
20376 ((looking-at org-outline-regexp)
20377 (goto-char (match-end 0))
20378 (insert org-quote-string " ")))))))
20380 (defun org-reftex-citation ()
20381 "Use reftex-citation to insert a citation into the buffer.
20382 This looks for a line like
20384 #+BIBLIOGRAPHY: foo plain option:-d
20386 and derives from it that foo.bib is the bibliography file relevant
20387 for this document. It then installs the necessary environment for RefTeX
20388 to work in this buffer and calls `reftex-citation' to insert a citation
20389 into the buffer.
20391 Export of such citations to both LaTeX and HTML is handled by the contributed
20392 package org-exp-bibtex by Taru Karttunen."
20393 (interactive)
20394 (let ((reftex-docstruct-symbol 'rds)
20396 rds bib)
20397 (save-excursion
20398 (save-restriction
20399 (widen)
20400 (let ((case-fold-search t)
20402 (if (not (save-excursion
20403 (or (re-search-forward re nil t)
20404 (re-search-backward re nil t))))
20405 (error "No bibliography defined in file")
20406 (setq bib (concat (match-string 1) ".bib")
20407 rds (list (list 'bib bib)))))))
20408 (call-interactively 'reftex-citation)))
20410 ;;;; Functions extending outline functionality
20412 (defun org-beginning-of-line (&optional arg)
20413 "Go to the beginning of the current line. If that is invisible, continue
20414 to a visible line beginning. This makes the function of C-a more intuitive.
20415 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20416 first attempt, and only move to after the tags when the cursor is already
20417 beyond the end of the headline."
20418 (interactive "P")
20419 (let ((pos (point))
20420 (special (if (consp org-special-ctrl-a/e)
20421 (car org-special-ctrl-a/e)
20422 org-special-ctrl-a/e))
20423 refpos)
20424 (if (org-bound-and-true-p line-move-visual)
20425 (beginning-of-visual-line 1)
20426 (beginning-of-line 1))
20427 (if (and arg (fboundp 'move-beginning-of-line))
20428 (call-interactively 'move-beginning-of-line)
20429 (if (bobp)
20430 nil
20431 (backward-char 1)
20432 (if (org-truely-invisible-p)
20433 (while (and (not (bobp)) (org-truely-invisible-p))
20434 (backward-char 1)
20435 (beginning-of-line 1))
20436 (forward-char 1))))
20437 (when special
20438 (cond
20439 ((and (looking-at org-complex-heading-regexp)
20440 (= (char-after (match-end 1)) ?\ ))
20441 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20442 (point-at-eol)))
20443 (goto-char
20444 (if (eq special t)
20445 (cond ((> pos refpos) refpos)
20446 ((= pos (point)) refpos)
20447 (t (point)))
20448 (cond ((> pos (point)) (point))
20449 ((not (eq last-command this-command)) (point))
20450 (t refpos)))))
20451 ((org-at-item-p)
20452 ;; Being at an item and not looking at an the item means point
20453 ;; was previously moved to beginning of a visual line, whiche
20454 ;; doesn't contain the item. Therefore, do nothing special,
20455 ;; just stay here.
20456 (when (looking-at org-list-full-item-re)
20457 ;; Set special position at first white space character after
20458 ;; bullet, and check-box, if any.
20459 (let ((after-bullet
20460 (let ((box (match-end 3)))
20461 (if (not box) (match-end 1)
20462 (let ((after (char-after box)))
20463 (if (and after (= after ? )) (1+ box) box))))))
20464 ;; Special case: Move point to special position when
20465 ;; currently after it or at beginning of line.
20466 (if (eq special t)
20467 (when (or (> pos after-bullet) (= (point) pos))
20468 (goto-char after-bullet))
20469 ;; Reversed case: Move point to special position when
20470 ;; point was already at beginning of line and command is
20471 ;; repeated.
20472 (when (and (= (point) pos) (eq last-command this-command))
20473 (goto-char after-bullet))))))))
20474 (org-no-warnings
20475 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20477 (defun org-end-of-line (&optional arg)
20478 "Go to the end of the line.
20479 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20480 first attempt, and only move to after the tags when the cursor is already
20481 beyond the end of the headline."
20482 (interactive "P")
20483 (let ((special (if (consp org-special-ctrl-a/e)
20484 (cdr org-special-ctrl-a/e)
20485 org-special-ctrl-a/e)))
20486 (cond
20487 ((or (not special) arg
20488 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20489 (call-interactively
20490 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20491 ((fboundp 'move-end-of-line) 'move-end-of-line)
20492 (t 'end-of-line))))
20493 ((org-at-heading-p)
20494 (let ((pos (point)))
20495 (beginning-of-line 1)
20497 (if (eq special t)
20498 (if (or (< pos (match-beginning 1))
20499 (= pos (match-end 0)))
20500 (goto-char (match-beginning 1))
20501 (goto-char (match-end 0)))
20502 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20503 (goto-char (match-end 0))
20504 (goto-char (match-beginning 1))))
20505 (call-interactively (if (fboundp 'move-end-of-line)
20506 'move-end-of-line
20507 'end-of-line)))))
20508 ((org-at-drawer-p)
20509 (move-end-of-line 1)
20510 (when (overlays-at (1- (point))) (backward-char 1)))
20511 ;; At an item: Move before any hidden text.
20512 (t (call-interactively
20513 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20514 ((fboundp 'move-end-of-line) 'move-end-of-line)
20515 (t 'end-of-line)))))
20516 (org-no-warnings
20517 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20519 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20520 (define-key org-mode-map "\C-e" 'org-end-of-line)
20522 (defun org-backward-sentence (&optional arg)
20523 "Go to beginning of sentence, or beginning of table field.
20524 This will call `backward-sentence' or `org-table-beginning-of-field',
20525 depending on context."
20526 (interactive "P")
20527 (cond
20528 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20529 (t (call-interactively 'backward-sentence))))
20531 (defun org-forward-sentence (&optional arg)
20532 "Go to end of sentence, or end of table field.
20533 This will call `forward-sentence' or `org-table-end-of-field',
20534 depending on context."
20535 (interactive "P")
20536 (cond
20537 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20538 (t (call-interactively 'forward-sentence))))
20540 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20541 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20543 (defun org-kill-line (&optional arg)
20544 "Kill line, to tags or end of line."
20545 (interactive "P")
20546 (cond
20547 ((or (not org-special-ctrl-k)
20548 (bolp)
20549 (not (org-at-heading-p)))
20550 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20551 org-ctrl-k-protect-subtree)
20552 (if (or (eq org-ctrl-k-protect-subtree 'error)
20553 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20554 (error "C-k aborted - would kill hidden subtree")))
20555 (call-interactively 'kill-line))
20557 (kill-region (point) (match-beginning 1))
20558 (org-set-tags nil t))
20559 (t (kill-region (point) (point-at-eol)))))
20561 (define-key org-mode-map "\C-k" 'org-kill-line)
20563 (defun org-yank (&optional arg)
20564 "Yank. If the kill is a subtree, treat it specially.
20565 This command will look at the current kill and check if is a single
20566 subtree, or a series of subtrees[1]. If it passes the test, and if the
20567 cursor is at the beginning of a line or after the stars of a currently
20568 empty headline, then the yank is handled specially. How exactly depends
20569 on the value of the following variables, both set by default.
20571 org-yank-folded-subtrees
20572 When set, the subtree(s) will be folded after insertion, but only
20573 if doing so would now swallow text after the yanked text.
20575 org-yank-adjusted-subtrees
20576 When set, the subtree will be promoted or demoted in order to
20577 fit into the local outline tree structure, which means that the level
20578 will be adjusted so that it becomes the smaller one of the two
20579 *visible* surrounding headings.
20581 Any prefix to this command will cause `yank' to be called directly with
20583 will just
20584 plainly yank the text as it is.
20586 \[1] The test checks if the first non-white line is a heading
20587 and if there are no other headings with fewer stars."
20588 (interactive "P")
20589 (org-yank-generic 'yank arg))
20591 (defun org-yank-generic (command arg)
20592 "Perform some yank-like command.
20594 This function implements the behavior described in the `org-yank'
20595 documentation. However, it has been generalized to work for any
20596 interactive command with similar behavior."
20598 ;; pretend to be command COMMAND
20599 (setq this-command command)
20601 (if arg
20602 (call-interactively command)
20604 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20605 (and (org-kill-is-subtree-p)
20606 (or (bolp)
20608 (string-match
20610 (buffer-substring (point-at-bol) (point)))))))
20611 swallowp)
20612 (cond
20613 ((and subtreep org-yank-folded-subtrees)
20614 (let ((beg (point))
20615 end)
20616 (if (and subtreep org-yank-adjusted-subtrees)
20617 (org-paste-subtree nil nil 'for-yank)
20618 (call-interactively command))
20620 (setq end (point))
20621 (goto-char beg)
20622 (when (and (bolp) subtreep
20623 (not (setq swallowp
20624 (org-yank-folding-would-swallow-text beg end))))
20625 (org-with-limited-levels
20626 (or (looking-at org-outline-regexp)
20627 (re-search-forward org-outline-regexp-bol end t))
20628 (while (and (< (point) end) (looking-at org-outline-regexp))
20629 (hide-subtree)
20630 (org-cycle-show-empty-lines 'folded)
20631 (condition-case nil
20632 (outline-forward-same-level 1)
20633 (error (goto-char end))))))
20634 (when swallowp
20635 (message
20636 "Inserted text not folded because that would swallow text"))
20638 (goto-char end)
20640 (beginning-of-line 1)
20641 (push-mark beg 'nomsg)))
20642 ((and subtreep org-yank-adjusted-subtrees)
20643 (let ((beg (point-at-bol)))
20644 (org-paste-subtree nil nil 'for-yank)
20645 (push-mark beg 'nomsg)))
20646 (t
20647 (call-interactively command))))))
20649 (defun org-yank-folding-would-swallow-text (beg end)
20650 "Would hide-subtree at BEG swallow any text after END?"
20651 (let (level)
20652 (org-with-limited-levels
20653 (save-excursion
20654 (goto-char beg)
20655 (when (or (looking-at org-outline-regexp)
20656 (re-search-forward org-outline-regexp-bol end t))
20657 (setq level (org-outline-level)))
20658 (goto-char end)
20660 (if (or (eobp)
20661 (and (bolp) (looking-at org-outline-regexp)
20662 (<= (org-outline-level) level)))
20663 nil ; Nothing would be swallowed
20664 t))))) ; something would swallow
20666 (define-key org-mode-map "\C-y" 'org-yank)
20668 (defun org-truely-invisible-p ()
20669 "Check if point is at a character currently not visible.
20670 This version does not only check the character property, but also
20671 `visible-mode'."
20672 ;; Early versions of noutline don't have `outline-invisible-p'.
20673 (if (org-bound-and-true-p visible-mode)
20674 nil
20675 (outline-invisible-p)))
20677 (defun org-invisible-p2 ()
20678 "Check if point is at a character currently not visible."
20679 (save-excursion
20680 (if (and (eolp) (not (bobp))) (backward-char 1))
20681 ;; Early versions of noutline don't have `outline-invisible-p'.
20682 (outline-invisible-p)))
20684 (defun org-back-to-heading (&optional invisible-ok)
20685 "Call `outline-back-to-heading', but provide a better error message."
20686 (condition-case nil
20687 (outline-back-to-heading invisible-ok)
20688 (error (error "Before first headline at position %d in buffer %s"
20689 (point) (current-buffer)))))
20691 (defun org-beginning-of-defun ()
20692 "Go to the beginning of the subtree, i.e. back to the heading."
20693 (org-back-to-heading))
20694 (defun org-end-of-defun ()
20695 "Go to the end of the subtree."
20696 (org-end-of-subtree nil t))
20698 (defun org-before-first-heading-p ()
20699 "Before first heading?"
20700 (save-excursion
20701 (end-of-line)
20702 (null (re-search-backward org-outline-regexp-bol nil t))))
20704 (defun org-at-heading-p (&optional ignored)
20705 (outline-on-heading-p t))
20706 ;; Compatibility alias with Org versions < 7.8.03
20707 (defalias 'org-on-heading-p 'org-at-heading-p)
20709 (defun org-at-drawer-p nil
20710 "Whether point is at a drawer."
20711 (save-excursion
20712 (move-beginning-of-line 1)
20713 (looking-at org-drawer-regexp)))
20715 (defun org-point-at-end-of-empty-headline ()
20716 "If point is at the end of an empty headline, return t, else nil.
20717 If the heading only contains a TODO keyword, it is still still considered
20718 empty."
20720 (save-excursion
20721 (beginning-of-line 1)
20722 (let ((case-fold-search nil))
20723 (looking-at org-todo-line-regexp)))
20724 (string= (match-string 3) "")))
20726 (defun org-at-heading-or-item-p ()
20727 (or (org-at-heading-p) (org-at-item-p)))
20729 (defun org-at-target-p ()
20730 (or (org-in-regexp org-radio-target-regexp)
20731 (org-in-regexp org-target-regexp)))
20732 ;; Compatibility alias with Org versions < 7.8.03
20733 (defalias 'org-on-target-p 'org-at-target-p)
20735 (defun org-up-heading-all (arg)
20736 "Move to the heading line of which the present line is a subheading.
20737 This function considers both visible and invisible heading lines.
20738 With argument, move up ARG levels."
20739 (if (fboundp 'outline-up-heading-all)
20740 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20741 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20743 (defun org-up-heading-safe ()
20744 "Move to the heading line of which the present line is a subheading.
20745 This version will not throw an error. It will return the level of the
20746 headline found, or nil if no higher level is found.
20748 Also, this function will be a lot faster than `outline-up-heading',
20749 because it relies on stars being the outline starters. This can really
20750 make a significant difference in outlines with very many siblings."
20751 (let (start-level re)
20752 (org-back-to-heading t)
20753 (setq start-level (funcall outline-level))
20754 (if (equal start-level 1)
20755 nil
20757 (if (re-search-backward re nil t)
20758 (funcall outline-level)))))
20760 (defun org-first-sibling-p ()
20761 "Is this heading the first child of its parents?"
20762 (interactive)
20763 (let ((re org-outline-regexp-bol)
20764 level l)
20765 (unless (org-at-heading-p t)
20766 (error "Not at a heading"))
20767 (setq level (funcall outline-level))
20768 (save-excursion
20769 (if (not (re-search-backward re nil t))
20770 t
20771 (setq l (funcall outline-level))
20772 (< l level)))))
20774 (defun org-goto-sibling (&optional previous)
20775 "Goto the next sibling, even if it is invisible.
20776 When PREVIOUS is set, go to the previous sibling instead. Returns t
20777 when a sibling was found. When none is found, return nil and don't
20778 move point."
20779 (let ((fun (if previous 're-search-backward 're-search-forward))
20780 (pos (point))
20781 (re org-outline-regexp-bol)
20782 level l)
20783 (when (condition-case nil (org-back-to-heading t) (error nil))
20784 (setq level (funcall outline-level))
20785 (catch 'exit
20786 (or previous (forward-char 1))
20787 (while (funcall fun re nil t)
20788 (setq l (funcall outline-level))
20789 (when (< l level) (goto-char pos) (throw 'exit nil))
20790 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20791 (goto-char pos)
20792 nil))))
20794 (defun org-show-siblings ()
20795 "Show all siblings of the current headline."
20796 (save-excursion
20797 (while (org-goto-sibling) (org-flag-heading nil)))
20798 (save-excursion
20799 (while (org-goto-sibling 'previous)
20800 (org-flag-heading nil))))
20802 (defun org-goto-first-child ()
20803 "Goto the first child, even if it is invisible.
20804 Return t when a child was found. Otherwise don't move point and
20805 return nil."
20806 (let (level (pos (point)) (re org-outline-regexp-bol))
20807 (when (condition-case nil (org-back-to-heading t) (error nil))
20808 (setq level (outline-level))
20809 (forward-char 1)
20810 (if (and (re-search-forward re nil t) (> (outline-level) level))
20811 (progn (goto-char (match-beginning 0)) t)
20812 (goto-char pos) nil))))
20814 (defun org-show-hidden-entry ()
20815 "Show an entry where even the heading is hidden."
20816 (save-excursion
20817 (org-show-entry)))
20819 (defun org-flag-heading (flag &optional entry)
20820 "Flag the current heading. FLAG non-nil means make invisible.
20821 When ENTRY is non-nil, show the entire entry."
20822 (save-excursion
20823 (org-back-to-heading t)
20824 ;; Check if we should show the entire entry
20825 (if entry
20826 (progn
20827 (org-show-entry)
20828 (save-excursion
20829 (and (outline-next-heading)
20830 (org-flag-heading nil))))
20831 (outline-flag-region (max (point-min) (1- (point)))
20832 (save-excursion (outline-end-of-heading) (point))
20833 flag))))
20835 (defun org-get-next-sibling ()
20836 "Move to next heading of the same level, and return point.
20837 If there is no such heading, return nil.
20838 This is like outline-next-sibling, but invisible headings are ok."
20839 (let ((level (funcall outline-level)))
20840 (outline-next-heading)
20841 (while (and (not (eobp)) (> (funcall outline-level) level))
20842 (outline-next-heading))
20843 (if (or (eobp) (< (funcall outline-level) level))
20844 nil
20845 (point))))
20847 (defun org-get-last-sibling ()
20848 "Move to previous heading of the same level, and return point.
20849 If there is no such heading, return nil."
20850 (let ((opoint (point))
20851 (level (funcall outline-level)))
20852 (outline-previous-heading)
20853 (when (and (/= (point) opoint) (outline-on-heading-p t))
20854 (while (and (> (funcall outline-level) level)
20855 (not (bobp)))
20856 (outline-previous-heading))
20857 (if (< (funcall outline-level) level)
20858 nil
20859 (point)))))
20861 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20862 ;; This contains an exact copy of the original function, but it uses
20863 ;; `org-back-to-heading', to make it work also in invisible
20864 ;; trees. And is uses an invisible-OK argument.
20865 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20866 ;; Furthermore, when used inside Org, finding the end of a large subtree
20867 ;; with many children and grandchildren etc, this can be much faster
20868 ;; than the outline version.
20869 (org-back-to-heading invisible-OK)
20870 (let ((first t)
20871 (level (funcall outline-level)))
20872 (if (and (eq major-mode 'org-mode) (< level 1000))
20873 ;; A true heading (not a plain list item), in Org-mode
20874 ;; This means we can easily find the end by looking
20875 ;; only for the right number of stars. Using a regexp to do
20876 ;; this is so much faster than using a Lisp loop.
20878 (forward-char 1)
20879 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20880 ;; something else, do it the slow way
20881 (while (and (not (eobp))
20882 (or first (> (funcall outline-level) level)))
20883 (setq first nil)
20884 (outline-next-heading)))
20885 (unless to-heading
20887 (progn
20888 ;; Go to end of line before heading
20889 (forward-char -1)
20891 ;; leave blank line before heading
20892 (forward-char -1))))))
20893 (point))
20895 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20896 "Use Org version in org-mode, for dramatic speed-up."
20897 (if (eq major-mode 'org-mode)
20898 (progn
20899 (org-end-of-subtree nil t)
20900 (unless (eobp) (backward-char 1)))
20901 ad-do-it))
20903 (defun org-end-of-meta-data-and-drawers ()
20904 "Jump to the first text after meta data and drawers in the current entry.
20905 This will move over empty lines, lines with planning time stamps,
20906 clocking lines, and drawers."
20907 (org-back-to-heading t)
20908 (let ((end (save-excursion (outline-next-heading) (point)))
20911 (forward-line 1)
20912 (while (re-search-forward re end t)
20913 (if (not (match-end 1))
20914 ;; empty or planning line
20915 (forward-line 1)
20916 ;; a drawer, find the end
20918 (forward-line 1)))
20920 (point)))
20922 (defun org-forward-same-level (arg &optional invisible-ok)
20923 "Move forward to the arg'th subheading at same level as this one.
20924 Stop at the first and last subheadings of a superior heading.
20925 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20926 it wil also look at invisible ones."
20927 (interactive "p")
20928 (org-back-to-heading invisible-ok)
20929 (org-at-heading-p)
20930 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20932 l)
20933 (forward-char 1)
20934 (while (> arg 0)
20935 (while (and (re-search-forward re nil 'move)
20936 (setq l (- (match-end 0) (match-beginning 0) 1))
20937 (= l level)
20938 (not invisible-ok)
20939 (progn (backward-char 1) (outline-invisible-p)))
20940 (if (< l level) (setq arg 1)))
20941 (setq arg (1- arg)))
20942 (beginning-of-line 1)))
20944 (defun org-backward-same-level (arg &optional invisible-ok)
20945 "Move backward to the arg'th subheading at same level as this one.
20946 Stop at the first and last subheadings of a superior heading."
20947 (interactive "p")
20948 (org-back-to-heading)
20949 (org-at-heading-p)
20950 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20952 l)
20953 (while (> arg 0)
20954 (while (and (re-search-backward re nil 'move)
20955 (setq l (- (match-end 0) (match-beginning 0) 1))
20956 (= l level)
20957 (not invisible-ok)
20958 (outline-invisible-p))
20959 (if (< l level) (setq arg 1)))
20960 (setq arg (1- arg)))))
20962 (defun org-show-subtree ()
20963 "Show everything after this heading at deeper levels."
20964 (outline-flag-region
20965 (point)
20966 (save-excursion
20967 (org-end-of-subtree t t))
20968 nil))
20970 (defun org-show-entry ()
20971 "Show the body directly following this heading.
20972 Show the heading too, if it is currently invisible."
20973 (interactive)
20974 (save-excursion
20975 (condition-case nil
20976 (progn
20977 (org-back-to-heading t)
20978 (outline-flag-region
20979 (max (point-min) (1- (point)))
20980 (save-excursion
20981 (if (re-search-forward
20983 (match-beginning 1)
20984 (point-max)))
20985 nil)
20986 (org-cycle-hide-drawers 'children))
20987 (error nil))))
20989 (defun org-make-options-regexp (kwds &optional extra)
20990 "Make a regular expression for keyword lines."
20991 (concat
20992 "^"
20999 ;; Make isearch reveal the necessary context
21000 (defun org-isearch-end ()
21001 "Reveal context after isearch exits."
21002 (when isearch-success ; only if search was successful
21003 (if (featurep 'xemacs)
21004 ;; Under XEmacs, the hook is run in the correct place,
21005 ;; we directly show the context.
21006 (org-show-context 'isearch)
21007 ;; In Emacs the hook runs *before* restoring the overlays.
21008 ;; So we have to use a one-time post-command-hook to do this.
21009 ;; (Emacs 22 has a special variable, see function `org-mode')
21010 (unless (and (boundp 'isearch-mode-end-hook-quit)
21011 isearch-mode-end-hook-quit)
21012 ;; Only when the isearch was not quitted.
21013 (org-add-hook 'post-command-hook 'org-isearch-post-command
21014 'append 'local)))))
21016 (defun org-isearch-post-command ()
21017 "Remove self from hook, and show context."
21018 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21019 (org-show-context 'isearch))
21022 ;;;; Integration with and fixes for other packages
21024 ;;; Imenu support
21026 (defvar org-imenu-markers nil
21027 "All markers currently used by Imenu.")
21028 (make-variable-buffer-local 'org-imenu-markers)
21030 (defun org-imenu-new-marker (&optional pos)
21031 "Return a new marker for use by Imenu, and remember the marker."
21032 (let ((m (make-marker)))
21033 (move-marker m (or pos (point)))
21034 (push m org-imenu-markers)
21035 m))
21037 (defun org-imenu-get-tree ()
21038 "Produce the index for Imenu."
21039 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21040 (setq org-imenu-markers nil)
21041 (let* ((n org-imenu-depth)
21042 (re (concat "^" (org-get-limited-outline-regexp)))
21043 (subs (make-vector (1+ n) nil))
21044 (last-level 0)
21045 m level head)
21046 (save-excursion
21047 (save-restriction
21048 (widen)
21049 (goto-char (point-max))
21050 (while (re-search-backward re nil t)
21051 (setq level (org-reduced-level (funcall outline-level)))
21052 (when (<= level n)
21053 (looking-at org-complex-heading-regexp)
21054 (setq head (org-link-display-format
21055 (org-match-string-no-properties 4))
21056 m (org-imenu-new-marker))
21057 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21058 (if (>= level last-level)
21059 (push (cons head m) (aref subs level))
21060 (push (cons head (aref subs (1+ level))) (aref subs level))
21061 (loop for i from (1+ level) to n do (aset subs i nil)))
21062 (setq last-level level)))))
21063 (aref subs 1)))
21065 (eval-after-load "imenu"
21066 '(progn
21067 (add-hook 'imenu-after-jump-hook
21068 (lambda ()
21069 (if (eq major-mode 'org-mode)
21070 (org-show-context 'org-goto))))))
21072 (defun org-link-display-format (link)
21073 "Replace a link with either the description, or the link target
21074 if no description is present"
21075 (save-match-data
21076 (if (string-match org-bracket-link-analytic-regexp link)
21077 (replace-match (if (match-end 5)
21078 (match-string 5 link)
21079 (concat (match-string 1 link)
21080 (match-string 3 link)))
21081 nil t link)
21082 link)))
21084 (defun org-toggle-link-display ()
21085 "Toggle the literal or descriptive display of links."
21086 (interactive)
21087 (if org-descriptive-links
21088 (progn (org-remove-from-invisibility-spec '(org-link))
21089 (org-restart-font-lock)
21090 (setq org-descriptive-links nil))
21091 (progn (add-to-invisibility-spec '(org-link))
21092 (org-restart-font-lock)
21093 (setq org-descriptive-links t))))
21095 ;; Speedbar support
21097 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21098 "Overlay marking the agenda restriction line in speedbar.")
21099 (overlay-put org-speedbar-restriction-lock-overlay
21100 'face 'org-agenda-restriction-lock)
21101 (overlay-put org-speedbar-restriction-lock-overlay
21102 'help-echo "Agendas are currently limited to this item.")
21103 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21105 (defun org-speedbar-set-agenda-restriction ()
21106 "Restrict future agenda commands to the location at point in speedbar.
21108 (interactive)
21109 (require 'org-agenda)
21110 (let (p m tp np dir txt)
21111 (cond
21112 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21113 'org-imenu t))
21114 (setq m (get-text-property p 'org-imenu-marker))
21115 (with-current-buffer (marker-buffer m)
21116 (goto-char m)
21117 (org-agenda-set-restriction-lock 'subtree)))
21118 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21119 'speedbar-function 'speedbar-find-file))
21120 (setq tp (previous-single-property-change
21121 (1+ p) 'speedbar-function)
21122 np (next-single-property-change
21123 tp 'speedbar-function)
21124 dir (speedbar-line-directory)
21125 txt (buffer-substring-no-properties (or tp (point-min))
21126 (or np (point-max))))
21127 (with-current-buffer (find-file-noselect
21128 (let ((default-directory dir))
21129 (expand-file-name txt)))
21130 (unless (eq major-mode 'org-mode)
21131 (error "Cannot restrict to non-Org-mode file"))
21132 (org-agenda-set-restriction-lock 'file)))
21133 (t (error "Don't know how to restrict Org-mode's agenda")))
21134 (move-overlay org-speedbar-restriction-lock-overlay
21135 (point-at-bol) (point-at-eol))
21136 (setq current-prefix-arg nil)
21137 (org-agenda-maybe-redo)))
21139 (eval-after-load "speedbar"
21140 '(progn
21141 (speedbar-add-supported-extension ".org")
21142 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21143 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21144 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21145 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21146 (add-hook 'speedbar-visiting-tag-hook
21147 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21149 ;;; Fixes and Hacks for problems with other packages
21151 ;; Make flyspell not check words in links, to not mess up our keymap
21152 (defun org-mode-flyspell-verify ()
21153 "Don't let flyspell put overlays at active buttons, or on
21154 {todo,all-time,additional-option-like}-keywords."
21155 (let ((pos (max (1- (point)) (point-min)))
21156 (word (thing-at-point 'word)))
21157 (and (not (get-text-property pos 'keymap))
21158 (not (get-text-property pos 'org-no-flyspell))
21159 (not (member word org-todo-keywords-1))
21160 (not (member word org-all-time-keywords))
21161 (not (member word org-additional-option-like-keywords)))))
21163 (defun org-remove-flyspell-overlays-in (beg end)
21164 "Remove flyspell overlays in region."
21165 (and (org-bound-and-true-p flyspell-mode)
21166 (fboundp 'flyspell-delete-region-overlays)
21167 (flyspell-delete-region-overlays beg end))
21168 (add-text-properties beg end '(org-no-flyspell t)))
21170 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21171 (eval-after-load "bookmark"
21172 '(if (boundp 'bookmark-after-jump-hook)
21173 ;; We can use the hook
21174 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21175 ;; Hook not available, use advice
21176 (defadvice bookmark-jump (after org-make-visible activate)
21177 "Make the position visible."
21178 (org-bookmark-jump-unhide))))
21180 ;; Make sure saveplace shows the location if it was hidden
21181 (eval-after-load "saveplace"
21182 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21183 "Make the position visible."
21184 (org-bookmark-jump-unhide)))
21186 ;; Make sure ecb shows the location if it was hidden
21187 (eval-after-load "ecb"
21188 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21189 "Make hierarchy visible when jumping into location from ECB tree buffer."
21190 (if (eq major-mode 'org-mode)
21191 (org-show-context))))
21193 (defun org-bookmark-jump-unhide ()
21194 "Unhide the current position, to show the bookmark location."
21195 (and (eq major-mode 'org-mode)
21196 (or (outline-invisible-p)
21197 (save-excursion (goto-char (max (point-min) (1- (point))))
21198 (outline-invisible-p)))
21199 (org-show-context 'bookmark-jump)))
21201 ;; Make session.el ignore our circular variable
21202 (eval-after-load "session"
21203 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21205 ;;;; Experimental code
21207 (defun org-closed-in-range ()
21208 "Sparse tree of items closed in a certain time range.
21209 Still experimental, may disappear in the future."
21210 (interactive)
21211 ;; Get the time interval from the user.
21212 (let* ((time1 (org-float-time
21213 (org-read-date nil 'to-time nil "Starting date: ")))
21214 (time2 (org-float-time
21215 (org-read-date nil 'to-time nil "End date:")))
21216 ;; callback function
21217 (callback (lambda ()
21218 (let ((time
21219 (org-float-time
21220 (apply 'encode-time
21221 (org-parse-time-string
21222 (match-string 1))))))
21223 ;; check if time in interval
21224 (and (>= time time1) (<= time time2))))))
21225 ;; make tree, check each match with the callback
21228 ;;;; Finish up
21230 (provide 'org)
21232 (run-hooks 'org-load-hook)
21234 ;;; org.el ends here