| blob | 3078edaa3c00dfdac261ffa1b20a1c66eb70d914 |
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.06
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
80 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
92 ;; Other stuff we need.
110 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
115 ;; babel
124 ;; load languages based on value of `org-babel-load-languages'
126 ;;;###autoload
128 "Load the languages defined in `org-babel-load-languages'."
140 org-babel-load-languages))
143 "Languages which can be evaluated in Org-mode buffers.
144 This list can be used to load support for any of the languages
145 below, note that each language will depend on a different set of
146 system executables and/or Emacs modes. When a language is
148 with `org-babel-execute-src-block' bound by default to C-c
149 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
150 be set to remove code block evaluation from the C-c C-c
151 keybinding. By default only Emacs Lisp (which has no
152 requirements) is loaded."
156 :key-type
196 ;;;; Customization variables
198 "Remove ID property of clones of a subtree.
199 When non-nil, clones of a subtree don't inherit the ID property.
200 Otherwise they inherit the ID property with a new unique
201 identifier."
205 ;;; Version
210 ;;;###autoload
212 "Show the org-mode version in the echo area.
213 With prefix arg HERE, insert it at point."
239 ;;; Compatibility constants
241 ;;; The custom variables
244 "Outline-based notes management and organizer."
250 "Mode hook for Org-mode, run after the mode was turned on."
255 "Hook that is run after org.el has been loaded."
260 "Hook that is run after an Org log buffer is created."
269 "Load all extensions listed in `org-modules'."
274 org-modules)
278 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
287 (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)
288 "Modules that should always be loaded together with org.el.
289 If a description starts with <C>, the file is not part of Emacs
290 and loading it will require that you have downloaded and properly installed
291 the org-mode distribution.
293 You can also use this system to load external packages (i.e. neither Org
294 core modules, nor modules from the CONTRIB directory). Just add symbols
295 to the end of the list. If the package is called org-xyz.el, then you need
296 to add the symbol `xyz', and the package must have a call to
298 (provide 'org-xyz)"
301 :type
332 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
341 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
350 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
366 "Non-nil means make shift-cursor commands select text when possible.
368 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
369 start selecting a region, or enlarge regions started in this way.
370 In Org-mode, in special contexts, these same keys are used for
371 other purposes, important enough to compete with shift selection.
372 Org tries to balance these needs by supporting `shift-select-mode'
373 outside these special contexts, under control of this variable.
375 The default of this variable is nil, to avoid confusing behavior. Shifted
376 cursor keys will then execute Org commands in the following contexts:
377 - on a headline, changing TODO state (left/right) and priority (up/down)
378 - on a time stamp, changing the time
379 - in a plain list item, changing the bullet type
380 - in a property definition line, switching between allowed values
381 - in the BEGIN line of a clock table (changing the time block).
382 Outside these contexts, the commands will throw an error.
384 When this variable is t and the cursor is not in a special
385 context, Org-mode will support shift-selection for making and
386 enlarging regions. To make this more effective, the bullet
387 cycling will no longer happen anywhere in an item line, but only
388 if the cursor is exactly on the bullet.
390 If you set this variable to the symbol `always', then the keys
391 will not be special in headlines, property lines, and item lines,
392 to make shift selection work there as well. If this is what you
393 want, you can use the following alternative commands: `C-c C-t'
394 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
395 can be used to switch TODO sets, `C-c -' to cycle item bullet
396 types, and properties can be edited by hand or in column view.
398 However, when the cursor is on a timestamp, shift-cursor commands
399 will still edit the time stamp - this is just too good to give up.
401 XEmacs user should have this variable set to nil, because
402 `shift-select-mode' is in Emacs 23 or later only."
410 "Shall some commands act upon headlines in the active region?
412 When set to `t', some commands will be performed in all headlines
413 within the active region.
415 When set to `start-level', some commands will be performed in all
416 headlines within the active region, provided that these headlines
417 are of the same level than the first one.
419 When set to a string, those commands will be performed on the
420 matching headlines within the active region. Such string must be
421 a tags/property/todo match as it is used in the agenda tags view.
423 The list of commands is: `org-schedule', `org-deadline',
424 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
425 `org-archive-to-archive-sibling'. The archiving commands skip
426 already archived entries."
435 "Options concerning startup of Org-mode."
440 "Non-nil means entering Org-mode will switch to OVERVIEW.
441 This can also be configured on a per-file basis by adding one of
442 the following lines anywhere in the buffer:
444 #+STARTUP: fold (or `overview', this is equivalent)
445 #+STARTUP: nofold (or `showall', this is equivalent)
446 #+STARTUP: content
447 #+STARTUP: showeverything"
456 "Non-nil means entering Org-mode will set `truncate-lines'.
457 This is useful since some lines containing links can be very long and
458 uninteresting. Also tables look terrible when wrapped."
463 "Non-nil means turn on `org-indent-mode' on startup.
464 This can also be configured on a per-file basis by adding one of
465 the following lines anywhere in the buffer:
467 #+STARTUP: indent
468 #+STARTUP: noindent"
476 When this option is turned on, you can use TeX-like syntax for sub- and
478 considered as a single item - so grouping with {} is normally not
479 needed. For example, the following things will be parsed as single
480 sub- or superscripts.
482 10^24 or 10^tau several digits will be considered 1 item.
483 10^-12 or 10^-tau a leading sign with digits or a word
484 x^2-y^3 will be read as x^2 - y^3, because items are
485 terminated by almost any nonword/nondigit char.
486 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
488 Still, ambiguity is possible - so when in doubt use {} to enclose the
489 sub/superscript. If you set this variable to the symbol `{}',
490 the braces are *required* in order to trigger interpretations as
492 frequently in plain text.
494 Not all export backends support this, but HTML does.
509 "Non-nil means turn on `org-beamer-mode' on startup.
510 This can also be configured on a per-file basis by adding one of
511 the following lines anywhere in the buffer:
513 #+STARTUP: beamer"
518 "Non-nil means align all tables when visiting a file.
519 This is useful when the column width in tables is forced with <N> cookies
520 in table fields. Such tables will look correct only after the first re-align.
521 This can also be configured on a per-file basis by adding one of
522 the following lines anywhere in the buffer:
523 #+STARTUP: align
524 #+STARTUP: noalign"
529 "Non-nil means show inline images when loading a new Org file.
530 This can also be configured on a per-file basis by adding one of
531 the following lines anywhere in the buffer:
532 #+STARTUP: inlineimages
533 #+STARTUP: noinlineimages"
538 "Non-nil means insert the first line setting Org-mode in empty files.
539 When the function `org-mode' is called interactively in an empty file, this
540 normally means that the file name does not automatically trigger Org-mode.
541 To ensure that the file will always be in Org-mode in the future, a
542 line enforcing Org-mode will be inserted into the buffer, if this option
543 has been set."
548 "Non-nil means use alternative key bindings for some keys.
549 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
550 These keys are also used by other packages like shift-selection-mode'
551 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
552 If you want to use Org-mode together with one of these other modes,
553 or more generally if you would like to move some Org-mode commands to
554 other keys, set this variable and configure the keys with the variable
555 `org-disputed-keys'.
557 This option is only relevant at load-time of Org-mode, and must be set
558 *before* org.el is loaded. Changing it requires a restart of Emacs to
559 become effective."
564 "Non-nil means use extra key sequence definitions for certain commands.
565 This happens automatically if you run XEmacs or if `window-system'
566 is nil. This variable lets you do the same manually. You must
567 set it before loading org.
569 Example: on Carbon Emacs 22 running graphically, with an external
570 keyboard on a Powerbook, the default way of setting M-left might
571 not work for either Alt or ESC. Setting this variable will make
572 it work for ESC."
586 "Keys for which Org-mode and other modes compete.
587 This is an alist, cars are the default keys, second element specifies
588 the alternative to use when `org-replace-disputed-keys' is t.
590 Keys can be specified in any syntax supported by `define-key'.
591 The value of this option takes effect only at Org-mode's startup,
592 therefore you'll have to restart Emacs to apply it after changing."
597 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
598 Or return the original if not disputed.
599 Also apply the translations defined in `org-xemacs-key-equivalents'."
604 org-disputed-keys)))
608 key)
618 "Define a key, possibly translated, as returned by `org-key'."
622 "The ellipsis to use in the Org-mode outline.
623 When nil, just use the standard three dots. When a string, use that instead,
624 When a face, use the standard 3 dots, but with the specified face.
625 The change affects only Org-mode (which will then use its own display table).
626 Changing this requires executing `M-x org-mode' in a buffer to become
627 effective."
637 "Keywords in Org-mode."
642 "String to mark deadline entries.
643 A deadline is this string, followed by a time stamp. Should be a word,
644 terminated by a colon. You can insert a schedule keyword and
646 Changes become only effective after restarting Emacs."
651 "String to mark scheduled TODO entries.
652 A schedule is this string, followed by a time stamp. Should be a word,
653 terminated by a colon. You can insert a schedule keyword and
655 Changes become only effective after restarting Emacs."
660 "String used as the prefix for timestamps logging closing a TODO entry."
665 "String used as prefix for timestamps clocking work hours on an item."
670 "Entries starting with this keyword will never be exported.
671 An entry can be toggled between COMMENT and normal with
673 Changes become only effective after restarting Emacs."
678 "Entries starting with this keyword will be exported in fixed-width font.
679 Quoting applies only to the text in the entry following the headline, and does
680 not extend beyond the next headline, even if that is lower level.
681 An entry can be toggled between QUOTE and normal with
688 "Regular expression for specifying repeated events.
692 "Options concerning the general structure of Org-mode files."
697 "Options about how to make context of a location visible."
721 "Non-nil means show full hierarchy when revealing a location.
722 Org-mode often shows locations in an org-mode file which might have
723 been invisible before. When this is set, the hierarchy of headings
724 above the exposed location is shown.
725 Turning this off for example for sparse trees makes them very compact.
726 Instead of t, this can also be an alist specifying this option for different
727 contexts. Valid contexts are
728 agenda when exposing an entry from the agenda
729 org-goto when using the command `org-goto' on key C-c C-j
730 occur-tree when using the command `org-occur' on key C-c /
731 tags-tree when constructing a sparse tree based on tags matches
732 link-search when exposing search matches associated with a link
733 mark-goto when exposing the jump goal of a mark
734 bookmark-jump when exposing a bookmark location
735 isearch when exiting from an incremental search
736 default default for all contexts not set explicitly"
741 "Non-nil means show following heading when revealing a location.
742 Org-mode often shows locations in an org-mode file which might have
743 been invisible before. When this is set, the heading following the
744 match is shown.
745 Turning this off for example for sparse trees makes them very compact,
746 but makes it harder to edit the location of the match. In such a case,
748 Instead of t, this can also be an alist specifying this option for different
749 contexts. See `org-show-hierarchy-above' for valid contexts."
754 "Non-nil means show all sibling heading when revealing a location.
755 Org-mode often shows locations in an org-mode file which might have
756 been invisible before. When this is set, the sibling of the current entry
757 heading are all made visible. If `org-show-hierarchy-above' is t,
758 the same happens on each level of the hierarchy above the current entry.
760 By default this is on for the isearch context, off for all other contexts.
761 Turning this off for example for sparse trees makes them very compact,
762 but makes it harder to edit the location of the match. In such a case,
764 Instead of t, this can also be an alist specifying this option for different
765 contexts. See `org-show-hierarchy-above' for valid contexts."
770 "Non-nil means show the entry below a headline when revealing a location.
771 Org-mode often shows locations in an org-mode file which might have
772 been invisible before. When this is set, the text below the headline that is
773 exposed is also shown.
775 By default this is off for all contexts.
776 Instead of t, this can also be an alist specifying this option for different
777 contexts. See `org-show-hierarchy-above' for valid contexts."
782 "How should indirect tree buffers be displayed?
783 This applies to indirect buffers created with the commands
785 Valid values are:
786 current-window Display in the current window
787 other-window Just display in another window.
788 dedicated-frame Create one new frame, and re-use it each time.
789 new-frame Make a new frame each time. Note that in this case
790 previously-made indirect buffers are kept, and you need to
791 kill these buffers yourself."
801 "Non-nil means activate single letter commands at beginning of a headline.
802 This may also be a function to test for appropriate locations where speed
803 commands should be active."
811 "Alist of additional speed commands.
812 This list will be checked before `org-speed-commands-default'
813 when the variable `org-use-speed-commands' is non-nil
814 and when the cursor is at the beginning of a headline.
815 The car if each entry is a string with a single letter, which must
816 be assigned to `self-insert-command' in the global map.
817 The cdr is either a command to be called interactively, a function
818 to be called, or a form to be evaluated.
819 An entry that is just a list with a single string will be interpreted
820 as a descriptive headline that will be added when listing the speed
821 commands in the Help buffer using the `?' speed command."
833 "Options concerning visibility cycling in Org-mode."
838 "Non-nil means skip CHILDREN state in entries that don't have any."
843 "Maximum level which should still be subject to visibility cycling.
844 Levels higher than this will, for cycling, be treated as text, not a headline.
845 When `org-odd-levels-only' is set, a value of N in this variable actually
846 means 2N-1 stars as the limiting headline.
847 When nil, cycle all levels.
848 Note that the limiting level of cycling is also influenced by
849 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
850 `org-inlinetask-min-level' is, cycling will be limited to levels one less
851 than its value."
858 "Names of drawers. Drawers are not opened by cycling on the headline above.
859 Drawers only open with a TAB on the drawer line itself. A drawer looks like
860 this:
861 :DRAWERNAME:
862 .....
863 :END:
865 the property API.
867 Drawers can be defined on the per-file basis with a line like:
869 #+DRAWERS: HIDDEN STATE PROPERTIES"
875 "Non-nil means entering Org-mode will fold all blocks.
876 This can also be set in on a per-file basis with
878 #+STARTUP: hideblocks
879 #+STARTUP: showblocks"
885 "Cycle globally if cursor is at beginning of buffer and not at a headline.
886 This makes it possible to do global cycling without having to use S-TAB or
888 of the buffer
889 must not be a headline - it may be empty or some other text. When used in
890 this way, `org-cycle-hook' is disables temporarily, to make sure the
891 cursor stays at the beginning of the buffer.
892 When this option is nil, don't do anything special at the beginning
893 of the buffer."
898 "Non-nil means cycle entry level or item indentation in new empty entries.
900 When the cursor is at the end of an empty headline, i.e with only stars
901 and maybe a TODO keyword, TAB will then switch the entry to become a child,
902 and then all possible ancestor states, before returning to the original state.
903 This makes data entry extremely fast: M-RET to create a new headline,
904 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
906 When the cursor is at the end of an empty plain list item, one TAB will
907 make it a subitem, two or more tabs will back up to make this an item
908 higher up in the item hierarchy."
913 "Where should `org-cycle' emulate TAB.
914 nil Never
915 white Only in completely white lines
916 whitestart Only at the beginning of lines, before the first non-white char
917 t Everywhere except in headlines
918 exc-hl-bol Everywhere except at the start of a headline
919 If TAB is used in a place where it does not emulate TAB, the current subtree
920 visibility is cycled."
927 ))
930 "Number of empty lines needed to keep an empty line between collapsed trees.
931 If you leave an empty line between the end of a subtree and the following
932 headline, this empty line is hidden when the subtree is folded.
933 Org-mode will leave (exactly) one empty line visible if the number of
934 empty lines is equal or larger to the number given in this variable.
935 So the default 2 means at least 2 empty lines after the end of a subtree
936 are needed to produce free space between a collapsed subtree and the
937 following headline.
939 If the number is negative, and the number of empty lines is at least -N,
940 all empty lines are shown.
942 Special case: when 0, never leave empty lines in collapsed view."
948 "Hook that is run before visibility cycling is happening.
949 The function(s) in this hook must accept a single argument which indicates
950 the new state that will be set right after running this hook. The
951 argument is a symbol. Before a global state change, it can have the values
952 `overview', `content', or `all'. Before a local state change, it can have
953 the values `folded', `children', or `subtree'."
958 org-cycle-hide-drawers
959 org-cycle-show-empty-lines
960 org-optimize-window-after-visibility-change)
961 "Hook that is run after `org-cycle' has changed the buffer visibility.
962 The function(s) in this hook must accept a single argument which indicates
963 the new state that was set by the most recent `org-cycle' command. The
964 argument is a symbol. After a global state change, it can have the values
965 `overview', `content', or `all'. After a local state change, it can have
966 the values `folded', `children', or `subtree'."
971 "Options concerning structure editing in Org-mode."
976 "Non-nil means skip even levels and only use odd levels for the outline.
977 This has the effect that two stars are being added/taken away in
978 promotion/demotion commands. It also influences how levels are
979 handled by the exporters.
980 Changing it requires restart of `font-lock-mode' to become effective
981 for fontification also in regions already fontified.
982 You may also set this on a per-file basis by adding one of the following
983 lines to the buffer:
985 #+STARTUP: odd
986 #+STARTUP: oddeven"
992 "Non-nil means adapt indentation to outline node level.
994 When this variable is set, Org assumes that you write outlines by
995 indenting text in each node to align with the headline (after the stars).
996 The following issues are influenced by this variable:
998 - When this is set and the *entire* text in an entry is indented, the
999 indentation is increased by one space in a demotion command, and
1000 decreased by one in a promotion command. If any line in the entry
1001 body starts with text at column 0, indentation is not changed at all.
1003 - Property drawers and planning information is inserted indented when
1004 this variable s set. When nil, they will not be indented.
1006 - TAB indents a line relative to context. The lines below a headline
1007 will be indented when this variable is set.
1009 Note that this is all about true indentation, by adding and removing
1010 space characters. See also `org-indent.el' which does level-dependent
1011 indentation in a virtual way, i.e. at display time in Emacs."
1016 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1018 When t, `C-a' will bring back the cursor to the beginning of the
1019 headline text, i.e. after the stars and after a possible TODO keyword.
1020 In an item, this will be the position after the bullet.
1021 When the cursor is already at that position, another `C-a' will bring
1022 it to the beginning of the line.
1024 `C-e' will jump to the end of the headline, ignoring the presence of tags
1025 in the headline. A second `C-e' will then jump to the true end of the
1026 line, after any tags. This also means that, when this variable is
1027 non-nil, `C-e' also will never jump beyond the end of the heading of a
1028 folded section, i.e. not after the ellipses.
1030 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1031 going to the true line boundary first. Only a directly following, identical
1032 keypress will bring the cursor to the special positions.
1034 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1035 set separately."
1054 "Non-nil means `C-k' will behave specially in headlines.
1055 When nil, `C-k' will call the default `kill-line' command.
1056 When t, the following will happen while the cursor is in the headline:
1058 - When the cursor is at the beginning of a headline, kill the entire
1059 line and possible the folded subtree below the line.
1060 - When in the middle of the headline text, kill the headline up to the tags.
1061 - When after the headline text, kill the tags."
1066 "Non-nil means, do not delete a hidden subtree with C-k.
1067 When set to the symbol `error', simply throw an error when C-k is
1068 used to kill (part-of) a headline that has hidden text behind it.
1069 Any other non-nil value will result in a query to the user, if it is
1070 OK to kill that hidden subtree. When nil, kill without remorse."
1078 "Check if in invisible region before inserting or deleting a character.
1079 Valid values are:
1081 nil Do not check, so just do invisible edits.
1082 error Throw an error and do nothing.
1083 show Make point visible, and do the requested edit.
1084 show-and-error Make point visible, then throw an error and abort the edit.
1085 smart Make point visible, and do insertion/deletion if it is
1086 adjacent to visible text and the change feels predictable.
1087 Never delete a previously invisible character or add in the
1088 middle or right after an invisible region. Basically, this
1089 allows insertion and backward-delete right before ellipses.
1090 FIXME: maybe in this case we should not even show?"
1100 "Non-nil means when yanking subtrees, fold them.
1101 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1102 it starts with a heading and all other headings in it are either children
1103 or siblings, then fold all the subtrees. However, do this only if no
1104 text after the yank would be swallowed into a folded tree by this action."
1109 "Non-nil means when yanking subtrees, adjust the level.
1110 With this setting, `org-paste-subtree' is used to insert the subtree, see
1111 this function for details."
1116 "Non-nil means M-RET will split the line at the cursor position.
1117 When nil, it will go to the end of the line before making a
1118 new line.
1119 You may also set this option in a different way for different
1120 contexts. Valid contexts are:
1122 headline when creating a new headline
1123 item when creating a new item
1124 table in a table field
1125 default the value to be used for all contexts not explicitly
1126 customized"
1143 "Non-nil means insert new headings after the current subtree.
1144 When nil, the new heading is created directly after the current line.
1147 for the duration of the command."
1153 "Should `org-insert-heading' leave a blank line before new heading/item?
1154 The value is an alist, with `heading' and `plain-list-item' as CAR,
1155 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1156 which case Org will look at the surrounding headings/items and try to
1157 make an intelligent decision whether to insert a blank line or not.
1159 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1160 set, the setting here is ignored and no empty line is inserted, to avoid
1161 breaking the list structure."
1174 "Hook being run after inserting a new heading."
1180 This currently only means they are never auto-wrapped.
1181 When nil, such lines will be treated like ordinary lines.
1182 See also the QUOTE keyword."
1187 "Non-nil means typing characters in `org-goto' starts incremental search."
1192 "Options concerning sparse trees in Org-mode."
1197 "Non-nil means highlight all matches that define a sparse tree.
1198 The highlights will automatically disappear the next time the buffer is
1199 changed by an edit command."
1204 "Non-nil means any change to the buffer will remove temporary highlights.
1205 Such highlights are created by `org-occur' and `org-clock-display'.
1206 When nil, `C-c C-c needs to be used to get rid of the highlights.
1207 The highlights created by `org-preview-latex-fragment' always need
1208 `C-c C-c' to be removed."
1215 "Hook that is run after `org-occur' has constructed a sparse tree.
1216 This can be used to recenter the window to show as much of the structure
1217 as possible."
1222 "Options concerning imenu and speedbar in Org-mode."
1227 "The maximum level for Imenu access to Org-mode headlines.
1228 This also applied for speedbar access."
1233 "Options concerning tables in Org-mode."
1239 When nil, such lines will be treated like ordinary lines.
1241 When equal to the symbol `optimized', the table editor will be optimized to
1242 do the following:
1243 - Automatic overwrite mode in front of whitespace in table fields.
1244 This makes the structure of the table stay in tact as long as the edited
1245 field does not exceed the column width.
1246 - Minimize the number of realigns. Normally, the table is aligned each time
1247 TAB or RET are pressed to move to another field. With optimization this
1248 happens only if changes to a field might have changed the column width.
1249 Optimization requires replacing the functions `self-insert-command',
1250 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1251 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1252 very good at guessing when a re-align will be necessary, but you can always
1255 If you would like to use the optimized version in Org-mode, but the
1256 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1258 This variable can be used to turn on and off the table editor during a session,
1259 but in order to toggle optimization, a restart is required.
1261 See also the variable `org-table-auto-blank-field'."
1269 "Non-nil means cluster self-insert commands for undo when possible.
1270 If this is set, then, like in the Emacs command loop, 20 consecutive
1271 characters will be undone together.
1272 This is configurable, because there is some impact on typing performance."
1277 "Non-nil means TAB will automatically notice a table.el table.
1278 When it sees such a table, it moves point into it and - if necessary -
1279 calls `table-recognize-table'."
1284 "Options concerning links in Org-mode."
1289 "Buffer-local version of `org-link-abbrev-alist', which see.
1294 "Alist of link abbreviations.
1295 The car of each element is a string, to be replaced at the start of a link.
1297 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1299 [[linkkey:tag][description]]
1301 The 'linkkey' must be a word word, starting with a letter, followed
1302 by letters, numbers, '-' or '_'.
1304 If REPLACE is a string, the tag will simply be appended to create the link.
1307 be inserted at that point (see the function `url-hexify-string').
1309 REPLACE may also be a function that will be called with the tag as the
1310 only argument to create the link, which should be returned as a string.
1312 See the manual for examples."
1322 "Non-nil means Org will display descriptive links.
1323 E.g. [[http://orgmode.org][Org website]] will be displayed as
1325 description. When set to `nil', Org will display the full links
1326 literally.
1328 You can interactively set the value of this variable by calling
1329 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1334 "How the path name in file links should be stored.
1335 Valid values are:
1337 relative Relative to the current directory, i.e. the directory of the file
1338 into which the link is being inserted.
1339 absolute Absolute path, if possible with ~ for home directory.
1340 noabbrev Absolute path, no abbreviation of home directory.
1341 adaptive Use relative path for files in the current directory and sub-
1342 directories of it. For other files, use an absolute path."
1351 "Types of links that should be activated in Org-mode files.
1352 This is a list of symbols, each leading to the activation of a certain link
1353 type. In principle, it does not hurt to turn on most link types - there may
1354 be a small gain when turning off unused link types. The types are:
1356 bracket The recommended [[link][description]] or [[link]] links with hiding.
1357 angle Links in angular brackets that may contain whitespace like
1358 <bbdb:Carsten Dominik>.
1359 plain Plain links in normal text, no whitespace, like http://google.com.
1360 radio Text that is matched by a radio target, see manual for details.
1361 tag Tag settings in a headline (link to tag search).
1362 date Time stamps (link to calendar).
1363 footnote Footnote labels.
1365 Changing this variable requires a restart of Emacs to become effective."
1377 "Function to use to generate link descriptions from links.
1378 If nil the link location will be used. This function must take
1379 two parameters; the first is the link and the second the
1380 description `org-insert-link' has generated, and should return the
1381 description to use."
1386 "Options concerning storing links in Org-mode."
1391 "Format of the description part of a link to an email or usenet message.
1392 The following %-escapes will be replaced by corresponding information:
1400 %s subject
1401 %d date
1402 %m message-id.
1404 You may use normal field width specification between the % and the letter.
1405 This is for example useful to limit the length of the subject.
1419 It should match if the message is from the user him/herself."
1424 "Non-nil means storing a link to an Org file will use entry IDs.
1426 Note that before this variable is even considered, org-id must be loaded,
1427 so please customize `org-modules' and turn it on.
1429 The variable can have the following values:
1431 t Create an ID if needed to make a link to the current entry.
1433 create-if-interactive
1434 If `org-store-link' is called directly (interactively, as a user
1435 command), do create an ID to support the link. But when doing the
1436 job for remember, only use the ID if it already exists. The
1437 purpose of this setting is to avoid proliferation of unwanted
1438 IDs, just because you happen to be in an Org file when you
1439 call `org-remember' that automatically and preemptively
1440 creates a link. If you do want to get an ID link in a remember
1441 template to an entry not having an ID, create it first by
1442 explicitly creating a link to it, using `C-c C-l' first.
1444 create-if-interactive-and-no-custom-id
1445 Like create-if-interactive, but do not create an ID if there is
1446 a CUSTOM_ID property defined in the entry. This is the default.
1448 use-existing
1449 Use existing ID, do not create one.
1451 nil Never use an ID to make a link, instead link using a text search for
1452 the headline text."
1457 create-if-interactive)
1459 create-if-interactive-and-no-custom-id)
1464 "Non-nil means file links from `org-store-link' contain context.
1465 A search string will be added to the file name with :: as separator and
1466 used to find the context when the link is activated by the command
1467 `org-open-at-point'. When this option is t, the entire active region
1468 will be placed in the search string of the file link. If set to a
1469 positive integer, only the first n lines of context will be stored.
1472 negates this setting for the duration of the command."
1477 "Non-nil means keep link in list for entire session.
1479 The command `org-store-link' adds a link pointing to the current
1480 location to an internal list. These links accumulate during a session.
1481 The command `org-insert-link' can be used to insert links into any
1482 Org-mode file (offering completion for all stored links). When this
1484 will be removed from the list, to make completing the unused links
1485 more efficient."
1490 "Options concerning following links in Org-mode."
1495 "Function to translate links with different syntax to Org syntax.
1496 This can be used to translate links created for example by the Planner
1497 or emacs-wiki packages to Org syntax.
1498 The function must accept two parameters, a TYPE containing the link
1500 which is everything after the link protocol. It should return a cons
1501 with possibly modified values of type and path.
1502 Org contains a function for this, so if you set this variable to
1503 `org-translate-link-from-planner', you should be able follow many
1504 links created by planner."
1509 "Hook that is run after a link has been followed."
1514 "Non-nil means on links TAB will follow the link.
1515 Needs to be set before org.el is loaded.
1516 This really should not be used, it does not make sense, and the
1517 implementation is bad."
1522 "Non-nil means on links RET will follow the link."
1528 "Non-nil means mouse-1 on a link will follow the link.
1529 A longer mouse click will still set point. Does not work on XEmacs.
1530 Needs to be set before org.el is loaded."
1535 "Number of different positions to be recorded in the ring.
1536 Changing this requires a restart of Emacs to work correctly."
1541 "Non-nil means internal links in Org files must exactly match a headline.
1542 When nil, the link search tries to match a phrase with all words
1543 in the search text."
1549 query-to-create)))
1556 "Setup the frame configuration for following links.
1557 When following a link with Emacs, it may often be useful to display
1558 this link in another window or frame. This variable can be used to
1559 set this up for the different types of links.
1560 For VM, use any of
1561 `vm-visit-folder'
1562 `vm-visit-folder-other-window'
1563 `vm-visit-folder-other-frame'
1564 For Gnus, use any of
1565 `gnus'
1566 `gnus-other-frame'
1567 `org-gnus-no-new-news'
1568 For FILE, use any of
1569 `find-file'
1570 `find-file-other-window'
1571 `find-file-other-frame'
1572 For Wanderlust use any of
1573 `wl'
1574 `wl-other-frame'
1575 For the calendar, use the variable `calendar-setup'.
1576 For BBDB, it is currently only possible to display the matches in
1577 another window."
1601 "Non-nil means use indirect buffer to display infile links.
1602 Activating internal links (from one location in a file to another location
1603 in the same file) normally just jumps to the location. When the link is
1605 is displayed in
1606 another window. When this option is set, the other window actually displays
1607 an indirect buffer clone of the current buffer, to avoid any visibility
1608 changes to the current buffer."
1613 "Non-nil means `org-open-file' will open non-existing files.
1614 When nil, an error will be generated.
1615 This variable applies only to external applications because they
1616 might choke on non-existing files. If the link is to a file that
1617 will be opened in Emacs, the variable is ignored."
1622 "Non-nil means a link to a directory really means to index.org.
1623 When nil, following a directory link will run dired or open a finder/explorer
1624 window on that directory."
1629 "Function and arguments to call for following mailto links.
1630 This is a list with the first element being a Lisp function, and the
1631 remaining elements being arguments to the function. In string arguments,
1632 %a will be replaced by the address, and %s will be replaced by the subject
1633 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1642 "Non-nil means ask for confirmation before executing shell links.
1643 Shell links can be dangerous: just think about a link
1645 [[shell:rm -rf ~/*][Google Search]]
1648 but really it would remove your entire home directory.
1649 Therefore we advise against setting this variable to nil.
1650 Just change it to `y-or-n-p' if you want to confirm with a
1658 'safe-local-variable
1662 "A regexp to skip confirmation for shell links."
1667 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1668 Elisp links can be dangerous: just think about a link
1673 but really it would remove your entire home directory.
1674 Therefore we advise against setting this variable to nil.
1675 Just change it to `y-or-n-p' if you want to confirm with a
1683 'safe-local-variable
1687 "A regexp to skip confirmation for Elisp links."
1695 "Default file applications on a UNIX or GNU/Linux system.
1706 "Default file applications on a MacOS X system.
1708 for some files for which the OS does not have a good default.
1716 'mswindows-shell-execute
1721 'mswindows-shell-execute
1724 "Default file applications on a Windows NT system.
1729 '(
1734 )
1735 "External applications for opening `file:path' items in a document.
1736 Org-mode uses system defaults for different file types, but
1737 you can use this variable to set the application for a given file
1738 extension. The entries in this list are cons cells where the car identifies
1739 files and the cdr the corresponding command. Possible values for the
1740 file identifier are
1742 ways, depending on its contents:
1744 - Alphanumeric characters only:
1745 Match links with this file extension.
1747 to open PDFs with evince.
1749 - Regular expression: Match links where the
1750 filename matches the regexp. If you want to
1751 use groups here, use shy groups.
1755 to open *.html and *.xhtml with firefox.
1757 - Regular expression which contains (non-shy) groups:
1759 anything after that, matches the regexp.
1760 In a custom command string, %1, %2, etc. are replaced with
1761 the parts of the link that were matched by the groups.
1762 For backwards compatibility, if a command string is given
1763 that does not use any of the group matches, this case is
1764 handled identically to the second one (i.e. match against
1765 file name only).
1766 In a custom lisp form, you can access the group matches with
1767 (match-string n link).
1770 to open [[file:document.pdf::5]] with evince at page 5.
1772 `directory' Matches a directory
1773 `remote' Matches a remote file, accessible through tramp or efs.
1774 Remote files most likely should be visited through Emacs
1775 because external applications cannot handle such paths.
1776 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1777 so all files Emacs knows how to handle. Using this with
1778 command `emacs' will open most files in Emacs. Beware that this
1779 will also open html files inside Emacs, unless you add
1781 t Default for files not matched by any of the other options.
1782 `system' The system command to open files, like `open' on Windows
1783 and Mac OS X, and mailcap under GNU/Linux. This is the command
1784 that will be selected if you call `C-c C-o' with a double
1787 Possible values for the command are:
1788 `emacs' The file will be visited by the current Emacs process.
1789 `default' Use the default application for this file type, which is the
1790 association for t in the list, most likely in the system-specific
1791 part.
1792 This can be used to overrule an unwanted setting in the
1793 system-specific variable.
1795 This command is specified by the entry whose car is `system'.
1796 Most likely, the system-specific version of this variable
1797 does define this command, but you can overrule/replace it
1798 here.
1799 string A command to be executed by a shell; %s will be replaced
1800 by the path to the file.
1801 sexp A Lisp form which will be evaluated. The file path will
1802 be available in the Lisp variable `file'.
1803 For more examples, see the system specific constants
1804 `org-file-apps-defaults-macosx'
1805 `org-file-apps-defaults-windowsnt'
1806 `org-file-apps-defaults-gnu'."
1816 auto-mode))
1827 "Options concerning refiling entries in Org-mode."
1832 "Directory with org files.
1833 This is just a default location to look for Org files. There is no need
1834 at all to put your files into this directory. It is only used in the
1835 following situations:
1837 1. When a remember template specifies a target file that is not an
1838 absolute path. The path will then be interpreted relative to
1839 `org-directory'
1840 2. When a remember note is filed away in an interactive way (when exiting the
1841 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1842 with `org-directory' as the default path."
1848 "Default target for storing notes.
1849 Used as a fall back file for org-remember.el and org-capture.el, for
1850 templates that do not specify a target file."
1855 file))
1858 "The default interface to be used for `org-goto'.
1859 Allowed values are:
1860 outline The interface shows an outline of the relevant file
1861 and the correct heading is found by moving through
1862 the outline or by searching with incremental search.
1863 outline-path-completion Headlines in the current buffer are offered via
1864 completion. This is the interface also used by
1865 the refile command."
1872 "Maximum target level when running `org-goto' with refile interface."
1877 "Non-nil means store new notes at the beginning of a file or entry.
1878 When nil, new notes will be filed to the end of a file or entry.
1879 This can also be a list with cons cells of regular expressions that
1880 are matched against file names, and values."
1890 "Information to record when a task is refiled.
1892 Possible values are:
1894 nil Don't add anything
1895 time Add a time stamp to the task
1896 note Prompt for a note and add it with template `org-log-note-headings'
1898 This option can also be set with on a per-file-basis with
1900 #+STARTUP: nologrefile
1901 #+STARTUP: logrefile
1902 #+STARTUP: lognoterefile
1904 You can have local logging settings for a subtree by setting the LOGGING
1905 property to one or more of these keywords.
1907 When bulk-refiling from the agenda, the value `note' is forbidden and
1908 will temporarily be changed to `time'."
1918 This is a list of cons cells. Each cell contains:
1919 - a specification of the files to be considered, either a list of files,
1920 or a symbol whose function or variable value will be used to retrieve
1921 a file name or a list of file names. If you use `org-agenda-files' for
1922 that, all agenda files will be scanned for targets. Nil means consider
1923 headings in the current buffer.
1924 - A specification of how to find candidate refile targets. This may be
1925 any of:
1927 This tag has to be present in all target headlines, inheritance will
1928 not be considered.
1930 todo keyword.
1932 headlines that are refiling targets.
1933 - a cons cell (:level . N). Any headline of level N is considered a target.
1934 Note that, when `org-odd-levels-only' is set, level corresponds to
1935 order in hierarchy, not to the number of stars.
1936 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1937 Note that, when `org-odd-levels-only' is set, level corresponds to
1938 order in hierarchy, not to the number of stars.
1940 Each element of this list generates a set of possible targets.
1941 The union of these sets is presented (with completion) to
1942 the user by `org-refile'.
1944 You can set the variable `org-refile-target-verify-function' to a function
1945 to verify each headline found by the simple criteria above.
1947 When this variable is nil, all top-level headlines in the current buffer
1948 are used, equivalent to the value `((nil . (:level . 1))'."
1964 "Function to verify if the headline at point should be a refile target.
1965 The function will be called without arguments, with point at the
1966 beginning of the headline. It should return t and leave point
1967 where it is if the headline is a valid target for refiling.
1969 If the target should not be selected, the function must return nil.
1970 In addition to this, it may move point to a place from where the search
1971 should be continued. For example, the function may decide that the entire
1972 subtree of the current entry should be excluded and move point to the end
1973 of the subtree."
1978 "Non-nil means cache refile targets to speed up the process.
1979 The cache for a particular file will be updated automatically when
1980 the buffer has been killed, or when any of the marker used for flagging
1981 refile targets no longer points at a live buffer.
1982 If you have added new entries to a buffer that might themselves be targets,
1983 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1984 find that easier, `C-u C-u C-u C-c C-w'."
1989 "Non-nil means provide refile targets as paths.
1990 So a level 3 headline will be available as level1/level2/level3.
1992 When the value is `file', also include the file name (without directory)
1993 into the path. In this case, you can also stop the completion after
1994 the file name, to get entries inserted as top level in the file.
1996 When `full-file-path', include the full file path."
2005 "Non-nil means complete the outline path in hierarchical steps.
2006 When Org-mode uses the refile interface to select an outline path
2007 \(see variable `org-refile-use-outline-path'), the completion of
2008 the path can be done is a single go, or if can be done in steps down
2009 the headline hierarchy. Going in steps is probably the best if you
2010 do not use a special completion package like `ido' or `icicles'.
2011 However, when using these packages, going in one step can be very
2012 fast, while still showing the whole path to the entry."
2017 "Non-nil means allow to create new nodes as refile targets.
2019 of an existing node. When the value of this variable is `confirm',
2020 new node creation must be confirmed by the user (recommended)
2021 When nil, the completion must match an existing entry.
2023 Note that, if the new heading is not seen by the criteria
2024 listed in `org-refile-targets', multiple instances of the same
2025 heading would be created by trying again to file under the new
2026 heading."
2034 "Non-nil means also refile active region within a subtree.
2036 By default `org-refile' doesn't allow refiling regions if they
2037 don't contain a set of subtrees, but it might be convenient to
2038 do so sometimes: in that case, the first line of the region is
2039 converted to a headline before refiling."
2044 "Options concerning TODO items in Org-mode."
2049 "Options concerning Progress logging in Org-mode."
2056 "The available interpretation symbols for customizing `org-todo-keywords'.
2060 "List of TODO entry keyword sequences and their interpretation.
2063 Each sequence starts with a symbol, either `sequence' or `type',
2064 indicating if the keywords should be interpreted as a sequence of
2065 action steps, or as different types of TODO items. The first
2066 keywords are states requiring action - these states will select a headline
2067 for inclusion into the global TODO list Org-mode produces. If one of
2070 the last keyword is treated as the only DONE state of the sequence.
2073 additional state where no keyword is present. For details about this
2074 cycling, see the manual.
2076 TODO keywords and interpretation can also be set on a per-file basis with
2077 the special #+SEQ_TODO and #+TYP_TODO lines.
2079 Each keyword can optionally specify a character for fast state selection
2080 \(in combination with the variable `org-use-fast-todo-selection')
2081 and specifiers for state change logging, using the same syntax
2084 indicates to record a time stamp each time this state is selected.
2086 Each keyword may also specify if a timestamp or a note should be
2087 recorded when entering or leaving the state, by adding additional
2088 characters in the parenthesis after the keyword. This looks like this:
2090 record only the time of the state change. With X and Y being either
2092 Y when leaving the state if and only if the *target* state does not
2093 define X. You may omit any of the fast-selection key or X or /Y,
2094 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2096 For backward compatibility, this variable may also be just a list
2097 of keywords - in this case the interpretation (sequence or type) will be
2098 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2108 ;;Quick and dirty way to see
2109 ;;`org-todo-interpretations'. This takes the
2110 ;;place of item arguments
2111 :convert-widget
2118 org-todo-interpretation-widgets))
2119 widget))
2150 "Controls how TODO keywords are interpreted.
2151 This variable is in principle obsolete and is only used for
2152 backward compatibility, if the interpretation of todo keywords is
2153 not given already in `org-todo-keywords'. See that variable for
2154 more information."
2161 "Non-nil means use the fast todo selection scheme with C-c C-t.
2162 This variable describes if and under what circumstances the cycling
2163 mechanism for TODO keywords will be replaced by a single-key, direct
2164 selection scheme.
2166 When nil, fast selection is never used.
2168 When the symbol `prefix', it will be used when `org-todo' is called with
2169 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2170 in an agenda buffer.
2172 When t, fast selection is used by default. In this case, the prefix
2173 argument forces cycling instead.
2175 In all cases, the special interface is only used if access keys have actually
2176 been assigned by the user, i.e. if keywords in the configuration are followed
2177 by a letter in parenthesis, like TODO(t)."
2185 "Non-nil means update todo statistics after insert and toggle.
2186 ALL-HEADLINES means update todo statistics by including headlines
2187 with no TODO keyword as well, counting them as not done.
2188 A list of TODO keywords means the same, but skip keywords that are
2189 not in this list.
2191 When this is set, todo statistics is updated in the parent of the
2192 current entry each time a todo state is changed."
2202 "Non-nil means TODO statistics covers just direct children.
2203 When nil, all entries in the subtree are considered.
2204 This has only an effect if `org-provide-todo-statistics' is set.
2205 To set this to nil for only a single subtree, use a COOKIE_DATA
2211 "Hook which is run after the state of a TODO item was changed.
2212 The new state (a string with a TODO keyword, or nil) is available in the
2213 Lisp variable `state'."
2218 "Hook for functions that are allowed to block a state change.
2220 Each function gets as its single argument a property list, see
2221 `org-trigger-hook' for more information about this list.
2223 If any of the functions in this hook returns nil, the state change
2227 "Hook for functions that are triggered by a state change.
2229 Each function gets as its single argument a property list with at least
2230 the following elements:
2232 (:type type-of-change :position pos-at-entry-start
2233 :from old-state :to new-state)
2235 Depending on the type, more properties may be present.
2237 This mechanism is currently implemented for:
2239 TODO state changes
2240 ------------------
2241 :type todo-state-change
2242 :from previous state (keyword as a string), or nil, or a symbol
2243 'todo' or 'done', to indicate the general type of state.
2247 "Non-nil means undone TODO entries will block switching the parent to DONE.
2248 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2249 be blocked if any prior sibling is not yet done.
2250 Finally, if the parent is blocked because of ordered siblings of its own,
2251 the child will also be blocked."
2263 "Non-nil means unchecked boxes will block switching the parent to DONE.
2264 When this is nil, checkboxes have no influence on switching TODO states.
2265 When non-nil, you first need to check off all check boxes before the TODO
2266 entry can be switched to DONE.
2267 This variable needs to be set before org.el is loaded, and you need to
2268 restart Emacs after a change to make the change effective. The only way
2269 to change is while Emacs is running is through the customize interface."
2281 "Non-nil means inserting a TODO heading is treated as state change.
2283 logging will apply if appropriate. When nil, the new TODO item will
2284 be inserted directly, and no logging will take place."
2289 "Non-nil means switching TODO states with S-cursor counts as state change.
2290 This is the default behavior. However, setting this to nil allows a
2291 convenient way to select a TODO state and bypass any logging associated
2292 with that."
2297 "Tag changes that should be triggered by TODO state changes.
2298 This is a list. Each entry is
2300 (state-change (tag . flag) .......)
2302 State-change can be a string with a state, and empty string to indicate the
2303 state that has no TODO keyword, or it can be one of the symbols `todo'
2304 or `done', meaning any not-done or done state, respectively."
2318 "Information to record when a task moves to the DONE state.
2320 Possible values are:
2322 nil Don't add anything, just change the keyword
2323 time Add a time stamp to the task
2324 note Prompt for a note and add it with template `org-log-note-headings'
2326 This option can also be set with on a per-file-basis with
2328 #+STARTUP: nologdone
2329 #+STARTUP: logdone
2330 #+STARTUP: lognotedone
2332 You can have local logging settings for a subtree by setting the LOGGING
2333 property to one or more of these keywords."
2341 ;; Normalize old uses of org-log-done.
2348 "Information to record when the scheduling date of a tasks is modified.
2350 Possible values are:
2352 nil Don't add anything, just change the date
2353 time Add a time stamp to the task
2354 note Prompt for a note and add it with template `org-log-note-headings'
2356 This option can also be set with on a per-file-basis with
2358 #+STARTUP: nologreschedule
2359 #+STARTUP: logreschedule
2360 #+STARTUP: lognotereschedule"
2369 "Information to record when the deadline date of a tasks is modified.
2371 Possible values are:
2373 nil Don't add anything, just change the date
2374 time Add a time stamp to the task
2375 note Prompt for a note and add it with template `org-log-note-headings'
2377 This option can also be set with on a per-file-basis with
2379 #+STARTUP: nologredeadline
2380 #+STARTUP: logredeadline
2381 #+STARTUP: lognoteredeadline
2383 You can have local logging settings for a subtree by setting the LOGGING
2384 property to one or more of these keywords."
2393 "Non-nil means record a note when clocking out of an item.
2394 This can also be configured on a per-file basis by adding one of
2395 the following lines anywhere in the buffer:
2397 #+STARTUP: lognoteclock-out
2398 #+STARTUP: nolognoteclock-out"
2404 "Non-nil means the CLOSED time stamp will contain date and time.
2405 When nil, only the date will be recorded."
2419 "Headings for notes added to entries.
2420 The value is an alist, with the car being a symbol indicating the note
2421 context, and the cdr is the heading to be used. The heading may also be the
2422 empty string.
2423 %t in the heading will be replaced by a time stamp.
2424 %T will be an active time stamp instead the default inactive one
2425 %d will be replaced by a short-format time stamp.
2426 %D will be replaced by an active short-format time stamp.
2427 %s will be replaced by the new TODO state, in double quotes.
2428 %S will be replaced by the old TODO state, in double quotes.
2429 %u will be replaced by the user name.
2430 %U will be replaced by the full user name.
2432 In fact, it is not a good idea to change the `state' entry, because
2433 agenda log mode depends on the format of these entries."
2439 "Heading when changing todo state (todo sequence only)"
2453 "Non-nil means insert state change notes and time stamps into a drawer.
2454 When nil, state changes notes will be inserted after the headline and
2455 any scheduling and clock lines, but not inside a drawer.
2457 The value of this variable should be the name of the drawer to use.
2458 LOGBOOK is proposed as the default drawer for this purpose, you can
2459 also set this to a string to define the drawer of your choice.
2463 If this variable is set, `org-log-state-notes-insert-after-drawers'
2464 will be ignored.
2466 You can set the property LOG_INTO_DRAWER to overrule this setting for
2467 a subtree."
2479 "Return the value of `org-log-into-drawer', but let properties overrule.
2480 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2481 used instead of the default value."
2489 "Non-nil means insert state change notes after any drawers in entry.
2490 Only the drawers that *immediately* follow the headline and the
2491 deadline/scheduled line are skipped.
2492 When nil, insert notes right after the heading and perhaps the line
2493 with deadline/scheduling if present.
2495 This variable will have no effect if `org-log-into-drawer' is
2496 set."
2502 "Non-nil means the latest state note will be directly after heading.
2503 When nil, the state change notes will be ordered according to time."
2509 "The TODO state to which a repeater should return the repeating task.
2510 By default this is the first task in a TODO sequence, or the previous state
2511 in a TODO_TYP set. But you can specify another task here.
2512 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2518 "Non-nil means record moving through the DONE state when triggering repeat.
2519 An auto-repeating task is immediately switched back to TODO when
2522 record a closing note, there will be no record of the task moving
2523 through DONE. This variable forces taking a note anyway.
2525 nil Don't force a record
2526 time Record a time stamp
2527 note Record a note
2529 This option can also be set with on a per-file-basis with
2531 #+STARTUP: logrepeat
2532 #+STARTUP: lognoterepeat
2533 #+STARTUP: nologrepeat
2535 You can have local logging settings for a subtree by setting the LOGGING
2536 property to one or more of these keywords."
2546 "Priorities in Org-mode."
2551 "Non-nil means priority commands are active.
2552 When nil, these commands will be disabled, so that you never accidentally
2553 set a priority."
2558 "The highest priority of TODO items. A character like ?A, ?B etc.
2559 Must have a smaller ASCII number than `org-lowest-priority'."
2564 "The lowest priority of TODO items. A character like ?A, ?B etc.
2565 Must have a larger ASCII number than `org-highest-priority'."
2570 "The default priority of TODO items.
2571 This is the priority an item gets if no explicit priority is given.
2572 When starting to cycle on an empty priority the first step in the cycle
2573 depends on `org-priority-start-cycle-with-default'. The resulting first
2574 step priority must not exceed the range from `org-highest-priority' to
2575 `org-lowest-priority' which means that `org-default-priority' has to be
2576 in this range exclusive or inclusive the range boundaries. Else the
2577 first step refuses to set the default and the second will fall back
2578 to (depending on the command used) the highest or lowest priority."
2583 "Non-nil means start with default priority when starting to cycle.
2584 When this is nil, the first step in the cycle will be (depending on the
2585 command used) one higher or lower than the default priority.
2586 See also `org-default-priority'."
2591 "Function to extract the priority from a string.
2592 The string is normally the headline. If this is nil Org computes the
2593 priority from the priority cookie like [#A] in the headline. It returns
2594 an integer, increasing by 1000 for each priority level.
2595 The user can set a different function here, which should take a string
2596 as an argument and return the numeric priority."
2601 "Options concerning time stamps and deadlines in Org-mode."
2606 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2607 When nil, these labeled time stamps are forces into the second line of an
2608 entry, just after the headline. When scheduling from the global TODO list,
2609 the time stamp will always be forced into the second line."
2614 "Formats for `format-time-string' which are used for time stamps.
2618 "Number of minutes to round time stamps to.
2619 These are two values, the first applies when first creating a time stamp.
2620 The second applies when changing it with the commands `S-up' and `S-down'.
2621 When changing the time stamp, this means that it will change in steps
2622 of N minutes, as given by the second value.
2624 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2625 numbers should be factors of 60, so for example 5, 10, 15.
2627 When this is larger than 1, you can still force an exact time stamp by using
2628 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2629 and by using a prefix arg to `S-up/down' to specify the exact number
2630 of minutes to shift."
2640 ;; Normalize old customizations of this variable.
2644 org-time-stamp-rounding-minutes)))
2647 "Non-nil means overlay custom formats over all time stamps.
2648 The formats are defined through the variable `org-time-stamp-custom-formats'.
2649 To turn this on on a per-file basis, insert anywhere in the file:
2650 #+STARTUP: customtime"
2658 "Custom formats for time stamps. See `format-time-string' for the syntax.
2659 These are overlaid over the default ISO format if the variable
2660 `org-display-custom-times' is set. Time like %H:%M should be at the
2661 end of the second format. The custom formats are also honored by export
2662 commands, if custom time display is turned on at the time of export."
2667 "Get the right format for a time string."
2672 f)))
2675 "The format string used when creating CLOCKSUM lines.
2676 This is also used when org-mode generates a time duration."
2682 org-mode generates a time duration."
2687 "The format string used when creating CLOCKSUM lines, or when
2688 org-mode generates a time duration."
2693 "No. of days before expiration during which a deadline becomes active.
2694 This variable governs the display in sparse trees and in the agenda.
2695 When 0 or negative, it means use this number (the absolute value of it)
2696 even if a deadline has a different individual lead time specified.
2698 Custom commands can set this variable in the options section."
2704 "Non-nil means assume future for incomplete date input from user.
2705 This affects the following situations:
2706 1. The user gives a month but not a year.
2709 2. The user gives a day, but no month.
2712 it will be considered as *this* month.
2714 If you set this variable to the symbol `time', then also the following
2715 will work:
2717 3. If the user gives a time, but no day. If the time is before now,
2718 to will be interpreted as tomorrow.
2720 Currently none of this works for ISO week specifications.
2722 When this option is nil, the current day, month and year will always be
2723 used as defaults.
2725 See also `org-agenda-jump-prefer-future'."
2733 "Should the agenda jump command prefer the future for incomplete dates?
2734 The default is to do the same as configured in `org-read-date-prefer-future'.
2735 But you can also set a deviating value here.
2736 This may t or nil, or the symbol `org-read-date-prefer-future'."
2741 org-read-date-prefer-future)
2746 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2748 Depending on the system Emacs is running on, certain dates cannot
2749 be represented with the type used internally to represent time.
2750 Dates between 1970-1-1 and 2038-1-1 can always be represented
2751 correctly. Some systems allow for earlier dates, some for later,
2752 some for both. One way to find out it to insert any date into an
2753 Org buffer, putting the cursor on the year and hitting S-up and
2754 S-down to test the range.
2756 When this variable is set to t, the date/time prompt will not let
2757 you specify dates outside the 1970-2037 range, so it is certain that
2758 these dates will work in whatever version of Emacs you are
2759 running, and also that you can move a file from one Emacs implementation
2760 to another. WHenever Org is forcing the year for you, it will display
2761 a message and beep.
2763 When this variable is nil, Org will check if the date is
2764 representable in the specific Emacs implementation you are using.
2765 If not, it will force a year, usually the current year, and beep
2766 to remind you. Currently this setting is not recommended because
2767 the likelihood that you will open your Org files in an Emacs that
2768 has limited date range is not negligible.
2770 A workaround for this problem is to use diary sexp dates for time
2771 stamps outside of this range."
2776 "Non-nil means display current interpretation of date prompt live.
2777 This display will be in an overlay, in the minibuffer."
2782 "Non-nil means pop up a calendar when prompting for a date.
2783 In the calendar, the date can be selected with mouse-1. However, the
2784 minibuffer will also be active, and you can simply enter the date as well.
2785 When nil, only the minibuffer will be available."
2793 "Hook to be used to set up keys for the date/time interface.
2794 Add key definitions to `minibuffer-local-map', which will be a temporary
2795 copy."
2800 "The hour when your day really ends. Must be an integer.
2801 This has influence for the following applications:
2803 the time given here, the day recognized as TODAY is actually yesterday.
2804 - When a date is read from the user and it is still before the time given
2805 here, the current date and time will be assumed to be yesterday, 23:59.
2806 Also, timestamps inserted in remember templates follow this rule.
2808 IMPORTANT: This is a feature whose implementation is and likely will
2809 remain incomplete. Really, it is only here because past midnight seems to
2810 be the favorite working time of John Wiegley :-)"
2815 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2816 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2818 23:59 of the previous day."
2823 "Non-nil means S-down will increase the time in a time stamp.
2824 When nil, S-up will increase."
2829 "Non-nil means make the calendar window follow timestamp changes.
2830 When a timestamp is modified and the calendar window is visible, it will be
2831 moved to the new date."
2836 "Options concerning tags in Org-mode."
2841 "List of tags allowed in Org-mode files.
2842 When this list is nil, Org-mode will base TAG input on what is already in the
2843 buffer.
2844 The value of this variable is an alist, the car of each entry must be a
2845 keyword as a string, the cdr may be a character that is used to select
2846 that tag through the fast-tag-selection interface.
2847 See the manual for details."
2862 "List of tags that will always appear in all Org-mode files.
2863 This is in addition to any in buffer settings or customizations
2864 of `org-tag-alist'.
2865 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2866 The value of this variable is an alist, the car of each entry must be a
2867 keyword as a string, the cdr may be a character that is used to select
2868 that tag through the fast-tag-selection interface.
2869 See the manual for details.
2870 To disable these tags on a per-file basis, insert anywhere in the file:
2871 #+STARTUP: noptag"
2882 "If non-nil, always offer completion for all tags of all agenda files.
2883 Instead of customizing this variable directly, you might want to
2884 set it locally for capture buffers, because there no list of
2885 tags in that file can be created dynamically (there are none).
2887 (add-hook 'org-capture-mode-hook
2888 (lambda ()
2889 (set (make-local-variable
2890 'org-complete-tags-always-offer-all-agenda-tags)
2891 t)))"
2896 "List of tags that can be inherited by all entries in the file.
2897 The tags will be inherited if the variable `org-use-tag-inheritance'
2898 says they should be.
2902 "Non-nil means use fast tag selection scheme.
2903 This is a special interface to select and deselect tags with single keys.
2904 When nil, fast selection is never used.
2905 When the symbol `auto', fast selection is used if and only if selection
2906 characters for tags have been configured, either through the variable
2907 `org-tag-alist' or through a #+TAGS line in the buffer.
2908 When t, fast selection is always used and selection keys are assigned
2909 automatically if necessary."
2917 "Non-nil means fast tag selection exits after first change.
2918 When nil, you have to press RET to exit it.
2919 During fast tag selection, you can toggle this flag with `C-c'.
2920 This variable can also have the value `expert'. In this case, the window
2921 displaying the tags menu is not even shown, until you press C-c again."
2929 "Non-nil means fast tags selection interface will also offer TODO states.
2933 "The column to which tags should be indented in a headline.
2934 If this number is positive, it specifies the column. If it is negative,
2935 it means that the tags should be flushright to that column. For example,
2936 -80 works well for a normal 80 character screen.
2937 When 0, place tags directly after headline text, with only one space in
2938 between."
2943 "Non-nil keeps tags aligned when modifying headlines.
2944 Some operations (i.e. demoting) change the length of a headline and
2945 therefore shift the tags around. With this option turned on, after
2946 each such operation the tags are again aligned to `org-tags-column'."
2951 "Non-nil means tags in levels apply also for sublevels.
2952 When nil, only the tags directly given in a specific line apply there.
2953 This may also be a list of tags that should be inherited, or a regexp that
2954 matches tags that should be inherited. Additional control is possible
2955 with the variable `org-tags-exclude-from-inheritance' which gives an
2956 explicit list of tags to be excluded from inheritance., even if the value of
2957 `org-use-tag-inheritance' would select it for inheritance.
2959 If this option is t, a match early-on in a tree can lead to a large
2960 number of matches in the subtree when constructing the agenda or creating
2961 a sparse tree. If you only want to see the first match in a tree during
2962 a search, check out the variable `org-tags-match-list-sublevels'."
2971 "List of tags that should never be inherited.
2972 This is a way to exclude a few tags from inheritance. For way to do
2973 the opposite, to actively allow inheritance for selected tags,
2974 see the variable `org-use-tag-inheritance'."
2979 "Check if TAG is one that should be inherited."
2991 "Non-nil means list also sublevels of headlines matching a search.
2992 This variable applies to tags/property searches, and also to stuck
2993 projects because this search is based on a tags match as well.
2995 When set to the symbol `indented', sublevels are indented with
2996 leading dots.
2998 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2999 the sublevels of a headline matching a tag search often also match
3000 the same search. Listing all of them can create very long lists.
3001 Setting this variable to nil causes subtrees of a match to be skipped.
3003 This variable is semi-obsolete and probably should always be true. It
3004 is better to limit inheritance to certain tags using the variables
3005 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3013 "When set, tags are sorted using this function as a comparator."
3029 "Options concerning properties in Org-mode."
3034 "How property key/value pairs should be formatted by `indent-line'.
3035 When `indent-line' hits a property definition, it will format the line
3036 according to this format, mainly to make sure that the values are
3037 lined-up with respect to each other."
3042 "Alist of properties and functions to adjust inserted values.
3043 Elements of this alist must be of the form
3045 ([string] [function])
3047 where [string] must be a property name and [function] must be a
3048 lambda expression: this lambda expression must take one argument,
3049 the value to adjust, and return the new value as a string.
3053 and the clock summary:
3056 (let ((clocksum (org-clock-sum-current-item))
3057 (effort (org-duration-string-to-minutes
3059 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3064 "Non-nil means properties apply also for sublevels.
3066 This setting is chiefly used during property searches. Turning it on can
3067 cause significant overhead when doing a search, which is why it is not
3068 on by default.
3070 When nil, only the properties directly given in the current entry count.
3071 When t, every property is inherited. The value may also be a list of
3072 properties that should have inheritance, or a regular expression matching
3073 properties that should be inherited.
3075 However, note that some special properties use inheritance under special
3076 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3078 for valid values of a property.
3080 Note for programmers:
3081 When querying an entry with `org-entry-get', you can control if inheritance
3082 should be used. By default, `org-entry-get' looks only at the local
3083 properties. You can request inheritance by setting the inherit argument
3084 to t (to force inheritance) or to `selective' (to respect the setting
3085 in this variable)."
3094 "Check if PROPERTY is one that should be inherited."
3105 "The default column format, if no other format has been defined.
3106 This variable can be set on the per-file basis by inserting a line
3108 #+COLUMNS: %25ITEM ....."
3113 "The ellipses to be used when a field in column view is truncated.
3114 When this is the empty string, as many characters as possible are shown,
3115 but then there will be no visual indication that the field has been truncated.
3116 When this is a string of length N, the last N characters of a truncated
3117 field are replaced by this string. If the column is narrower than the
3118 ellipses string, only part of the ellipses string will be shown."
3123 "Function that modifies values for display in column view.
3124 For example, it can be used to cut out a certain part from a time stamp.
3125 The function must take 2 arguments:
3127 column-title The title of the column (*not* the property name)
3128 value The value that should be modified.
3130 The function should return the value that should be displayed,
3131 or nil if the normal value should be used."
3136 "The property that is being used to keep track of effort estimates.
3137 Effort estimates given in this property need to have the format H:MM."
3145 "List of property/value pairs that can be inherited by any entry.
3147 These are fixed values, for the preset properties. The user variable
3148 that can be used to add to this list is `org-global-properties'.
3150 The entries in this list are cons cells where the car is a property
3151 name and cdr is a string with the value. If the value represents
3156 "List of property/value pairs that can be inherited by any entry.
3158 This list will be combined with the constant `org-global-properties-fixed'.
3160 The entries in this list are cons cells where the car is a property
3161 name and cdr is a string with the value.
3163 You can set buffer-local values for the same purpose in the variable
3164 `org-file-properties' this by adding lines like
3166 #+PROPERTY: NAME VALUE"
3173 "List of property/value pairs that can be inherited by any entry.
3174 Valid for the current buffer.
3179 "Options concerning agenda views in Org-mode."
3184 "Variable used by org files to set a category for agenda display.
3185 Such files should use a file variable to set it, for example
3189 or contain a special line
3191 #+CATEGORY: ELisp
3193 If the file does not specify a category, then file's base name
3199 "The files to be used for agenda display.
3203 If an entry is a directory, all files in that directory that are matched by
3204 `org-agenda-file-regexp' will be part of the file list.
3206 If the value of the variable is not a list but a single file name, then
3207 the list of agenda files is actually stored and maintained in that file, one
3208 agenda file per line. In this file paths can be given relative to
3209 `org-directory'. Tilde expansion and environment variable substitution
3210 are also made."
3217 "Regular expression to match files for `org-agenda-files'.
3218 If any element in the list in that variable contains a directory instead
3219 of a normal file, all files in that directory that are matched by this
3220 regular expression will be included."
3225 "List of extra files to be searched by text search commands.
3226 These files will be search in addition to the agenda files by the
3227 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3228 Note that these files will only be searched for text search commands,
3229 not for the other agenda views like todo lists, tag searches or the weekly
3230 agenda. This variable is intended to list notes and possibly archive files
3231 that should also be searched by these two commands.
3232 In fact, if the first element in the list is the symbol `agenda-archives',
3233 than all archive files of all agenda files will be added to the search
3234 scope."
3245 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3246 A nil value means to remove them, after a query, from the list."
3251 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3252 The command `org-calendar-goto-agenda' will be bound to this key. The
3253 default is the character `c' because then `c' can be used to switch back and
3254 forth between agenda and calendar."
3259 "The key to be installed in `calendar-mode-map' for agenda-action.
3260 The command `org-agenda-action' will be bound to this key. The
3261 default is the character `k' because we use the same key in the agenda."
3266 "The key to be installed in `calendar-mode-map' for adding diary entries.
3267 This option is irrelevant until `org-agenda-diary-file' has been configured
3268 to point to an Org-mode file. When that is the case, the command
3269 `org-agenda-diary-entry' will be bound to the key given here, by default
3270 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3271 if you want to continue doing this, you need to change this to a different
3272 key."
3277 "File to which to add new entries with the `i' key in agenda and calendar.
3278 When this is the symbol `diary-file', the functionality in the Emacs
3279 calendar will be used to add entries to the `diary-file'. But when this
3280 points to a file, `org-agenda-diary-entry' will be used instead."
3296 org-calendar-insert-diary-entry-key
3300 "Options for embedding LaTeX code into Org-mode."
3308 "Options for creating images from LaTeX fragments.
3309 This is a property list with the following properties:
3311 `default' means use the foreground of the default face.
3313 `default' means use the background of the default face.
3314 :scale a scaling factor for the size of the images, to get more pixels
3315 :html-foreground, :html-background, :html-scale
3316 the same numbers for HTML export.
3317 :matchers a list indicating which matchers should be used to
3318 find LaTeX fragments. Valid members of this list are:
3329 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3330 When nil, just push out a message."
3335 Use this to specify additional executable file say a jar file.
3337 When using MathToWeb as the converter, specify the full-path to
3338 your mathtoweb.jar file."
3345 "Command to convert LaTeX fragments to MathML.
3346 Replace format-specifiers in the command as noted below and use
3347 `shell-command' to convert LaTeX to MathML.
3348 %j: Executable file in fully expanded form as specified by
3349 `org-latex-to-mathml-jar-file'.
3350 %I: Input LaTeX file in fully expanded form
3351 %o: Output MathML file
3352 This command is used by `org-create-math-formula'.
3354 When using MathToWeb as the converter, set this to
3362 "Return t if `org-latex-to-mathml-convert-command' is usable."
3365 org-latex-to-mathml-convert-command)
3367 org-latex-to-mathml-convert-command))))
3372 t))))))
3379 \[PACKAGES]
3380 \[DEFAULT-PACKAGES]
3381 % The settings below are copied from fullpage.sty
3394 "The document header used for processing LaTeX fragments.
3395 It is imperative that this header make sure that no page number
3396 appears on the page. The package defined in the variables
3397 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3399 will be appended."
3406 "Set the packages alist and make sure it has 3 elements per entry."
3410 x))
3411 val)))
3415 "Get the packages alist and make sure it has 3 elements per entry."
3419 x))
3422 ;; The following variables are defined here because is it also used
3423 ;; when formatting latex fragments. Originally it was part of the
3424 ;; LaTeX exporter, which is why the name includes "export".
3441 )
3442 "Alist of default packages to be inserted in the header.
3443 Change this only if one of the packages here causes an incompatibility
3444 with another package you are using.
3445 The packages in this list are needed by one part or another of Org-mode
3446 to function properly.
3448 - inputenc, fontenc: for basic font and character selection
3449 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3450 for interpreting the entities in `org-entities'. You can skip some of these
3451 packages if you don't use any of the symbols in it.
3452 - graphicx: for including images
3453 - float, wrapfig: for figure placement
3454 - longtable: for long tables
3455 - hyperref: for cross references
3457 Therefore you should not modify this variable unless you know what you
3458 are doing. The one reason to change it anyway is that you might be loading
3459 some other package that conflicts with one of the default packages.
3461 If SNIPPET-FLAG is t, the package also needs to be included when
3462 compiling LaTeX snippets into images for inclusion into HTML."
3475 "Alist of packages to be inserted in every LaTeX header.
3476 These will be inserted after `org-export-latex-default-packages-alist'.
3478 SNIPPET-FLAG, when t, indicates that this package is also needed when
3479 turning LaTeX snippets into images for inclusion into HTML.
3480 Make sure that you only list packages here which:
3481 - you want in every file
3482 - do not conflict with the default packages in
3483 `org-export-latex-default-packages-alist'
3484 - do not conflict with the setup in `org-format-latex-header'."
3498 "Settings for Org-mode appearance."
3503 "Non-nil means fontify only the stars in each headline.
3504 When nil, the entire headline is fontified.
3505 Changing it requires restart of `font-lock-mode' to become effective
3506 also in regions already fontified."
3511 "Non-nil means hide the first N-1 stars in a headline.
3512 This works by using the face `org-hide' for these stars. This
3513 face is white for a light background, and black for a dark
3514 background. You may have to customize the face `org-hide' to
3515 make this work.
3516 Changing it requires restart of `font-lock-mode' to become effective
3517 also in regions already fontified.
3518 You may also set this on a per-file basis by adding one of the following
3519 lines to the buffer:
3521 #+STARTUP: hidestars
3522 #+STARTUP: showstars"
3527 "List of symbols corresponding to keywords to be hidden the org buffer.
3528 For example, a value '(title) for this list will make the document's title
3529 appear in the buffer without the initial #+TITLE: keyword."
3537 "Non-nil means change the face of a headline if it is marked DONE.
3538 Normally, only the TODO/DONE keyword indicates the state of a headline.
3539 When this is non-nil, the headline after the keyword is set to the
3540 `org-headline-done' as an additional indication."
3545 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3546 Changing this variable requires a restart of Emacs to take effect."
3551 "Non-nil means fontify the whole line for headings.
3552 This is useful when setting a background color for the
3553 org-level-* faces."
3558 "Non-nil means fontify what is treated specially by the exporters."
3563 "Non-nil mean font-lock should hide the emphasis marker characters."
3568 "Non-nil means show entities as UTF8 characters.
3574 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3579 "Regular expression for matching emphasis.
3580 After a match, the match groups contain these elements:
3581 0 The match of the full regular expression, including the characters
3582 before and after the proper match
3583 1 The character before the proper match, or empty at beginning of line
3584 2 The proper match, including the leading and trailing markers
3585 3 The leading marker like * or /, indicating the type of highlighting
3586 4 The text between the emphasis markers, not including the markers
3593 "Set variable and compute the emphasis regular expression."
3597 org-emphasis-alist org-emphasis-regexp-components)
3609 ;; make sure special characters appear at the right position in the class
3621 ;; Make the regexp
3629 body1
3641 body1
3649 "Components used to build the regular expression for emphasis.
3650 This is a list with five entries. Terminology: In an emphasis string
3654 specify what is allowed/forbidden in each part:
3656 pre Chars allowed as prematch. Beginning of line will be allowed too.
3657 post Chars allowed as postmatch. End of line will be allowed too.
3658 border The chars *forbidden* as border characters.
3660 non-shy groups here, and don't allow newline here.
3661 newline The maximum number of newlines allowed in an emphasis exp.
3663 Use customize to modify this, or restart Emacs after changing it."
3682 )
3683 "Special syntax for emphasized text.
3684 Text starting and ending with a special character will be emphasized, for
3685 example *bold*, _underlined_ and /italic/. This variable sets the marker
3686 characters, the face to be used by font-lock for highlighting in Org-mode
3687 Emacs buffers, and the HTML tags to be used for this.
3688 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3689 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3690 Use customize to modify this, or restart Emacs after changing it."
3705 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3708 ;;; Miscellaneous options
3711 "Completion in Org-mode."
3716 "Non-nil means use ido completion wherever possible.
3717 Note that `ido-mode' must be active for this variable to be relevant.
3718 If you decide to turn this variable on, you might well want to turn off
3719 `org-outline-path-complete-in-steps'.
3720 See also `org-completion-use-iswitchb'."
3725 "Non-nil means use iswitchb completion wherever possible.
3726 Note that `iswitchb-mode' must be active for this variable to be relevant.
3727 If you decide to turn this variable on, you might well want to turn off
3728 `org-outline-path-complete-in-steps'.
3729 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3735 Normal means, no org-mode-specific context."
3739 ;;; Functions and variables from their packages
3740 ;; Declared here to avoid compiler warnings
3742 ;; XEmacs only
3748 ;; Emacs only
3751 ;; Various packages
3770 org-agenda-format-item "org-agenda"
3801 ;;; Autoload and prepare some org modules
3803 ;; Some table stuff that needs to be defined here, because it is used
3804 ;; by the functions setting up org-mode or checking for table context.
3817 "Detect the first line outside a table when searching from within it.
3820 ;; Autoload the functions in org-table.el that are needed by functions here.
3825 org-table-convert org-table-convert-region org-table-copy-down
3826 org-table-copy-region org-table-create
3827 org-table-create-or-convert-from-region
3828 org-table-create-with-table.el org-table-current-dline
3829 org-table-cut-region org-table-delete-column org-table-edit-field
3830 org-table-edit-formulas org-table-end org-table-eval-formula
3831 org-table-export org-table-field-info
3832 org-table-get-stored-formulas org-table-goto-column
3833 org-table-hline-and-move org-table-import org-table-insert-column
3834 org-table-insert-hline org-table-insert-row org-table-iterate
3835 org-table-justify-field-maybe org-table-kill-row
3836 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3837 org-table-move-column org-table-move-column-left
3838 org-table-move-column-right org-table-move-row
3839 org-table-move-row-down org-table-move-row-up
3840 org-table-next-field org-table-next-row org-table-paste-rectangle
3841 org-table-previous-field org-table-recalculate
3842 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3843 org-table-toggle-coordinate-overlays
3844 org-table-toggle-formula-debugger org-table-wrap-region
3845 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3846 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3847 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3850 "Return t if the cursor is inside an org-type table.
3851 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3856 org-table-line-regexp)))
3857 nil))
3861 "Return t if and only if we are at a table.el table."
3867 "If there is a table.el table nearby, recognize it and move into it."
3873 nil
3883 t
3888 t)
3889 nil)
3890 nil))
3893 "Return t if the cursor is inside a hline in a table."
3898 nil))
3903 "Apply FUNCTION to the start of all tables in the buffer."
3919 ;; Declare and autoload functions from org-exp.el & Co
3927 org-insert-export-options-template
3928 org-table-clean-before-export))
3931 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3932 org-export-region-as-ascii))
3935 org-replace-region-by-latex org-export-region-as-latex
3936 org-export-as-latex org-export-as-pdf
3937 org-export-as-pdf-and-open))
3940 org-export-as-html-batch org-export-as-html-to-buffer
3941 org-replace-region-by-html org-export-region-as-html
3942 org-export-as-html))
3945 org-replace-region-by-docbook org-export-region-as-docbook
3946 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3947 org-export-as-docbook))
3950 org-export-icalendar-all-agenda-files
3951 org-export-icalendar-combine-agenda-files))
3955 ;; Declare and autoload functions from org-agenda.el
3960 org-todo-list org-tags-view org-agenda-list-stuck-projects
3961 org-diary org-agenda-to-appt
3962 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3964 ;; Autoload org-remember
3969 org-remember-apply-template org-remember org-remember-handler)))
3974 org-capture-import-remember-templates)))
3976 ;; Autoload org-clock.el
3991 "Return non-nil if clock is currently running.
3992 The return value is actually the clock marker."
3997 "org-clock"
3999 org-clock-goto org-clock-sum org-clock-display
4000 org-clock-remove-overlays org-clock-report
4001 org-clocktable-shift org-dblock-write:clocktable
4002 org-get-clocktable org-resolve-clocks)))
4005 "If this is a CLOCK line, update it and return t.
4006 Otherwise, return nil."
4015 ts te h m s neg)
4018 nil)
4023 ;; The clock is running here
4044 t))))))
4047 "Check if the current buffer contains the running clock.
4048 If yes, offer to stop it and to save the buffer with the changes."
4057 "Check if this line starts a clock table, if yes, shift the time block."
4061 ;; Autoload org-timer.el
4065 "org-timer"
4067 org-timer-change-times-in-region
4068 org-timer-set-timer
4069 org-timer-reset-timers
4070 org-timer-show-remaining-time)))
4072 ;; Autoload org-feed.el
4076 "org-feed"
4080 ;; Autoload org-indent.el
4082 ;; Define the variable already here, to make sure we have it.
4084 "Non-nil if Org-Indent mode is enabled.
4089 "org-indent"
4092 ;; Autoload org-mobile.el
4096 "org-mobile"
4099 ;; Autoload archiving code
4100 ;; The stuff that is needed for cycling and tags has to be defined here.
4103 "Options concerning archiving in Org-mode."
4108 "The location where subtrees should be archived.
4110 The value of this variable is a string, consisting of two parts,
4111 separated by a double-colon. The first part is a filename and
4112 the second part is a headline.
4114 When the filename is omitted, archiving happens in the same file.
4115 %s in the filename will be replaced by the current file
4116 name (without the directory part). Archiving to a different file
4117 is useful to keep archived entries from contributing to the
4118 Org-mode Agenda.
4120 The archived entries will be filed as subtrees of the specified
4121 headline. When the headline is omitted, the subtrees are simply
4122 filed away at the end of the file, as top-level entries. Also in
4123 the heading you can use %s to represent the file name, this can be
4124 useful when using the same archive for a number of different files.
4126 Here are a few examples:
4128 If the current file is Projects.org, archive in file
4129 Projects.org_archive, as top-level trees. This is the default.
4132 Archive in the current file, under the top-level headline
4136 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4139 Archive in file ~/org/archive.org (absolute path), under headlines
4143 Archive in file ./basement (relative path), as level 3 trees
4146 You may set this option on a per-file basis by adding to the buffer a
4147 line like
4149 #+ARCHIVE: basement::** Finished Tasks
4151 You may also define it locally for a subtree by setting an ARCHIVE property
4152 in the entry. If such a property is found in an entry, or anywhere up
4153 the hierarchy, it will be used."
4158 "The tag that marks a subtree as archived.
4159 An archived subtree does not open during visibility cycling, and does
4160 not contribute to the agenda listings.
4161 After changing this, font-lock must be restarted in the relevant buffers to
4162 get the proper fontification."
4168 "Non-nil means the agenda will skip any items located in archived trees.
4169 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4170 variable is no longer recommended, you should leave it at the value t.
4171 Instead, use the key `v' to cycle the archives-mode in the agenda."
4177 "Non-nil means ignore archived trees when creating column view."
4183 "Non-nil means `org-cycle' will open archived trees.
4184 An archived tree is a tree marked with the tag ARCHIVE.
4185 When nil, archived trees will stay folded. You can still open them with
4186 normal outline commands like `show-all', but not with the cycling commands."
4192 "Non-nil means sparse tree construction shows matches in archived trees.
4193 When nil, matches in these trees are highlighted, but the trees are kept in
4194 collapsed state."
4200 "Re-hide all archived subtrees after a visibility state change."
4211 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4214 "Cycle subtree even if it is archived."
4221 "Re-hide all archived subtrees after a visibility state change."
4236 flag)))
4243 org-archive-to-archive-sibling org-toggle-archive-tag
4244 org-archive-subtree-default
4245 org-archive-subtree-default-with-confirmation)))
4247 ;; Autoload Column View Code
4255 org-columns-compute org-agenda-columns org-columns-remove-overlays
4258 ;; Autoload ID code
4266 org-id-get-with-outline-path-completion
4267 org-id-get-with-outline-drilling org-id-store-link
4268 org-id-goto org-id-find org-id-store-link))
4270 ;; Autoload Plotting Code
4275 ;;; Variables for pre-computed regular expressions, all buffer local
4293 "Matches a headline and puts everything into groups:
4294 group 1: the stars
4295 group 2: The todo keyword, maybe
4296 group 3: Priority cookie
4297 group 4: True headline
4301 "Printf format to make regexp to match an exact headline.
4302 This regexp will match the headline of any node which has the
4303 exact headline text that is put into the format, but may have any
4307 "Matches a headline and puts TODO state into group 2 if present.
4356 "Regular expression to match a plain time or time range.
4357 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4358 groups carry important information:
4359 0 the full match
4360 1 the first time, range or not
4368 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4369 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4370 groups carry important information:
4371 0 the full match
4372 7 hours of duration
4381 "Regular expression to match a timestamp time or time range.
4382 After a match, the following groups carry important information:
4383 0 the full match
4384 1 date plus weekday, for back referencing to make sure both times are on the same day
4385 2 the first time, range or not
4440 "Variable associated with STARTUP options for org-mode.
4441 Each element is a list of three items: The startup options as written
4442 in the #+STARTUP line, the corresponding variable, and the value to
4443 set this variable to if the option is found. An optional forth element PUSH
4447 "Update PROPS with KEY and VAL."
4461 "Printf format for a regexp matching an headline with some keyword.
4462 This regexp will match the headline of any node which has the
4463 exact keyword that is put into the format. The keyword isn't in
4467 "Printf format for a regexp matching an headline, possibly with some keyword.
4468 This regexp can match any headline with the specified keyword, or
4469 without a keyword. The keyword isn't in any group by default,
4473 "Precompute regular expressions for current buffer."
4493 kwds kws0 kwsa key log value cat arch tags const links hw dws
4494 tail sep kws1 prio props ftags drawers beamer-p
4516 ;; general TODO-like setup
4528 links)))
4535 props))))
4540 ftags
4550 l var val)
4580 ;; search for property blocks
4589 props)))))))
4606 ;; Process the TODO keywords
4608 ;; Use the global values as if they had been given locally.
4620 kws)))
4623 kwsa nil
4626 ;; 1 2
4634 kw)
4636 kws0)
4653 ;; Process the constants
4661 ;; Process the tags.
4672 tgs))
4680 ;; Compute the regular expressions and other local variables.
4681 ;; Using `org-outline-regexp-bol' would complicate them much,
4682 ;; because of the fixed white space at the end of that string.
4690 org-drawer-regexp
4694 org-not-done-keywords
4696 org-todo-regexp
4700 org-not-done-regexp
4704 org-not-done-heading-regexp
4706 org-todo-line-regexp
4708 org-complex-heading-regexp
4715 org-complex-heading-regexp-format
4720 ;; Stats cookies can be stuck to body.
4727 org-todo-line-tags-regexp
4734 org-deadline-time-regexp
4736 org-deadline-line-regexp
4738 org-scheduled-regexp
4740 org-scheduled-time-regexp
4742 org-closed-time-regexp
4744 org-keyword-time-regexp
4750 org-keyword-time-not-clock-regexp
4756 org-maybe-keyword-time-regexp
4762 org-planning-or-clock-line-re
4767 org-all-time-keywords
4770 org-clock-string org-closed-string))
4771 )
4776 "Return the contents of FILE, as a string."
4790 "Extract the log state setting from a TODO keyword string.
4804 "Remove a pair of parenthesis at the end of each string in LIST."
4808 x))
4809 list))
4812 "Assign fast keys to a keyword-key alist.
4813 Respect keys that are already there."
4831 ;;; Some variables used in various places
4838 "Function to be called when `C-c C-c' is used.
4842 ;; FIXME: Occasionally check by commenting these, to make sure
4843 ;; no other functions uses these, forgetting to let-bind them.
4848 ;; Defined somewhere in this file, but used before definition.
4854 ;;;; Define the Org-mode
4857 (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"))
4860 ;; We use a before-change function to check if a table might need
4861 ;; an update.
4863 "Indicates that a table might need an update.
4864 This variable is set by `org-before-change-function'.
4867 "Every change indicates that a table might need an update."
4877 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4878 ;; some places -- e.g. see the macro org-with-limited-levels.
4879 ;;
4880 ;; In Org buffers, the value of `outline-regexp' is that of
4881 ;; `org-outline-regexp'. The only function still directly relying on
4882 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4883 ;; job when `orgstruct-mode' is active.
4887 "Regexp to match Org headlines.
4888 This is similar to `org-outline-regexp' but additionally makes
4892 "Matches an headline, putting stars and text into groups.
4895 ;;;###autoload
4897 "Outline-based notes management and organizer, alias
4900 Org-mode develops organizational tasks around a NOTES file which
4901 contains information about projects as plain text. Org-mode is
4902 implemented on top of outline-mode, which is ideal to keep the content
4903 of large files well structured. It supports ToDo items, deadlines and
4904 time stamps, which magically appear in the diary listing of the Emacs
4905 calendar. Tables are easily created with a built-in table editor.
4906 Plain text URL-like links connect to websites, emails (VM), Usenet
4907 messages (Gnus), BBDB entries, and any files related to the project.
4908 For printing and sharing of notes, an Org-mode file (or a part of it)
4909 can be exported as a structured ASCII or HTML file.
4911 The following commands are available:
4915 ;; Get rid of Outline menus, they are not needed
4916 ;; Need to do this here because define-derived-mode sets up
4917 ;; the keymap so late. Still, it is a waste to call this each time
4918 ;; we switch another buffer into org-mode.
4921 ;; Assume this is Greg's port, it uses easymenu
4947 org-display-table 4
4950 org-ellipsis)))
4955 ;; tag faces set outside customize.... force initialization.
4957 ;; Calc embedded
4963 ;; Activate before-change-function
4967 ;; Check for running clock before killing a buffer
4969 ;; Paragraphs and auto-filling
4973 ;; Beginning/end of defun
4976 ;; Next error for sparse trees
4978 ;; Make sure dependence stuff works reliably, even for users who set it
4979 ;; too late :-(
4991 ;; Comment characters
4995 ;; Align options lines
4997 'align-mode-rules-list
5002 ;; Imenu
5006 ;; Make isearch reveal context
5009 ;; Emacs 21 and XEmacs make use of the hook
5011 ;; Emacs 22 deals with this through a special variable
5015 ;; Turn on org-beamer-mode?
5018 ;; Setup the pcomplete hooks
5032 ;; If empty file that did not turn on org-mode automatically, make it to.
5057 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5067 "Return today date, considering `org-extend-today-until'."
5072 ;;;; Font-Lock stuff, including the activators
5103 "Regular expression used to analyze links.
5104 Here is what the match groups contain after a match:
5105 1: http:
5106 2: http
5107 3: path
5108 4: [desc]
5116 "Number of stacked braces for sub/superscript matching.
5117 This has to be set before loading org.el to be effective."
5122 "Create a regular expression which will match a balanced sexp.
5123 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5124 as single character strings.
5125 The regexp returned will match the entire expression including the
5126 delimiters. It will also define a single group which contains the
5127 match except for the outermost delimiters. The maximum depth of
5128 stacked delimiters is N. Escaping delimiters is not possible."
5157 "Update the link regular expressions.
5158 This should be called after the variable `org-link-types' has changed."
5162 org-link-re-with-space
5168 org-link-re-with-space2
5174 org-link-re-with-space3
5179 org-angle-link-re
5185 org-plain-link-re
5189 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5190 org-bracket-link-regexp
5192 org-bracket-link-analytic-regexp
5200 org-bracket-link-analytic-regexp++
5208 org-any-link-re
5217 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5219 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5220 "Regular expression matching time strings for analysis.
5221 This one does not require the space after the date, so it can be used
5223 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5239 "Regular expression matching a time stamp or time stamp range.
5245 "Run through the buffer and add overlays to emphasized strings."
5254 'face
5267 rtn))
5270 "Insert or change an emphasis, i.e. a font like bold or italic.
5271 If there is an active region, change that region to a new emphasis.
5272 If there is no region, just insert the marker characters and position
5273 the cursor between them.
5274 CHAR should be either the marker character, or the first character of the
5275 HTML tag associated with that emphasis. If CHAR is a space, the means
5276 to remove the emphasis of the selected region.
5277 If char is not given (for example in an interactive call) it
5278 will be prompted for."
5329 "Run through the buffer and add overlays to links."
5338 nil
5344 t)))))
5352 t)))
5355 "When non-nil, fontify code in code blocks."
5366 "Fontify #+ lines and blocks, in the correct ways."
5369 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5370 limit t)
5378 end end1 quoting block-type ovl)
5381 ;; a single line of backend-specific content
5389 ; for backend-specific code
5390 t)
5392 ;; Truly a block
5404 beg end
5412 ;; remove old background overlays
5417 ;; add a background overlay
5431 t))
5444 ;; just any other in-buffer setting, but not indented
5448 t)
5456 t)
5464 "Strip protective commas between BEG and END in the current buffer."
5480 "Run through the buffer and add overlays to links."
5488 t)))
5491 "Run through the buffer and add overlays to footnotes."
5498 'keymap org-mouse-map
5499 'help-echo
5501 "Footnote definition"
5503 'font-lock-fontified t
5504 'font-lock-multiline t
5508 "Run through the buffer and add overlays to bracketed links."
5512 ;; FIXME: above we should remove the escapes.
5513 ;; but that requires another match, protecting match data,
5514 ;; a lot of overhead for font-lock.
5521 ;; We need to remove the invisible property here. Table narrowing
5522 ;; may have made some of this invisible.
5540 t)))
5543 "Run through the buffer and add overlays to dates."
5555 t)))
5564 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5568 "Run through the buffer and add overlays to target matches."
5576 'keymap org-mouse-map
5580 t)))))
5583 "Find all radio targets in this file and update the regular expression."
5598 t)))
5605 ;; This should be with the exporter code, but we also use if for font-locking
5615 "Compute regular expression for stuff treated specially by exporters."
5622 org-latex-regexps)))
5650 org-entities)))
5654 org-latex-entities)
5655 nil))
5657 ))
5658 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5661 org-export-html-special-string-regexps)))
5666 ))))
5668 'org-latex-and-specials-regexp
5673 "Run through the buffer and add overlays to links."
5677 limit t))
5691 rtn)))
5694 "Restart `font-lock-mode', to force refontification."
5700 "Return a list of all targets in this file.
5701 With optional argument RADIO, only find radio targets."
5703 rtn)
5708 rtn)))
5711 "Make regular expression matching all strings in TARGETS.
5712 The regular expression finds the targets also if there is a line break
5713 between words."
5722 x)
5723 targets
5735 t)))
5738 "Compute the outline level of the heading at point.
5739 This function assumes that the cursor is at the beginning of a line matched
5740 by `outline-regexp'. Otherwise it returns garbage.
5741 If this is called at a normal headline, the level is the number of stars.
5742 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5749 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5756 "Functions that can manipulate `org-font-lock-extra-keywords'.
5757 This is called after `org-font-lock-extra-keywords' is defined, but before
5758 it is installed to be used by font lock. This can be useful if something
5769 ;; Call the hook
5771 ;; Headlines
5778 ;; Table lines
5781 ;; Table internals
5786 ;; Drawers
5789 ;; Properties
5793 ;; Links
5803 ;; TODO keyword
5805 org-todo-regexp)
5807 ;; DONE
5815 nil)
5816 ;; Priorities
5818 ;; Tags
5820 ;; Special keywords
5825 ;; Emphasis
5830 ;; Checkboxes
5831 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5836 ;; Description list items
5839 ;; ARCHIVEd headings
5841 org-outline-regexp-bol
5844 ;; Specials
5848 ;; Code
5850 ;; COMMENT
5857 ;; Blocks and meta lines
5859 )))
5862 ;; Now set the full font-lock-keywords
5869 "Toggle the composition display of entities as UTF8 characters."
5881 "Find an entity to fontify."
5887 limit t)
5899 nil))))
5902 "Fontify string S like in Org-mode."
5914 "Get the right face for match N in font-lock matching of headlines."
5927 "Get the right face for a TODO keyword KWD.
5928 If KWD is a number, get the corresponding match group."
5936 "Create a face list that inherits INHERIT, but sets the foreground color.
5937 When FACE-OR-COLOR is not a string, just return it."
5941 face-or-color)
5942 face-or-color))
5945 "Add the special tag faces."
5954 "Add the special priority faces."
5961 org-priority-faces)))
5966 "Get the right face for a TODO keyword KWD.
5967 If KWD is a number, get the corresponding match group."
5974 "Remove fontification and activation overlays from links."
5979 deactivate-mark buffer-file-name buffer-file-truename)
5983 invisible t intangible t
5984 org-no-flyspell t org-emphasis t))
5994 "Remove specific display properties that have been added by font lock.
5995 The will remove the raise properties that are used to show superscripts
5996 and subscripts."
6006 "Add raise properties to sub/superscripts."
6010 org-match-substring-regexp
6011 org-match-substring-with-braces-regexp)
6012 limit t)
6022 ;; FIXME: Should we go back one character here, for a_b^c
6023 ;; (goto-char (1- pos)) ;????????????????????
6025 t
6027 'display
6043 t)))))
6045 ;;;; Visibility cycling, including org-goto and indirect buffer
6047 ;;; Cycling
6054 ;;;###autoload
6059 "TAB-action and visibility cycling for Org-mode.
6061 This is the command invoked in Org-mode by the TAB key. Its main purpose
6062 is outline visibility cycling, but it also invokes other actions
6063 in special contexts.
6065 - When this function is called with a prefix argument, rotate the entire
6066 buffer through 3 states (global cycling)
6067 1. OVERVIEW: Show only top-level headlines.
6068 2. CONTENTS: Show all headlines of all levels, but no body text.
6069 3. SHOW ALL: Show everything.
6070 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6071 determined by the variable `org-startup-folded', and by any VISIBILITY
6072 properties in the buffer.
6073 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6074 including any drawers.
6076 - When inside a table, re-align the table and move to the next field.
6078 - When point is at the beginning of a headline, rotate the subtree started
6079 by this line through 3 different states (local cycling)
6080 1. FOLDED: Only the main headline is shown.
6081 2. CHILDREN: The main headline and the direct children are shown.
6082 From this state, you can move to one of the children
6083 and zoom in further.
6084 3. SUBTREE: Show the entire subtree, including body text.
6085 If there is no subtree, switch directly from CHILDREN to FOLDED.
6087 - When point is at the beginning of an empty headline and the variable
6088 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6089 of the headline by demoting and promoting it to likely levels. This
6090 speeds up creation document structure by pressing TAB once or several
6091 times right after creating a new headline.
6093 - When there is a numeric prefix, go up to a heading with level ARG, do
6094 a `show-subtree' and return to the previous cursor position. If ARG
6095 is negative, go up that many levels.
6097 - When point is not at the beginning of a headline, execute the global
6098 binding for TAB, which is re-indenting the line. See the option
6099 `org-cycle-emulate-tab' for details.
6101 - Special case: if point is at the beginning of the buffer and there is
6102 no headline in line 1, this function will act as if called with prefix arg
6103 (C-u TAB, same as S-TAB) also when called without prefix arg.
6104 But only if also the variable `org-cycle-global-at-bob' is t."
6114 org-inlinetask-min-level
6119 limit-level)))
6122 outline-regexp
6130 org-cycle-hook))
6134 ;; special case: use global cycling
6148 ;; Table: enter it or move to the next field.
6159 ;; Global cycling: delegate to `org-cycle-internal-global'.
6162 ;; Drawers: delegate to `org-flag-drawer'.
6170 ;; Show-subtree, ARG levels up from here.
6178 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6186 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6193 ;; From there: TAB emulation and template completion.
6215 t
6224 "Do the global cycling action."
6228 ;; We just created the overview - now do table of contents
6229 ;; This can be slow in very large buffers, so indicate action
6239 ;; We just showed the table of contents - now show everything
6247 ;; Default action: go to overview
6255 "Do the local cycling action."
6257 ;; First, determine end of headline (EOH), end of subtree or item
6258 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6282 ;; Determine end invisible part of buffer (EOL)
6284 ;; XEmacs doesn't have `next-single-char-property-change'
6294 ;; Find out what to do next and set `this-command'
6297 ;; Nothing is hidden behind this heading
6309 org-cycle-skip-children-state-if-no-children))))
6310 ;; Entire subtree is hidden in one line: children view
6316 ;; FIXME: This slows down the func way too much.
6317 ;; How keep drawers hidden in subtree anyway?
6318 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6319 ;; (org-cycle-hide-drawers 'subtree))
6321 ;; Fold every list in subtree to top-level items.
6343 ;; We just showed the children, or no children are there,
6344 ;; now show everything.
6351 ;; Default action: hide the subtree.
6358 ;;;###autoload
6360 "Cycle the global visibility. For details see `org-cycle'.
6362 With a numeric prefix, show all headlines up to that level."
6378 "Set the visibility required by startup options and properties."
6393 "Switch subtree visibilities according to :VISIBILITY: property."
6400 nil t)
6424 ;; This function uses outline-regexp instead of the more fundamental
6425 ;; org-outline-regexp so that org-cycle-global works outside of Org
6426 ;; buffers, where outline-regexp is needed.
6428 "Switch to overview mode, showing only top-level headlines.
6429 Really, this shows all headlines with level equal or greater than the level
6430 of the first headline in the buffer. This is important, because if the
6431 first headline is not level one, then (hide-sublevels 1) gives confusing
6432 results."
6443 "Show all headlines in the buffer, like a table of contents.
6444 With numerical argument N, show content up to level N."
6447 ;; Visit all headings and show their offspring
6454 t)
6463 "Adjust the window after a change in outline visibility.
6464 This function is the default value of the hook `org-cycle-hook'."
6474 "Remove outline overlays that do not contain non-white stuff."
6484 "Fix visibility issues after moving a subtree."
6485 ;; First, find a reasonable region to look at:
6486 ;; Start two siblings above, end three below
6504 ;; Properly fold already folded siblings
6515 "Show empty lines above all visible headlines.
6516 The region to be covered depends on STATE when called through
6517 `org-cycle-hook'. Lisp program can use t for STATE to get the
6518 entire buffer covered. Note that an empty line is only shown if there
6519 are at least `org-cycle-separator-lines' empty lines before the headline."
6529 beg end b e)
6553 ;; Never hide empty lines at the end of the file.
6563 "Move to the parent and re-show empty lines before visible headlines."
6569 "Return `org-agenda-files' list, plus all open org-mode files.
6570 This is useful for operations that need to scan all of a user's
6571 open and agenda-wise Org files."
6579 files))
6582 "Return the beginning position of the current entry."
6586 "Return the end position of the current entry."
6590 "Re-hide all drawers after a visibility state change."
6616 "Is the end of the current subtree visible?"
6621 "Move cursor to the first headline and recenter the headline.
6622 Optional argument N means put the headline into the Nth line of the window."
6628 ;;; Saving and restoring visibility
6631 "Return a list of the locations of all outline overlays.
6632 These are overlays with the `invisible' property value `outline'.
6633 The return value is a list of cons cells, with start and stop
6634 positions for each overlay.
6635 If USE-MARKERS is set, return the positions as markers."
6653 "Create visibility overlays for all positions in DATA.
6654 DATA should have been made by `org-outline-overlay-data'."
6662 data)))))
6664 ;;; Folding of blocks
6671 "Call FUNCTION at the head of all source blocks in the current buffer.
6672 Optional arguments START and END can be used to limit the range."
6684 "Toggle the visibility of all blocks in the current buffer."
6688 "Fold all blocks in the current buffer."
6694 "Unfold all blocks in the current buffer."
6700 "Toggle visibility of block at point."
6711 "Toggle the visibility of the current block."
6718 ov)
6734 ;; make the block accessible to isearch
6736 ov 'isearch-open-invisible
6747 ;; org-tab-after-check-for-cycling-hook
6749 ;; Remove overlays when changing major mode
6754 ;;; Org-goto
6760 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6776 nil)
6777 (org-defkey map "q" 'org-goto-quit)
6778 (org-defkey map "n" 'outline-next-visible-heading)
6779 (org-defkey map "p" 'outline-previous-visible-heading)
6780 (org-defkey map "f" 'outline-forward-same-level)
6781 (org-defkey map "b" 'outline-backward-same-level)
6782 (org-defkey map "u" 'outline-up-heading))
6783 (org-defkey map "/" 'org-occur)
6784 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6785 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6786 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6787 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6788 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6789 map))
6791 (defconst org-goto-help
6792 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6793 RET=jump to location [Q]uit and return to previous location
6794 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6796 (defvar org-goto-start-pos) ; dynamically scoped parameter
6798 ;; FIXME: Docstring does not mention both interfaces
6799 (defun org-goto (&optional alternative-interface)
6800 "Look up a different location in the current file, keeping current visibility.
6802 When you want look-up or go to a different location in a document, the
6803 fastest way is often to fold the entire buffer and then dive into the tree.
6804 This method has the disadvantage, that the previous location will be folded,
6805 which may not be what you want.
6807 This command works around this by showing a copy of the current buffer
6808 in an indirect buffer, in overview mode. You can dive into the tree in
6809 that copy, use org-occur and incremental search to find a location.
6810 When pressing RET or `Q', the command returns to the original buffer in
6811 which the visibility is still unchanged. After RET it will also jump to
6812 the location selected in the indirect buffer and expose the headline
6813 hierarchy above."
6814 (interactive "P")
6815 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6816 (org-refile-use-outline-path t)
6817 (org-refile-target-verify-function nil)
6818 (interface
6819 (if (not alternative-interface)
6820 org-goto-interface
6821 (if (eq org-goto-interface 'outline)
6822 'outline-path-completion
6823 'outline)))
6824 (org-goto-start-pos (point))
6825 (selected-point
6826 (if (eq interface 'outline)
6827 (car (org-get-location (current-buffer) org-goto-help))
6828 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6829 (org-refile-check-position pa)
6830 (nth 3 pa)))))
6831 (if selected-point
6832 (progn
6833 (org-mark-ring-push org-goto-start-pos)
6834 (goto-char selected-point)
6835 (if (or (outline-invisible-p) (org-invisible-p2))
6836 (org-show-context 'org-goto)))
6837 (message "Quit"))))
6839 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6840 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6841 (defvar org-goto-local-auto-isearch-map) ; defined below
6843 (defun org-get-location (buf help)
6844 "Let the user select a location in the Org-mode buffer BUF.
6845 This function uses a recursive edit. It returns the selected position
6846 or nil."
6847 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6848 (isearch-hide-immediately nil)
6849 (isearch-search-fun-function
6850 (lambda () 'org-goto-local-search-headings))
6851 (org-goto-selected-point org-goto-exit-command)
6852 (pop-up-frames nil)
6853 (special-display-buffer-names nil)
6854 (special-display-regexps nil)
6855 (special-display-function nil))
6856 (save-excursion
6857 (save-window-excursion
6858 (delete-other-windows)
6859 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6860 (org-pop-to-buffer-same-window
6861 (condition-case nil
6862 (make-indirect-buffer (current-buffer) "*org-goto*")
6863 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6864 (with-output-to-temp-buffer "*Help*"
6865 (princ help))
6866 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6867 (setq buffer-read-only nil)
6868 (let ((org-startup-truncated t)
6869 (org-startup-folded nil)
6870 (org-startup-align-all-tables nil))
6871 (org-mode)
6872 (org-overview))
6873 (setq buffer-read-only t)
6874 (if (and (boundp 'org-goto-start-pos)
6875 (integer-or-marker-p org-goto-start-pos))
6876 (let ((org-show-hierarchy-above t)
6877 (org-show-siblings t)
6878 (org-show-following-heading t))
6879 (goto-char org-goto-start-pos)
6880 (and (outline-invisible-p) (org-show-context)))
6881 (goto-char (point-min)))
6882 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6883 (message "Select location and press RET")
6884 (use-local-map org-goto-map)
6885 (recursive-edit)
6886 ))
6887 (kill-buffer "*org-goto*")
6888 (cons org-goto-selected-point org-goto-exit-command)))
6890 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6891 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6892 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6893 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6895 (defun org-goto-local-search-headings (string bound noerror)
6896 "Search and make sure that any matches are in headlines."
6897 (catch 'return
6898 (while (if isearch-forward
6899 (search-forward string bound noerror)
6900 (search-backward string bound noerror))
6901 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6902 (and (member :headline context)
6903 (not (member :tags context))))
6904 (throw 'return (point))))))
6906 (defun org-goto-local-auto-isearch ()
6907 "Start isearch."
6908 (interactive)
6909 (goto-char (point-min))
6910 (let ((keys (this-command-keys)))
6911 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6912 (isearch-mode t)
6913 (isearch-process-search-char (string-to-char keys)))))
6915 (defun org-goto-ret (&optional arg)
6916 "Finish `org-goto' by going to the new location."
6917 (interactive "P")
6918 (setq org-goto-selected-point (point)
6919 org-goto-exit-command 'return)
6920 (throw 'exit nil))
6922 (defun org-goto-left ()
6923 "Finish `org-goto' by going to the new location."
6924 (interactive)
6925 (if (org-at-heading-p)
6926 (progn
6927 (beginning-of-line 1)
6928 (setq org-goto-selected-point (point)
6929 org-goto-exit-command 'left)
6930 (throw 'exit nil))
6931 (error "Not on a heading")))
6933 (defun org-goto-right ()
6934 "Finish `org-goto' by going to the new location."
6935 (interactive)
6936 (if (org-at-heading-p)
6937 (progn
6938 (setq org-goto-selected-point (point)
6939 org-goto-exit-command 'right)
6940 (throw 'exit nil))
6941 (error "Not on a heading")))
6943 (defun org-goto-quit ()
6944 "Finish `org-goto' without cursor motion."
6945 (interactive)
6946 (setq org-goto-selected-point nil)
6947 (setq org-goto-exit-command 'quit)
6948 (throw 'exit nil))
6950 ;;; Indirect buffer display of subtrees
6952 (defvar org-indirect-dedicated-frame nil
6953 "This is the frame being used for indirect tree display.")
6954 (defvar org-last-indirect-buffer nil)
6956 (defun org-tree-to-indirect-buffer (&optional arg)
6957 "Create indirect buffer and narrow it to current subtree.
6958 With numerical prefix ARG, go up to this level and then take that tree.
6959 If ARG is negative, go up that many levels.
6960 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6961 indirect buffer previously made with this command, to avoid proliferation of
6962 indirect buffers. However, when you call the command with a \
6964 when `org-indirect-buffer-display' is `new-frame', the last buffer
6965 is kept so that you can work with several indirect buffers at the same time.
6966 If `org-indirect-buffer-display' is `dedicated-frame', the \
6968 requests that a new frame be made for the new buffer, so that the dedicated
6969 frame is not changed."
6970 (interactive "P")
6971 (let ((cbuf (current-buffer))
6972 (cwin (selected-window))
6973 (pos (point))
6974 beg end level heading ibuf)
6975 (save-excursion
6976 (org-back-to-heading t)
6977 (when (numberp arg)
6978 (setq level (org-outline-level))
6979 (if (< arg 0) (setq arg (+ level arg)))
6980 (while (> (setq level (org-outline-level)) arg)
6981 (outline-up-heading 1 t)))
6982 (setq beg (point)
6983 heading (org-get-heading))
6984 (org-end-of-subtree t t)
6985 (if (org-at-heading-p) (backward-char 1))
6986 (setq end (point)))
6987 (if (and (buffer-live-p org-last-indirect-buffer)
6988 (not (eq org-indirect-buffer-display 'new-frame))
6989 (not arg))
6990 (kill-buffer org-last-indirect-buffer))
6991 (setq ibuf (org-get-indirect-buffer cbuf)
6992 org-last-indirect-buffer ibuf)
6993 (cond
6994 ((or (eq org-indirect-buffer-display 'new-frame)
6995 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6996 (select-frame (make-frame))
6997 (delete-other-windows)
6998 (org-pop-to-buffer-same-window ibuf)
6999 (org-set-frame-title heading))
7000 ((eq org-indirect-buffer-display 'dedicated-frame)
7001 (raise-frame
7002 (select-frame (or (and org-indirect-dedicated-frame
7003 (frame-live-p org-indirect-dedicated-frame)
7004 org-indirect-dedicated-frame)
7005 (setq org-indirect-dedicated-frame (make-frame)))))
7006 (delete-other-windows)
7007 (org-pop-to-buffer-same-window ibuf)
7008 (org-set-frame-title (concat "Indirect: " heading)))
7009 ((eq org-indirect-buffer-display 'current-window)
7010 (org-pop-to-buffer-same-window ibuf))
7011 ((eq org-indirect-buffer-display 'other-window)
7012 (pop-to-buffer ibuf))
7013 (t (error "Invalid value")))
7014 (if (featurep 'xemacs)
7015 (save-excursion (org-mode) (turn-on-font-lock)))
7016 (narrow-to-region beg end)
7017 (show-all)
7018 (goto-char pos)
7019 (run-hook-with-args 'org-cycle-hook 'all)
7020 (and (window-live-p cwin) (select-window cwin))))
7022 (defun org-get-indirect-buffer (&optional buffer)
7023 (setq buffer (or buffer (current-buffer)))
7024 (let ((n 1) (base (buffer-name buffer)) bname)
7025 (while (buffer-live-p
7026 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7027 (setq n (1+ n)))
7028 (condition-case nil
7029 (make-indirect-buffer buffer bname 'clone)
7030 (error (make-indirect-buffer buffer bname)))))
7032 (defun org-set-frame-title (title)
7033 "Set the title of the current frame to the string TITLE."
7034 ;; FIXME: how to name a single frame in XEmacs???
7035 (unless (featurep 'xemacs)
7036 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7038 ;;;; Structure editing
7040 ;;; Inserting headlines
7042 (defun org-previous-line-empty-p ()
7043 (save-excursion
7044 (and (not (bobp))
7045 (or (beginning-of-line 0) t)
7046 (save-match-data
7049 (defun org-insert-heading (&optional force-heading invisible-ok)
7050 "Insert a new heading or item with same depth at point.
7051 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7052 If point is at the beginning of a headline, insert a sibling before the
7053 current headline. If point is not at the beginning, split the line,
7054 create the new headline with the text in the current line after point
7055 \(but see also the variable `org-M-RET-may-split-line').
7057 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7058 This is important for non-interactive uses of the command."
7059 (interactive "P")
7060 (if (or (= (buffer-size) 0)
7061 (and (not (save-excursion
7062 (and (ignore-errors (org-back-to-heading invisible-ok))
7063 (org-at-heading-p))))
7064 (or force-heading (not (org-in-item-p)))))
7065 (progn
7067 (run-hooks 'org-insert-heading-hook))
7068 (when (or force-heading (not (org-insert-item)))
7069 (let* ((empty-line-p nil)
7070 (level nil)
7071 (on-heading (org-at-heading-p))
7072 (head (save-excursion
7073 (condition-case nil
7074 (progn
7075 (org-back-to-heading invisible-ok)
7076 (when (and (not on-heading)
7077 (featurep 'org-inlinetask)
7078 (integerp org-inlinetask-min-level)
7079 (>= (length (match-string 0))
7080 org-inlinetask-min-level))
7081 ;; Find a heading level before the inline task
7082 (while (and (setq level (org-up-heading-safe))
7083 (>= level org-inlinetask-min-level)))
7084 (if (org-at-heading-p)
7085 (org-back-to-heading invisible-ok)
7086 (error "This should not happen")))
7087 (setq empty-line-p (org-previous-line-empty-p))
7088 (match-string 0))
7089 (error "*"))))
7090 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7091 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7092 pos hide-previous previous-pos)
7093 (cond
7094 ((and (org-at-heading-p) (bolp)
7095 (or (bobp)
7096 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7097 ;; insert before the current line
7098 (open-line (if blank 2 1)))
7099 ((and (bolp)
7100 (not org-insert-heading-respect-content)
7101 (or (bobp)
7102 (save-excursion
7103 (backward-char 1) (not (outline-invisible-p)))))
7104 ;; insert right here
7105 nil)
7106 (t
7107 ;; somewhere in the line
7108 (save-excursion
7109 (setq previous-pos (point-at-bol))
7110 (end-of-line)
7111 (setq hide-previous (outline-invisible-p)))
7112 (and org-insert-heading-respect-content (org-show-subtree))
7113 (let ((split
7114 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7115 (save-excursion
7116 (let ((p (point)))
7117 (goto-char (point-at-bol))
7118 (and (looking-at org-complex-heading-regexp)
7119 (match-beginning 4)
7120 (> p (match-beginning 4)))))))
7121 tags pos)
7122 (cond
7123 (org-insert-heading-respect-content
7124 (org-end-of-subtree nil t)
7125 (when (featurep 'org-inlinetask)
7126 (while (and (not (eobp))
7128 (>= (length (match-string 1))
7129 org-inlinetask-min-level))
7130 (org-end-of-subtree nil t)))
7131 (or (bolp) (newline))
7132 (or (org-previous-line-empty-p)
7133 (and blank (newline)))
7134 (open-line 1))
7135 ((org-at-heading-p)
7136 (when hide-previous
7137 (show-children)
7138 (org-show-entry))
7140 (setq tags (and (match-end 2) (match-string 2)))
7141 (and (match-end 1)
7142 (delete-region (match-beginning 1) (match-end 1)))
7143 (setq pos (point-at-bol))
7144 (or split (end-of-line 1))
7145 (delete-horizontal-space)
7147 (buffer-substring (point-at-bol) (point)))
7148 (insert " "))
7149 (newline (if blank 2 1))
7150 (when tags
7151 (save-excursion
7152 (goto-char pos)
7153 (end-of-line 1)
7154 (insert " " tags)
7155 (org-set-tags nil 'align))))
7156 (t
7157 (or split (end-of-line 1))
7158 (newline (if blank 2 1)))))))
7159 (insert head) (just-one-space)
7160 (setq pos (point))
7161 (end-of-line 1)
7162 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7163 (when (and org-insert-heading-respect-content hide-previous)
7164 (save-excursion
7165 (goto-char previous-pos)
7166 (hide-subtree)))
7167 (run-hooks 'org-insert-heading-hook)))))
7169 (defun org-get-heading (&optional no-tags no-todo)
7170 "Return the heading of the current entry, without the stars.
7171 When NO-TAGS is non-nil, don't include tags.
7172 When NO-TODO is non-nil, don't include TODO keywords."
7173 (save-excursion
7174 (org-back-to-heading t)
7175 (cond
7176 ((and no-tags no-todo)
7177 (looking-at org-complex-heading-regexp)
7178 (match-string 4))
7179 (no-tags
7180 (looking-at (concat org-outline-regexp
7183 (match-string 1))
7184 (no-todo
7185 (looking-at org-todo-line-regexp)
7186 (match-string 3))
7187 (t (looking-at org-heading-regexp)
7188 (match-string 2)))))
7190 (defun org-heading-components ()
7191 "Return the components of the current heading.
7192 This is a list with the following elements:
7193 - the level as an integer
7194 - the reduced level, different if `org-odd-levels-only' is set.
7195 - the TODO keyword, or nil
7196 - the priority character, like ?A, or nil if no priority is given
7197 - the headline text itself, or the tags string if no headline text
7198 - the tags string, or nil."
7199 (save-excursion
7200 (org-back-to-heading t)
7201 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7202 (list (length (match-string 1))
7203 (org-reduced-level (length (match-string 1)))
7204 (org-match-string-no-properties 2)
7205 (and (match-end 3) (aref (match-string 3) 2))
7206 (org-match-string-no-properties 4)
7207 (org-match-string-no-properties 5)))))
7209 (defun org-get-entry ()
7210 "Get the entry text, after heading, entire subtree."
7211 (save-excursion
7212 (org-back-to-heading t)
7213 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7215 (defun org-insert-heading-after-current ()
7216 "Insert a new heading with same level as current, after current subtree."
7217 (interactive)
7218 (org-back-to-heading)
7219 (org-insert-heading)
7220 (org-move-subtree-down)
7221 (end-of-line 1))
7223 (defun org-insert-heading-respect-content ()
7224 (interactive)
7225 (let ((org-insert-heading-respect-content t))
7226 (org-insert-heading t)))
7228 (defun org-insert-todo-heading-respect-content (&optional force-state)
7229 (interactive "P")
7230 (let ((org-insert-heading-respect-content t))
7231 (org-insert-todo-heading force-state t)))
7233 (defun org-insert-todo-heading (arg &optional force-heading)
7234 "Insert a new heading with the same level and TODO state as current heading.
7235 If the heading has no TODO state, or if the state is DONE, use the first
7236 state (TODO by default). Also with prefix arg, force first state."
7237 (interactive "P")
7238 (when (or force-heading (not (org-insert-item 'checkbox)))
7239 (org-insert-heading force-heading)
7240 (save-excursion
7241 (org-back-to-heading)
7242 (outline-previous-heading)
7243 (looking-at org-todo-line-regexp))
7244 (let*
7245 ((new-mark-x
7246 (if (or arg
7247 (not (match-beginning 2))
7248 (member (match-string 2) org-done-keywords))
7249 (car org-todo-keywords-1)
7250 (match-string 2)))
7251 (new-mark
7252 (or
7253 (run-hook-with-args-until-success
7254 'org-todo-get-default-hook new-mark-x nil)
7255 new-mark-x)))
7256 (beginning-of-line 1)
7257 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7258 (if org-treat-insert-todo-heading-as-state-change
7259 (org-todo new-mark)
7260 (insert new-mark " "))))
7261 (when org-provide-todo-statistics
7262 (org-update-parent-todo-statistics))))
7264 (defun org-insert-subheading (arg)
7265 "Insert a new subheading and demote it.
7266 Works for outline headings and for plain lists alike."
7267 (interactive "P")
7268 (org-insert-heading arg)
7269 (cond
7270 ((org-at-heading-p) (org-do-demote))
7271 ((org-at-item-p) (org-indent-item))))
7273 (defun org-insert-todo-subheading (arg)
7274 "Insert a new subheading with TODO keyword or checkbox and demote it.
7275 Works for outline headings and for plain lists alike."
7276 (interactive "P")
7277 (org-insert-todo-heading arg)
7278 (cond
7279 ((org-at-heading-p) (org-do-demote))
7280 ((org-at-item-p) (org-indent-item))))
7282 ;;; Promotion and Demotion
7284 (defvar org-after-demote-entry-hook nil
7285 "Hook run after an entry has been demoted.
7286 The cursor will be at the beginning of the entry.
7287 When a subtree is being demoted, the hook will be called for each node.")
7289 (defvar org-after-promote-entry-hook nil
7290 "Hook run after an entry has been promoted.
7291 The cursor will be at the beginning of the entry.
7292 When a subtree is being promoted, the hook will be called for each node.")
7294 (defun org-promote-subtree ()
7295 "Promote the entire subtree.
7296 See also `org-promote'."
7297 (interactive)
7298 (save-excursion
7299 (org-with-limited-levels (org-map-tree 'org-promote)))
7300 (org-fix-position-after-promote))
7302 (defun org-demote-subtree ()
7303 "Demote the entire subtree. See `org-demote'.
7304 See also `org-promote'."
7305 (interactive)
7306 (save-excursion
7307 (org-with-limited-levels (org-map-tree 'org-demote)))
7308 (org-fix-position-after-promote))
7311 (defun org-do-promote ()
7312 "Promote the current heading higher up the tree.
7313 If the region is active in `transient-mark-mode', promote all headings
7314 in the region."
7315 (interactive)
7316 (save-excursion
7317 (if (org-region-active-p)
7318 (org-map-region 'org-promote (region-beginning) (region-end))
7319 (org-promote)))
7320 (org-fix-position-after-promote))
7322 (defun org-do-demote ()
7323 "Demote the current heading lower down the tree.
7324 If the region is active in `transient-mark-mode', demote all headings
7325 in the region."
7326 (interactive)
7327 (save-excursion
7328 (if (org-region-active-p)
7329 (org-map-region 'org-demote (region-beginning) (region-end))
7330 (org-demote)))
7331 (org-fix-position-after-promote))
7333 (defun org-fix-position-after-promote ()
7334 "Make sure that after pro/demotion cursor position is right."
7335 (let ((pos (point)))
7336 (when (save-excursion
7337 (beginning-of-line 1)
7338 (looking-at org-todo-line-regexp)
7339 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7340 (cond ((eobp) (insert " "))
7341 ((eolp) (insert " "))
7342 ((equal (char-after) ?\ ) (forward-char 1))))))
7344 (defun org-current-level ()
7345 "Return the level of the current entry, or nil if before the first headline.
7346 The level is the number of stars at the beginning of the headline."
7347 (save-excursion
7348 (org-with-limited-levels
7349 (if (ignore-errors (org-back-to-heading t))
7350 (funcall outline-level)))))
7352 (defun org-get-previous-line-level ()
7353 "Return the outline depth of the last headline before the current line.
7354 Returns 0 for the first headline in the buffer, and nil if before the
7355 first headline."
7356 (let ((current-level (org-current-level))
7357 (prev-level (when (> (line-number-at-pos) 1)
7358 (save-excursion
7359 (beginning-of-line 0)
7360 (org-current-level)))))
7361 (cond ((null current-level) nil) ; Before first headline
7362 ((null prev-level) 0) ; At first headline
7363 (prev-level))))
7365 (defun org-reduced-level (l)
7366 "Compute the effective level of a heading.
7367 This takes into account the setting of `org-odd-levels-only'."
7368 (cond
7369 ((zerop l) 0)
7370 (org-odd-levels-only (1+ (floor (/ l 2))))
7371 (t l)))
7373 (defun org-level-increment ()
7374 "Return the number of stars that will be added or removed at a
7375 time to headlines when structure editing, based on the value of
7376 `org-odd-levels-only'."
7377 (if org-odd-levels-only 2 1))
7379 (defun org-get-valid-level (level &optional change)
7380 "Rectify a level change under the influence of `org-odd-levels-only'
7381 LEVEL is a current level, CHANGE is by how much the level should be
7382 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7383 even level numbers will become the next higher odd number."
7384 (if org-odd-levels-only
7385 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7386 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7387 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7388 (max 1 (+ level (or change 0)))))
7390 (if (boundp 'define-obsolete-function-alias)
7391 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7392 (define-obsolete-function-alias 'org-get-legal-level
7393 'org-get-valid-level)
7394 (define-obsolete-function-alias 'org-get-legal-level
7395 'org-get-valid-level "23.1")))
7397 (defun org-promote ()
7398 "Promote the current heading higher up the tree.
7399 If the region is active in `transient-mark-mode', promote all headings
7400 in the region."
7401 (org-back-to-heading t)
7402 (let* ((level (save-match-data (funcall outline-level)))
7403 (after-change-functions (remove 'flyspell-after-change-function
7404 after-change-functions))
7405 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7406 (diff (abs (- level (length up-head) -1))))
7407 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7408 (replace-match up-head nil t)
7409 ;; Fixup tag positioning
7410 (and org-auto-align-tags (org-set-tags nil t))
7411 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7412 (run-hooks 'org-after-promote-entry-hook)))
7414 (defun org-demote ()
7415 "Demote the current heading lower down the tree.
7416 If the region is active in `transient-mark-mode', demote all headings
7417 in the region."
7418 (org-back-to-heading t)
7419 (let* ((level (save-match-data (funcall outline-level)))
7420 (after-change-functions (remove 'flyspell-after-change-function
7421 after-change-functions))
7422 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7423 (diff (abs (- level (length down-head) -1))))
7424 (replace-match down-head nil t)
7425 ;; Fixup tag positioning
7426 (and org-auto-align-tags (org-set-tags nil t))
7427 (if org-adapt-indentation (org-fixup-indentation diff))
7428 (run-hooks 'org-after-demote-entry-hook)))
7430 (defun org-cycle-level ()
7431 "Cycle the level of an empty headline through possible states.
7432 This goes first to child, then to parent, level, then up the hierarchy.
7433 After top level, it switches back to sibling level."
7434 (interactive)
7435 (let ((org-adapt-indentation nil))
7436 (when (org-point-at-end-of-empty-headline)
7437 (setq this-command 'org-cycle-level) ; Only needed for caching
7438 (let ((cur-level (org-current-level))
7439 (prev-level (org-get-previous-line-level)))
7440 (cond
7441 ;; If first headline in file, promote to top-level.
7442 ((= prev-level 0)
7443 (loop repeat (/ (- cur-level 1) (org-level-increment))
7444 do (org-do-promote)))
7445 ;; If same level as prev, demote one.
7446 ((= prev-level cur-level)
7447 (org-do-demote))
7448 ;; If parent is top-level, promote to top level if not already.
7449 ((= prev-level 1)
7450 (loop repeat (/ (- cur-level 1) (org-level-increment))
7451 do (org-do-promote)))
7452 ;; If top-level, return to prev-level.
7453 ((= cur-level 1)
7454 (loop repeat (/ (- prev-level 1) (org-level-increment))
7455 do (org-do-demote)))
7456 ;; If less than prev-level, promote one.
7457 ((< cur-level prev-level)
7458 (org-do-promote))
7459 ;; If deeper than prev-level, promote until higher than
7460 ;; prev-level.
7461 ((> cur-level prev-level)
7462 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7463 do (org-do-promote))))
7464 t))))
7466 (defun org-map-tree (fun)
7467 "Call FUN for every heading underneath the current one."
7468 (org-back-to-heading)
7469 (let ((level (funcall outline-level)))
7470 (save-excursion
7471 (funcall fun)
7472 (while (and (progn
7473 (outline-next-heading)
7474 (> (funcall outline-level) level))
7475 (not (eobp)))
7476 (funcall fun)))))
7478 (defun org-map-region (fun beg end)
7479 "Call FUN for every heading between BEG and END."
7480 (let ((org-ignore-region t))
7481 (save-excursion
7482 (setq end (copy-marker end))
7483 (goto-char beg)
7484 (if (and (re-search-forward org-outline-regexp-bol nil t)
7485 (< (point) end))
7486 (funcall fun))
7487 (while (and (progn
7488 (outline-next-heading)
7489 (< (point) end))
7490 (not (eobp)))
7491 (funcall fun)))))
7493 (defvar org-property-end-re) ; silence byte-compiler
7494 (defun org-fixup-indentation (diff)
7495 "Change the indentation in the current entry by DIFF.
7496 However, if any line in the current entry has no indentation, or if it
7497 would end up with no indentation after the change, nothing at all is done."
7498 (save-excursion
7499 (let ((end (save-excursion (outline-next-heading)
7500 (point-marker)))
7501 (prohibit (if (> diff 0)
7504 col)
7505 (unless (save-excursion (end-of-line 1)
7506 (re-search-forward prohibit end t))
7507 (while (and (< (point) end)
7509 (goto-char (match-end 0))
7510 (setq col (current-column))
7511 (if (< diff 0) (replace-match ""))
7512 (org-indent-to-column (+ diff col))))
7513 (move-marker end nil))))
7515 (defun org-convert-to-odd-levels ()
7516 "Convert an org-mode file with all levels allowed to one with odd levels.
7517 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7518 level 5 etc."
7519 (interactive)
7520 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7521 (let ((outline-level 'org-outline-level)
7522 (org-odd-levels-only nil) n)
7523 (save-excursion
7524 (goto-char (point-min))
7526 (setq n (- (length (match-string 0)) 2))
7527 (while (>= (setq n (1- n)) 0)
7528 (org-demote))
7529 (end-of-line 1))))))
7531 (defun org-convert-to-oddeven-levels ()
7532 "Convert an org-mode file with only odd levels to one with odd/even levels.
7533 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7534 file contains a section with an even level, conversion would
7535 destroy the structure of the file. An error is signaled in this
7536 case."
7537 (interactive)
7538 (goto-char (point-min))
7539 ;; First check if there are no even levels
7541 (org-show-context t)
7542 (error "Not all levels are odd in this file. Conversion not possible"))
7543 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7544 (let ((outline-regexp org-outline-regexp)
7545 (outline-level 'org-outline-level)
7546 (org-odd-levels-only nil) n)
7547 (save-excursion
7548 (goto-char (point-min))
7550 (setq n (/ (1- (length (match-string 0))) 2))
7551 (while (>= (setq n (1- n)) 0)
7552 (org-promote))
7553 (end-of-line 1))))))
7555 (defun org-tr-level (n)
7556 "Make N odd if required."
7557 (if org-odd-levels-only (1+ (/ n 2)) n))
7559 ;;; Vertical tree motion, cutting and pasting of subtrees
7561 (defun org-move-subtree-up (&optional arg)
7562 "Move the current subtree up past ARG headlines of the same level."
7563 (interactive "p")
7564 (org-move-subtree-down (- (prefix-numeric-value arg))))
7566 (defun org-move-subtree-down (&optional arg)
7567 "Move the current subtree down past ARG headlines of the same level."
7568 (interactive "p")
7569 (setq arg (prefix-numeric-value arg))
7570 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7571 'org-get-last-sibling))
7572 (ins-point (make-marker))
7573 (cnt (abs arg))
7574 (col (current-column))
7575 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7576 ;; Select the tree
7577 (org-back-to-heading)
7578 (setq beg0 (point))
7579 (save-excursion
7580 (setq ne-beg (org-back-over-empty-lines))
7581 (setq beg (point)))
7582 (save-match-data
7583 (save-excursion (outline-end-of-heading)
7584 (setq folded (outline-invisible-p)))
7585 (outline-end-of-subtree))
7586 (outline-next-heading)
7587 (setq ne-end (org-back-over-empty-lines))
7588 (setq end (point))
7589 (goto-char beg0)
7590 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7591 ;; include less whitespace
7592 (save-excursion
7593 (goto-char beg)
7594 (forward-line (- ne-beg ne-end))
7595 (setq beg (point))))
7596 ;; Find insertion point, with error handling
7597 (while (> cnt 0)
7598 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7599 (progn (goto-char beg0)
7600 (error "Cannot move past superior level or buffer limit")))
7601 (setq cnt (1- cnt)))
7602 (if (> arg 0)
7603 ;; Moving forward - still need to move over subtree
7604 (progn (org-end-of-subtree t t)
7605 (save-excursion
7606 (org-back-over-empty-lines)
7607 (or (bolp) (newline)))))
7608 (setq ne-ins (org-back-over-empty-lines))
7609 (move-marker ins-point (point))
7610 (setq txt (buffer-substring beg end))
7611 (org-save-markers-in-region beg end)
7612 (delete-region beg end)
7613 (org-remove-empty-overlays-at beg)
7614 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7615 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7617 (let ((bbb (point)))
7618 (insert-before-markers txt)
7619 (org-reinstall-markers-in-region bbb)
7620 (move-marker ins-point bbb))
7622 (setq ins-end (point))
7623 (goto-char ins-point)
7624 (org-skip-whitespace)
7625 (when (and (< arg 0)
7626 (org-first-sibling-p)
7627 (> ne-ins ne-beg))
7628 ;; Move whitespace back to beginning
7629 (save-excursion
7630 (goto-char ins-end)
7631 (let ((kill-whole-line t))
7632 (kill-line (- ne-ins ne-beg)) (point)))
7634 (move-marker ins-point nil)
7635 (if folded
7636 (hide-subtree)
7637 (org-show-entry)
7638 (show-children)
7639 (org-cycle-hide-drawers 'children))
7640 (org-clean-visibility-after-subtree-move)
7641 ;; move back to the initial column we were at
7642 (move-to-column col)))
7644 (defvar org-subtree-clip ""
7645 "Clipboard for cut and paste of subtrees.
7646 This is actually only a copy of the kill, because we use the normal kill
7647 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7649 (defvar org-subtree-clip-folded nil
7650 "Was the last copied subtree folded?
7651 This is used to fold the tree back after pasting.")
7653 (defun org-cut-subtree (&optional n)
7654 "Cut the current subtree into the clipboard.
7655 With prefix arg N, cut this many sequential subtrees.
7656 This is a short-hand for marking the subtree and then cutting it."
7657 (interactive "p")
7658 (org-copy-subtree n 'cut))
7660 (defun org-copy-subtree (&optional n cut force-store-markers)
7661 "Cut the current subtree into the clipboard.
7662 With prefix arg N, cut this many sequential subtrees.
7663 This is a short-hand for marking the subtree and then copying it.
7664 If CUT is non-nil, actually cut the subtree.
7665 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7666 of some markers in the region, even if CUT is non-nil. This is
7667 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7668 (interactive "p")
7669 (let (beg end folded (beg0 (point)))
7670 (if (org-called-interactively-p 'any)
7671 (org-back-to-heading nil) ; take what looks like a subtree
7672 (org-back-to-heading t)) ; take what is really there
7673 (org-back-over-empty-lines)
7674 (setq beg (point))
7676 (save-match-data
7677 (save-excursion (outline-end-of-heading)
7678 (setq folded (outline-invisible-p)))
7679 (condition-case nil
7680 (org-forward-same-level (1- n) t)
7681 (error nil))
7682 (org-end-of-subtree t t))
7683 (org-back-over-empty-lines)
7684 (setq end (point))
7685 (goto-char beg0)
7686 (when (> end beg)
7687 (setq org-subtree-clip-folded folded)
7688 (when (or cut force-store-markers)
7689 (org-save-markers-in-region beg end))
7690 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7691 (setq org-subtree-clip (current-kill 0))
7692 (message "%s: Subtree(s) with %d characters"
7693 (if cut "Cut" "Copied")
7694 (length org-subtree-clip)))))
7696 (defun org-paste-subtree (&optional level tree for-yank)
7697 "Paste the clipboard as a subtree, with modification of headline level.
7698 The entire subtree is promoted or demoted in order to match a new headline
7699 level.
7701 If the cursor is at the beginning of a headline, the same level as
7702 that headline is used to paste the tree
7704 If not, the new level is derived from the *visible* headings
7705 before and after the insertion point, and taken to be the inferior headline
7706 level of the two. So if the previous visible heading is level 3 and the
7707 next is level 4 (or vice versa), level 4 will be used for insertion.
7708 This makes sure that the subtree remains an independent subtree and does
7709 not swallow low level entries.
7711 You can also force a different level, either by using a numeric prefix
7712 argument, or by inserting the heading marker by hand. For example, if the
7715 If optional TREE is given, use this text instead of the kill ring.
7717 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7718 move back over whitespace before inserting, and move point to the end of
7719 the inserted text when done."
7720 (interactive "P")
7721 (setq tree (or tree (and kill-ring (current-kill 0))))
7722 (unless (org-kill-is-subtree-p tree)
7723 (error "%s"
7724 (substitute-command-keys
7726 (org-with-limited-levels
7727 (let* ((visp (not (outline-invisible-p)))
7728 (txt tree)
7730 (old-level (if (string-match org-outline-regexp-bol txt)
7731 (- (match-end 0) (match-beginning 0) 1)
7732 -1))
7733 (force-level (cond (level (prefix-numeric-value level))
7735 (string-match
7737 (point-at-bol) (point))))
7738 (- (match-end 1) (match-beginning 1)))
7739 ((and (bolp)
7740 (looking-at org-outline-regexp))
7741 (- (match-end 0) (point) 1))
7742 (t nil)))
7743 (previous-level (save-excursion
7744 (condition-case nil
7745 (progn
7746 (outline-previous-visible-heading 1)
7747 (if (looking-at ^re_)
7748 (- (match-end 0) (match-beginning 0) 1)
7749 1))
7750 (error 1))))
7751 (next-level (save-excursion
7752 (condition-case nil
7753 (progn
7754 (or (looking-at org-outline-regexp)
7755 (outline-next-visible-heading 1))
7756 (if (looking-at ^re_)
7757 (- (match-end 0) (match-beginning 0) 1)
7758 1))
7759 (error 1))))
7760 (new-level (or force-level (max previous-level next-level)))
7761 (shift (if (or (= old-level -1)
7762 (= new-level -1)
7763 (= old-level new-level))
7764 0
7765 (- new-level old-level)))
7766 (delta (if (> shift 0) -1 1))
7767 (func (if (> shift 0) 'org-demote 'org-promote))
7768 (org-odd-levels-only nil)
7769 beg end newend)
7770 ;; Remove the forced level indicator
7771 (if force-level
7772 (delete-region (point-at-bol) (point)))
7773 ;; Paste
7774 (beginning-of-line (if (bolp) 1 2))
7775 (unless for-yank (org-back-over-empty-lines))
7776 (setq beg (point))
7777 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7778 (insert-before-markers txt)
7780 (setq newend (point))
7781 (org-reinstall-markers-in-region beg)
7782 (setq end (point))
7783 (goto-char beg)
7785 (setq beg (point))
7786 (if (and (outline-invisible-p) visp)
7787 (save-excursion (outline-show-heading)))
7788 ;; Shift if necessary
7789 (unless (= shift 0)
7790 (save-restriction
7791 (narrow-to-region beg end)
7792 (while (not (= shift 0))
7793 (org-map-region func (point-min) (point-max))
7794 (setq shift (+ delta shift)))
7795 (goto-char (point-min))
7796 (setq newend (point-max))))
7797 (when (or (org-called-interactively-p 'interactive) for-yank)
7798 (message "Clipboard pasted as level %d subtree" new-level))
7799 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7800 kill-ring
7801 (eq org-subtree-clip (current-kill 0))
7802 org-subtree-clip-folded)
7803 ;; The tree was folded before it was killed/copied
7804 (hide-subtree))
7805 (and for-yank (goto-char newend)))))
7807 (defun org-kill-is-subtree-p (&optional txt)
7808 "Check if the current kill is an outline subtree, or a set of trees.
7809 Returns nil if kill does not start with a headline, or if the first
7810 headline level is not the largest headline level in the tree.
7811 So this will actually accept several entries of equal levels as well,
7812 which is OK for `org-paste-subtree'.
7813 If optional TXT is given, check this string instead of the current kill."
7814 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7815 (re (org-get-limited-outline-regexp))
7816 (^re (concat "^" re))
7817 (start-level (and kill
7818 (string-match
7820 kill)
7821 (- (match-end 2) (match-beginning 2) 1)))
7822 (start (1+ (or (match-beginning 2) -1))))
7823 (if (not start-level)
7824 (progn
7825 nil) ;; does not even start with a heading
7826 (catch 'exit
7827 (while (setq start (string-match ^re kill (1+ start)))
7828 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7829 (throw 'exit nil)))
7830 t))))
7832 (defvar org-markers-to-move nil
7833 "Markers that should be moved with a cut-and-paste operation.
7834 Those markers are stored together with their positions relative to
7835 the start of the region.")
7837 (defun org-save-markers-in-region (beg end)
7838 "Check markers in region.
7839 If these markers are between BEG and END, record their position relative
7840 to BEG, so that after moving the block of text, we can put the markers back
7841 into place.
7842 This function gets called just before an entry or tree gets cut from the
7843 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7844 called immediately, to move the markers with the entries."
7845 (setq org-markers-to-move nil)
7846 (when (featurep 'org-clock)
7847 (org-clock-save-markers-for-cut-and-paste beg end))
7848 (when (featurep 'org-agenda)
7849 (org-agenda-save-markers-for-cut-and-paste beg end)))
7851 (defun org-check-and-save-marker (marker beg end)
7852 "Check if MARKER is between BEG and END.
7853 If yes, remember the marker and the distance to BEG."
7854 (when (and (marker-buffer marker)
7855 (equal (marker-buffer marker) (current-buffer)))
7856 (if (and (>= marker beg) (< marker end))
7857 (push (cons marker (- marker beg)) org-markers-to-move))))
7859 (defun org-reinstall-markers-in-region (beg)
7860 "Move all remembered markers to their position relative to BEG."
7861 (mapc (lambda (x)
7862 (move-marker (car x) (+ beg (cdr x))))
7863 org-markers-to-move)
7864 (setq org-markers-to-move nil))
7866 (defun org-narrow-to-subtree ()
7867 "Narrow buffer to the current subtree."
7868 (interactive)
7869 (save-excursion
7870 (save-match-data
7871 (org-with-limited-levels
7872 (narrow-to-region
7873 (progn (org-back-to-heading t) (point))
7874 (progn (org-end-of-subtree t t)
7875 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7876 (point)))))))
7878 (defun org-narrow-to-block ()
7879 "Narrow buffer to the current block."
7880 (interactive)
7881 (let* ((case-fold-search t)
7884 (if blockp
7885 (narrow-to-region (car blockp) (cdr blockp))
7886 (error "Not in a block"))))
7888 (eval-when-compile
7889 (defvar org-property-drawer-re))
7891 (defvar org-property-start-re) ;; defined below
7892 (defun org-clone-subtree-with-time-shift (n &optional shift)
7893 "Clone the task (subtree) at point N times.
7894 The clones will be inserted as siblings.
7896 In interactive use, the user will be prompted for the number of
7897 clones to be produced, and for a time SHIFT, which may be a
7898 repeater as used in time stamps, for example `+3d'.
7900 When a valid repeater is given and the entry contains any time
7901 stamps, the clones will become a sequence in time, with time
7902 stamps in the subtree shifted for each clone produced. If SHIFT
7903 is nil or the empty string, time stamps will be left alone. The
7904 ID property of the original subtree is removed.
7906 If the original subtree did contain time stamps with a repeater,
7907 the following will happen:
7908 - the repeater will be removed in each clone
7909 - an additional clone will be produced, with the current, unshifted
7910 date(s) in the entry.
7911 - the original entry will be placed *after* all the clones, with
7912 repeater intact.
7913 - the start days in the repeater in the original entry will be shifted
7914 to past the last clone.
7915 In this way you can spell out a number of instances of a repeating task,
7916 and still retain the repeater to cover future instances of the task."
7917 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7918 (let (beg end template task idprop
7919 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7920 (drawer-re org-drawer-regexp))
7921 (if (not (and (integerp n) (> n 0)))
7922 (error "Invalid number of replications %s" n))
7925 shift)))
7926 (error "Invalid shift specification %s" shift))
7927 (when doshift
7928 (setq shift-n (string-to-number (match-string 1 shift))
7929 shift-what (cdr (assoc (match-string 2 shift)
7930 '(("d" . day) ("w" . week)
7931 ("m" . month) ("y" . year))))))
7932 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7933 (setq nmin 1 nmax n)
7934 (org-back-to-heading t)
7935 (setq beg (point))
7936 (setq idprop (org-entry-get nil "ID"))
7937 (org-end-of-subtree t t)
7939 (setq end (point))
7940 (setq template (buffer-substring beg end))
7941 (when (and doshift
7943 (delete-region beg end)
7944 (setq end beg)
7945 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7946 (goto-char end)
7947 (loop for n from nmin to nmax do
7948 ;; prepare clone
7949 (with-temp-buffer
7950 (insert template)
7951 (org-mode)
7952 (goto-char (point-min))
7953 (org-show-subtree)
7954 (and idprop (if org-clone-delete-id
7955 (org-entry-delete nil "ID")
7956 (org-id-get-create t)))
7957 (unless (= n 0)
7959 (kill-whole-line))
7960 (goto-char (point-min))
7961 (while (re-search-forward drawer-re nil t)
7962 (mapc (lambda (d)
7963 (org-remove-empty-drawer-at d (point))) org-drawers)))
7964 (goto-char (point-min))
7965 (when doshift
7966 (while (re-search-forward org-ts-regexp-both nil t)
7967 (org-timestamp-change (* n shift-n) shift-what))
7968 (unless (= n n-no-remove)
7969 (goto-char (point-min))
7970 (while (re-search-forward org-ts-regexp nil t)
7971 (save-excursion
7972 (goto-char (match-beginning 0))
7974 (delete-region (match-beginning 1) (match-end 1)))))))
7975 (setq task (buffer-string)))
7976 (insert task))
7977 (goto-char beg)))
7979 ;;; Outline Sorting
7981 (defun org-sort (with-case)
7982 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7983 Optional argument WITH-CASE means sort case-sensitively."
7984 (interactive "P")
7985 (cond
7986 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7987 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7988 (t
7989 (org-call-with-arg 'org-sort-entries with-case))))
7991 (defun org-sort-remove-invisible (s)
7992 (remove-text-properties 0 (length s) org-rm-props s)
7993 (while (string-match org-bracket-link-regexp s)
7994 (setq s (replace-match (if (match-end 2)
7995 (match-string 3 s)
7996 (match-string 1 s)) t t s)))
7997 s)
7999 (defvar org-priority-regexp) ; defined later in the file
8001 (defvar org-after-sorting-entries-or-items-hook nil
8002 "Hook that is run after a bunch of entries or items have been sorted.
8003 When children are sorted, the cursor is in the parent line when this
8004 hook gets called. When a region or a plain list is sorted, the cursor
8005 will be in the first entry of the sorted region/list.")
8007 (defun org-sort-entries
8008 (&optional with-case sorting-type getkey-func compare-func property)
8009 "Sort entries on a certain level of an outline tree.
8010 If there is an active region, the entries in the region are sorted.
8011 Else, if the cursor is before the first entry, sort the top-level items.
8012 Else, the children of the entry at point are sorted.
8014 Sorting can be alphabetically, numerically, by date/time as given by
8015 a time stamp, by a property or by priority.
8017 The command prompts for the sorting type unless it has been given to the
8018 function through the SORTING-TYPE argument, which needs to be a character,
8019 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8020 precise meaning of each character:
8022 n Numerically, by converting the beginning of the entry/item to a number.
8023 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8024 t By date/time, either the first active time stamp in the entry, or, if
8025 none exist, by the first inactive one.
8026 s By the scheduled date/time.
8027 d By deadline date/time.
8028 c By creation time, which is assumed to be the first inactive time stamp
8029 at the beginning of a line.
8030 p By priority according to the cookie.
8031 r By the value of a property.
8033 Capital letters will reverse the sort order.
8035 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8036 called with point at the beginning of the record. It must return either
8037 a string or a number that should serve as the sorting key for that record.
8039 Comparing entries ignores case by default. However, with an optional argument
8040 WITH-CASE, the sorting considers case as well."
8041 (interactive "P")
8042 (let ((case-func (if with-case 'identity 'downcase))
8043 start beg end stars re re2
8044 txt what tmp)
8045 ;; Find beginning and end of region to sort
8046 (cond
8047 ((org-region-active-p)
8048 ;; we will sort the region
8049 (setq end (region-end)
8050 what "region")
8051 (goto-char (region-beginning))
8052 (if (not (org-at-heading-p)) (outline-next-heading))
8053 (setq start (point)))
8054 ((or (org-at-heading-p)
8055 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8056 ;; we will sort the children of the current headline
8057 (org-back-to-heading)
8058 (setq start (point)
8059 end (progn (org-end-of-subtree t t)
8061 (org-back-over-empty-lines)
8062 (point))
8063 what "children")
8064 (goto-char start)
8065 (show-subtree)
8066 (outline-next-heading))
8067 (t
8068 ;; we will sort the top-level entries in this file
8069 (goto-char (point-min))
8070 (or (org-at-heading-p) (outline-next-heading))
8071 (setq start (point))
8072 (goto-char (point-max))
8073 (beginning-of-line 1)
8075 ;; File ends in a non-white line
8076 (end-of-line 1)
8078 (setq end (point-max))
8079 (setq what "top-level")
8080 (goto-char start)
8081 (show-all)))
8083 (setq beg (point))
8084 (if (>= beg end) (error "Nothing to sort"))
8087 (setq stars (match-string 1)
8088 re (concat "^" (regexp-quote stars) " +")
8090 txt (buffer-substring beg end))
8092 (if (and (not (equal stars "*")) (string-match re2 txt))
8093 (error "Region to sort contains a level above the first entry"))
8095 (unless sorting-type
8096 (message
8097 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8099 A/N/T/S/D/C/P/O/F means reversed:"
8100 what)
8101 (setq sorting-type (read-char-exclusive))
8103 (and (= (downcase sorting-type) ?f)
8104 (setq getkey-func
8105 (org-icompleting-read "Sort using function: "
8106 obarray 'fboundp t nil nil))
8107 (setq getkey-func (intern getkey-func)))
8109 (and (= (downcase sorting-type) ?r)
8110 (setq property
8111 (org-icompleting-read "Property: "
8112 (mapcar 'list (org-buffer-property-keys t))
8113 nil t))))
8115 (message "Sorting entries...")
8117 (save-restriction
8118 (narrow-to-region start end)
8119 (let ((dcst (downcase sorting-type))
8120 (case-fold-search nil)
8121 (now (current-time)))
8122 (sort-subr
8123 (/= dcst sorting-type)
8124 ;; This function moves to the beginning character of the "record" to
8125 ;; be sorted.
8126 (lambda nil
8127 (if (re-search-forward re nil t)
8128 (goto-char (match-beginning 0))
8129 (goto-char (point-max))))
8130 ;; This function moves to the last character of the "record" being
8131 ;; sorted.
8132 (lambda nil
8133 (save-match-data
8134 (condition-case nil
8135 (outline-forward-same-level 1)
8136 (error
8137 (goto-char (point-max))))))
8138 ;; This function returns the value that gets sorted against.
8139 (lambda nil
8140 (cond
8141 ((= dcst ?n)
8142 (if (looking-at org-complex-heading-regexp)
8143 (string-to-number (match-string 4))
8144 nil))
8145 ((= dcst ?a)
8146 (if (looking-at org-complex-heading-regexp)
8147 (funcall case-func (match-string 4))
8148 nil))
8149 ((= dcst ?t)
8150 (let ((end (save-excursion (outline-next-heading) (point))))
8151 (if (or (re-search-forward org-ts-regexp end t)
8152 (re-search-forward org-ts-regexp-both end t))
8153 (org-time-string-to-seconds (match-string 0))
8154 (org-float-time now))))
8155 ((= dcst ?c)
8156 (let ((end (save-excursion (outline-next-heading) (point))))
8157 (if (re-search-forward
8159 end t)
8160 (org-time-string-to-seconds (match-string 0))
8161 (org-float-time now))))
8162 ((= dcst ?s)
8163 (let ((end (save-excursion (outline-next-heading) (point))))
8164 (if (re-search-forward org-scheduled-time-regexp end t)
8165 (org-time-string-to-seconds (match-string 1))
8166 (org-float-time now))))
8167 ((= dcst ?d)
8168 (let ((end (save-excursion (outline-next-heading) (point))))
8169 (if (re-search-forward org-deadline-time-regexp end t)
8170 (org-time-string-to-seconds (match-string 1))
8171 (org-float-time now))))
8172 ((= dcst ?p)
8173 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8174 (string-to-char (match-string 2))
8175 org-default-priority))
8176 ((= dcst ?r)
8177 (or (org-entry-get nil property) ""))
8178 ((= dcst ?o)
8179 (if (looking-at org-complex-heading-regexp)
8180 (- 9999 (length (member (match-string 2)
8181 org-todo-keywords-1)))))
8182 ((= dcst ?f)
8183 (if getkey-func
8184 (progn
8185 (setq tmp (funcall getkey-func))
8186 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8187 tmp)
8188 (error "Invalid key function `%s'" getkey-func)))
8189 (t (error "Invalid sorting type `%c'" sorting-type))))
8190 nil
8191 (cond
8192 ((= dcst ?a) 'string<)
8193 ((= dcst ?f) compare-func)
8194 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8195 (t nil)))))
8196 (run-hooks 'org-after-sorting-entries-or-items-hook)
8197 (message "Sorting entries...done")))
8199 (defun org-do-sort (table what &optional with-case sorting-type)
8200 "Sort TABLE of WHAT according to SORTING-TYPE.
8201 The user will be prompted for the SORTING-TYPE if the call to this
8202 function does not specify it. WHAT is only for the prompt, to indicate
8203 what is being sorted. The sorting key will be extracted from
8204 the car of the elements of the table.
8205 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8206 (unless sorting-type
8207 (message
8208 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8209 what)
8210 (setq sorting-type (read-char-exclusive)))
8211 (let ((dcst (downcase sorting-type))
8212 extractfun comparefun)
8213 ;; Define the appropriate functions
8214 (cond
8215 ((= dcst ?n)
8216 (setq extractfun 'string-to-number
8217 comparefun (if (= dcst sorting-type) '< '>)))
8218 ((= dcst ?a)
8219 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8220 (lambda(x) (downcase (org-sort-remove-invisible x))))
8221 comparefun (if (= dcst sorting-type)
8222 'string<
8223 (lambda (a b) (and (not (string< a b))
8224 (not (string= a b)))))))
8225 ((= dcst ?t)
8226 (setq extractfun
8227 (lambda (x)
8228 (if (or (string-match org-ts-regexp x)
8229 (string-match org-ts-regexp-both x))
8230 (org-float-time
8231 (org-time-string-to-time (match-string 0 x)))
8232 0))
8233 comparefun (if (= dcst sorting-type) '< '>)))
8234 (t (error "Invalid sorting type `%c'" sorting-type)))
8236 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8237 table)
8238 (lambda (a b) (funcall comparefun (car a) (car b))))))
8241 ;;; The orgstruct minor mode
8243 ;; Define a minor mode which can be used in other modes in order to
8244 ;; integrate the org-mode structure editing commands.
8246 ;; This is really a hack, because the org-mode structure commands use
8247 ;; keys which normally belong to the major mode. Here is how it
8248 ;; works: The minor mode defines all the keys necessary to operate the
8249 ;; structure commands, but wraps the commands into a function which
8250 ;; tests if the cursor is currently at a headline or a plain list
8251 ;; item. If that is the case, the structure command is used,
8252 ;; temporarily setting many Org-mode variables like regular
8253 ;; expressions for filling etc. However, when any of those keys is
8254 ;; used at a different location, function uses `key-binding' to look
8255 ;; up if the key has an associated command in another currently active
8256 ;; keymap (minor modes, major mode, global), and executes that
8257 ;; command. There might be problems if any of the keys is otherwise
8258 ;; used as a prefix key.
8260 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8261 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8262 ;; addresses this by checking explicitly for both bindings.
8264 (defvar orgstruct-mode-map (make-sparse-keymap)
8265 "Keymap for the minor `orgstruct-mode'.")
8267 (defvar org-local-vars nil
8268 "List of local variables, for use by `orgstruct-mode'.")
8270 ;;;###autoload
8271 (define-minor-mode orgstruct-mode
8272 "Toggle the minor mode `orgstruct-mode'.
8273 This mode is for using Org-mode structure commands in other
8274 modes. The following keys behave as if Org-mode were active, if
8275 the cursor is on a headline, or on a plain list item (both as
8276 defined by Org-mode).
8278 M-up Move entry/item up
8279 M-down Move entry/item down
8280 M-left Promote
8281 M-right Demote
8282 M-S-up Move entry/item up
8283 M-S-down Move entry/item down
8284 M-S-left Promote subtree
8285 M-S-right Demote subtree
8286 M-q Fill paragraph and items like in Org-mode
8287 C-c ^ Sort entries
8288 C-c - Cycle list bullet
8289 TAB Cycle item visibility
8290 M-RET Insert new heading/item
8291 S-M-RET Insert new TODO heading / Checkbox item
8292 C-c C-c Set tags / toggle checkbox"
8293 nil " OrgStruct" nil
8294 (org-load-modules-maybe)
8295 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8297 ;;;###autoload
8298 (defun turn-on-orgstruct ()
8299 "Unconditionally turn on `orgstruct-mode'."
8300 (orgstruct-mode 1))
8302 (defun orgstruct++-mode (&optional arg)
8303 "Toggle `orgstruct-mode', the enhanced version of it.
8304 In addition to setting orgstruct-mode, this also exports all indentation
8305 and autofilling variables from org-mode into the buffer. It will also
8306 recognize item context in multiline items.
8307 Note that turning off orgstruct-mode will *not* remove the
8308 indentation/paragraph settings. This can only be done by refreshing the
8310 (interactive "P")
8311 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8312 (if (< arg 1)
8313 (orgstruct-mode -1)
8314 (orgstruct-mode 1)
8315 (let (var val)
8316 (mapc
8317 (lambda (x)
8318 (when (string-match
8320 (symbol-name (car x)))
8321 (setq var (car x) val (nth 1 x))
8322 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8323 org-local-vars)
8324 (org-set-local 'orgstruct-is-++ t))))
8326 (defvar orgstruct-is-++ nil
8327 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8328 (make-variable-buffer-local 'orgstruct-is-++)
8330 ;;;###autoload
8331 (defun turn-on-orgstruct++ ()
8332 "Unconditionally turn on `orgstruct++-mode'."
8333 (orgstruct++-mode 1))
8335 (defun orgstruct-error ()
8336 "Error when there is no default binding for a structure key."
8337 (interactive)
8338 (error "This key has no function outside structure elements"))
8340 (defun orgstruct-setup ()
8341 "Setup orgstruct keymaps."
8342 (let ((nfunc 0)
8343 (bindings
8344 (list
8345 '([(meta up)] org-metaup)
8346 '([(meta down)] org-metadown)
8347 '([(meta left)] org-metaleft)
8348 '([(meta right)] org-metaright)
8349 '([(meta shift up)] org-shiftmetaup)
8350 '([(meta shift down)] org-shiftmetadown)
8351 '([(meta shift left)] org-shiftmetaleft)
8352 '([(meta shift right)] org-shiftmetaright)
8353 '([?\e (up)] org-metaup)
8354 '([?\e (down)] org-metadown)
8355 '([?\e (left)] org-metaleft)
8356 '([?\e (right)] org-metaright)
8357 '([?\e (shift up)] org-shiftmetaup)
8358 '([?\e (shift down)] org-shiftmetadown)
8359 '([?\e (shift left)] org-shiftmetaleft)
8360 '([?\e (shift right)] org-shiftmetaright)
8361 '([(shift up)] org-shiftup)
8362 '([(shift down)] org-shiftdown)
8363 '([(shift left)] org-shiftleft)
8364 '([(shift right)] org-shiftright)
8365 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8366 '("\M-q" fill-paragraph)
8367 '("\C-c^" org-sort)
8368 '("\C-c-" org-cycle-list-bullet)))
8369 elt key fun cmd)
8370 (while (setq elt (pop bindings))
8371 (setq nfunc (1+ nfunc))
8372 (setq key (org-key (car elt))
8373 fun (nth 1 elt)
8374 cmd (orgstruct-make-binding fun nfunc key))
8375 (org-defkey orgstruct-mode-map key cmd))
8377 ;; Special treatment needed for TAB and RET
8378 (org-defkey orgstruct-mode-map [(tab)]
8379 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8380 (org-defkey orgstruct-mode-map "\C-i"
8381 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8383 (org-defkey orgstruct-mode-map "\M-\C-m"
8384 (orgstruct-make-binding 'org-insert-heading 105
8385 "\M-\C-m" [(meta return)]))
8386 (org-defkey orgstruct-mode-map [(meta return)]
8387 (orgstruct-make-binding 'org-insert-heading 106
8388 [(meta return)] "\M-\C-m"))
8390 (org-defkey orgstruct-mode-map [(shift meta return)]
8391 (orgstruct-make-binding 'org-insert-todo-heading 107
8392 [(meta return)] "\M-\C-m"))
8394 (org-defkey orgstruct-mode-map "\e\C-m"
8395 (orgstruct-make-binding 'org-insert-heading 108
8396 "\e\C-m" [?\e (return)]))
8397 (org-defkey orgstruct-mode-map [?\e (return)]
8398 (orgstruct-make-binding 'org-insert-heading 109
8399 [?\e (return)] "\e\C-m"))
8400 (org-defkey orgstruct-mode-map [?\e (shift return)]
8401 (orgstruct-make-binding 'org-insert-todo-heading 110
8402 [?\e (return)] "\e\C-m"))
8404 (unless org-local-vars
8405 (setq org-local-vars (org-get-local-variables)))
8407 t))
8409 (defun orgstruct-make-binding (fun n &rest keys)
8410 "Create a function for binding in the structure minor mode.
8411 FUN is the command to call inside a table. N is used to create a unique
8412 command name. KEYS are keys that should be checked in for a command
8413 to execute outside of tables."
8414 (eval
8415 (list 'defun
8416 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8417 '(arg)
8419 "Outside of structure, run the binding of `"
8420 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8421 "'.")
8422 '(interactive "p")
8423 (list 'if
8424 `(org-context-p 'headline 'item
8425 (and orgstruct-is-++
8426 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8427 'item-body))
8428 (list 'org-run-like-in-org-mode (list 'quote fun))
8429 (list 'let '(orgstruct-mode)
8430 (list 'call-interactively
8431 (append '(or)
8432 (mapcar (lambda (k)
8433 (list 'key-binding k))
8434 keys)
8435 '('orgstruct-error))))))))
8437 (defun org-context-p (&rest contexts)
8438 "Check if local context is any of CONTEXTS.
8439 Possible values in the list of contexts are `table', `headline', and `item'."
8440 (let ((pos (point)))
8441 (goto-char (point-at-bol))
8442 (prog1 (or (and (memq 'table contexts)
8444 (and (memq 'headline contexts)
8445 (looking-at org-outline-regexp))
8446 (and (memq 'item contexts)
8448 (and (memq 'item-body contexts)
8449 (org-in-item-p)))
8450 (goto-char pos))))
8452 (defun org-get-local-variables ()
8453 "Return a list of all local variables in an org-mode buffer."
8454 (let (varlist)
8455 (with-current-buffer (get-buffer-create "*Org tmp*")
8456 (erase-buffer)
8457 (org-mode)
8458 (setq varlist (buffer-local-variables)))
8459 (kill-buffer "*Org tmp*")
8460 (delq nil
8461 (mapcar
8462 (lambda (x)
8463 (setq x
8464 (if (symbolp x)
8465 (list x)
8466 (list (car x) (list 'quote (cdr x)))))
8467 (if (string-match
8468 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8469 (symbol-name (car x)))
8470 x nil))
8471 varlist))))
8473 (defun org-clone-local-variables (from-buffer &optional regexp)
8474 "Clone local variables from FROM-BUFFER.
8475 Optional argument REGEXP selects variables to clone."
8476 (mapc
8477 (lambda (pair)
8478 (and (symbolp (car pair))
8479 (or (null regexp)
8480 (string-match regexp (symbol-name (car pair))))
8481 (set (make-local-variable (car pair))
8482 (cdr pair))))
8483 (buffer-local-variables from-buffer)))
8485 ;;;###autoload
8486 (defun org-run-like-in-org-mode (cmd)
8487 "Run a command, pretending that the current buffer is in Org-mode.
8488 This will temporarily bind local variables that are typically bound in
8489 Org-mode to the values they have in Org-mode, and then interactively
8490 call CMD."
8491 (org-load-modules-maybe)
8492 (unless org-local-vars
8493 (setq org-local-vars (org-get-local-variables)))
8494 (eval (list 'let org-local-vars
8495 (list 'call-interactively (list 'quote cmd)))))
8497 ;;;; Archiving
8499 (defun org-get-category (&optional pos force-refresh)
8500 "Get the category applying to position POS."
8501 (save-match-data
8502 (if force-refresh (org-refresh-category-properties))
8503 (let ((pos (or pos (point))))
8504 (or (get-text-property pos 'org-category)
8505 (progn (org-refresh-category-properties)
8506 (get-text-property pos 'org-category))))))
8508 (defun org-refresh-category-properties ()
8509 "Refresh category text properties in the buffer."
8510 (let ((def-cat (cond
8511 ((null org-category)
8512 (if buffer-file-name
8513 (file-name-sans-extension
8514 (file-name-nondirectory buffer-file-name))
8515 "???"))
8516 ((symbolp org-category) (symbol-name org-category))
8517 (t org-category)))
8518 beg end cat pos optionp)
8519 (org-unmodified
8520 (save-excursion
8521 (save-restriction
8522 (widen)
8523 (goto-char (point-min))
8524 (put-text-property (point) (point-max) 'org-category def-cat)
8525 (while (re-search-forward
8527 (setq pos (match-end 0)
8528 optionp (equal (char-after (match-beginning 0)) ?#)
8529 cat (org-trim (match-string 2)))
8530 (if optionp
8531 (setq beg (point-at-bol) end (point-max))
8532 (org-back-to-heading t)
8533 (setq beg (point) end (org-end-of-subtree t t)))
8534 (put-text-property beg end 'org-category cat)
8535 (put-text-property beg end 'org-category-position beg)
8536 (goto-char pos)))))))
8539 ;;;; Link Stuff
8541 ;;; Link abbreviations
8543 (defun org-link-expand-abbrev (link)
8544 "Apply replacements as defined in `org-link-abbrev-alist."
8546 (let* ((key (match-string 1 link))
8547 (as (or (assoc key org-link-abbrev-alist-local)
8548 (assoc key org-link-abbrev-alist)))
8549 (tag (and (match-end 2) (match-string 3 link)))
8550 rpl)
8551 (if (not as)
8552 link
8553 (setq rpl (cdr as))
8554 (cond
8555 ((symbolp rpl) (funcall rpl tag))
8556 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8557 ((string-match "%h" rpl)
8558 (replace-match (url-hexify-string (or tag "")) t t rpl))
8559 (t (concat rpl tag)))))
8560 link))
8562 ;;; Storing and inserting links
8564 (defvar org-insert-link-history nil
8565 "Minibuffer history for links inserted with `org-insert-link'.")
8567 (defvar org-stored-links nil
8568 "Contains the links stored with `org-store-link'.")
8570 (defvar org-store-link-plist nil
8571 "Plist with info about the most recently link created with `org-store-link'.")
8573 (defvar org-link-protocols nil
8574 "Link protocols added to Org-mode using `org-add-link-type'.")
8576 (defvar org-store-link-functions nil
8577 "List of functions that are called to create and store a link.
8578 Each function will be called in turn until one returns a non-nil
8579 value. Each function should check if it is responsible for creating
8580 this link (for example by looking at the major mode).
8581 If not, it must exit and return nil.
8582 If yes, it should return a non-nil value after a calling
8583 `org-store-link-props' with a list of properties and values.
8584 Special properties are:
8588 This is obligatory as well.
8589 :description Optional default description for the second pair
8590 of brackets in an Org-mode link. The user can still change
8591 this when inserting this link into an Org-mode buffer.
8593 In addition to these, any additional properties can be specified
8594 and then used in remember templates.")
8596 (defun org-add-link-type (type &optional follow export)
8597 "Add TYPE to the list of `org-link-types'.
8598 Re-compute all regular expressions depending on `org-link-types'
8600 FOLLOW and EXPORT are two functions.
8602 FOLLOW should take the link path as the single argument and do whatever
8603 is necessary to follow the link, for example find a file or display
8604 a mail message.
8606 EXPORT should format the link path for export to one of the export formats.
8607 It should be a function accepting three arguments:
8610 desc the description of the link, if any, or a description added by
8611 org-export-normalize-links if there is none
8612 format the export format, a symbol like `html' or `latex' or `ascii'..
8614 The function may use the FORMAT information to return different values
8615 depending on the format. The return value will be put literally into
8616 the exported file. If the return value is nil, this means Org should
8617 do what it normally does with links which do not have EXPORT defined.
8619 Org-mode has a built-in default for exporting links. If you are happy with
8620 this default, there is no need to define an export function for the link
8621 type. For a simple example of an export function, see `org-bbdb.el'."
8622 (add-to-list 'org-link-types type t)
8623 (org-make-link-regexps)
8624 (if (assoc type org-link-protocols)
8625 (setcdr (assoc type org-link-protocols) (list follow export))
8626 (push (list type follow export) org-link-protocols)))
8628 (defvar org-agenda-buffer-name)
8630 ;;;###autoload
8631 (defun org-store-link (arg)
8633 This link is added to `org-stored-links' and can later be inserted
8636 For some link types, a prefix arg is interpreted:
8637 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8638 For file links, arg negates `org-context-in-file-links'."
8639 (interactive "P")
8640 (org-load-modules-maybe)
8641 (setq org-store-link-plist nil) ; reset
8642 (org-with-limited-levels
8643 (let (link cpltxt desc description search txt custom-id agenda-link)
8644 (cond
8646 ((run-hook-with-args-until-success 'org-store-link-functions)
8647 (setq link (plist-get org-store-link-plist :link)
8648 desc (or (plist-get org-store-link-plist :description) link)))
8650 ((org-src-edit-buffer-p)
8651 (let (label gc)
8652 (while (or (not label)
8653 (save-excursion
8654 (save-restriction
8655 (widen)
8656 (goto-char (point-min))
8657 (re-search-forward
8658 (regexp-quote (format org-coderef-label-format label))
8659 nil t))))
8660 (when label (message "Label exists already") (sit-for 2))
8661 (setq label (read-string "Code line label: " label)))
8662 (end-of-line 1)
8663 (setq link (format org-coderef-label-format label))
8664 (setq gc (- 79 (length link)))
8665 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8666 (insert link)
8667 (setq link (concat "(" label ")") desc nil)))
8669 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8670 ;; We are in the agenda, link to referenced location
8671 (let ((m (or (get-text-property (point) 'org-hd-marker)
8672 (get-text-property (point) 'org-marker))))
8673 (when m
8674 (org-with-point-at m
8675 (setq agenda-link
8676 (if (org-called-interactively-p 'any)
8677 (call-interactively 'org-store-link)
8678 (org-store-link nil)))))))
8680 ((eq major-mode 'calendar-mode)
8681 (let ((cd (calendar-cursor-to-date)))
8682 (setq link
8683 (format-time-string
8684 (car org-time-stamp-formats)
8685 (apply 'encode-time
8686 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8687 nil nil nil))))
8688 (org-store-link-props :type "calendar" :date cd)))
8690 ((eq major-mode 'w3-mode)
8691 (setq cpltxt (if (and (buffer-name)
8692 (not (string-match "Untitled" (buffer-name))))
8693 (buffer-name)
8694 (url-view-url t))
8695 link (org-make-link (url-view-url t)))
8696 (org-store-link-props :type "w3" :url (url-view-url t)))
8698 ((eq major-mode 'w3m-mode)
8699 (setq cpltxt (or w3m-current-title w3m-current-url)
8700 link (org-make-link w3m-current-url))
8701 (org-store-link-props :type "w3m" :url (url-view-url t)))
8703 ((setq search (run-hook-with-args-until-success
8704 'org-create-file-search-functions))
8705 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8706 "::" search))
8707 (setq cpltxt (or description link)))
8709 ((eq major-mode 'image-mode)
8710 (setq cpltxt (concat "file:"
8711 (abbreviate-file-name buffer-file-name))
8712 link (org-make-link cpltxt))
8713 (org-store-link-props :type "image" :file buffer-file-name))
8715 ((eq major-mode 'dired-mode)
8716 ;; link to the file in the current line
8717 (let ((file (dired-get-filename nil t)))
8718 (setq file (if file
8719 (abbreviate-file-name
8720 (expand-file-name (dired-get-filename nil t)))
8721 ;; otherwise, no file so use current directory.
8722 default-directory))
8723 (setq cpltxt (concat "file:" file)
8724 link (org-make-link cpltxt))))
8726 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8727 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8728 (cond
8730 (setq cpltxt
8731 (concat "file:"
8732 (abbreviate-file-name
8733 (buffer-file-name (buffer-base-buffer)))
8734 "::" (match-string 1))
8735 link (org-make-link cpltxt)))
8736 ((and (featurep 'org-id)
8737 (or (eq org-link-to-org-use-id t)
8738 (and (eq org-link-to-org-use-id 'create-if-interactive)
8739 (org-called-interactively-p 'any))
8740 (and (eq org-link-to-org-use-id
8741 'create-if-interactive-and-no-custom-id)
8742 (org-called-interactively-p 'any)
8743 (not custom-id))
8744 (and org-link-to-org-use-id
8745 (org-entry-get nil "ID"))))
8746 ;; We can make a link using the ID.
8747 (setq link (condition-case nil
8748 (prog1 (org-id-store-link)
8749 (setq desc (plist-get org-store-link-plist
8750 :description)))
8751 (error
8752 ;; probably before first headline, link to file only
8753 (concat "file:"
8754 (abbreviate-file-name
8755 (buffer-file-name (buffer-base-buffer))))))))
8756 (t
8757 ;; Just link to current headline
8758 (setq cpltxt (concat "file:"
8759 (abbreviate-file-name
8760 (buffer-file-name (buffer-base-buffer)))))
8761 ;; Add a context search string
8762 (when (org-xor org-context-in-file-links arg)
8763 (setq txt (cond
8764 ((org-at-heading-p) nil)
8765 ((org-region-active-p)
8766 (buffer-substring (region-beginning) (region-end)))
8767 (t nil)))
8769 (setq cpltxt
8770 (concat cpltxt "::"
8771 (condition-case nil
8772 (org-make-org-heading-search-string txt)
8773 (error "")))
8774 desc (or (nth 4 (ignore-errors
8775 (org-heading-components))) "NONE"))))
8777 (setq cpltxt (substring cpltxt 0 -2)))
8778 (setq link (org-make-link cpltxt)))))
8780 ((buffer-file-name (buffer-base-buffer))
8781 ;; Just link to this file here.
8782 (setq cpltxt (concat "file:"
8783 (abbreviate-file-name
8784 (buffer-file-name (buffer-base-buffer)))))
8785 ;; Add a context string
8786 (when (org-xor org-context-in-file-links arg)
8787 (setq txt (if (org-region-active-p)
8788 (buffer-substring (region-beginning) (region-end))
8789 (buffer-substring (point-at-bol) (point-at-eol))))
8790 ;; Only use search option if there is some text.
8792 (setq cpltxt
8793 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8794 desc "NONE")))
8795 (setq link (org-make-link cpltxt)))
8797 ((org-called-interactively-p 'interactive)
8798 (error "Cannot link to a buffer which is not visiting a file"))
8800 (t (setq link nil)))
8802 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8803 (setq link (or link cpltxt)
8804 desc (or desc cpltxt))
8805 (if (equal desc "NONE") (setq desc nil))
8807 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8808 (progn
8809 (setq org-stored-links
8810 (cons (list link desc) org-stored-links))
8811 (message "Stored: %s" (or desc link))
8812 (when custom-id
8813 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8814 "::#" custom-id))
8815 (setq org-stored-links
8816 (cons (list link desc) org-stored-links))))
8817 (or agenda-link (and link (org-make-link-string link desc)))))))
8819 (defun org-store-link-props (&rest plist)
8820 "Store link properties, extract names and addresses."
8821 (let (x adr)
8822 (when (setq x (plist-get plist :from))
8823 (setq adr (mail-extract-address-components x))
8824 (setq plist (plist-put plist :fromname (car adr)))
8825 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8826 (when (setq x (plist-get plist :to))
8827 (setq adr (mail-extract-address-components x))
8828 (setq plist (plist-put plist :toname (car adr)))
8829 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8830 (let ((from (plist-get plist :from))
8831 (to (plist-get plist :to)))
8832 (when (and from to org-from-is-user-regexp)
8833 (setq plist
8834 (plist-put plist :fromto
8835 (if (string-match org-from-is-user-regexp from)
8836 (concat "to %t")
8837 (concat "from %f"))))))
8838 (setq org-store-link-plist plist))
8840 (defun org-add-link-props (&rest plist)
8841 "Add these properties to the link property list."
8842 (let (key value)
8843 (while plist
8844 (setq key (pop plist) value (pop plist))
8845 (setq org-store-link-plist
8846 (plist-put org-store-link-plist key value)))))
8848 (defun org-email-link-description (&optional fmt)
8849 "Return the description part of an email link.
8850 This takes information from `org-store-link-plist' and formats it
8851 according to FMT (default from `org-email-link-description-format')."
8852 (setq fmt (or fmt org-email-link-description-format))
8853 (let* ((p org-store-link-plist)
8854 (to (plist-get p :toaddress))
8855 (from (plist-get p :fromaddress))
8856 (table
8857 (list
8858 (cons "%c" (plist-get p :fromto))
8859 (cons "%F" (plist-get p :from))
8860 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8861 (cons "%T" (plist-get p :to))
8862 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8863 (cons "%s" (plist-get p :subject))
8864 (cons "%d" (plist-get p :date))
8865 (cons "%m" (plist-get p :message-id)))))
8866 (when (string-match "%c" fmt)
8867 ;; Check if the user wrote this message
8868 (if (and org-from-is-user-regexp from to
8869 (save-match-data (string-match org-from-is-user-regexp from)))
8870 (setq fmt (replace-match "to %t" t t fmt))
8871 (setq fmt (replace-match "from %f" t t fmt))))
8872 (org-replace-escapes fmt table)))
8874 (defun org-make-org-heading-search-string (&optional string heading)
8875 "Make search string for STRING or current headline."
8876 (interactive)
8877 (let ((s (or string (org-get-heading)))
8878 (lines org-context-in-file-links))
8879 (unless (and string (not heading))
8880 ;; We are using a headline, clean up garbage in there.
8881 (if (string-match org-todo-regexp s)
8882 (setq s (replace-match "" t t s)))
8884 (setq s (replace-match "" t t s)))
8885 (setq s (org-trim s))
8888 (setq s (replace-match "" t t s)))
8889 (while (string-match org-ts-regexp s)
8890 (setq s (replace-match "" t t s))))
8891 (or string (setq s (concat "*" s))) ; Add * for headlines
8892 (when (and string (integerp lines) (> lines 0))
8894 (when (< lines (length slines))
8895 (setq s (mapconcat
8896 'identity
8897 (reverse (nthcdr (- (length slines) lines)
8901 (defun org-make-link (&rest strings)
8902 "Concatenate STRINGS."
8903 (apply 'concat strings))
8905 (defun org-make-link-string (link &optional description)
8906 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8908 (error "Empty link"))
8909 (when (and description
8910 (stringp description)
8912 (setq description nil))
8913 (when (stringp description)
8914 ;; Remove brackets from the description, they are fatal.
8916 (setq description (replace-match "{" t t description)))
8918 (setq description (replace-match "}" t t description))))
8919 (when (equal link description)
8920 ;; No description needed, it is identical
8921 (setq description nil))
8922 (when (and (not description)
8923 (not (string-match (org-image-file-name-regexp) link))
8924 (not (equal link (org-link-escape link))))
8925 (setq description (org-extract-attributes link)))
8926 (setq link
8927 (cond ((string-match (org-image-file-name-regexp) link) link)
8928 ((string-match org-link-types-re link)
8929 (concat (match-string 1 link)
8930 (org-link-escape (substring link (match-end 1)))))
8931 (t (org-link-escape link))))
8932 (concat "[[" link "]"
8933 (if description (concat "[" description "]") "")
8934 "]"))
8936 (defconst org-link-escape-chars
8937 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8938 "List of characters that should be escaped in link.
8939 This is the list that is used for internal purposes.")
8941 (defvar org-url-encoding-use-url-hexify nil)
8943 (defconst org-link-escape-chars-browser
8944 '(?\ )
8945 "List of escapes for characters that are problematic in links.
8946 This is the list that is used before handing over to the browser.")
8948 (defun org-link-escape (text &optional table merge)
8949 "Return percent escaped representation of TEXT.
8950 TEXT is a string with the text to escape.
8951 Optional argument TABLE is a list with characters that should be
8952 escaped. When nil, `org-link-escape-chars' is used.
8953 If optional argument MERGE is set, merge TABLE into
8954 `org-link-escape-chars'."
8955 (if (and org-url-encoding-use-url-hexify (not table))
8956 (url-hexify-string text)
8957 (cond
8958 ((and table merge)
8959 (mapc (lambda (defchr)
8960 (unless (member defchr table)
8961 (setq table (cons defchr table)))) org-link-escape-chars))
8962 ((null table)
8963 (setq table org-link-escape-chars)))
8964 (mapconcat
8965 (lambda (char)
8966 (if (or (member char table)
8967 (< char 32) (= char 37) (> char 126))
8968 (mapconcat (lambda (sequence-element)
8969 (format "%%%.2X" sequence-element))
8970 (or (encode-coding-char char 'utf-8)
8971 (error "Unable to percent escape character: %s"
8972 (char-to-string char))) "")
8973 (char-to-string char))) text "")))
8975 (defun org-link-unescape (str)
8976 "Unhex hexified Unicode strings as returned from the JavaScript function
8977 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8978 (unless (and (null str) (string= "" str))
8979 (let ((pos 0) (case-fold-search t) unhexed)
8981 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8982 (setq str (replace-match unhexed t t str))
8983 (setq pos (+ pos (length unhexed))))))
8984 str)
8986 (defun org-link-unescape-compound (hex)
8987 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8988 Note: this function also decodes single byte encodings like
8990 (save-match-data
8991 (let* ((bytes (cdr (split-string hex "%")))
8992 (ret "")
8993 (eat 0)
8994 (sum 0))
8995 (while bytes
8996 (let* ((val (string-to-number (pop bytes) 16))
8997 (shift-xor
8998 (if (= 0 eat)
8999 (cond
9000 ((>= val 252) (cons 6 252))
9001 ((>= val 248) (cons 5 248))
9002 ((>= val 240) (cons 4 240))
9003 ((>= val 224) (cons 3 224))
9004 ((>= val 192) (cons 2 192))
9005 (t (cons 0 0)))
9006 (cons 6 128))))
9007 (if (>= val 192) (setq eat (car shift-xor)))
9008 (setq val (logxor val (cdr shift-xor)))
9009 (setq sum (+ (lsh sum (car shift-xor)) val))
9010 (if (> eat 0) (setq eat (- eat 1)))
9011 (cond
9012 ((= 0 eat) ;multi byte
9013 (setq ret (concat ret (org-char-to-string sum)))
9014 (setq sum 0))
9015 ((not bytes) ; single byte(s)
9016 (setq ret (org-link-unescape-single-byte-sequence hex))))
9017 )) ;; end (while bytes
9018 ret )))
9020 (defun org-link-unescape-single-byte-sequence (hex)
9021 "Unhexify hex-encoded single byte character sequences."
9022 (mapconcat (lambda (byte)
9023 (char-to-string (string-to-number byte 16)))
9024 (cdr (split-string hex "%")) ""))
9026 (defun org-xor (a b)
9027 "Exclusive or."
9028 (if a (not b) b))
9030 (defun org-fixup-message-id-for-http (s)
9031 "Replace special characters in a message id, so it can be used in an http query."
9032 (when (string-match "%" s)
9033 (setq s (mapconcat (lambda (c)
9034 (if (eq c ?%)
9035 "%25"
9036 (char-to-string c)))
9037 s "")))
9038 (while (string-match "<" s)
9039 (setq s (replace-match "%3C" t t s)))
9040 (while (string-match ">" s)
9041 (setq s (replace-match "%3E" t t s)))
9042 (while (string-match "@" s)
9043 (setq s (replace-match "%40" t t s)))
9044 s)
9046 ;;;###autoload
9047 (defun org-insert-link-global ()
9048 "Insert a link like Org-mode does.
9049 This command can be called in any mode to insert a link in Org-mode syntax."
9050 (interactive)
9051 (org-load-modules-maybe)
9052 (org-run-like-in-org-mode 'org-insert-link))
9054 (defun org-insert-link (&optional complete-file link-location default-description)
9055 "Insert a link. At the prompt, enter the link.
9057 Completion can be used to insert any of the link protocol prefixes like
9058 http or ftp in use.
9060 The history can be used to select a link previously stored with
9061 `org-store-link'. When the empty string is entered (i.e. if you just
9062 press RET at the prompt), the link defaults to the most recently
9063 stored link. As SPC triggers completion in the minibuffer, you need to
9064 use M-SPC or C-q SPC to force the insertion of a space character.
9066 You will also be prompted for a description, and if one is given, it will
9067 be displayed in the buffer instead of the link.
9069 If there is already a link at point, this command will allow you to edit link
9070 and description parts.
9073 be selected using completion. The path to the file will be relative to the
9074 current directory if the file is in the current directory or a subdirectory.
9075 Otherwise, the link will be the absolute path as completed in the minibuffer
9076 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9077 option `org-link-file-path-type'.
9080 the current directory or below.
9083 `org-keep-stored-link-after-insertion'.
9085 If `org-make-link-description-function' is non-nil, this function will be
9086 called with the link target, and the result will be the default
9087 link description.
9089 If the LINK-LOCATION parameter is non-nil, this value will be
9090 used as the link location instead of reading one interactively.
9092 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9093 be used as the default description."
9094 (interactive "P")
9095 (let* ((wcf (current-window-configuration))
9096 (region (if (org-region-active-p)
9097 (buffer-substring (region-beginning) (region-end))))
9098 (remove (and region (list (region-beginning) (region-end))))
9099 (desc region)
9100 tmphist ; byte-compile incorrectly complains about this
9101 (link link-location)
9102 entry file all-prefixes)
9103 (cond
9104 (link-location) ; specified by arg, just use it.
9105 ((org-in-regexp org-bracket-link-regexp 1)
9106 ;; We do have a link at point, and we are going to edit it.
9107 (setq remove (list (match-beginning 0) (match-end 0)))
9108 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9109 (setq link (read-string "Link: "
9110 (org-link-unescape
9111 (org-match-string-no-properties 1)))))
9112 ((or (org-in-regexp org-angle-link-re)
9113 (org-in-regexp org-plain-link-re))
9114 ;; Convert to bracket link
9115 (setq remove (list (match-beginning 0) (match-end 0))
9116 link (read-string "Link: "
9117 (org-remove-angle-brackets (match-string 0)))))
9118 ((member complete-file '((4) (16)))
9119 ;; Completing read for file names.
9120 (setq link (org-file-complete-link complete-file)))
9121 (t
9122 ;; Read link, with completion for stored links.
9123 (with-output-to-temp-buffer "*Org Links*"
9124 (princ "Insert a link.
9126 (when org-stored-links
9128 (princ (mapconcat
9129 (lambda (x)
9130 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9132 (let ((cw (selected-window)))
9133 (select-window (get-buffer-window "*Org Links*" 'visible))
9134 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9135 (unless (pos-visible-in-window-p (point-max))
9136 (org-fit-window-to-buffer))
9137 (and (window-live-p cw) (select-window cw)))
9138 ;; Fake a link history, containing the stored links.
9139 (setq tmphist (append (mapcar 'car org-stored-links)
9140 org-insert-link-history))
9141 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9142 (mapcar 'car org-link-abbrev-alist)
9143 org-link-types))
9144 (unwind-protect
9145 (progn
9146 (setq link
9147 (let ((org-completion-use-ido nil)
9148 (org-completion-use-iswitchb nil))
9149 (org-completing-read
9150 "Link: "
9151 (append
9152 (mapcar (lambda (x) (list (concat x ":")))
9153 all-prefixes)
9154 (mapcar 'car org-stored-links))
9155 nil nil nil
9156 'tmphist
9157 (car (car org-stored-links)))))
9159 (error "No link selected"))
9160 (if (or (member link all-prefixes)
9161 (and (equal ":" (substring link -1))
9162 (member (substring link 0 -1) all-prefixes)
9163 (setq link (substring link 0 -1))))
9164 (setq link (org-link-try-special-completion link))))
9165 (set-window-configuration wcf)
9166 (kill-buffer "*Org Links*"))
9167 (setq entry (assoc link org-stored-links))
9168 (or entry (push link org-insert-link-history))
9169 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9170 (not org-keep-stored-link-after-insertion))
9171 (setq org-stored-links (delq (assoc link org-stored-links)
9172 org-stored-links)))
9173 (setq desc (or desc (nth 1 entry)))))
9175 (if (string-match org-plain-link-re link)
9176 ;; URL-like link, normalize the use of angular brackets.
9177 (setq link (org-make-link (org-remove-angle-brackets link))))
9179 ;; Check if we are linking to the current file with a search option
9180 ;; If yes, simplify the link by using only the search option.
9181 (when (and buffer-file-name
9183 (let* ((path (match-string 1 link))
9184 (case-fold-search nil)
9185 (search (match-string 2 link)))
9186 (save-match-data
9187 (if (equal (file-truename buffer-file-name) (file-truename path))
9188 ;; We are linking to this same file, with a search option
9189 (setq link search)))))
9191 ;; Check if we can/should use a relative path. If yes, simplify the link
9193 (let* ((type (match-string 1 link))
9194 (path (match-string 2 link))
9195 (origpath path)
9196 (case-fold-search nil))
9197 (cond
9198 ((or (eq org-link-file-path-type 'absolute)
9199 (equal complete-file '(16)))
9200 (setq path (abbreviate-file-name (expand-file-name path))))
9201 ((eq org-link-file-path-type 'noabbrev)
9202 (setq path (expand-file-name path)))
9203 ((eq org-link-file-path-type 'relative)
9204 (setq path (file-relative-name path)))
9205 (t
9206 (save-match-data
9207 (if (string-match (concat "^" (regexp-quote
9208 (expand-file-name
9209 (file-name-as-directory
9210 default-directory))))
9211 (expand-file-name path))
9212 ;; We are linking a file with relative path name.
9213 (setq path (substring (expand-file-name path)
9214 (match-end 0)))
9215 (setq path (abbreviate-file-name (expand-file-name path)))))))
9216 (setq link (concat type path))
9217 (if (equal desc origpath)
9218 (setq desc path))))
9220 (if org-make-link-description-function
9221 (setq desc (funcall org-make-link-description-function link desc))
9222 (if default-description (setq desc default-description)))
9224 (setq desc (read-string "Description: " desc))
9226 (if remove (apply 'delete-region remove))
9227 (insert (org-make-link-string link desc))))
9229 (defun org-link-try-special-completion (type)
9230 "If there is completion support for link type TYPE, offer it."
9231 (let ((fun (intern (concat "org-" type "-complete-link"))))
9232 (if (functionp fun)
9233 (funcall fun)
9234 (read-string "Link (no completion support): " (concat type ":")))))
9236 (defun org-file-complete-link (&optional arg)
9237 "Create a file link using completion."
9238 (let (file link)
9239 (setq file (read-file-name "File: "))
9240 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9241 (pwd1 (file-name-as-directory (abbreviate-file-name
9242 (expand-file-name ".")))))
9243 (cond
9244 ((equal arg '(16))
9245 (setq link (org-make-link
9246 "file:"
9247 (abbreviate-file-name (expand-file-name file)))))
9249 (setq link (org-make-link "file:" (match-string 1 file))))
9251 (expand-file-name file))
9252 (setq link (org-make-link
9253 "file:" (match-string 1 (expand-file-name file)))))
9254 (t (setq link (org-make-link "file:" file)))))
9255 link))
9257 (defun org-completing-read (&rest args)
9258 "Completing-read with SPACE being a normal character."
9259 (let ((enable-recursive-minibuffers t)
9260 (minibuffer-local-completion-map
9261 (copy-keymap minibuffer-local-completion-map)))
9262 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9263 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9264 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9265 (apply 'org-icompleting-read args)))
9267 (defun org-completing-read-no-i (&rest args)
9268 (let (org-completion-use-ido org-completion-use-iswitchb)
9269 (apply 'org-completing-read args)))
9271 (defun org-iswitchb-completing-read (prompt choices &rest args)
9272 "Use iswitch as a completing-read replacement to choose from choices.
9273 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9274 from."
9275 (let* ((iswitchb-use-virtual-buffers nil)
9276 (iswitchb-make-buflist-hook
9277 (lambda ()
9278 (setq iswitchb-temp-buflist choices))))
9279 (iswitchb-read-buffer prompt)))
9281 (defun org-icompleting-read (&rest args)
9282 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9283 (org-without-partial-completion
9284 (if (and org-completion-use-ido
9285 (fboundp 'ido-completing-read)
9286 (boundp 'ido-mode) ido-mode
9287 (listp (second args)))
9288 (let ((ido-enter-matching-directory nil))
9289 (apply 'ido-completing-read (concat (car args))
9290 (if (consp (car (nth 1 args)))
9291 (mapcar 'car (nth 1 args))
9292 (nth 1 args))
9293 (cddr args)))
9294 (if (and org-completion-use-iswitchb
9295 (boundp 'iswitchb-mode) iswitchb-mode
9296 (listp (second args)))
9297 (apply 'org-iswitchb-completing-read (concat (car args))
9298 (if (consp (car (nth 1 args)))
9299 (mapcar 'car (nth 1 args))
9300 (nth 1 args))
9301 (cddr args))
9302 (apply 'completing-read args)))))
9304 (defun org-extract-attributes (s)
9305 "Extract the attributes cookie from a string and set as text property."
9306 (let (a attr (start 0) key value)
9307 (save-match-data
9309 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9311 (setq key (match-string 1 a) value (match-string 2 a)
9312 start (match-end 0)
9313 attr (plist-put attr (intern key) value))))
9314 (org-add-props s nil 'org-attr attr))
9315 s))
9317 (defun org-extract-attributes-from-string (tag)
9318 (let (key value attr)
9320 (setq key (match-string 1 tag) value (match-string 2 tag)
9321 tag (replace-match "" t t tag)
9322 attr (plist-put attr (intern key) value)))
9323 (cons tag attr)))
9325 (defun org-attributes-to-string (plist)
9326 "Format a property list into an HTML attribute list."
9327 (let ((s "") key value)
9328 (while plist
9329 (setq key (pop plist) value (pop plist))
9330 (and value
9332 s))
9334 ;;; Opening/following a link
9336 (defvar org-link-search-failed nil)
9338 (defvar org-open-link-functions nil
9339 "Hook for functions finding a plain text link.
9340 These functions must take a single argument, the link content.
9341 They will be called for links that look like [[link text][description]]
9345 These functions will be called *before* Org attempts to resolve the
9346 link by doing text searches in the current buffer - so if you want a
9348 handle this as a special case.
9350 When the function does handle the link, it must return a non-nil value.
9351 If it decides that it is not responsible for this link, it must return
9352 nil to indicate that that Org-mode can continue with other options
9353 like exact and fuzzy text search.")
9355 (defun org-next-link ()
9356 "Move forward to the next link.
9357 If the link is in hidden text, expose it."
9358 (interactive)
9359 (when (and org-link-search-failed (eq this-command last-command))
9360 (goto-char (point-min))
9361 (message "Link search wrapped back to beginning of buffer"))
9362 (setq org-link-search-failed nil)
9363 (let* ((pos (point))
9364 (ct (org-context))
9365 (a (assoc :link ct)))
9366 (if a (goto-char (nth 2 a)))
9367 (if (re-search-forward org-any-link-re nil t)
9368 (progn
9369 (goto-char (match-beginning 0))
9370 (if (outline-invisible-p) (org-show-context)))
9371 (goto-char pos)
9372 (setq org-link-search-failed t)
9373 (error "No further link found"))))
9375 (defun org-previous-link ()
9376 "Move backward to the previous link.
9377 If the link is in hidden text, expose it."
9378 (interactive)
9379 (when (and org-link-search-failed (eq this-command last-command))
9380 (goto-char (point-max))
9381 (message "Link search wrapped back to end of buffer"))
9382 (setq org-link-search-failed nil)
9383 (let* ((pos (point))
9384 (ct (org-context))
9385 (a (assoc :link ct)))
9386 (if a (goto-char (nth 1 a)))
9387 (if (re-search-backward org-any-link-re nil t)
9388 (progn
9389 (goto-char (match-beginning 0))
9390 (if (outline-invisible-p) (org-show-context)))
9391 (goto-char pos)
9392 (setq org-link-search-failed t)
9393 (error "No further link found"))))
9395 (defun org-translate-link (s)
9396 "Translate a link string if a translation function has been defined."
9397 (if (and org-link-translation-function
9398 (fboundp org-link-translation-function)
9400 (progn
9401 (setq s (funcall org-link-translation-function
9402 (match-string 1) (match-string 2)))
9403 (concat (car s) ":" (cdr s)))
9404 s))
9406 (defun org-translate-link-from-planner (type path)
9407 "Translate a link from Emacs Planner syntax so that Org can follow it.
9408 This is still an experimental function, your mileage may vary."
9409 (cond
9410 ((member type '("http" "https" "news" "ftp"))
9411 ;; standard Internet links are the same.
9412 nil)
9413 ((and (equal type "irc") (string-match "^//" path))
9414 ;; Planner has two / at the beginning of an irc link, we have 1.
9415 ;; We should have zero, actually....
9416 (setq path (substring path 1)))
9417 ((and (equal type "lisp") (string-match "^/" path))
9418 ;; Planner has a slash, we do not.
9419 (setq type "elisp" path (substring path 1)))
9421 ;; A typical message link. Planner has the id after the final slash,
9422 ;; we separate it with a hash mark
9423 (setq path (concat (match-string 1 path) "#"
9424 (org-remove-angle-brackets (match-string 2 path)))))
9425 )
9426 (cons type path))
9428 (defun org-find-file-at-mouse (ev)
9429 "Open file link or URL at mouse."
9430 (interactive "e")
9431 (mouse-set-point ev)
9432 (org-open-at-point 'in-emacs))
9434 (defun org-open-at-mouse (ev)
9435 "Open file link or URL at mouse.
9436 See the docstring of `org-open-file' for details."
9437 (interactive "e")
9438 (mouse-set-point ev)
9439 (if (eq major-mode 'org-agenda-mode)
9440 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9441 (org-open-at-point))
9443 (defvar org-window-config-before-follow-link nil
9444 "The window configuration before following a link.
9445 This is saved in case the need arises to restore it.")
9447 (defvar org-open-link-marker (make-marker)
9448 "Marker pointing to the location where `org-open-at-point; was called.")
9450 ;;;###autoload
9451 (defun org-open-at-point-global ()
9452 "Follow a link like Org-mode does.
9453 This command can be called in any mode to follow a link that has
9454 Org-mode syntax."
9455 (interactive)
9456 (org-run-like-in-org-mode 'org-open-at-point))
9458 ;;;###autoload
9459 (defun org-open-link-from-string (s &optional arg reference-buffer)
9460 "Open a link in the string S, as if it was in Org-mode."
9462 (let ((reference-buffer (or reference-buffer (current-buffer))))
9463 (with-temp-buffer
9464 (let ((org-inhibit-startup (not reference-buffer)))
9465 (org-mode)
9466 (insert s)
9467 (goto-char (point-min))
9468 (when reference-buffer
9469 (setq org-link-abbrev-alist-local
9470 (with-current-buffer reference-buffer
9471 org-link-abbrev-alist-local)))
9472 (org-open-at-point arg reference-buffer)))))
9474 (defvar org-open-at-point-functions nil
9475 "Hook that is run when following a link at point.
9477 Functions in this hook must return t if they identify and follow
9478 a link at point. If they don't find anything interesting at point,
9479 they must return nil.")
9481 (defun org-open-at-point (&optional arg reference-buffer)
9482 "Open link at or after point.
9483 If there is no link at point, this function will search forward up to
9484 the end of the current line.
9485 Normally, files will be opened by an appropriate application. If the
9486 optional prefix argument ARG is non-nil, Emacs will visit the file.
9487 With a double prefix argument, try to open outside of Emacs, in the
9488 application the system uses for this file type."
9489 (interactive "P")
9490 ;; if in a code block, then open the block's results
9491 (unless (call-interactively #'org-babel-open-src-block-result)
9492 (org-load-modules-maybe)
9493 (move-marker org-open-link-marker (point))
9494 (setq org-window-config-before-follow-link (current-window-configuration))
9495 (org-remove-occur-highlights nil nil t)
9496 (cond
9497 ((and (org-at-heading-p)
9498 (not (org-in-regexp
9503 (not (get-text-property (point) 'org-linked-text)))
9504 (or (org-offer-links-in-entry arg)
9505 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9506 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9507 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9508 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9509 (not (org-in-regexp org-bracket-link-regexp)))
9510 (org-footnote-action))
9511 (t
9512 (let (type path link line search (pos (point)))
9513 (catch 'match
9514 (save-excursion
9516 (when (org-in-regexp org-bracket-link-regexp 1)
9517 (setq link (org-extract-attributes
9518 (org-link-unescape (org-match-string-no-properties 1))))
9520 (setq link (replace-match " " t t link)))
9521 (setq link (org-link-expand-abbrev link))
9522 (cond
9523 ((or (file-name-absolute-p link)
9525 (setq type "file" path link))
9526 ((string-match org-link-re-with-space3 link)
9527 (setq type (match-string 1 link) path (match-string 2 link)))
9528 (t (setq type "thisfile" path link)))
9529 (throw 'match t)))
9531 (when (get-text-property (point) 'org-linked-text)
9532 (setq type "thisfile"
9533 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9534 (1+ (point)) (point))
9535 path (buffer-substring
9536 (or (previous-single-property-change pos 'org-linked-text)
9537 (point-min))
9538 (or (next-single-property-change pos 'org-linked-text)
9539 (point-max))))
9540 (throw 'match t))
9542 (save-excursion
9543 (when (or (org-in-regexp org-angle-link-re)
9544 (org-in-regexp org-plain-link-re))
9545 (setq type (match-string 1)
9546 path (org-link-unescape (match-string 2)))
9547 (throw 'match t)))
9548 (save-excursion
9550 (setq type "tags"
9551 path (match-string 1))
9552 (while (string-match ":" path)
9553 (setq path (replace-match "+" t t path)))
9554 (throw 'match t)))
9556 (setq type "tree-match"
9557 path (match-string 1))
9558 (throw 'match t)))
9559 (unless path
9560 (error "No link found"))
9562 ;; switch back to reference buffer
9563 ;; needed when if called in a temporary buffer through
9564 ;; org-open-link-from-string
9565 (with-current-buffer (or reference-buffer (current-buffer))
9567 ;; Remove any trailing spaces in path
9569 (setq path (replace-match "" t t path)))
9570 (if (and org-link-translation-function
9571 (fboundp org-link-translation-function))
9572 ;; Check if we need to translate the link
9573 (let ((tmp (funcall org-link-translation-function type path)))
9574 (setq type (car tmp) path (cdr tmp))))
9576 (cond
9578 ((assoc type org-link-protocols)
9579 (funcall (nth 1 (assoc type org-link-protocols)) path))
9581 ((equal type "mailto")
9582 (let ((cmd (car org-link-mailto-program))
9583 (args (cdr org-link-mailto-program)) args1
9584 (address path) (subject "") a)
9586 (setq address (match-string 1 path)
9587 subject (org-link-escape (match-string 2 path))))
9588 (while args
9589 (cond
9590 ((not (stringp (car args))) (push (pop args) args1))
9591 (t (setq a (pop args))
9592 (if (string-match "%a" a)
9593 (setq a (replace-match address t t a)))
9594 (if (string-match "%s" a)
9595 (setq a (replace-match subject t t a)))
9596 (push a args1))))
9597 (apply cmd (nreverse args1))))
9599 ((member type '("http" "https" "ftp" "news"))
9600 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9601 (org-link-escape
9602 path org-link-escape-chars-browser)
9603 path))))
9605 ((string= type "doi")
9606 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9607 (org-link-escape
9608 path org-link-escape-chars-browser)
9609 path))))
9611 ((member type '("message"))
9612 (browse-url (concat type ":" path)))
9614 ((string= type "tags")
9615 (org-tags-view arg path))
9617 ((string= type "tree-match")
9620 ((string= type "file")
9622 (setq line (string-to-number (match-string 1 path))
9623 path (substring path 0 (match-beginning 0)))
9625 (setq search (match-string 1 path)
9626 path (substring path 0 (match-beginning 0)))))
9627 (if (string-match "[*?{]" (file-name-nondirectory path))
9628 (dired path)
9629 (org-open-file path arg line search)))
9631 ((string= type "shell")
9632 (let ((cmd path))
9633 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9634 (string-match org-confirm-shell-link-not-regexp cmd))
9635 (not org-confirm-shell-link-function)
9636 (funcall org-confirm-shell-link-function
9638 (org-add-props cmd nil
9639 'face 'org-warning))))
9640 (progn
9641 (message "Executing %s" cmd)
9642 (shell-command cmd))
9643 (error "Abort"))))
9645 ((string= type "elisp")
9646 (let ((cmd path))
9647 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9648 (string-match org-confirm-elisp-link-not-regexp cmd))
9649 (not org-confirm-elisp-link-function)
9650 (funcall org-confirm-elisp-link-function
9652 (org-add-props cmd nil
9653 'face 'org-warning))))
9654 (message "%s => %s" cmd
9655 (if (equal (string-to-char cmd) ?\()
9656 (eval (read cmd))
9657 (call-interactively (read cmd))))
9658 (error "Abort"))))
9660 ((and (string= type "thisfile")
9661 (run-hook-with-args-until-success
9662 'org-open-link-functions path)))
9664 ((string= type "thisfile")
9665 (if arg
9666 (switch-to-buffer-other-window
9667 (org-get-buffer-for-internal-link (current-buffer)))
9668 (org-mark-ring-push))
9669 (let ((cmd `(org-link-search
9670 ,path
9671 ,(cond ((equal arg '(4)) ''occur)
9672 ((equal arg '(16)) ''org-occur)
9673 (t nil))
9674 ,pos)))
9675 (condition-case nil (let ((org-link-search-inhibit-query t))
9676 (eval cmd))
9677 (error (progn (widen) (eval cmd))))))
9679 (t
9680 (browse-url-at-point)))))))
9681 (move-marker org-open-link-marker nil)
9682 (run-hook-with-args 'org-follow-link-hook)))
9684 (defun org-offer-links-in-entry (&optional nth zero)
9685 "Offer links in the current entry and follow the selected link.
9686 If there is only one link, follow it immediately as well.
9687 If NTH is an integer, immediately pick the NTH link found.
9688 If ZERO is a string, check also this string for a link, and if
9689 there is one, offer it as link number zero."
9693 (cnt ?0)
9694 (in-emacs (if (integerp nth) nil nth))
9695 have-zero end links link c)
9696 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9697 (push (match-string 0 zero) links)
9698 (setq cnt (1- cnt) have-zero t))
9699 (save-excursion
9700 (org-back-to-heading t)
9701 (setq end (save-excursion (outline-next-heading) (point)))
9702 (while (re-search-forward re end t)
9703 (push (match-string 0) links))
9704 (setq links (org-uniquify (reverse links))))
9706 (cond
9707 ((null links)
9708 (message "No links"))
9709 ((equal (length links) 1)
9710 (setq link (list (car links))))
9711 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9712 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9713 (t ; we have to select a link
9714 (save-excursion
9715 (save-window-excursion
9716 (delete-other-windows)
9717 (with-output-to-temp-buffer "*Select Link*"
9718 (mapc (lambda (l)
9719 (if (not (string-match org-bracket-link-regexp l))
9721 (org-remove-angle-brackets l)))
9722 (if (match-end 3)
9724 (match-string 3 l) (match-string 1 l)))
9726 (match-string 1 l))))))
9727 links))
9728 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9729 (message "Select link to open, RET to open all:")
9730 (setq c (read-char-exclusive))
9731 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9732 (when (equal c ?q) (error "Abort"))
9733 (if (equal c ?\C-m)
9734 (setq link links)
9735 (setq nth (- c ?0))
9736 (if have-zero (setq nth (1+ nth)))
9737 (unless (and (integerp nth) (>= (length links) nth))
9738 (error "Invalid link selection"))
9739 (setq link (list (nth (1- nth) links))))))
9740 (if link
9741 (let ((buf (current-buffer)))
9742 (dolist (l link)
9743 (org-open-link-from-string l in-emacs buf))
9744 t)
9745 nil)))
9747 ;; Add special file links that specify the way of opening
9749 (org-add-link-type "file+sys" 'org-open-file-with-system)
9750 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9751 (defun org-open-file-with-system (path)
9752 "Open file at PATH using the system way of opening it."
9753 (org-open-file path 'system))
9754 (defun org-open-file-with-emacs (path)
9755 "Open file at PATH in Emacs."
9756 (org-open-file path 'emacs))
9757 (defun org-remove-file-link-modifiers ()
9758 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9759 (goto-char (point-min))
9761 (org-if-unprotected
9762 (replace-match "file:" t t))))
9763 (eval-after-load "org-exp"
9764 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9765 'org-remove-file-link-modifiers))
9767 ;;;; Time estimates
9769 (defun org-get-effort (&optional pom)
9770 "Get the effort estimate for the current entry."
9771 (org-entry-get pom org-effort-property))
9773 ;;; File search
9775 (defvar org-create-file-search-functions nil
9776 "List of functions to construct the right search string for a file link.
9777 These functions are called in turn with point at the location to
9778 which the link should point.
9780 A function in the hook should first test if it would like to
9781 handle this file type, for example by checking the `major-mode'
9782 or the file extension. If it decides not to handle this file, it
9783 should just return nil to give other functions a chance. If it
9784 does handle the file, it must return the search string to be used
9785 when following the link. The search string will be part of the
9786 file link, given after a double colon, and `org-open-at-point'
9787 will automatically search for it. If special measures must be
9788 taken to make the search successful, another function should be
9789 added to the companion hook `org-execute-file-search-functions',
9790 which see.
9792 A function in this hook may also use `setq' to set the variable
9793 `description' to provide a suggestion for the descriptive text to
9794 be used for this link when it gets inserted into an Org-mode
9797 (defvar org-execute-file-search-functions nil
9798 "List of functions to execute a file search triggered by a link.
9800 Functions added to this hook must accept a single argument, the
9801 search string that was part of the file link, the part after the
9802 double colon. The function must first check if it would like to
9803 handle this search, for example by checking the `major-mode' or
9804 the file extension. If it decides not to handle this search, it
9805 should just return nil to give other functions a chance. If it
9806 does handle the search, it must return a non-nil value to keep
9807 other functions from trying.
9809 Each function can access the current prefix argument through the
9810 variable `current-prefix-argument'. Note that a single prefix is
9811 used to force opening a link in Emacs, so it may be good to only
9812 use a numeric or double prefix to guide the search function.
9814 In case this is needed, a function in this hook can also restore
9815 the window configuration before `org-open-at-point' was called using:
9817 (set-window-configuration org-window-config-before-follow-link)")
9819 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9820 (defun org-link-search (s &optional type avoid-pos stealth)
9821 "Search for a link search option.
9822 If S is surrounded by forward slashes, it is interpreted as a
9823 regular expression. In org-mode files, this will create an `org-occur'
9824 sparse tree. In ordinary files, `occur' will be used to list matches.
9825 If the current buffer is in `dired-mode', grep will be used to search
9826 in all files. If AVOID-POS is given, ignore matches near that position.
9828 When optional argument STEALTH is non-nil, do not modify
9829 visibility around point, thus ignoring
9830 `org-show-hierarchy-above', `org-show-following-heading' and
9831 `org-show-siblings' variables."
9832 (let ((case-fold-search t)
9836 org-emphasis-alist)
9838 (pos (point))
9839 (pre nil) (post nil)
9840 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9841 (cond
9842 ;; First check if there are any special search functions
9843 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9844 ;; Now try the builtin stuff
9845 ((and (equal (string-to-char s0) ?#)
9846 (> (length s0) 1)
9847 (save-excursion
9848 (goto-char (point-min))
9849 (and
9850 (re-search-forward
9852 (setq type 'dedicated
9853 pos (match-beginning 0))))
9854 ;; There is an exact target for this
9855 (goto-char pos)
9856 (org-back-to-heading t)))
9857 ((save-excursion
9858 (goto-char (point-min))
9859 (and
9860 (re-search-forward
9861 (concat "<<" (regexp-quote s0) ">>") nil t)
9862 (setq type 'dedicated
9863 pos (match-beginning 0))))
9864 ;; There is an exact target for this
9865 (goto-char pos))
9867 (save-excursion
9868 (goto-char (point-min))
9869 (and
9870 (re-search-forward
9871 (concat "[^[]" (regexp-quote
9872 (format org-coderef-label-format
9873 (match-string 1 s0))))
9874 nil t)
9875 (setq type 'dedicated
9876 pos (1+ (match-beginning 0))))))
9877 ;; There is a coderef target for this
9878 (goto-char pos))
9880 ;; A regular expression
9881 (cond
9882 ((eq major-mode 'org-mode)
9883 (org-occur (match-string 1 s)))
9884 ;;((eq major-mode 'dired-mode)
9885 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9886 (t (org-do-occur (match-string 1 s)))))
9887 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9888 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9889 (goto-char (point-min))
9890 (cond
9891 ((let (case-fold-search)
9892 (re-search-forward (format org-complex-heading-regexp-format
9893 (regexp-quote s))
9894 nil t))
9895 ;; OK, found a match
9896 (setq type 'dedicated)
9897 (goto-char (match-beginning 0)))
9898 ((and (not org-link-search-inhibit-query)
9899 (eq org-link-search-must-match-exact-headline 'query-to-create)
9900 (y-or-n-p "No match - create this as a new heading? "))
9901 (goto-char (point-max))
9902 (or (bolp) (newline))
9904 (beginning-of-line 0))
9905 (t
9906 (goto-char pos)
9907 (error "No match"))))
9908 (t
9909 ;; A normal search string
9910 (when (equal (string-to-char s) ?*)
9911 ;; Anchor on headlines, post may include tags.
9914 s (substring s 1)))
9915 (remove-text-properties
9916 0 (length s)
9917 '(face nil mouse-face nil keymap nil fontified nil) s)
9918 ;; Make a series of regular expressions to find a match
9927 re4 (concat "[^a-zA-Z_]" re4_)
9929 re1 (concat pre re2 post)
9930 re3 (concat pre (if pre re4_ re4) post)
9931 re5 (concat pre ".*" re4)
9932 re2 (concat pre re2)
9933 re2a (concat pre (if pre re2a_ re2a))
9934 re4 (concat pre (if pre re4_ re4))
9938 ))
9939 (cond
9940 ((eq type 'org-occur) (org-occur reall))
9941 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9942 (t (goto-char (point-min))
9943 (setq type 'fuzzy)
9944 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9945 (org-search-not-self 1 re1 nil t)
9946 (org-search-not-self 1 re2 nil t)
9947 (org-search-not-self 1 re2a nil t)
9948 (org-search-not-self 1 re3 nil t)
9949 (org-search-not-self 1 re4 nil t)
9950 (org-search-not-self 1 re5 nil t)
9951 )
9952 (goto-char (match-beginning 1))
9953 (goto-char pos)
9954 (error "No match"))))))
9955 (and (eq major-mode 'org-mode)
9956 (not stealth)
9957 (org-show-context 'link-search))
9958 type))
9960 (defun org-search-not-self (group &rest args)
9961 "Execute `re-search-forward', but only accept matches that do not
9962 enclose the position of `org-open-link-marker'."
9963 (let ((m org-open-link-marker))
9964 (catch 'exit
9965 (while (apply 're-search-forward args)
9966 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9967 (goto-char (match-end group))
9968 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9969 (> (match-beginning 0) (marker-position m))
9970 (< (match-end 0) (marker-position m)))
9971 (save-match-data
9972 (or (not (org-in-regexp
9973 org-bracket-link-analytic-regexp 1))
9974 (not (match-end 4)) ; no description
9975 (and (<= (match-beginning 4) (point))
9976 (>= (match-end 4) (point))))))
9977 (throw 'exit (point))))))))
9979 (defun org-get-buffer-for-internal-link (buffer)
9980 "Return a buffer to be used for displaying the link target of internal links."
9981 (cond
9982 ((not org-display-internal-link-with-indirect-buffer)
9983 buffer)
9984 ((string-match "(Clone)$" (buffer-name buffer))
9985 (message "Buffer is already a clone, not making another one")
9986 ;; we also do not modify visibility in this case
9987 buffer)
9988 (t ; make a new indirect buffer for displaying the link
9989 (let* ((bn (buffer-name buffer))
9990 (ibn (concat bn "(Clone)"))
9991 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9992 (with-current-buffer ib (org-overview))
9993 ib))))
9995 (defun org-do-occur (regexp &optional cleanup)
9996 "Call the Emacs command `occur'.
9997 If CLEANUP is non-nil, remove the printout of the regular expression
9998 in the *Occur* buffer. This is useful if the regex is long and not useful
9999 to read."
10000 (occur regexp)
10001 (when cleanup
10002 (let ((cwin (selected-window)) win beg end)
10003 (when (setq win (get-buffer-window "*Occur*"))
10004 (select-window win))
10005 (goto-char (point-min))
10006 (when (re-search-forward "match[a-z]+" nil t)
10007 (setq beg (match-end 0))
10009 (setq end (1- (match-beginning 0)))))
10010 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10011 (goto-char (point-min))
10012 (select-window cwin))))
10014 ;;; The mark ring for links jumps
10016 (defvar org-mark-ring nil
10017 "Mark ring for positions before jumps in Org-mode.")
10018 (defvar org-mark-ring-last-goto nil
10019 "Last position in the mark ring used to go back.")
10020 ;; Fill and close the ring
10021 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10022 (loop for i from 1 to org-mark-ring-length do
10023 (push (make-marker) org-mark-ring))
10024 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10025 org-mark-ring)
10027 (defun org-mark-ring-push (&optional pos buffer)
10028 "Put the current position or POS into the mark ring and rotate it."
10029 (interactive)
10030 (setq pos (or pos (point)))
10031 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10032 (move-marker (car org-mark-ring)
10033 (or pos (point))
10034 (or buffer (current-buffer)))
10035 (message "%s"
10036 (substitute-command-keys
10039 (defun org-mark-ring-goto (&optional n)
10040 "Jump to the previous position in the mark ring.
10041 With prefix arg N, jump back that many stored positions. When
10042 called several times in succession, walk through the entire ring.
10043 Org-mode commands jumping to a different position in the current file,
10044 or to another Org-mode file, automatically push the old position
10045 onto the ring."
10046 (interactive "p")
10047 (let (p m)
10048 (if (eq last-command this-command)
10049 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10050 (setq p org-mark-ring))
10051 (setq org-mark-ring-last-goto p)
10052 (setq m (car p))
10053 (org-pop-to-buffer-same-window (marker-buffer m))
10054 (goto-char m)
10055 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10057 (defun org-remove-angle-brackets (s)
10058 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10059 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10060 s)
10061 (defun org-add-angle-brackets (s)
10062 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10063 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10064 s)
10065 (defun org-remove-double-quotes (s)
10068 s)
10070 ;;; Following specific links
10072 (defun org-follow-timestamp-link ()
10073 (cond
10074 ((org-at-date-range-p t)
10075 (let ((org-agenda-start-on-weekday)
10076 (t1 (match-string 1))
10077 (t2 (match-string 2)))
10078 (setq t1 (time-to-days (org-time-string-to-time t1))
10079 t2 (time-to-days (org-time-string-to-time t2)))
10080 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10081 ((org-at-timestamp-p t)
10082 (org-agenda-list nil (time-to-days (org-time-string-to-time
10083 (substring (match-string 1) 0 10)))
10084 1))
10085 (t (error "This should not happen"))))
10088 ;;; Following file links
10089 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10090 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10091 (declare-function mailcap-mime-info
10092 "mailcap" (string &optional request no-decode))
10093 (defvar org-wait nil)
10094 (defun org-open-file (path &optional in-emacs line search)
10095 "Open the file at PATH.
10096 First, this expands any special file name abbreviations. Then the
10097 configuration variable `org-file-apps' is checked if it contains an
10098 entry for this file type, and if yes, the corresponding command is launched.
10100 If no application is found, Emacs simply visits the file.
10102 With optional prefix argument IN-EMACS, Emacs will visit the file.
10104 prefix arg, Org tries to avoid opening in Emacs
10105 and to use an external application to visit the file.
10107 Optional LINE specifies a line to go to, optional SEARCH a string
10108 to search for. If LINE or SEARCH is given, the file will be
10109 opened in Emacs, unless an entry from org-file-apps that makes
10110 use of groups in a regexp matches.
10112 If you want to change the way frames are used when following a
10113 link, please customize `org-link-frame-setup'.
10115 If the file does not exist, an error is thrown."
10116 (let* ((file (if (equal path "")
10117 buffer-file-name
10118 (substitute-in-file-name (expand-file-name path))))
10119 (file-apps (append org-file-apps (org-default-apps)))
10120 (apps (org-remove-if
10121 'org-file-apps-entry-match-against-dlink-p file-apps))
10122 (apps-dlink (org-remove-if-not
10123 'org-file-apps-entry-match-against-dlink-p file-apps))
10124 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10125 (dirp (if remp nil (file-directory-p file)))
10126 (file (if (and dirp org-open-directory-means-index-dot-org)
10127 (concat (file-name-as-directory file) "index.org")
10128 file))
10129 (a-m-a-p (assq 'auto-mode apps))
10130 (dfile (downcase file))
10131 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10132 (link (cond ((and (eq line nil)
10133 (eq search nil))
10134 file)
10135 (line
10136 (concat file "::" (number-to-string line)))
10137 (search
10138 (concat file "::" search))))
10139 (dlink (downcase link))
10140 (old-buffer (current-buffer))
10141 (old-pos (point))
10142 (old-mode major-mode)
10143 ext cmd link-match-data)
10145 (setq ext (match-string 1 dfile))
10147 (setq ext (match-string 1 dfile))))
10148 (cond
10149 ((member in-emacs '((16) system))
10150 (setq cmd (cdr (assoc 'system apps))))
10151 (in-emacs (setq cmd 'emacs))
10152 (t
10153 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10154 (and dirp (cdr (assoc 'directory apps)))
10155 ; first, try matching against apps-dlink
10156 ; if we get a match here, store the match data for later
10157 (let ((match (assoc-default dlink apps-dlink
10158 'string-match)))
10159 (if match
10160 (progn (setq link-match-data (match-data))
10161 match)
10162 (progn (setq in-emacs (or in-emacs line search))
10163 nil))) ; if we have no match in apps-dlink,
10164 ; always open the file in emacs if line or search
10165 ; is given (for backwards compatibility)
10166 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10167 'string-match)
10168 (cdr (assoc ext apps))
10169 (cdr (assoc t apps))))))
10170 (when (eq cmd 'system)
10171 (setq cmd (cdr (assoc 'system apps))))
10172 (when (eq cmd 'default)
10173 (setq cmd (cdr (assoc t apps))))
10174 (when (eq cmd 'mailcap)
10175 (require 'mailcap)
10176 (mailcap-parse-mailcaps)
10177 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10178 (command (mailcap-mime-info mime-type)))
10179 (if (stringp command)
10180 (setq cmd command)
10181 (setq cmd 'emacs))))
10182 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10183 (not (file-exists-p file))
10184 (not org-open-non-existing-files))
10185 (error "No such file: %s" file))
10186 (cond
10188 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10190 (setq cmd (replace-match "%s" t t cmd)))
10191 (while (string-match "%s" cmd)
10192 (setq cmd (replace-match
10193 (save-match-data
10194 (shell-quote-argument
10195 (convert-standard-filename file)))
10196 t t cmd)))
10198 ;; Replace "%1", "%2" etc. in command with group matches from regex
10199 (save-match-data
10200 (let ((match-index 1)
10201 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10202 (set-match-data link-match-data)
10203 (while (<= match-index number-of-groups)
10204 (let ((regex (concat "%" (number-to-string match-index)))
10205 (replace-with (match-string match-index dlink)))
10206 (while (string-match regex cmd)
10207 (setq cmd (replace-match replace-with t t cmd))))
10208 (setq match-index (+ match-index 1)))))
10210 (save-window-excursion
10211 (start-process-shell-command cmd nil cmd)
10212 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10213 ))
10214 ((or (stringp cmd)
10215 (eq cmd 'emacs))
10216 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10217 (widen)
10218 (if line (org-goto-line line)
10219 (if search (org-link-search search))))
10220 ((consp cmd)
10221 (let ((file (convert-standard-filename file)))
10222 (save-match-data
10223 (set-match-data link-match-data)
10224 (eval cmd))))
10225 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10226 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10227 (or (not (equal old-buffer (current-buffer)))
10228 (not (equal old-pos (point))))
10229 (org-mark-ring-push old-pos old-buffer))))
10231 (defun org-file-apps-entry-match-against-dlink-p (entry)
10232 "This function returns non-nil if `entry' uses a regular
10233 expression which should be matched against the whole link by
10234 org-open-file.
10236 It assumes that is the case when the entry uses a regular
10237 expression which has at least one grouping construct and the
10238 action is either a lisp form or a command string containing
10239 '%1', i.e. using at least one subexpression match as a
10240 parameter."
10241 (let ((selector (car entry))
10242 (action (cdr entry)))
10243 (if (stringp selector)
10244 (and (> (regexp-opt-depth selector) 0)
10245 (or (and (stringp action)
10246 (string-match "%[0-9]" action))
10247 (consp action)))
10248 nil)))
10250 (defun org-default-apps ()
10251 "Return the default applications for this operating system."
10252 (cond
10253 ((eq system-type 'darwin)
10254 org-file-apps-defaults-macosx)
10255 ((eq system-type 'windows-nt)
10256 org-file-apps-defaults-windowsnt)
10257 (t org-file-apps-defaults-gnu)))
10259 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10260 "Convert extensions to regular expressions in the cars of LIST.
10261 Also, weed out any non-string entries, because the return value is used
10262 only for regexp matching.
10263 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10264 point to the symbol `emacs', indicating that the file should
10265 be opened in Emacs."
10266 (append
10267 (delq nil
10268 (mapcar (lambda (x)
10269 (if (not (stringp (car x)))
10270 nil
10272 x
10274 list))
10275 (if add-auto-mode
10276 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10278 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10279 (defun org-file-remote-p (file)
10280 "Test whether FILE specifies a location on a remote system.
10281 Return non-nil if the location is indeed remote.
10285 (cond ((fboundp 'file-remote-p)
10286 (file-remote-p file))
10287 ((fboundp 'tramp-handle-file-remote-p)
10288 (tramp-handle-file-remote-p file))
10289 ((and (boundp 'ange-ftp-name-format)
10290 (string-match (car ange-ftp-name-format) file))
10291 t)
10292 (t nil)))
10295 ;;;; Refiling
10297 (defun org-get-org-file ()
10298 "Read a filename, with default directory `org-directory'."
10299 (let ((default (or org-default-notes-file remember-data-file)))
10300 (read-file-name (format "File name [%s]: " default)
10301 (file-name-as-directory org-directory)
10302 default)))
10304 (defun org-notes-order-reversed-p ()
10305 "Check if the current file should receive notes in reversed order."
10306 (cond
10307 ((not org-reverse-note-order) nil)
10308 ((eq t org-reverse-note-order) t)
10309 ((not (listp org-reverse-note-order)) nil)
10310 (t (catch 'exit
10311 (let ((all org-reverse-note-order)
10312 entry)
10313 (while (setq entry (pop all))
10314 (if (string-match (car entry) buffer-file-name)
10315 (throw 'exit (cdr entry))))
10316 nil)))))
10318 (defvar org-refile-target-table nil
10319 "The list of refile targets, created by `org-refile'.")
10321 (defvar org-agenda-new-buffers nil
10322 "Buffers created to visit agenda files.")
10324 (defvar org-refile-cache nil
10325 "Cache for refile targets.")
10327 (defvar org-refile-markers nil
10328 "All the markers used for caching refile locations.")
10330 (defun org-refile-marker (pos)
10331 "Get a new refile marker, but only if caching is in use."
10332 (if (not org-refile-use-cache)
10333 pos
10334 (let ((m (make-marker)))
10335 (move-marker m pos)
10336 (push m org-refile-markers)
10337 m)))
10339 (defun org-refile-cache-clear ()
10340 "Clear the refile cache and disable all the markers."
10341 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10342 (setq org-refile-markers nil)
10343 (setq org-refile-cache nil)
10344 (message "Refile cache has been cleared"))
10346 (defun org-refile-cache-check-set (set)
10347 "Check if all the markers in the cache still have live buffers."
10348 (let (marker)
10349 (catch 'exit
10350 (while (and set (setq marker (nth 3 (pop set))))
10351 ;; if org-refile-use-outline-path is 'file, marker may be nil
10352 (when (and marker (null (marker-buffer marker)))
10353 (message "not found") (sit-for 3)
10354 (throw 'exit nil)))
10355 t)))
10357 (defun org-refile-cache-put (set &rest identifiers)
10358 "Push the refile targets SET into the cache, under IDENTIFIERS."
10359 (let* ((key (sha1 (prin1-to-string identifiers)))
10360 (entry (assoc key org-refile-cache)))
10361 (if entry
10362 (setcdr entry set)
10363 (push (cons key set) org-refile-cache))))
10365 (defun org-refile-cache-get (&rest identifiers)
10366 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10367 (cond
10368 ((not org-refile-cache) nil)
10369 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10370 (t
10371 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10372 org-refile-cache))))
10373 (and set (org-refile-cache-check-set set) set)))))
10375 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10376 "Produce a table with refile targets."
10377 (let ((case-fold-search nil)
10378 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10379 (entries (or org-refile-targets '((nil . (:level . 1)))))
10380 targets tgs txt re files f desc descre fast-path-p level pos0)
10381 (message "Getting targets...")
10382 (with-current-buffer (or default-buffer (current-buffer))
10383 (while (setq entry (pop entries))
10384 (setq files (car entry) desc (cdr entry))
10385 (setq fast-path-p nil)
10386 (cond
10387 ((null files) (setq files (list (current-buffer))))
10388 ((eq files 'org-agenda-files)
10389 (setq files (org-agenda-files 'unrestricted)))
10390 ((and (symbolp files) (fboundp files))
10391 (setq files (funcall files)))
10392 ((and (symbolp files) (boundp files))
10393 (setq files (symbol-value files))))
10394 (if (stringp files) (setq files (list files)))
10395 (cond
10396 ((eq (car desc) :tag)
10398 ((eq (car desc) :todo)
10400 ((eq (car desc) :regexp)
10401 (setq descre (cdr desc)))
10402 ((eq (car desc) :level)
10404 (if org-odd-levels-only
10405 (1- (* 2 (cdr desc)))
10406 (cdr desc)))
10408 ((eq (car desc) :maxlevel)
10409 (setq fast-path-p t)
10411 (if org-odd-levels-only
10412 (1- (* 2 (cdr desc)))
10413 (cdr desc)))
10415 (t (error "Bad refiling target description %s" desc)))
10416 (while (setq f (pop files))
10417 (with-current-buffer
10418 (if (bufferp f) f (org-get-agenda-file-buffer f))
10419 (or
10420 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10421 (progn
10422 (if (bufferp f) (setq f (buffer-file-name
10423 (buffer-base-buffer f))))
10424 (setq f (and f (expand-file-name f)))
10425 (if (eq org-refile-use-outline-path 'file)
10426 (push (list (file-name-nondirectory f) f nil nil) tgs))
10427 (save-excursion
10428 (save-restriction
10429 (widen)
10430 (goto-char (point-min))
10431 (while (re-search-forward descre nil t)
10432 (goto-char (setq pos0 (point-at-bol)))
10433 (catch 'next
10434 (when org-refile-target-verify-function
10435 (save-match-data
10436 (or (funcall org-refile-target-verify-function)
10437 (throw 'next t))))
10438 (when (and (looking-at org-complex-heading-regexp)
10439 (not (member (match-string 4) excluded-entries))
10440 (match-string 4))
10441 (setq level (org-reduced-level
10442 (- (match-end 1) (match-beginning 1)))
10443 txt (org-link-display-format (match-string 4))
10445 re (format org-complex-heading-regexp-format
10446 (regexp-quote (match-string 4))))
10447 (when org-refile-use-outline-path
10448 (setq txt (mapconcat
10449 'org-protect-slash
10450 (append
10451 (if (eq org-refile-use-outline-path
10452 'file)
10453 (list (file-name-nondirectory
10454 (buffer-file-name
10455 (buffer-base-buffer))))
10456 (if (eq org-refile-use-outline-path
10457 'full-file-path)
10458 (list (buffer-file-name
10459 (buffer-base-buffer)))))
10460 (org-get-outline-path fast-path-p
10461 level txt)
10462 (list txt))
10463 "/")))
10464 (push (list txt f re (org-refile-marker (point)))
10465 tgs)))
10466 (when (= (point) pos0)
10467 ;; verification function has not moved point
10468 (goto-char (point-at-eol))))))))
10469 (when org-refile-use-cache
10470 (org-refile-cache-put tgs (buffer-file-name) descre))
10471 (setq targets (append tgs targets))
10472 ))))
10473 (message "Getting targets...done")
10474 (nreverse targets)))
10476 (defun org-protect-slash (s)
10477 (while (string-match "/" s)
10479 s)
10481 (defvar org-olpa (make-vector 20 nil))
10483 (defun org-get-outline-path (&optional fastp level heading)
10484 "Return the outline path to the current entry, as a list.
10486 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10487 routine which makes outline path derivations for an entire file,
10488 avoiding backtracing. Refile target collection makes use of that."
10489 (if fastp
10490 (progn
10491 (if (> level 19)
10492 (error "Outline path failure, more than 19 levels"))
10493 (loop for i from level upto 19 do
10494 (aset org-olpa i nil))
10495 (prog1
10496 (delq nil (append org-olpa nil))
10497 (aset org-olpa level heading)))
10498 (let (rtn case-fold-search)
10499 (save-excursion
10500 (save-restriction
10501 (widen)
10502 (while (org-up-heading-safe)
10503 (when (looking-at org-complex-heading-regexp)
10504 (push (org-match-string-no-properties 4) rtn)))
10505 rtn)))))
10507 (defun org-format-outline-path (path &optional width prefix)
10508 "Format the outline path PATH for display.
10509 Width is the maximum number of characters that is available.
10510 Prefix is a prefix to be included in the returned string,
10511 such as the file name."
10512 (setq width (or width 79))
10513 (if prefix (setq width (- width (length prefix))))
10514 (if (not path)
10515 (or prefix "")
10516 (let* ((nsteps (length path))
10517 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10518 (maxwidth (if (<= total-width width)
10519 10000 ;; everything fits
10520 ;; we need to shorten the level headings
10521 (/ (- width nsteps) nsteps)))
10522 (org-odd-levels-only nil)
10523 (n 0)
10524 (total (1+ (length prefix))))
10525 (setq maxwidth (max maxwidth 10))
10526 (concat prefix
10527 (mapconcat
10528 (lambda (h)
10529 (setq n (1+ n))
10530 (if (and (= n nsteps) (< maxwidth 10000))
10531 (setq maxwidth (- total-width total)))
10532 (if (< (length h) maxwidth)
10533 (progn (setq total (+ total (length h) 1)) h)
10534 (setq h (substring h 0 (- maxwidth 2))
10535 total (+ total maxwidth 1))
10537 (setq h (substring h 0 (match-beginning 0))))
10538 (setq h (concat h "..")))
10539 (org-add-props h nil 'face
10540 (nth (% (1- n) org-n-level-faces)
10541 org-level-faces))
10542 h)
10543 path "/")))))
10545 (defun org-display-outline-path (&optional file current)
10546 "Display the current outline path in the echo area."
10547 (interactive "P")
10548 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10549 (case-fold-search nil)
10550 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10551 (if current (setq path (append path
10552 (save-excursion
10553 (org-back-to-heading t)
10554 (if (looking-at org-complex-heading-regexp)
10555 (list (match-string 4)))))))
10556 (message "%s"
10557 (org-format-outline-path
10558 path
10559 (1- (frame-width))
10560 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10562 (defvar org-refile-history nil
10563 "History for refiling operations.")
10565 (defvar org-after-refile-insert-hook nil
10566 "Hook run after `org-refile' has inserted its stuff at the new location.
10567 Note that this is still *before* the stuff will be removed from
10568 the *old* location.")
10570 (defvar org-capture-last-stored-marker)
10571 (defun org-refile (&optional goto default-buffer rfloc)
10572 "Move the entry or entries at point to another heading.
10573 The list of target headings is compiled using the information in
10574 `org-refile-targets', which see.
10576 At the target location, the entry is filed as a subitem of the target
10577 heading. Depending on `org-reverse-note-order', the new subitem will
10578 either be the first or the last subitem.
10580 If there is an active region, all entries in that region will be moved.
10581 However, the region must fulfill the requirement that the first heading
10582 is the first one sets the top-level of the moved text - at most siblings
10583 below it are allowed.
10585 With prefix arg GOTO, the command will only visit the target location
10586 and not actually move anything.
10589 go to the location where the last refiling operation has put the subtree.
10590 With a prefix argument of `2', refile to the running clock.
10592 RFLOC can be a refile location obtained in a different way.
10594 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10596 If you are using target caching (see `org-refile-use-cache'),
10597 You have to clear the target cache in order to find new targets.
10598 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10599 prefix argument (`C-u C-u C-u C-c C-w')."
10601 (interactive "P")
10602 (if (member goto '(0 (64)))
10603 (org-refile-cache-clear)
10604 (let* ((cbuf (current-buffer))
10605 (regionp (org-region-active-p))
10606 (region-start (and regionp (region-beginning)))
10607 (region-end (and regionp (region-end)))
10608 (region-length (and regionp (- region-end region-start)))
10609 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10610 pos it nbuf file re level reversed)
10611 (setq last-command nil)
10612 (when regionp
10613 (goto-char region-start)
10614 (or (bolp) (goto-char (point-at-bol)))
10615 (setq region-start (point))
10616 (unless (or (org-kill-is-subtree-p
10617 (buffer-substring region-start region-end))
10618 (prog1 org-refile-active-region-within-subtree
10619 (org-toggle-heading)))
10620 (error "The region is not a (sequence of) subtree(s)")))
10621 (if (equal goto '(16))
10622 (org-refile-goto-last-stored)
10623 (when (or
10624 (and (equal goto 2)
10625 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10626 (prog1
10627 (setq it (list (or org-clock-heading "running clock")
10628 (buffer-file-name
10629 (marker-buffer org-clock-hd-marker))
10630 ""
10631 (marker-position org-clock-hd-marker)))
10632 (setq goto nil)))
10633 (setq it (or rfloc
10634 (let (heading-text)
10635 (save-excursion
10636 (unless goto
10637 (org-back-to-heading t)
10638 (setq heading-text
10639 (nth 4 (org-heading-components))))
10640 (org-refile-get-location
10641 (cond (goto "Goto")
10642 (regionp "Refile region to")
10645 default-buffer
10646 (and (not (equal '(4) goto))
10647 org-refile-allow-creating-parent-nodes)
10648 goto))))))
10649 (setq file (nth 1 it)
10650 re (nth 2 it)
10651 pos (nth 3 it))
10652 (if (and (not goto)
10653 pos
10654 (equal (buffer-file-name) file)
10655 (if regionp
10656 (and (>= pos region-start)
10657 (<= pos region-end))
10658 (and (>= pos (point))
10659 (< pos (save-excursion
10660 (org-end-of-subtree t t))))))
10661 (error "Cannot refile to position inside the tree or region"))
10663 (setq nbuf (or (find-buffer-visiting file)
10664 (find-file-noselect file)))
10665 (if goto
10666 (progn
10667 (org-pop-to-buffer-same-window nbuf)
10668 (goto-char pos)
10669 (org-show-context 'org-goto))
10670 (if regionp
10671 (progn
10672 (org-kill-new (buffer-substring region-start region-end))
10673 (org-save-markers-in-region region-start region-end))
10674 (org-copy-subtree 1 nil t))
10675 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10676 (find-file-noselect file)))
10677 (setq reversed (org-notes-order-reversed-p))
10678 (save-excursion
10679 (save-restriction
10680 (widen)
10681 (if pos
10682 (progn
10683 (goto-char pos)
10684 (looking-at org-outline-regexp)
10685 (setq level (org-get-valid-level (funcall outline-level) 1))
10686 (goto-char
10687 (if reversed
10688 (or (outline-next-heading) (point-max))
10689 (or (save-excursion (org-get-next-sibling))
10690 (org-end-of-subtree t t)
10691 (point-max)))))
10692 (setq level 1)
10693 (if (not reversed)
10694 (goto-char (point-max))
10695 (goto-char (point-min))
10696 (or (outline-next-heading) (goto-char (point-max)))))
10697 (if (not (bolp)) (newline))
10698 (org-paste-subtree level)
10699 (when org-log-refile
10700 (org-add-log-setup 'refile nil nil 'findpos
10701 org-log-refile)
10702 (unless (eq org-log-refile 'note)
10703 (save-excursion (org-add-log-note))))
10704 (and org-auto-align-tags (org-set-tags nil t))
10705 (bookmark-set "org-refile-last-stored")
10706 ;; If we are refiling for capture, make sure that the
10707 ;; last-capture pointers point here
10708 (when (org-bound-and-true-p org-refile-for-capture)
10709 (bookmark-set "org-capture-last-stored-marker")
10710 (move-marker org-capture-last-stored-marker (point)))
10711 (if (fboundp 'deactivate-mark) (deactivate-mark))
10712 (run-hooks 'org-after-refile-insert-hook))))
10713 (if regionp
10714 (delete-region (point) (+ (point) region-length))
10715 (org-cut-subtree))
10716 (when (featurep 'org-inlinetask)
10717 (org-inlinetask-remove-END-maybe))
10718 (setq org-markers-to-move nil)
10721 (defun org-refile-goto-last-stored ()
10722 "Go to the location where the last refile was stored."
10723 (interactive)
10724 (bookmark-jump "org-refile-last-stored")
10725 (message "This is the location of the last refile"))
10727 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10728 no-exclude)
10729 "Prompt the user for a refile location, using PROMPT.
10730 PROMPT should not be suffixed with a colon and a space, because
10731 this function appends the default value from
10732 `org-refile-history' automatically, if that is not empty.
10733 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10734 this is used for the GOTO interface."
10735 (let ((org-refile-targets org-refile-targets)
10736 (org-refile-use-outline-path org-refile-use-outline-path)
10737 excluded-entries)
10738 (when (and (eq major-mode 'org-mode)
10739 (not org-refile-use-cache)
10740 (not no-exclude))
10741 (org-map-tree
10742 (lambda()
10743 (setq excluded-entries
10744 (append excluded-entries (list (org-get-heading t t)))))))
10745 (setq org-refile-target-table
10746 (org-refile-get-targets default-buffer excluded-entries)))
10747 (unless org-refile-target-table
10748 (error "No refile targets"))
10749 (let* ((prompt (concat prompt
10750 (and (car org-refile-history)
10751 (concat " (default " (car org-refile-history) ")"))
10752 ": "))
10753 (cbuf (current-buffer))
10754 (partial-completion-mode nil)
10755 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10756 (cfunc (if (and org-refile-use-outline-path
10757 org-outline-path-complete-in-steps)
10758 'org-olpath-completing-read
10759 'org-icompleting-read))
10760 (extra (if org-refile-use-outline-path "/" ""))
10761 (filename (and cfn (expand-file-name cfn)))
10762 (tbl (mapcar
10763 (lambda (x)
10764 (if (and (not (member org-refile-use-outline-path
10765 '(file full-file-path)))
10766 (not (equal filename (nth 1 x))))
10767 (cons (concat (car x) extra " ("
10768 (file-name-nondirectory (nth 1 x)) ")")
10769 (cdr x))
10770 (cons (concat (car x) extra) (cdr x))))
10771 org-refile-target-table))
10772 (completion-ignore-case t)
10773 pa answ parent-target child parent old-hist)
10774 (setq old-hist org-refile-history)
10775 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10776 nil 'org-refile-history (car org-refile-history)))
10777 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10778 (org-refile-check-position pa)
10779 (if pa
10780 (progn
10781 (when (or (not org-refile-history)
10782 (not (eq old-hist org-refile-history))
10783 (not (equal (car pa) (car org-refile-history))))
10784 (setq org-refile-history
10785 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10786 org-refile-history
10787 (cdr org-refile-history))))
10788 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10789 (pop org-refile-history)))
10790 pa)
10792 (progn
10793 (setq parent (match-string 1 answ)
10794 child (match-string 2 answ))
10795 (setq parent-target (or (assoc parent tbl)
10796 (assoc (concat parent "/") tbl)))
10797 (when (and parent-target
10798 (or (eq new-nodes t)
10799 (and (eq new-nodes 'confirm)
10801 child)))))
10802 (org-refile-new-child parent-target child)))
10803 (error "Invalid target location")))))
10805 (defun org-refile-check-position (refile-pointer)
10806 "Check if the refile pointer matches the readline to which it points."
10807 (let* ((file (nth 1 refile-pointer))
10808 (re (nth 2 refile-pointer))
10809 (pos (nth 3 refile-pointer))
10810 buffer)
10811 (when (org-string-nw-p re)
10812 (setq buffer (if (markerp pos)
10813 (marker-buffer pos)
10814 (or (find-buffer-visiting file)
10815 (find-file-noselect file))))
10816 (with-current-buffer buffer
10817 (save-excursion
10818 (save-restriction
10819 (widen)
10820 (goto-char pos)
10821 (beginning-of-line 1)
10822 (unless (org-looking-at-p re)
10823 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10825 (defun org-refile-new-child (parent-target child)
10826 "Use refile target PARENT-TARGET to add new CHILD below it."
10827 (unless parent-target
10828 (error "Cannot find parent for new node"))
10829 (let ((file (nth 1 parent-target))
10830 (pos (nth 3 parent-target))
10831 level)
10832 (with-current-buffer (or (find-buffer-visiting file)
10833 (find-file-noselect file))
10834 (save-excursion
10835 (save-restriction
10836 (widen)
10837 (if pos
10838 (goto-char pos)
10839 (goto-char (point-max))
10840 (if (not (bolp)) (newline)))
10841 (when (looking-at org-outline-regexp)
10842 (setq level (funcall outline-level))
10843 (org-end-of-subtree t t))
10844 (org-back-over-empty-lines)
10846 (if pos (org-get-valid-level level 1) 1) ?*)
10848 (beginning-of-line 0)
10849 (list (concat (car parent-target) "/" child) file "" (point)))))))
10851 (defun org-olpath-completing-read (prompt collection &rest args)
10852 "Read an outline path like a file name."
10853 (let ((thetable collection)
10854 (org-completion-use-ido nil) ; does not work with ido.
10855 (org-completion-use-iswitchb nil)) ; or iswitchb
10856 (apply
10857 'org-icompleting-read prompt
10858 (lambda (string predicate &optional flag)
10859 (let (rtn r f (l (length string)))
10860 (cond
10861 ((eq flag nil)
10862 ;; try completion
10863 (try-completion string thetable))
10864 ((eq flag t)
10865 ;; all-completions
10866 (setq rtn (all-completions string thetable predicate))
10867 (mapcar
10868 (lambda (x)
10869 (setq r (substring x l))
10870 (if (string-match " ([^)]*)$" x)
10871 (setq f (match-string 0 x))
10872 (setq f ""))
10873 (if (string-match "/" r)
10874 (concat string (substring r 0 (match-end 0)) f)
10875 x))
10876 rtn))
10877 ((eq flag 'lambda)
10878 ;; exact match?
10879 (assoc string thetable)))
10880 ))
10881 args)))
10883 ;;;; Dynamic blocks
10885 (defun org-find-dblock (name)
10886 "Find the first dynamic block with name NAME in the buffer.
10887 If not found, stay at current position and return nil."
10888 (let (pos)
10889 (save-excursion
10890 (goto-char (point-min))
10892 nil t)
10893 (match-beginning 0))))
10894 (if pos (goto-char pos))
10895 pos))
10897 (defconst org-dblock-start-re
10899 "Matches the start line of a dynamic block, with parameters.")
10902 "Matches the end of a dynamic block.")
10904 (defun org-create-dblock (plist)
10905 "Create a dynamic block section, with parameters taken from PLIST.
10906 PLIST must contain a :name entry which is used as name of the block."
10908 (end-of-line 1)
10909 (newline))
10910 (let ((col (current-column))
10911 (name (plist-get plist :name)))
10912 (insert "#+BEGIN: " name)
10913 (while plist
10914 (if (eq (car plist) :name)
10915 (setq plist (cddr plist))
10916 (insert " " (prin1-to-string (pop plist)))))
10918 (beginning-of-line -2)))
10920 (defun org-prepare-dblock ()
10921 "Prepare dynamic block for refresh.
10922 This empties the block, puts the cursor at the insert position and returns
10923 the property list including an extra property :name with the block name."
10924 (unless (looking-at org-dblock-start-re)
10925 (error "Not at a dynamic block"))
10926 (let* ((begdel (1+ (match-end 0)))
10927 (name (org-no-properties (match-string 1)))
10928 (params (append (list :name name)
10929 (read (concat "(" (match-string 3) ")")))))
10930 (save-excursion
10931 (beginning-of-line 1)
10933 (setq params (plist-put params :indentation-column (current-column))))
10934 (unless (re-search-forward org-dblock-end-re nil t)
10935 (error "Dynamic block not terminated"))
10936 (setq params
10937 (append params
10938 (list :content (buffer-substring
10939 begdel (match-beginning 0)))))
10940 (delete-region begdel (match-beginning 0))
10941 (goto-char begdel)
10942 (open-line 1)
10943 params))
10945 (defun org-map-dblocks (&optional command)
10946 "Apply COMMAND to all dynamic blocks in the current buffer.
10947 If COMMAND is not given, use `org-update-dblock'."
10948 (let ((cmd (or command 'org-update-dblock)))
10949 (save-excursion
10950 (goto-char (point-min))
10951 (while (re-search-forward org-dblock-start-re nil t)
10952 (goto-char (match-beginning 0))
10953 (save-excursion
10954 (condition-case nil
10955 (funcall cmd)
10956 (error (message "Error during update of dynamic block"))))
10957 (unless (re-search-forward org-dblock-end-re nil t)
10958 (error "Dynamic block not terminated"))))))
10960 (defun org-dblock-update (&optional arg)
10961 "User command for updating dynamic blocks.
10962 Update the dynamic block at point. With prefix ARG, update all dynamic
10963 blocks in the buffer."
10964 (interactive "P")
10965 (if arg
10966 (org-update-all-dblocks)
10967 (or (looking-at org-dblock-start-re)
10968 (org-beginning-of-dblock))
10969 (org-update-dblock)))
10971 (defun org-update-dblock ()
10972 "Update the dynamic block at point.
10973 This means to empty the block, parse for parameters and then call
10974 the correct writing function."
10975 (interactive)
10976 (save-window-excursion
10977 (let* ((pos (point))
10978 (line (org-current-line))
10979 (params (org-prepare-dblock))
10980 (name (plist-get params :name))
10981 (indent (plist-get params :indentation-column))
10982 (cmd (intern (concat "org-dblock-write:" name))))
10983 (message "Updating dynamic block `%s' at line %d..." name line)
10984 (funcall cmd params)
10985 (message "Updating dynamic block `%s' at line %d...done" name line)
10986 (goto-char pos)
10987 (when (and indent (> indent 0))
10988 (setq indent (make-string indent ?\ ))
10989 (save-excursion
10990 (org-beginning-of-dblock)
10991 (forward-line 1)
10992 (while (not (looking-at org-dblock-end-re))
10993 (insert indent)
10994 (beginning-of-line 2))
10995 (when (looking-at org-dblock-end-re)
10997 (replace-match ""))
10998 (insert indent)))))))
11000 (defun org-beginning-of-dblock ()
11001 "Find the beginning of the dynamic block at point.
11002 Error if there is no such block at point."
11003 (let ((pos (point))
11004 beg)
11005 (end-of-line 1)
11006 (if (and (re-search-backward org-dblock-start-re nil t)
11007 (setq beg (match-beginning 0))
11008 (re-search-forward org-dblock-end-re nil t)
11009 (> (match-end 0) pos))
11010 (goto-char beg)
11011 (goto-char pos)
11012 (error "Not in a dynamic block"))))
11014 (defun org-update-all-dblocks ()
11015 "Update all dynamic blocks in the buffer.
11016 This function can be used in a hook."
11017 (interactive)
11018 (when (eq major-mode 'org-mode)
11019 (org-map-dblocks 'org-update-dblock)))
11022 ;;;; Completion
11024 (defconst org-additional-option-like-keywords
11025 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11026 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11027 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11028 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11029 "BEGIN:" "END:"
11030 "ORGTBL" "TBLFM:" "TBLNAME:"
11031 "BEGIN_EXAMPLE" "END_EXAMPLE"
11032 "BEGIN_QUOTE" "END_QUOTE"
11033 "BEGIN_VERSE" "END_VERSE"
11034 "BEGIN_CENTER" "END_CENTER"
11035 "BEGIN_SRC" "END_SRC"
11036 "BEGIN_RESULT" "END_RESULT"
11037 "NAME:" "RESULTS:"
11038 "HEADER:" "HEADERS:"
11039 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11040 "CAPTION:" "LABEL:"
11041 "SETUPFILE:"
11042 "INCLUDE:"
11043 "BIND:"
11044 "MACRO:"))
11046 (defcustom org-structure-template-alist
11047 '(
11060 ("L" "#+latex: "
11064 ("H" "#+html: "
11067 ("A" "#+ascii: ")
11068 ("i" "#+index: ?"
11069 "#+index: ?")
11070 ("I" "#+include %file ?"
11072 )
11073 "Structure completion elements.
11074 This is a list of abbreviation keys and values. The value gets inserted
11075 if you type `<' followed by the key and then press the completion key,
11076 usually `M-TAB'. %file will be replaced by a file name after prompting
11077 for the file using completion. The cursor will be placed at the position
11078 of the `?` in the template.
11079 There are two templates for each key, the first uses the original Org syntax,
11080 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11081 the default when the /org-mtags.el/ module has been loaded. See also the
11082 variable `org-mtags-prefer-muse-templates'.
11083 This is an experimental feature, it is undecided if it is going to stay in."
11084 :group 'org-completion
11085 :type '(repeat
11086 (string :tag "Key")
11087 (string :tag "Template")
11088 (string :tag "Muse Template")))
11090 (defun org-try-structure-completion ()
11091 "Try to complete a structure template before point.
11093 expands them."
11094 (let ((l (buffer-substring (point-at-bol) (point)))
11095 a)
11098 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11099 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11100 (match-beginning 1)) a)
11101 t)))
11103 (defun org-complete-expand-structure-template (start cell)
11104 "Expand a structure template."
11105 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11106 (rpl (nth (if musep 2 1) cell))
11107 (ind ""))
11108 (delete-region start (point))
11110 (cond
11111 ((bolp))
11113 (setq ind (buffer-substring (point-at-bol) (point))))
11114 (t (newline))))
11115 (setq start (point))
11116 (if (string-match "%file" rpl)
11117 (setq rpl (replace-match
11118 (concat
11120 (save-match-data
11121 (abbreviate-file-name (read-file-name "Include file: ")))
11123 t t rpl)))
11126 (insert rpl)
11129 ;;;; TODO, DEADLINE, Comments
11131 (defun org-toggle-comment ()
11132 "Change the COMMENT state of an entry."
11133 (interactive)
11134 (save-excursion
11135 (org-back-to-heading)
11136 (let (case-fold-search)
11137 (cond
11138 ((looking-at (format org-heading-keyword-regexp-format
11139 org-comment-string))
11140 (goto-char (match-end 1))
11141 (looking-at (concat " +" org-comment-string))
11142 (replace-match "" t t)
11143 (when (eolp) (insert " ")))
11144 ((looking-at org-outline-regexp)
11145 (goto-char (match-end 0))
11146 (insert org-comment-string " "))))))
11148 (defvar org-last-todo-state-is-todo nil
11149 "This is non-nil when the last TODO state change led to a TODO state.
11150 If the last change removed the TODO tag or switched to DONE, then
11151 this is nil.")
11153 (defvar org-setting-tags nil) ; dynamically skipped
11155 (defvar org-todo-setup-filter-hook nil
11156 "Hook for functions that pre-filter todo specs.
11157 Each function takes a todo spec and returns either nil or the spec
11158 transformed into canonical form." )
11160 (defvar org-todo-get-default-hook nil
11161 "Hook for functions that get a default item for todo.
11162 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11163 nil or a string to be used for the todo mark." )
11165 (defvar org-agenda-headline-snapshot-before-repeat)
11167 (defun org-current-effective-time ()
11168 "Return current time adjusted for `org-extend-today-until' variable"
11169 (let* ((ct (org-current-time))
11170 (dct (decode-time ct))
11171 (ct1
11172 (if (and org-use-effective-time
11173 (< (nth 2 dct) org-extend-today-until))
11174 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11175 ct)))
11176 ct1))
11178 (defun org-todo-yesterday (&optional arg)
11179 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11180 (interactive "P")
11181 (if (eq major-mode 'org-agenda-mode)
11182 (apply 'org-agenda-todo-yesterday arg)
11183 (let* ((hour (third (decode-time
11184 (org-current-time))))
11185 (org-extend-today-until (1+ hour)))
11186 (org-todo arg))))
11188 (defun org-todo (&optional arg)
11189 "Change the TODO state of an item.
11190 The state of an item is given by a keyword at the start of the heading,
11191 like
11192 *** TODO Write paper
11193 *** DONE Call mom
11195 The different keywords are specified in the variable `org-todo-keywords'.
11197 So for this example: when the item starts with TODO, it is changed to DONE.
11198 When it starts with DONE, the DONE is removed. And when neither TODO nor
11199 DONE are present, add TODO at the beginning of the heading.
11202 state.
11203 With numeric prefix arg, switch to that state.
11205 keywords (nextset).
11207 With a numeric prefix arg of 0, inhibit note taking for the change.
11209 For calling through lisp, arg is also interpreted in the following way:
11210 'none -> empty state
11212 'done -> switch to DONE
11213 'nextset -> switch to the next set of keywords
11214 'previousset -> switch to the previous set of keywords
11216 really is a member of `org-todo-keywords'."
11217 (interactive "P")
11218 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11219 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11220 'region-start-level 'region))
11221 org-loop-over-headlines-in-active-region)
11222 (org-map-entries
11223 `(org-todo ,arg)
11224 org-loop-over-headlines-in-active-region
11225 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11226 (if (equal arg '(16)) (setq arg 'nextset))
11227 (let ((org-blocker-hook org-blocker-hook)
11228 (case-fold-search nil))
11229 (when (equal arg '(64))
11230 (setq arg nil org-blocker-hook nil))
11231 (when (and org-blocker-hook
11232 (or org-inhibit-blocking
11233 (org-entry-get nil "NOBLOCKING")))
11234 (setq org-blocker-hook nil))
11235 (save-excursion
11236 (catch 'exit
11237 (org-back-to-heading t)
11238 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11241 (let* ((match-data (match-data))
11242 (startpos (point-at-bol))
11243 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11244 (org-log-done org-log-done)
11245 (org-log-repeat org-log-repeat)
11246 (org-todo-log-states org-todo-log-states)
11247 (org-inhibit-logging
11248 (if (equal arg 0)
11249 (progn (setq arg nil) 'note) org-inhibit-logging))
11250 (this (match-string 1))
11251 (hl-pos (match-beginning 0))
11252 (head (org-get-todo-sequence-head this))
11253 (ass (assoc head org-todo-kwd-alist))
11254 (interpret (nth 1 ass))
11255 (done-word (nth 3 ass))
11256 (final-done-word (nth 4 ass))
11257 (last-state (or this ""))
11258 (completion-ignore-case t)
11259 (member (member this org-todo-keywords-1))
11260 (tail (cdr member))
11261 (state (cond
11262 ((and org-todo-key-trigger
11263 (or (and (equal arg '(4))
11264 (eq org-use-fast-todo-selection 'prefix))
11265 (and (not arg) org-use-fast-todo-selection
11266 (not (eq org-use-fast-todo-selection
11267 'prefix)))))
11268 ;; Use fast selection
11269 (org-fast-todo-selection))
11270 ((and (equal arg '(4))
11271 (or (not org-use-fast-todo-selection)
11272 (not org-todo-key-trigger)))
11273 ;; Read a state with completion
11274 (org-icompleting-read
11275 "State: " (mapcar (lambda(x) (list x))
11276 org-todo-keywords-1)
11277 nil t))
11278 ((eq arg 'right)
11279 (if this
11280 (if tail (car tail) nil)
11281 (car org-todo-keywords-1)))
11282 ((eq arg 'left)
11283 (if (equal member org-todo-keywords-1)
11284 nil
11285 (if this
11286 (nth (- (length org-todo-keywords-1)
11287 (length tail) 2)
11288 org-todo-keywords-1)
11289 (org-last org-todo-keywords-1))))
11290 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11291 (setq arg nil))) ; hack to fall back to cycling
11292 (arg
11293 ;; user or caller requests a specific state
11294 (cond
11295 ((equal arg "") nil)
11296 ((eq arg 'none) nil)
11297 ((eq arg 'done) (or done-word (car org-done-keywords)))
11298 ((eq arg 'nextset)
11299 (or (car (cdr (member head org-todo-heads)))
11300 (car org-todo-heads)))
11301 ((eq arg 'previousset)
11302 (let ((org-todo-heads (reverse org-todo-heads)))
11303 (or (car (cdr (member head org-todo-heads)))
11304 (car org-todo-heads))))
11305 ((car (member arg org-todo-keywords-1)))
11306 ((stringp arg)
11307 (error "State `%s' not valid in this file" arg))
11308 ((nth (1- (prefix-numeric-value arg))
11309 org-todo-keywords-1))))
11310 ((null member) (or head (car org-todo-keywords-1)))
11311 ((equal this final-done-word) nil) ;; -> make empty
11312 ((null tail) nil) ;; -> first entry
11313 ((memq interpret '(type priority))
11314 (if (eq this-command last-command)
11315 (car tail)
11316 (if (> (length tail) 0)
11317 (or done-word (car org-done-keywords))
11318 nil)))
11319 (t
11320 (car tail))))
11321 (state (or
11322 (run-hook-with-args-until-success
11323 'org-todo-get-default-hook state last-state)
11324 state))
11325 (next (if state (concat " " state " ") " "))
11326 (change-plist (list :type 'todo-state-change :from this :to state
11327 :position startpos))
11328 dolog now-done-p)
11329 (when org-blocker-hook
11330 (setq org-last-todo-state-is-todo
11331 (not (member this org-done-keywords)))
11332 (unless (save-excursion
11333 (save-match-data
11334 (org-with-wide-buffer
11335 (run-hook-with-args-until-failure
11336 'org-blocker-hook change-plist))))
11337 (if (org-called-interactively-p 'interactive)
11338 (error "TODO state change from %s to %s blocked" this state)
11339 ;; fail silently
11340 (message "TODO state change from %s to %s blocked" this state)
11341 (throw 'exit nil))))
11342 (store-match-data match-data)
11343 (replace-match next t t)
11344 (unless (pos-visible-in-window-p hl-pos)
11345 (message "TODO state changed to %s" (org-trim next)))
11346 (unless head
11347 (setq head (org-get-todo-sequence-head state)
11348 ass (assoc head org-todo-kwd-alist)
11349 interpret (nth 1 ass)
11350 done-word (nth 3 ass)
11351 final-done-word (nth 4 ass)))
11352 (when (memq arg '(nextset previousset))
11353 (message "Keyword-Set %d/%d: %s"
11354 (- (length org-todo-sets) -1
11355 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11356 (length org-todo-sets)
11357 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11358 (setq org-last-todo-state-is-todo
11359 (not (member state org-done-keywords)))
11360 (setq now-done-p (and (member state org-done-keywords)
11361 (not (member this org-done-keywords))))
11362 (and logging (org-local-logging logging))
11363 (when (and (or org-todo-log-states org-log-done)
11364 (not (eq org-inhibit-logging t))
11365 (not (memq arg '(nextset previousset))))
11366 ;; we need to look at recording a time and note
11367 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11368 (nth 2 (assoc this org-todo-log-states))))
11369 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11370 (setq dolog 'time))
11371 (when (and state
11372 (member state org-not-done-keywords)
11373 (not (member this org-not-done-keywords)))
11374 ;; This is now a todo state and was not one before
11375 ;; If there was a CLOSED time stamp, get rid of it.
11376 (org-add-planning-info nil nil 'closed))
11377 (when (and now-done-p org-log-done)
11378 ;; It is now done, and it was not done before
11379 (org-add-planning-info 'closed (org-current-effective-time))
11380 (if (and (not dolog) (eq 'note org-log-done))
11381 (org-add-log-setup 'done state this 'findpos 'note)))
11382 (when (and state dolog)
11383 ;; This is a non-nil state, and we need to log it
11384 (org-add-log-setup 'state state this 'findpos dolog)))
11385 ;; Fixup tag positioning
11386 (org-todo-trigger-tag-changes state)
11387 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11388 (when org-provide-todo-statistics
11389 (org-update-parent-todo-statistics))
11390 (run-hooks 'org-after-todo-state-change-hook)
11391 (if (and arg (not (member state org-done-keywords)))
11392 (setq head (org-get-todo-sequence-head state)))
11393 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11394 ;; Do we need to trigger a repeat?
11395 (when now-done-p
11396 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11397 ;; This is for the agenda, take a snapshot of the headline.
11398 (save-match-data
11399 (setq org-agenda-headline-snapshot-before-repeat
11400 (org-get-heading))))
11401 (org-auto-repeat-maybe state))
11402 ;; Fixup cursor location if close to the keyword
11403 (if (and (outline-on-heading-p)
11404 (not (bolp))
11405 (save-excursion (beginning-of-line 1)
11406 (looking-at org-todo-line-regexp))
11407 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11408 (progn
11409 (goto-char (or (match-end 2) (match-end 1)))
11410 (and (looking-at " ") (just-one-space))))
11411 (when org-trigger-hook
11412 (save-excursion
11413 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11415 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11416 "Block turning an entry into a TODO, using the hierarchy.
11417 This checks whether the current task should be blocked from state
11418 changes. Such blocking occurs when:
11420 1. The task has children which are not all in a completed state.
11422 2. A task has a parent with the property :ORDERED:, and there
11423 are siblings prior to the current task with incomplete
11424 status.
11426 3. The parent of the task is blocked because it has siblings that should
11427 be done first, or is child of a block grandparent TODO entry."
11429 (if (not org-enforce-todo-dependencies)
11430 t ; if locally turned off don't block
11431 (catch 'dont-block
11432 ;; If this is not a todo state change, or if this entry is already DONE,
11433 ;; do not block
11434 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11435 (member (plist-get change-plist :from)
11436 (cons 'done org-done-keywords))
11437 (member (plist-get change-plist :to)
11438 (cons 'todo org-not-done-keywords))
11439 (not (plist-get change-plist :to)))
11440 (throw 'dont-block t))
11441 ;; If this task has children, and any are undone, it's blocked
11442 (save-excursion
11443 (org-back-to-heading t)
11444 (let ((this-level (funcall outline-level)))
11445 (outline-next-heading)
11446 (let ((child-level (funcall outline-level)))
11447 (while (and (not (eobp))
11448 (> child-level this-level))
11449 ;; this todo has children, check whether they are all
11450 ;; completed
11451 (if (and (not (org-entry-is-done-p))
11452 (org-entry-is-todo-p))
11453 (throw 'dont-block nil))
11454 (outline-next-heading)
11455 (setq child-level (funcall outline-level))))))
11456 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11457 ;; any previous siblings are undone, it's blocked
11458 (save-excursion
11459 (org-back-to-heading t)
11460 (let* ((pos (point))
11461 (parent-pos (and (org-up-heading-safe) (point))))
11462 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11463 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11464 (forward-line 1)
11465 (re-search-forward org-not-done-heading-regexp pos t))
11466 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11467 ;; Search further up the hierarchy, to see if an ancestor is blocked
11468 (while t
11469 (goto-char parent-pos)
11470 (if (not (looking-at org-not-done-heading-regexp))
11471 (throw 'dont-block t)) ; do not block, parent is not a TODO
11472 (setq pos (point))
11473 (setq parent-pos (and (org-up-heading-safe) (point)))
11474 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11475 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11476 (forward-line 1)
11477 (re-search-forward org-not-done-heading-regexp pos t))
11478 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11480 (defcustom org-track-ordered-property-with-tag nil
11481 "Should the ORDERED property also be shown as a tag?
11482 The ORDERED property decides if an entry should require subtasks to be
11483 completed in sequence. Since a property is not very visible, setting
11484 this option means that toggling the ORDERED property with the command
11485 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11486 not relevant for the behavior, but it makes things more visible.
11488 Note that toggling the tag with tags commands will not change the property
11489 and therefore not influence behavior!
11491 This can be t, meaning the tag ORDERED should be used, It can also be a
11492 string to select a different tag for this task."
11493 :group 'org-todo
11494 :type '(choice
11495 (const :tag "No tracking" nil)
11496 (const :tag "Track with ORDERED tag" t)
11497 (string :tag "Use other tag")))
11499 (defun org-toggle-ordered-property ()
11500 "Toggle the ORDERED property of the current entry.
11501 For better visibility, you can track the value of this property with a tag.
11502 See variable `org-track-ordered-property-with-tag'."
11503 (interactive)
11504 (let* ((t1 org-track-ordered-property-with-tag)
11505 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11506 (save-excursion
11507 (org-back-to-heading)
11508 (if (org-entry-get nil "ORDERED")
11509 (progn
11510 (org-delete-property "ORDERED")
11511 (and tag (org-toggle-tag tag 'off))
11512 (message "Subtasks can be completed in arbitrary order"))
11513 (org-entry-put nil "ORDERED" "t")
11514 (and tag (org-toggle-tag tag 'on))
11515 (message "Subtasks must be completed in sequence")))))
11517 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11518 (defun org-block-todo-from-checkboxes (change-plist)
11519 "Block turning an entry into a TODO, using checkboxes.
11520 This checks whether the current task should be blocked from state
11521 changes because there are unchecked boxes in this entry."
11522 (if (not org-enforce-todo-checkbox-dependencies)
11523 t ; if locally turned off don't block
11524 (catch 'dont-block
11525 ;; If this is not a todo state change, or if this entry is already DONE,
11526 ;; do not block
11527 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11528 (member (plist-get change-plist :from)
11529 (cons 'done org-done-keywords))
11530 (member (plist-get change-plist :to)
11531 (cons 'todo org-not-done-keywords))
11532 (not (plist-get change-plist :to)))
11533 (throw 'dont-block t))
11534 ;; If this task has checkboxes that are not checked, it's blocked
11535 (save-excursion
11536 (org-back-to-heading t)
11537 (let ((beg (point)) end)
11538 (outline-next-heading)
11539 (setq end (point))
11540 (goto-char beg)
11541 (if (org-list-search-forward
11542 (concat (org-item-beginning-re)
11545 end t)
11546 (progn
11547 (if (boundp 'org-blocked-by-checkboxes)
11548 (setq org-blocked-by-checkboxes t))
11549 (throw 'dont-block nil)))))
11550 t))) ; do not block
11552 (defun org-entry-blocked-p ()
11553 "Is the current entry blocked?"
11554 (if (org-entry-get nil "NOBLOCKING")
11555 nil ;; Never block this entry
11556 (not
11557 (run-hook-with-args-until-failure
11558 'org-blocker-hook
11559 (list :type 'todo-state-change
11560 :position (point)
11561 :from 'todo
11562 :to 'done)))))
11564 (defun org-update-statistics-cookies (all)
11565 "Update the statistics cookie, either from TODO or from checkboxes.
11566 This should be called with the cursor in a line with a statistics cookie."
11567 (interactive "P")
11568 (if all
11569 (progn
11570 (org-update-checkbox-count 'all)
11571 (org-map-entries 'org-update-parent-todo-statistics))
11572 (if (not (org-at-heading-p))
11573 (org-update-checkbox-count)
11574 (let ((pos (move-marker (make-marker) (point)))
11575 end l1 l2)
11576 (ignore-errors (org-back-to-heading t))
11577 (if (not (org-at-heading-p))
11578 (org-update-checkbox-count)
11579 (setq l1 (org-outline-level))
11580 (setq end (save-excursion
11581 (outline-next-heading)
11582 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11583 (point)))
11584 (if (and (save-excursion
11585 (re-search-forward
11587 (not (save-excursion (re-search-forward
11589 (org-update-checkbox-count)
11590 (if (and l2 (> l2 l1))
11591 (progn
11592 (goto-char end)
11593 (org-update-parent-todo-statistics))
11594 (goto-char pos)
11595 (beginning-of-line 1)
11596 (while (re-search-forward
11598 (point-at-eol) t)
11599 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11600 (goto-char pos)
11601 (move-marker pos nil)))))
11603 (defvar org-entry-property-inherited-from) ;; defined below
11604 (defun org-update-parent-todo-statistics ()
11605 "Update any statistics cookie in the parent of the current headline.
11606 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11607 the entire subtree and this will travel up the hierarchy and update
11608 statistics everywhere."
11609 (let* ((prop (save-excursion (org-up-heading-safe)
11610 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11611 (recursive (or (not org-hierarchical-todo-statistics)
11613 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11614 0))
11615 (first t)
11617 level ltoggle l1 new ndel
11618 (cnt-all 0) (cnt-done 0) is-percent kwd
11619 checkbox-beg ov ovs ove cookie-present)
11620 (catch 'exit
11621 (save-excursion
11622 (beginning-of-line 1)
11623 (setq ltoggle (funcall outline-level))
11624 ;; Three situations are to consider:
11626 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11627 ;; to the top-level ancestor on the headline;
11629 ;; 2. If parent has "recursive" property, repeat up to the
11630 ;; headline setting that property, taking inheritance into
11631 ;; account;
11633 ;; 3. Else, move up to direct parent and proceed only once.
11634 (while (and (setq level (org-up-heading-safe))
11635 (or recursive first)
11636 (>= (point) lim))
11637 (setq first nil cookie-present nil)
11638 (unless (and level
11639 (not (string-match
11641 (downcase (or (org-entry-get nil "COOKIE_DATA")
11642 "")))))
11643 (throw 'exit nil))
11644 (while (re-search-forward box-re (point-at-eol) t)
11645 (setq cnt-all 0 cnt-done 0 cookie-present t)
11646 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11647 (save-match-data
11648 (unless (outline-next-heading) (throw 'exit nil))
11649 (while (and (looking-at org-complex-heading-regexp)
11650 (> (setq l1 (length (match-string 1))) level))
11651 (setq kwd (and (or recursive (= l1 ltoggle))
11652 (match-string 2)))
11653 (if (or (eq org-provide-todo-statistics 'all-headlines)
11654 (and (listp org-provide-todo-statistics)
11655 (or (member kwd org-provide-todo-statistics)
11656 (member kwd org-done-keywords))))
11657 (setq cnt-all (1+ cnt-all))
11658 (if (eq org-provide-todo-statistics t)
11659 (and kwd (setq cnt-all (1+ cnt-all)))))
11660 (and (member kwd org-done-keywords)
11661 (setq cnt-done (1+ cnt-done)))
11662 (outline-next-heading)))
11663 (setq new
11664 (if is-percent
11665 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11666 (format "[%d/%d]" cnt-done cnt-all))
11667 ndel (- (match-end 0) checkbox-beg))
11668 ;; handle overlays when updating cookie from column view
11669 (when (setq ov (car (overlays-at checkbox-beg)))
11670 (setq ovs (overlay-start ov) ove (overlay-end ov))
11671 (delete-overlay ov))
11672 (goto-char checkbox-beg)
11673 (insert new)
11674 (delete-region (point) (+ (point) ndel))
11675 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11676 (when ov (move-overlay ov ovs ove)))
11677 (when cookie-present
11678 (run-hook-with-args 'org-after-todo-statistics-hook
11679 cnt-done (- cnt-all cnt-done))))))
11680 (run-hooks 'org-todo-statistics-hook)))
11682 (defvar org-after-todo-statistics-hook nil
11683 "Hook that is called after a TODO statistics cookie has been updated.
11684 Each function is called with two arguments: the number of not-done entries
11685 and the number of done entries.
11687 For example, the following function, when added to this hook, will switch
11688 an entry to DONE when all children are done, and back to TODO when new
11689 entries are set to a TODO status. Note that this hook is only called
11690 when there is a statistics cookie in the headline!
11692 (defun org-summary-todo (n-done n-not-done)
11694 (let (org-log-done org-log-states) ; turn off logging
11696 ")
11698 (defvar org-todo-statistics-hook nil
11699 "Hook that is run whenever Org thinks TODO statistics should be updated.
11700 This hook runs even if there is no statistics cookie present, in which case
11701 `org-after-todo-statistics-hook' would not run.")
11703 (defun org-todo-trigger-tag-changes (state)
11704 "Apply the changes defined in `org-todo-state-tags-triggers'."
11705 (let ((l org-todo-state-tags-triggers)
11706 changes)
11707 (when (or (not state) (equal state ""))
11708 (setq changes (append changes (cdr (assoc "" l)))))
11709 (when (and (stringp state) (> (length state) 0))
11710 (setq changes (append changes (cdr (assoc state l)))))
11711 (when (member state org-not-done-keywords)
11712 (setq changes (append changes (cdr (assoc 'todo l)))))
11713 (when (member state org-done-keywords)
11714 (setq changes (append changes (cdr (assoc 'done l)))))
11715 (dolist (c changes)
11716 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11718 (defun org-local-logging (value)
11719 "Get logging settings from a property VALUE."
11720 (let* (words w a)
11721 ;; directly set the variables, they are already local.
11722 (setq org-log-done nil
11723 org-log-repeat nil
11724 org-todo-log-states nil)
11725 (setq words (org-split-string value))
11726 (while (setq w (pop words))
11727 (cond
11728 ((setq a (assoc w org-startup-options))
11729 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11730 (set (nth 1 a) (nth 2 a))))
11731 ((setq a (org-extract-log-state-settings w))
11732 (and (member (car a) org-todo-keywords-1)
11733 (push a org-todo-log-states)))))))
11735 (defun org-get-todo-sequence-head (kwd)
11736 "Return the head of the TODO sequence to which KWD belongs.
11737 If KWD is not set, check if there is a text property remembering the
11738 right sequence."
11739 (let (p)
11740 (cond
11741 ((not kwd)
11742 (or (get-text-property (point-at-bol) 'org-todo-head)
11743 (progn
11744 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11745 nil (point-at-eol)))
11746 (get-text-property p 'org-todo-head))))
11747 ((not (member kwd org-todo-keywords-1))
11748 (car org-todo-keywords-1))
11749 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11751 (defun org-fast-todo-selection ()
11752 "Fast TODO keyword selection with single keys.
11753 Returns the new TODO keyword, or nil if no state change should occur."
11754 (let* ((fulltable org-todo-key-alist)
11755 (done-keywords org-done-keywords) ;; needed for the faces.
11756 (maxlen (apply 'max (mapcar
11757 (lambda (x)
11758 (if (stringp (car x)) (string-width (car x)) 0))
11759 fulltable)))
11760 (expert nil)
11761 (fwidth (+ maxlen 3 1 3))
11762 (ncol (/ (- (window-width) 4) fwidth))
11763 tg cnt e c tbl
11764 groups ingroup)
11765 (save-excursion
11766 (save-window-excursion
11767 (if expert
11768 (set-buffer (get-buffer-create " *Org todo*"))
11769 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11770 (erase-buffer)
11771 (org-set-local 'org-done-keywords done-keywords)
11772 (setq tbl fulltable cnt 0)
11773 (while (setq e (pop tbl))
11774 (cond
11775 ((equal e '(:startgroup))
11776 (push '() groups) (setq ingroup t)
11777 (when (not (= cnt 0))
11778 (setq cnt 0)
11780 (insert "{ "))
11781 ((equal e '(:endgroup))
11782 (setq ingroup nil cnt 0)
11784 ((equal e '(:newline))
11785 (when (not (= cnt 0))
11786 (setq cnt 0)
11788 (setq e (car tbl))
11789 (while (equal (car tbl) '(:newline))
11791 (setq tbl (cdr tbl)))))
11792 (t
11793 (setq tg (car e) c (cdr e))
11794 (if ingroup (push tg (car groups)))
11795 (setq tg (org-add-props tg nil 'face
11796 (org-get-todo-face tg)))
11797 (if (and (= cnt 0) (not ingroup)) (insert " "))
11798 (insert "[" c "] " tg (make-string
11799 (- fwidth 4 (length tg)) ?\ ))
11800 (when (= (setq cnt (1+ cnt)) ncol)
11802 (if ingroup (insert " "))
11803 (setq cnt 0)))))
11805 (goto-char (point-min))
11806 (if (not expert) (org-fit-window-to-buffer))
11807 (message "[a-z..]:Set [SPC]:clear")
11808 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11809 (cond
11810 ((or (= c ?\C-g)
11811 (and (= c ?q) (not (rassoc c fulltable))))
11812 (setq quit-flag t))
11813 ((= c ?\ ) nil)
11814 ((setq e (rassoc c fulltable) tg (car e))
11815 tg)
11816 (t (setq quit-flag t)))))))
11818 (defun org-entry-is-todo-p ()
11819 (member (org-get-todo-state) org-not-done-keywords))
11821 (defun org-entry-is-done-p ()
11822 (member (org-get-todo-state) org-done-keywords))
11824 (defun org-get-todo-state ()
11825 (save-excursion
11826 (org-back-to-heading t)
11827 (and (looking-at org-todo-line-regexp)
11828 (match-end 2)
11829 (match-string 2))))
11831 (defun org-at-date-range-p (&optional inactive-ok)
11832 "Is the cursor inside a date range?"
11833 (interactive)
11834 (save-excursion
11835 (catch 'exit
11836 (let ((pos (point)))
11838 (skip-chars-backward "<[")
11839 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11840 (>= (match-end 0) pos)
11841 (throw 'exit t))
11843 (skip-chars-backward "<[")
11844 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11845 (>= (match-end 0) pos)
11846 (throw 'exit t)))
11847 nil)))
11849 (defun org-get-repeat (&optional tagline)
11850 "Check if there is a deadline/schedule with repeater in this entry."
11851 (save-match-data
11852 (save-excursion
11853 (org-back-to-heading t)
11854 (and (re-search-forward (if tagline
11856 org-repeat-re)
11857 (org-entry-end-position) t)
11858 (match-string-no-properties 1)))))
11860 (defvar org-last-changed-timestamp)
11861 (defvar org-last-inserted-timestamp)
11862 (defvar org-log-post-message)
11863 (defvar org-log-note-purpose)
11864 (defvar org-log-note-how)
11865 (defvar org-log-note-extra)
11866 (defun org-auto-repeat-maybe (done-word)
11867 "Check if the current headline contains a repeated deadline/schedule.
11868 If yes, set TODO state back to what it was and change the base date
11869 of repeating deadline/scheduled time stamps to new date.
11870 This function is run automatically after each state change to a DONE state."
11871 ;; last-state is dynamically scoped into this function
11872 (let* ((repeat (org-get-repeat))
11873 (aa (assoc last-state org-todo-kwd-alist))
11874 (interpret (nth 1 aa))
11875 (head (nth 2 aa))
11876 (whata '(("d" . day) ("m" . month) ("y" . year)))
11877 (msg "Entry repeats: ")
11878 (org-log-done nil)
11879 (org-todo-log-states nil)
11880 re type n what ts time to-state)
11881 (when repeat
11882 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11883 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11884 org-todo-repeat-to-state))
11885 (unless (and to-state (member to-state org-todo-keywords-1))
11886 (setq to-state (if (eq interpret 'type) last-state head)))
11887 (org-todo to-state)
11888 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11889 (org-entry-put nil "LAST_REPEAT" (format-time-string
11890 (org-time-stamp-format t t))))
11891 (when org-log-repeat
11892 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11893 (memq 'org-add-log-note post-command-hook))
11894 ;; OK, we are already setup for some record
11895 (if (eq org-log-repeat 'note)
11896 ;; make sure we take a note, not only a time stamp
11897 (setq org-log-note-how 'note))
11898 ;; Set up for taking a record
11899 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11900 last-state
11901 'findpos org-log-repeat)))
11902 (org-back-to-heading t)
11903 (org-add-planning-info nil nil 'closed)
11907 (while (re-search-forward
11908 re (save-excursion (outline-next-heading) (point)) t)
11909 (setq type (if (match-end 1) org-scheduled-string
11910 (if (match-end 3) org-deadline-string "Plain:"))
11911 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11913 (setq n (string-to-number (match-string 2 ts))
11914 what (match-string 3 ts))
11915 (if (equal what "w") (setq n (* n 7) what "d"))
11916 ;; Preparation, see if we need to modify the start date for the change
11917 (when (match-end 1)
11918 (setq time (save-match-data (org-time-string-to-time ts)))
11919 (cond
11920 ((equal (match-string 1 ts) ".")
11921 ;; Shift starting date to today
11922 (org-timestamp-change
11923 (- (org-today) (time-to-days time))
11924 'day))
11925 ((equal (match-string 1 ts) "+")
11926 (let ((nshiftmax 10) (nshift 0))
11927 (while (or (= nshift 0)
11928 (<= (time-to-days time)
11929 (time-to-days (current-time))))
11930 (when (= (incf nshift) nshiftmax)
11931 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11932 (error "Abort")))
11933 (org-timestamp-change n (cdr (assoc what whata)))
11934 (org-at-timestamp-p t)
11935 (setq ts (match-string 1))
11936 (setq time (save-match-data (org-time-string-to-time ts)))))
11937 (org-timestamp-change (- n) (cdr (assoc what whata)))
11938 ;; rematch, so that we have everything in place for the real shift
11939 (org-at-timestamp-p t)
11940 (setq ts (match-string 1))
11942 (org-timestamp-change n (cdr (assoc what whata)))
11943 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11944 (setq org-log-post-message msg)
11945 (message "%s" msg))))
11947 (defun org-show-todo-tree (arg)
11948 "Make a compact tree which shows all headlines marked with TODO.
11949 The tree will show the lines where the regexp matches, and all higher
11950 headlines above the match.
11952 With a numeric prefix N, construct a sparse tree for the Nth element
11953 of `org-todo-keywords-1'."
11954 (interactive "P")
11955 (let ((case-fold-search nil)
11956 (kwd-re
11957 (cond ((null arg) org-not-done-regexp)
11958 ((equal arg '(4))
11959 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11960 (mapcar 'list org-todo-keywords-1))))
11964 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11965 (regexp-quote (nth (1- (prefix-numeric-value arg))
11966 org-todo-keywords-1)))
11967 (t (error "Invalid prefix argument: %s" arg)))))
11968 (message "%d TODO entries found"
11969 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11971 (defun org-deadline (&optional remove time)
11973 With argument REMOVE, remove any deadline from the item.
11974 With argument TIME, set the deadline at the corresponding date. TIME
11976 (interactive "P")
11977 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11978 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11979 'region-start-level 'region))
11980 org-loop-over-headlines-in-active-region)
11981 (org-map-entries
11982 `(org-deadline ',remove ,time)
11983 org-loop-over-headlines-in-active-region
11984 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11985 (let* ((old-date (org-entry-get nil "DEADLINE"))
11986 (repeater (and old-date
11987 (string-match
11989 old-date)
11990 (match-string 1 old-date))))
11991 (if remove
11992 (progn
11993 (when (and old-date org-log-redeadline)
11994 (org-add-log-setup 'deldeadline nil old-date 'findpos
11995 org-log-redeadline))
11996 (org-remove-timestamp-with-keyword org-deadline-string)
11997 (message "Item no longer has a deadline."))
11998 (org-add-planning-info 'deadline time 'closed)
11999 (when (and old-date org-log-redeadline
12000 (not (equal old-date
12001 (substring org-last-inserted-timestamp 1 -1))))
12002 (org-add-log-setup 'redeadline nil old-date 'findpos
12003 org-log-redeadline))
12004 (when repeater
12005 (save-excursion
12006 (org-back-to-heading t)
12007 (when (re-search-forward (concat org-deadline-string " "
12008 org-last-inserted-timestamp)
12009 (save-excursion
12010 (outline-next-heading) (point)) t)
12011 (goto-char (1- (match-end 0)))
12012 (insert " " repeater)
12013 (setq org-last-inserted-timestamp
12014 (concat (substring org-last-inserted-timestamp 0 -1)
12015 " " repeater
12016 (substring org-last-inserted-timestamp -1))))))
12017 (message "Deadline on %s" org-last-inserted-timestamp)))))
12019 (defun org-schedule (&optional remove time)
12020 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12021 With argument REMOVE, remove any scheduling date from the item.
12022 With argument TIME, scheduled at the corresponding date. TIME can
12024 (interactive "P")
12025 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12026 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12027 'region-start-level 'region))
12028 org-loop-over-headlines-in-active-region)
12029 (org-map-entries
12030 `(org-schedule ',remove ,time)
12031 org-loop-over-headlines-in-active-region
12032 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12033 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12034 (repeater (and old-date
12035 (string-match
12037 old-date)
12038 (match-string 1 old-date))))
12039 (if remove
12040 (progn
12041 (when (and old-date org-log-reschedule)
12042 (org-add-log-setup 'delschedule nil old-date 'findpos
12043 org-log-reschedule))
12044 (org-remove-timestamp-with-keyword org-scheduled-string)
12045 (message "Item is no longer scheduled."))
12046 (org-add-planning-info 'scheduled time 'closed)
12047 (when (and old-date org-log-reschedule
12048 (not (equal old-date
12049 (substring org-last-inserted-timestamp 1 -1))))
12050 (org-add-log-setup 'reschedule nil old-date 'findpos
12051 org-log-reschedule))
12052 (when repeater
12053 (save-excursion
12054 (org-back-to-heading t)
12055 (when (re-search-forward (concat org-scheduled-string " "
12056 org-last-inserted-timestamp)
12057 (save-excursion
12058 (outline-next-heading) (point)) t)
12059 (goto-char (1- (match-end 0)))
12060 (insert " " repeater)
12061 (setq org-last-inserted-timestamp
12062 (concat (substring org-last-inserted-timestamp 0 -1)
12063 " " repeater
12064 (substring org-last-inserted-timestamp -1))))))
12065 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12067 (defun org-get-scheduled-time (pom &optional inherit)
12068 "Get the scheduled time as a time tuple, of a format suitable
12069 for calling org-schedule with, or if there is no scheduling,
12070 returns nil."
12071 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12072 (when time
12073 (apply 'encode-time (org-parse-time-string time)))))
12075 (defun org-get-deadline-time (pom &optional inherit)
12076 "Get the deadline as a time tuple, of a format suitable for
12077 calling org-deadline with, or if there is no scheduling, returns
12078 nil."
12079 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12080 (when time
12081 (apply 'encode-time (org-parse-time-string time)))))
12083 (defun org-remove-timestamp-with-keyword (keyword)
12084 "Remove all time stamps with KEYWORD in the current entry."
12086 beg)
12087 (save-excursion
12088 (org-back-to-heading t)
12089 (setq beg (point))
12090 (outline-next-heading)
12091 (while (re-search-backward re beg t)
12092 (replace-match "")
12094 (equal (char-before) ?\ ))
12095 (backward-delete-char 1)
12097 (point-at-bol) (point-at-eol)))
12098 (delete-region (point-at-bol)
12099 (min (point-max) (1+ (point-at-eol))))))))))
12101 (defun org-add-planning-info (what &optional time &rest remove)
12102 "Insert new timestamp with keyword in the line directly after the headline.
12103 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12104 If non is given, the user is prompted for a date.
12105 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12106 be removed."
12107 (interactive)
12108 (let (org-time-was-given org-end-time-was-given ts
12109 end default-time default-input)
12111 (catch 'exit
12112 (when (and (memq what '(scheduled deadline))
12113 (or (not time)
12114 (and (stringp time)
12115 (string-match "^[-+]+[0-9]" time))))
12116 ;; Try to get a default date/time from existing timestamp
12117 (save-excursion
12118 (org-back-to-heading t)
12119 (setq end (save-excursion (outline-next-heading) (point)))
12120 (when (re-search-forward (if (eq what 'scheduled)
12121 org-scheduled-time-regexp
12122 org-deadline-time-regexp)
12123 end t)
12124 (setq ts (match-string 1)
12125 default-time
12126 (apply 'encode-time (org-parse-time-string ts))
12127 default-input (and ts (org-get-compact-tod ts))))))
12128 (when what
12129 (setq time
12130 (if (stringp time)
12131 ;; This is a string (relative or absolute), set proper date
12132 (apply 'encode-time
12133 (org-read-date-analyze
12134 time default-time (decode-time default-time)))
12135 ;; If necessary, get the time from the user
12136 (or time (org-read-date nil 'to-time nil nil
12137 default-time default-input)))))
12139 (when (and org-insert-labeled-timestamps-at-point
12140 (member what '(scheduled deadline)))
12141 (insert
12142 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12143 (org-insert-time-stamp time org-time-was-given
12144 nil nil nil (list org-end-time-was-given))
12145 (setq what nil))
12146 (save-excursion
12147 (save-restriction
12148 (let (col list elt ts buffer-invisibility-spec)
12149 (org-back-to-heading t)
12151 (goto-char (match-end 1))
12152 (setq col (current-column))
12153 (goto-char (match-end 0))
12155 (when (and (not what)
12156 (not (looking-at
12158 org-keyword-time-not-clock-regexp))))
12159 ;; Nothing to add, nothing to remove...... :-)
12160 (throw 'exit nil))
12161 (if (and (not (looking-at org-outline-regexp))
12164 (not (equal (match-string 1) org-clock-string)))
12165 (narrow-to-region (match-beginning 0) (match-end 0))
12167 (backward-char 1)
12168 (narrow-to-region (point) (point))
12169 (and org-adapt-indentation (org-indent-to-column col)))
12170 ;; Check if we have to remove something.
12171 (setq list (cons what remove))
12172 (while list
12173 (setq elt (pop list))
12174 (when (or (and (eq elt 'scheduled)
12175 (re-search-forward org-scheduled-time-regexp nil t))
12176 (and (eq elt 'deadline)
12177 (re-search-forward org-deadline-time-regexp nil t))
12178 (and (eq elt 'closed)
12179 (re-search-forward org-closed-time-regexp nil t)))
12180 (replace-match "")
12181 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12183 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12184 (when what
12185 (insert
12186 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12187 (cond ((eq what 'scheduled) org-scheduled-string)
12188 ((eq what 'deadline) org-deadline-string)
12189 ((eq what 'closed) org-closed-string))
12190 " ")
12191 (setq ts (org-insert-time-stamp
12192 time
12193 (or org-time-was-given
12194 (and (eq what 'closed) org-log-done-with-time))
12195 (eq what 'closed)
12196 nil nil (list org-end-time-was-given)))
12197 (insert
12198 (if (not (or (bolp) (eq (char-before) ?\ )
12199 (memq (char-after) '(32 10))
12200 (eobp))) " " ""))
12201 (end-of-line 1))
12202 (goto-char (point-min))
12203 (widen)
12206 (delete-region (1- (point)) (point-at-eol)))
12207 ts))))))
12209 (defvar org-log-note-marker (make-marker))
12210 (defvar org-log-note-purpose nil)
12211 (defvar org-log-note-state nil)
12212 (defvar org-log-note-previous-state nil)
12213 (defvar org-log-note-how nil)
12214 (defvar org-log-note-extra nil)
12215 (defvar org-log-note-window-configuration nil)
12216 (defvar org-log-note-return-to (make-marker))
12217 (defvar org-log-note-effective-time nil
12218 "Remembered current time so that dynamically scoped
12219 `org-extend-today-until' affects tha timestamps in state change
12220 log")
12222 (defvar org-log-post-message nil
12223 "Message to be displayed after a log note has been stored.
12224 The auto-repeater uses this.")
12226 (defun org-add-note ()
12227 "Add a note to the current entry.
12228 This is done in the same way as adding a state change note."
12229 (interactive)
12230 (org-add-log-setup 'note nil nil 'findpos nil))
12232 (defvar org-property-end-re)
12233 (defun org-add-log-setup (&optional purpose state prev-state
12234 findpos how extra)
12235 "Set up the post command hook to take a note.
12236 If this is about to TODO state change, the new state is expected in STATE.
12237 When FINDPOS is non-nil, find the correct position for the note in
12238 the current entry. If not, assume that it can be inserted at point.
12239 HOW is an indicator what kind of note should be created.
12240 EXTRA is additional text that will be inserted into the notes buffer."
12241 (let* ((org-log-into-drawer (org-log-into-drawer))
12242 (drawer (cond ((stringp org-log-into-drawer)
12243 org-log-into-drawer)
12244 (org-log-into-drawer "LOGBOOK")
12245 (t nil))))
12246 (save-restriction
12247 (save-excursion
12248 (when findpos
12249 (org-back-to-heading t)
12250 (narrow-to-region (point) (save-excursion
12251 (outline-next-heading) (point)))
12255 (goto-char (match-end 0))
12256 (cond
12257 (drawer
12259 nil t)
12260 (progn
12261 (goto-char (match-end 0))
12262 (or org-log-states-order-reversed
12263 (and (re-search-forward org-property-end-re nil t)
12264 (goto-char (1- (match-beginning 0))))))
12266 (beginning-of-line 0)
12267 (org-indent-line-function)
12268 (beginning-of-line 2)
12269 (org-indent-line-function)
12270 (end-of-line 0)))
12271 ((and org-log-state-notes-insert-after-drawers
12272 (save-excursion
12273 (forward-line) (looking-at org-drawer-regexp)))
12274 (forward-line)
12275 (while (looking-at org-drawer-regexp)
12276 (goto-char (match-end 0))
12277 (re-search-forward org-property-end-re (point-max) t)
12278 (forward-line))
12279 (forward-line -1)))
12280 (unless org-log-states-order-reversed
12282 (org-skip-over-state-notes)
12284 (move-marker org-log-note-marker (point))
12285 (setq org-log-note-purpose purpose
12286 org-log-note-state state
12287 org-log-note-previous-state prev-state
12288 org-log-note-how how
12289 org-log-note-extra extra
12290 org-log-note-effective-time (org-current-effective-time))
12291 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12293 (defun org-skip-over-state-notes ()
12294 "Skip past the list of State notes in an entry."
12296 (when (ignore-errors (goto-char (org-in-item-p)))
12297 (let* ((struct (org-list-struct))
12298 (prevs (org-list-prevs-alist struct)))
12300 (goto-char (or (org-list-get-next-item (point) struct prevs)
12301 (org-list-get-item-end (point) struct)))))))
12303 (defun org-add-log-note (&optional purpose)
12304 "Pop up a window for taking a note, and add this note later at point."
12305 (remove-hook 'post-command-hook 'org-add-log-note)
12306 (setq org-log-note-window-configuration (current-window-configuration))
12307 (delete-other-windows)
12308 (move-marker org-log-note-return-to (point))
12309 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12310 (goto-char org-log-note-marker)
12311 (org-switch-to-buffer-other-window "*Org Note*")
12312 (erase-buffer)
12313 (if (memq org-log-note-how '(time state))
12314 (let (current-prefix-arg) (org-store-log-note))
12315 (let ((org-inhibit-startup t)) (org-mode))
12316 (insert (format "# Insert note for %s.
12318 (cond
12319 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12320 ((eq org-log-note-purpose 'done) "closed todo item")
12321 ((eq org-log-note-purpose 'state)
12323 (or org-log-note-previous-state "")
12324 (or org-log-note-state "")))
12325 ((eq org-log-note-purpose 'reschedule)
12326 "rescheduling")
12327 ((eq org-log-note-purpose 'delschedule)
12328 "no longer scheduled")
12329 ((eq org-log-note-purpose 'redeadline)
12330 "changing deadline")
12331 ((eq org-log-note-purpose 'deldeadline)
12332 "removing deadline")
12333 ((eq org-log-note-purpose 'refile)
12334 "refiling")
12335 ((eq org-log-note-purpose 'note)
12336 "this entry")
12337 (t (error "This should not happen")))))
12338 (if org-log-note-extra (insert org-log-note-extra))
12339 (org-set-local 'org-finish-function 'org-store-log-note)
12340 (run-hooks 'org-log-buffer-setup-hook)))
12342 (defvar org-note-abort nil) ; dynamically scoped
12343 (defun org-store-log-note ()
12344 "Finish taking a log note, and insert it to where it belongs."
12345 (let ((txt (buffer-string))
12346 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12347 lines ind bul)
12348 (kill-buffer (current-buffer))
12350 (setq txt (replace-match "" t t txt)))
12352 (setq txt (replace-match "" t t txt)))
12355 (setq note
12356 (org-replace-escapes
12357 note
12358 (list (cons "%u" (user-login-name))
12359 (cons "%U" user-full-name)
12360 (cons "%t" (format-time-string
12361 (org-time-stamp-format 'long 'inactive)
12362 org-log-note-effective-time))
12363 (cons "%T" (format-time-string
12364 (org-time-stamp-format 'long nil)
12365 org-log-note-effective-time))
12366 (cons "%d" (format-time-string
12367 (org-time-stamp-format nil 'inactive)
12368 org-log-note-effective-time))
12369 (cons "%D" (format-time-string
12370 (org-time-stamp-format nil nil)
12371 org-log-note-effective-time))
12372 (cons "%s" (if org-log-note-state
12374 ""))
12375 (cons "%S" (if org-log-note-previous-state
12379 (push note lines))
12380 (when (or current-prefix-arg org-note-abort)
12381 (when org-log-into-drawer
12382 (org-remove-empty-drawer-at
12383 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12384 org-log-note-marker))
12385 (setq lines nil))
12386 (when lines
12387 (with-current-buffer (marker-buffer org-log-note-marker)
12388 (save-excursion
12389 (goto-char org-log-note-marker)
12390 (move-marker org-log-note-marker nil)
12391 (end-of-line 1)
12393 (setq ind (save-excursion
12394 (if (ignore-errors (goto-char (org-in-item-p)))
12395 (let ((struct (org-list-struct)))
12396 (org-list-get-ind
12397 (org-list-get-top-point struct) struct))
12399 (cond
12400 ((and (org-at-heading-p)
12401 org-adapt-indentation)
12402 (1+ (org-current-level)))
12403 ((org-at-heading-p) 0)
12404 (t (org-get-indentation))))))
12405 (setq bul (org-list-bullet-string "-"))
12406 (org-indent-line-to ind)
12407 (insert bul (pop lines))
12408 (let ((ind-body (+ (length bul) ind)))
12409 (while lines
12411 (org-indent-line-to ind-body)
12412 (insert (pop lines))))
12413 (message "Note stored")
12414 (org-back-to-heading t)
12415 (org-cycle-hide-drawers 'children)))))
12416 (set-window-configuration org-log-note-window-configuration)
12417 (with-current-buffer (marker-buffer org-log-note-return-to)
12418 (goto-char org-log-note-return-to))
12419 (move-marker org-log-note-return-to nil)
12420 (and org-log-post-message (message "%s" org-log-post-message)))
12422 (defun org-remove-empty-drawer-at (drawer pos)
12423 "Remove an empty drawer DRAWER at position POS.
12424 POS may also be a marker."
12425 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12426 (save-excursion
12427 (save-restriction
12428 (widen)
12429 (goto-char pos)
12430 (if (org-in-regexp
12432 (replace-match ""))))))
12434 (defun org-sparse-tree (&optional arg)
12435 "Create a sparse tree, prompt for the details.
12436 This command can create sparse trees. You first need to select the type
12437 of match used to create the tree:
12439 t Show all TODO entries.
12440 T Show entries with a specific TODO keyword.
12441 m Show entries selected by a tags/property match.
12442 p Enter a property name and its value (both with completion on existing
12443 names/values) and show entries with that property.
12444 r Show entries matching a regular expression (`/' can be used as well)
12445 d Show deadlines due within `org-deadline-warning-days'.
12446 b Show deadlines and scheduled items before a date.
12447 a Show deadlines and scheduled items after a date."
12448 (interactive "P")
12449 (let (ans kwd value)
12450 (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")
12451 (setq ans (read-char-exclusive))
12452 (cond
12453 ((equal ans ?d)
12454 (call-interactively 'org-check-deadlines))
12455 ((equal ans ?b)
12456 (call-interactively 'org-check-before-date))
12457 ((equal ans ?a)
12458 (call-interactively 'org-check-after-date))
12459 ((equal ans ?D)
12460 (call-interactively 'org-check-dates-range))
12461 ((equal ans ?t)
12462 (org-show-todo-tree nil))
12463 ((equal ans ?T)
12464 (org-show-todo-tree '(4)))
12465 ((member ans '(?T ?m))
12466 (call-interactively 'org-match-sparse-tree))
12467 ((member ans '(?p ?P))
12468 (setq kwd (org-icompleting-read "Property: "
12469 (mapcar 'list (org-buffer-property-keys))))
12470 (setq value (org-icompleting-read "Value: "
12471 (mapcar 'list (org-property-values kwd))))
12474 (org-match-sparse-tree arg (concat kwd "=" value)))
12475 ((member ans '(?r ?R ?/))
12476 (call-interactively 'org-occur))
12479 (defvar org-occur-highlights nil
12480 "List of overlays used for occur matches.")
12481 (make-variable-buffer-local 'org-occur-highlights)
12482 (defvar org-occur-parameters nil
12483 "Parameters of the active org-occur calls.
12484 This is a list, each call to org-occur pushes as cons cell,
12485 containing the regular expression and the callback, onto the list.
12486 The list can contain several entries if `org-occur' has been called
12487 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12488 will only contain one set of parameters. When the highlights are
12489 removed (for example with `C-c C-c', or with the next edit (depending
12490 on `org-remove-highlights-with-change'), this variable is emptied
12491 as well.")
12492 (make-variable-buffer-local 'org-occur-parameters)
12494 (defun org-occur (regexp &optional keep-previous callback)
12495 "Make a compact tree which shows all matches of REGEXP.
12496 The tree will show the lines where the regexp matches, and all higher
12497 headlines above the match. It will also show the heading after the match,
12498 to make sure editing the matching entry is easy.
12499 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12500 call to `org-occur' will be kept, to allow stacking of calls to this
12501 command.
12502 If CALLBACK is non-nil, it is a function which is called to confirm
12503 that the match should indeed be shown."
12505 (when (equal regexp "")
12506 (error "Regexp cannot be empty"))
12507 (unless keep-previous
12508 (org-remove-occur-highlights nil nil t))
12509 (push (cons regexp callback) org-occur-parameters)
12510 (let ((cnt 0))
12511 (save-excursion
12512 (goto-char (point-min))
12513 (if (or (not keep-previous) ; do not want to keep
12514 (not org-occur-highlights)) ; no previous matches
12515 ;; hide everything
12516 (org-overview))
12517 (while (re-search-forward regexp nil t)
12518 (when (or (not callback)
12519 (save-match-data (funcall callback)))
12520 (setq cnt (1+ cnt))
12521 (when org-highlight-sparse-tree-matches
12522 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12523 (org-show-context 'occur-tree))))
12524 (when org-remove-highlights-with-change
12525 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12526 nil 'local))
12527 (unless org-sparse-tree-open-archived-trees
12528 (org-hide-archived-subtrees (point-min) (point-max)))
12529 (run-hooks 'org-occur-hook)
12530 (if (org-called-interactively-p 'interactive)
12531 (message "%d match(es) for regexp %s" cnt regexp))
12532 cnt))
12534 (defun org-occur-next-match (&optional n reset)
12535 "Function for `next-error-function' to find sparse tree matches.
12536 N is the number of matches to move, when negative move backwards.
12537 RESET is entirely ignored - this function always goes back to the
12538 starting point when no match is found."
12539 (let* ((limit (if (< n 0) (point-min) (point-max)))
12540 (search-func (if (< n 0)
12541 'previous-single-char-property-change
12542 'next-single-char-property-change))
12543 (n (abs n))
12544 (pos (point))
12545 p1)
12546 (catch 'exit
12547 (while (setq p1 (funcall search-func (point) 'org-type))
12548 (when (equal p1 limit)
12549 (goto-char pos)
12550 (error "No more matches"))
12551 (when (equal (get-char-property p1 'org-type) 'org-occur)
12552 (setq n (1- n))
12553 (when (= n 0)
12554 (goto-char p1)
12555 (throw 'exit (point))))
12556 (goto-char p1))
12557 (goto-char p1)
12558 (error "No more matches"))))
12560 (defun org-show-context (&optional key)
12561 "Make sure point and context are visible.
12562 How much context is shown depends upon the variables
12563 `org-show-hierarchy-above', `org-show-following-heading',
12564 `org-show-entry-below' and `org-show-siblings'."
12565 (let ((heading-p (org-at-heading-p t))
12566 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12567 (following-p (org-get-alist-option org-show-following-heading key))
12568 (entry-p (org-get-alist-option org-show-entry-below key))
12569 (siblings-p (org-get-alist-option org-show-siblings key)))
12570 (catch 'exit
12571 ;; Show heading or entry text
12572 (if (and heading-p (not entry-p))
12573 (org-flag-heading nil) ; only show the heading
12574 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12575 (org-show-hidden-entry))) ; show entire entry
12576 (when following-p
12577 ;; Show next sibling, or heading below text
12578 (save-excursion
12579 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12580 (org-flag-heading nil))))
12581 (when siblings-p (org-show-siblings))
12582 (when hierarchy-p
12583 ;; show all higher headings, possibly with siblings
12584 (save-excursion
12585 (while (and (condition-case nil
12586 (progn (org-up-heading-all 1) t)
12587 (error nil))
12588 (not (bobp)))
12589 (org-flag-heading nil)
12590 (when siblings-p (org-show-siblings))))))))
12592 (defvar org-reveal-start-hook nil
12593 "Hook run before revealing a location.")
12595 (defun org-reveal (&optional siblings)
12596 "Show current entry, hierarchy above it, and the following headline.
12597 This can be used to show a consistent set of context around locations
12598 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12599 not t for the search context.
12601 With optional argument SIBLINGS, on each level of the hierarchy all
12602 siblings are shown. This repairs the tree structure to what it would
12603 look like when opened with hierarchical calls to `org-cycle'.
12605 go to the parent and show the
12606 entire tree."
12607 (interactive "P")
12608 (run-hooks 'org-reveal-start-hook)
12609 (let ((org-show-hierarchy-above t)
12610 (org-show-following-heading t)
12611 (org-show-siblings (if siblings t org-show-siblings)))
12612 (org-show-context nil))
12613 (when (equal siblings '(16))
12614 (save-excursion
12615 (when (org-up-heading-safe)
12616 (org-show-subtree)
12617 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12619 (defun org-highlight-new-match (beg end)
12620 "Highlight from BEG to END and mark the highlight is an occur headline."
12621 (let ((ov (make-overlay beg end)))
12622 (overlay-put ov 'face 'secondary-selection)
12623 (overlay-put ov 'org-type 'org-occur)
12624 (push ov org-occur-highlights)))
12626 (defun org-remove-occur-highlights (&optional beg end noremove)
12627 "Remove the occur highlights from the buffer.
12628 BEG and END are ignored. If NOREMOVE is nil, remove this function
12629 from the `before-change-functions' in the current buffer."
12630 (interactive)
12631 (unless org-inhibit-highlight-removal
12632 (mapc 'delete-overlay org-occur-highlights)
12633 (setq org-occur-highlights nil)
12634 (setq org-occur-parameters nil)
12635 (unless noremove
12636 (remove-hook 'before-change-functions
12637 'org-remove-occur-highlights 'local))))
12639 ;;;; Priorities
12642 "Regular expression matching the priority indicator.")
12644 (defvar org-remove-priority-next-time nil)
12646 (defun org-priority-up ()
12647 "Increase the priority of the current item."
12648 (interactive)
12649 (org-priority 'up))
12651 (defun org-priority-down ()
12652 "Decrease the priority of the current item."
12653 (interactive)
12654 (org-priority 'down))
12656 (defun org-priority (&optional action)
12657 "Change the priority of an item by ARG.
12658 ACTION can be `set', `up', `down', or a character."
12659 (interactive)
12660 (unless org-enable-priority-commands
12661 (error "Priority commands are disabled"))
12662 (setq action (or action 'set))
12663 (let (current new news have remove)
12664 (save-excursion
12665 (org-back-to-heading t)
12666 (if (looking-at org-priority-regexp)
12667 (setq current (string-to-char (match-string 2))
12668 have t))
12669 (cond
12670 ((eq action 'remove)
12671 (setq remove t new ?\ ))
12672 ((or (eq action 'set)
12673 (if (featurep 'xemacs) (characterp action) (integerp action)))
12674 (if (not (eq action 'set))
12675 (setq new action)
12676 (message "Priority %c-%c, SPC to remove: "
12677 org-highest-priority org-lowest-priority)
12678 (save-match-data
12679 (setq new (read-char-exclusive))))
12680 (if (and (= (upcase org-highest-priority) org-highest-priority)
12681 (= (upcase org-lowest-priority) org-lowest-priority))
12682 (setq new (upcase new)))
12683 (cond ((equal new ?\ ) (setq remove t))
12684 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12685 (error "Priority must be between `%c' and `%c'"
12686 org-highest-priority org-lowest-priority))))
12687 ((eq action 'up)
12688 (setq new (if have
12689 (1- current) ; normal cycling
12690 ;; last priority was empty
12691 (if (eq last-command this-command)
12692 org-lowest-priority ; wrap around empty to lowest
12693 ;; default
12694 (if org-priority-start-cycle-with-default
12695 org-default-priority
12696 (1- org-default-priority))))))
12697 ((eq action 'down)
12698 (setq new (if have
12699 (1+ current) ; normal cycling
12700 ;; last priority was empty
12701 (if (eq last-command this-command)
12702 org-highest-priority ; wrap around empty to highest
12703 ;; default
12704 (if org-priority-start-cycle-with-default
12705 org-default-priority
12706 (1+ org-default-priority))))))
12707 (t (error "Invalid action")))
12708 (if (or (< (upcase new) org-highest-priority)
12709 (> (upcase new) org-lowest-priority))
12710 (if (and (memq action '(up down))
12711 (not have) (not (eq last-command this-command)))
12712 ;; `new' is from default priority
12713 (error
12714 "The default can not be set, see `org-default-priority' why")
12715 ;; normal cycling: `new' is beyond highest/lowest priority
12716 ;; and is wrapped around to the empty priority
12717 (setq remove t)))
12718 (setq news (format "%c" new))
12719 (if have
12720 (if remove
12721 (replace-match "" t t nil 1)
12722 (replace-match news t t nil 2))
12723 (if remove
12724 (error "No priority cookie found in line")
12725 (let ((case-fold-search nil))
12726 (looking-at org-todo-line-regexp))
12727 (if (match-end 2)
12728 (progn
12729 (goto-char (match-end 2))
12730 (insert " [#" news "]"))
12731 (goto-char (match-beginning 3))
12732 (insert "[#" news "] "))))
12733 (org-preserve-lc (org-set-tags nil 'align)))
12734 (if remove
12735 (message "Priority removed")
12736 (message "Priority of current item set to %s" news))))
12738 (defun org-get-priority (s)
12739 "Find priority cookie and return priority."
12740 (if (functionp org-get-priority-function)
12741 (funcall org-get-priority-function)
12742 (save-match-data
12743 (if (not (string-match org-priority-regexp s))
12744 (* 1000 (- org-lowest-priority org-default-priority))
12745 (* 1000 (- org-lowest-priority
12746 (string-to-char (match-string 2 s))))))))
12748 ;;;; Tags
12750 (defvar org-agenda-archives-mode)
12751 (defvar org-map-continue-from nil
12752 "Position from where mapping should continue.
12753 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12755 (defvar org-scanner-tags nil
12756 "The current tag list while the tags scanner is running.")
12757 (defvar org-trust-scanner-tags nil
12758 "Should `org-get-tags-at' use the tags for the scanner.
12759 This is for internal dynamical scoping only.
12760 When this is non-nil, the function `org-get-tags-at' will return the value
12761 of `org-scanner-tags' instead of building the list by itself. This
12762 can lead to large speed-ups when the tags scanner is used in a file with
12763 many entries, and when the list of tags is retrieved, for example to
12764 obtain a list of properties. Building the tags list for each entry in such
12765 a file becomes an N^2 operation - but with this variable set, it scales
12766 as N.")
12768 (defun org-scan-tags (action matcher todo-only &optional start-level)
12769 "Scan headline tags with inheritance and produce output ACTION.
12771 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12772 or `agenda' to produce an entry list for an agenda view. It can also be
12773 a Lisp form or a function that should be called at each matched headline, in
12774 this case the return value is a list of all return values from these calls.
12776 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12777 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12778 only lines with a not-done TODO keyword are included in the output.
12779 This should be the same variable that was scoped into
12780 and set by `org-make-tags-matcher' when it constructed MATCHER.
12782 START-LEVEL can be a string with asterisks, reducing the scope to
12783 headlines matching this string."
12784 (require 'org-agenda)
12785 (let* ((re (concat "^"
12786 (if start-level
12787 ;; Get the correct level to match
12789 org-outline-regexp)
12792 (org-re
12794 (props (list 'face 'default
12795 'done-face 'org-agenda-done
12796 'undone-face 'default
12797 'mouse-face 'highlight
12798 'org-not-done-regexp org-not-done-regexp
12799 'org-todo-regexp org-todo-regexp
12800 'org-complex-heading-regexp org-complex-heading-regexp
12801 'help-echo
12802 (format "mouse-2 or RET jump to org file %s"
12803 (abbreviate-file-name
12804 (or (buffer-file-name (buffer-base-buffer))
12805 (buffer-name (buffer-base-buffer)))))))
12806 (case-fold-search nil)
12807 (org-map-continue-from nil)
12808 lspos tags tags-list
12809 (tags-alist (list (cons 0 org-file-tags)))
12810 (llast 0) rtn rtn1 level category i txt
12811 todo marker entry priority)
12812 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12813 (setq action (list 'lambda nil action)))
12814 (save-excursion
12815 (goto-char (point-min))
12816 (when (eq action 'sparse-tree)
12817 (org-overview)
12818 (org-remove-occur-highlights))
12819 (while (re-search-forward re nil t)
12820 (setq org-map-continue-from nil)
12821 (catch :skip
12822 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12823 tags (if (match-end 4) (org-match-string-no-properties 4)))
12824 (goto-char (setq lspos (match-beginning 0)))
12825 (setq level (org-reduced-level (funcall outline-level))
12826 category (org-get-category))
12827 (setq i llast llast level)
12828 ;; remove tag lists from same and sublevels
12829 (while (>= i level)
12830 (when (setq entry (assoc i tags-alist))
12831 (setq tags-alist (delete entry tags-alist)))
12832 (setq i (1- i)))
12833 ;; add the next tags
12834 (when tags
12835 (setq tags (org-split-string tags ":")
12836 tags-alist
12837 (cons (cons level tags) tags-alist)))
12838 ;; compile tags for current headline
12839 (setq tags-list
12840 (if org-use-tag-inheritance
12841 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12842 tags)
12843 org-scanner-tags tags-list)
12844 (when org-use-tag-inheritance
12845 (setcdr (car tags-alist)
12846 (mapcar (lambda (x)
12847 (setq x (copy-sequence x))
12848 (org-add-prop-inherited x))
12849 (cdar tags-alist))))
12850 (when (and tags org-use-tag-inheritance
12851 (or (not (eq t org-use-tag-inheritance))
12852 org-tags-exclude-from-inheritance))
12853 ;; selective inheritance, remove uninherited ones
12854 (setcdr (car tags-alist)
12855 (org-remove-uninherited-tags (cdar tags-alist))))
12856 (when (and
12858 ;; eval matcher only when the todo condition is OK
12859 (and (or (not todo-only) (member todo org-not-done-keywords))
12860 (let ((case-fold-search t)) (eval matcher)))
12862 ;; Call the skipper, but return t if it does not skip,
12863 ;; so that the `and' form continues evaluating
12864 (progn
12865 (unless (eq action 'sparse-tree) (org-agenda-skip))
12866 t)
12868 ;; Check if timestamps are deselecting this entry
12869 (or (not todo-only)
12870 (and (member todo org-not-done-keywords)
12871 (or (not org-agenda-tags-todo-honor-ignore-options)
12872 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12874 ;; Extra check for the archive tag
12875 ;; FIXME: Does the skipper already do this????
12876 (or
12877 (not (member org-archive-tag tags-list))
12878 ;; we have an archive tag, should we use this anyway?
12879 (or (not org-agenda-skip-archived-trees)
12880 (and (eq action 'agenda) org-agenda-archives-mode))))
12882 ;; select this headline
12884 (cond
12885 ((eq action 'sparse-tree)
12886 (and org-highlight-sparse-tree-matches
12887 (org-get-heading) (match-end 0)
12888 (org-highlight-new-match
12889 (match-beginning 1) (match-end 1)))
12890 (org-show-context 'tags-tree))
12891 ((eq action 'agenda)
12892 (setq txt (org-agenda-format-item
12893 ""
12894 (concat
12895 (if (eq org-tags-match-list-sublevels 'indented)
12896 (make-string (1- level) ?.) "")
12897 (org-get-heading))
12898 category
12899 tags-list
12900 )
12901 priority (org-get-priority txt))
12902 (goto-char lspos)
12903 (setq marker (org-agenda-new-marker))
12904 (org-add-props txt props
12905 'org-marker marker 'org-hd-marker marker 'org-category category
12906 'todo-state todo
12907 'priority priority 'type "tagsmatch")
12908 (push txt rtn))
12909 ((functionp action)
12910 (setq org-map-continue-from nil)
12911 (save-excursion
12912 (setq rtn1 (funcall action))
12913 (push rtn1 rtn)))
12914 (t (error "Invalid action")))
12916 ;; if we are to skip sublevels, jump to end of subtree
12917 (unless org-tags-match-list-sublevels
12918 (org-end-of-subtree t)
12919 (backward-char 1))))
12920 ;; Get the correct position from where to continue
12921 (if org-map-continue-from
12922 (goto-char org-map-continue-from)
12923 (and (= (point) lspos) (end-of-line 1)))))
12924 (when (and (eq action 'sparse-tree)
12925 (not org-sparse-tree-open-archived-trees))
12926 (org-hide-archived-subtrees (point-min) (point-max)))
12927 (nreverse rtn)))
12929 (defun org-remove-uninherited-tags (tags)
12930 "Remove all tags that are not inherited from the list TAGS."
12931 (cond
12932 ((eq org-use-tag-inheritance t)
12933 (if org-tags-exclude-from-inheritance
12934 (org-delete-all org-tags-exclude-from-inheritance tags)
12935 tags))
12936 ((not org-use-tag-inheritance) nil)
12937 ((stringp org-use-tag-inheritance)
12938 (delq nil (mapcar
12939 (lambda (x)
12940 (if (and (string-match org-use-tag-inheritance x)
12941 (not (member x org-tags-exclude-from-inheritance)))
12942 x nil))
12943 tags)))
12944 ((listp org-use-tag-inheritance)
12945 (delq nil (mapcar
12946 (lambda (x)
12947 (if (member x org-use-tag-inheritance) x nil))
12948 tags)))))
12950 (defun org-match-sparse-tree (&optional todo-only match)
12951 "Create a sparse tree according to tags string MATCH.
12952 MATCH can contain positive and negative selection of tags, like
12954 If optional argument TODO-ONLY is non-nil, only select lines that are
12955 also TODO lines."
12956 (interactive "P")
12957 (org-prepare-agenda-buffers (list (current-buffer)))
12958 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12960 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12962 (defvar org-cached-props nil)
12963 (defun org-cached-entry-get (pom property)
12964 (if (or (eq t org-use-property-inheritance)
12965 (and (stringp org-use-property-inheritance)
12966 (string-match org-use-property-inheritance property))
12967 (and (listp org-use-property-inheritance)
12968 (member property org-use-property-inheritance)))
12969 ;; Caching is not possible, check it directly
12970 (org-entry-get pom property 'inherit)
12971 ;; Get all properties, so that we can do complicated checks easily
12972 (cdr (assoc property (or org-cached-props
12973 (setq org-cached-props
12974 (org-entry-properties pom)))))))
12976 (defun org-global-tags-completion-table (&optional files)
12977 "Return the list of all tags in all agenda buffer/files.
12978 Optional FILES argument is a list of files to which can be used
12979 instead of the agenda files."
12980 (save-excursion
12981 (org-uniquify
12982 (delq nil
12983 (apply 'append
12984 (mapcar
12985 (lambda (file)
12986 (set-buffer (find-file-noselect file))
12987 (append (org-get-buffer-tags)
12988 (mapcar (lambda (x) (if (stringp (car-safe x))
12989 (list (car-safe x)) nil))
12990 org-tag-alist)))
12991 (if (and files (car files))
12992 files
12993 (org-agenda-files))))))))
12995 (defun org-make-tags-matcher (match)
12996 "Create the TAGS/TODO matcher form for the selection string MATCH.
12998 The variable `todo-only' is scoped dynamically into this function; it will be
12999 set to t if the matcher restricts matching to TODO entries,
13000 otherwise will not be touched.
13002 Returns a cons of the selection string MATCH and the constructed
13003 lisp form implementing the matcher. The matcher is to be
13004 evaluated at an Org entry, with point on the headline,
13005 and returns t if the entry matches the
13006 selection string MATCH. The returned lisp form references
13007 two variables with information about the entry, which must be
13008 bound around the form's evaluation: todo, the TODO keyword at the
13009 entry (or nil of none); and tags-list, the list of all tags at the
13010 entry including inherited ones. Additionally, the category
13011 of the entry (if any) must be specified as the text property
13012 'org-category on the headline.
13014 See also `org-scan-tags'.
13015 "
13016 (declare (special todo-only))
13017 (unless (boundp 'todo-only)
13018 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13019 (unless match
13020 ;; Get a new match request, with completion
13021 (let ((org-last-tags-completion-table
13022 (org-global-tags-completion-table)))
13023 (setq match (org-completing-read-no-i
13024 "Match: " 'org-tags-completion-function nil nil nil
13025 'org-tags-history))))
13027 ;; Parse the string and create a lisp form
13028 (let ((match0 match)
13029 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13030 minus tag mm
13031 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13032 orterms term orlist re-p str-p level-p level-op time-p
13033 prop-p pn pv po gv rest)
13034 (if (string-match "/+" match)
13035 ;; match contains also a todo-matching request
13036 (progn
13037 (setq tagsmatch (substring match 0 (match-beginning 0))
13038 todomatch (substring match (match-end 0)))
13039 (if (string-match "^!" todomatch)
13040 (setq todo-only t todomatch (substring todomatch 1)))
13042 (setq todomatch nil)))
13043 ;; only matching tags
13044 (setq tagsmatch match todomatch nil))
13046 ;; Make the tags matcher
13048 (setq tagsmatcher t)
13049 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13050 (while (setq term (pop orterms))
13052 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13053 (while (string-match re term)
13054 (setq rest (substring term (match-end 0))
13055 minus (and (match-end 1)
13056 (equal (match-string 1 term) "-"))
13057 tag (save-match-data (replace-regexp-in-string
13059 (match-string 2 term)))
13060 re-p (equal (string-to-char tag) ?{)
13061 level-p (match-end 4)
13062 prop-p (match-end 5)
13063 mm (cond
13064 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13065 (level-p
13066 (setq level-op (org-op-to-function (match-string 3 term)))
13067 `(,level-op level ,(string-to-number
13068 (match-string 4 term))))
13069 (prop-p
13070 (setq pn (match-string 5 term)
13071 po (match-string 6 term)
13072 pv (match-string 7 term)
13073 re-p (equal (string-to-char pv) ?{)
13075 time-p (save-match-data
13077 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13078 (if time-p (setq pv (org-matcher-time pv)))
13079 (setq po (org-op-to-function po (if time-p 'time str-p)))
13080 (cond
13081 ((equal pn "CATEGORY")
13082 (setq gv '(get-text-property (point) 'org-category)))
13083 ((equal pn "TODO")
13084 (setq gv 'todo))
13085 (t
13086 (setq gv `(org-cached-entry-get nil ,pn))))
13087 (if re-p
13088 (if (eq po 'org<>)
13089 `(not (string-match ,pv (or ,gv "")))
13090 `(string-match ,pv (or ,gv "")))
13091 (if str-p
13092 `(,po (or ,gv "") ,pv)
13093 `(,po (string-to-number (or ,gv ""))
13094 ,(string-to-number pv) ))))
13095 (t `(member ,tag tags-list)))
13096 mm (if minus (list 'not mm) mm)
13097 term rest)
13098 (push mm tagsmatcher))
13099 (push (if (> (length tagsmatcher) 1)
13100 (cons 'and tagsmatcher)
13101 (car tagsmatcher))
13102 orlist)
13103 (setq tagsmatcher nil))
13104 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13105 (setq tagsmatcher
13106 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13107 ;; Make the todo matcher
13109 (setq todomatcher t)
13110 (setq orterms (org-split-string todomatch "|") orlist nil)
13111 (while (setq term (pop orterms))
13112 (while (string-match re term)
13113 (setq minus (and (match-end 1)
13114 (equal (match-string 1 term) "-"))
13115 kwd (match-string 2 term)
13116 re-p (equal (string-to-char kwd) ?{)
13117 term (substring term (match-end 0))
13118 mm (if re-p
13119 `(string-match ,(substring kwd 1 -1) todo)
13120 (list 'equal 'todo kwd))
13121 mm (if minus (list 'not mm) mm))
13122 (push mm todomatcher))
13123 (push (if (> (length todomatcher) 1)
13124 (cons 'and todomatcher)
13125 (car todomatcher))
13126 orlist)
13127 (setq todomatcher nil))
13128 (setq todomatcher (if (> (length orlist) 1)
13129 (cons 'or orlist) (car orlist))))
13131 ;; Return the string and lisp forms of the matcher
13132 (setq matcher (if todomatcher
13133 (list 'and tagsmatcher todomatcher)
13134 tagsmatcher))
13135 (when todo-only
13136 (setq matcher (list 'and '(member todo org-not-done-keywords)
13137 matcher)))
13138 (cons match0 matcher)))
13140 (defun org-op-to-function (op &optional stringp)
13141 "Turn an operator into the appropriate function."
13142 (setq op
13143 (cond
13144 ((equal op "<" ) '(< string< org-time<))
13145 ((equal op ">" ) '(> org-string> org-time>))
13146 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13147 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13148 ((member op '("=" "==")) '(= string= org-time=))
13149 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13150 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13152 (defun org<> (a b) (not (= a b)))
13153 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13154 (defun org-string>= (a b) (not (string< a b)))
13155 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13156 (defun org-string<> (a b) (not (string= a b)))
13157 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13158 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13159 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13160 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13161 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13162 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13163 (defun org-2ft (s)
13164 "Convert S to a floating point time.
13165 If S is already a number, just return it. If it is a string, parse
13166 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13167 (cond
13168 ((numberp s) s)
13169 ((stringp s)
13170 (condition-case nil
13171 (float-time (apply 'encode-time (org-parse-time-string s)))
13172 (error 0.)))
13173 (t 0.)))
13175 (defun org-time-today ()
13176 "Time in seconds today at 0:00.
13177 Returns the float number of seconds since the beginning of the
13178 epoch to the beginning of today (00:00)."
13179 (float-time (apply 'encode-time
13180 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13182 (defun org-matcher-time (s)
13183 "Interpret a time comparison value."
13184 (save-match-data
13185 (cond
13186 ((string= s "<now>") (float-time))
13187 ((string= s "<today>") (org-time-today))
13188 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13189 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13191 (+ (org-time-today)
13192 (* (string-to-number (match-string 1 s))
13193 (cdr (assoc (match-string 2 s)
13194 '(("d" . 86400.0) ("w" . 604800.0)
13195 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13196 (t (org-2ft s)))))
13198 (defun org-match-any-p (re list)
13199 "Does re match any element of list?"
13200 (setq list (mapcar (lambda (x) (string-match re x)) list))
13201 (delq nil list))
13203 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13204 (defvar org-tags-overlay (make-overlay 1 1))
13205 (org-detach-overlay org-tags-overlay)
13207 (defun org-get-local-tags-at (&optional pos)
13208 "Get a list of tags defined in the current headline."
13209 (org-get-tags-at pos 'local))
13211 (defun org-get-local-tags ()
13212 "Get a list of tags defined in the current headline."
13213 (org-get-tags-at nil 'local))
13215 (defun org-get-tags-at (&optional pos local)
13216 "Get a list of all headline tags applicable at POS.
13217 POS defaults to point. If tags are inherited, the list contains
13218 the targets in the same sequence as the headlines appear, i.e.
13219 the tags of the current headline come last.
13220 When LOCAL is non-nil, only return tags from the current headline,
13221 ignore inherited ones."
13222 (interactive)
13223 (if (and org-trust-scanner-tags
13224 (or (not pos) (equal pos (point)))
13225 (not local))
13226 org-scanner-tags
13227 (let (tags ltags lastpos parent)
13228 (save-excursion
13229 (save-restriction
13230 (widen)
13231 (goto-char (or pos (point)))
13232 (save-match-data
13233 (catch 'done
13234 (condition-case nil
13235 (progn
13236 (org-back-to-heading t)
13237 (while (not (equal lastpos (point)))
13238 (setq lastpos (point))
13239 (when (looking-at
13241 (setq ltags (org-split-string
13242 (org-match-string-no-properties 1) ":"))
13243 (when parent
13244 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13245 (setq tags (append
13246 (if parent
13247 (org-remove-uninherited-tags ltags)
13248 ltags)
13249 tags)))
13250 (or org-use-tag-inheritance (throw 'done t))
13251 (if local (throw 'done t))
13252 (or (org-up-heading-safe) (error nil))
13253 (setq parent t)))
13254 (error nil)))))
13255 (if local
13256 tags
13257 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13259 (defun org-add-prop-inherited (s)
13260 (add-text-properties 0 (length s) '(inherited t) s)
13261 s)
13263 (defun org-toggle-tag (tag &optional onoff)
13264 "Toggle the tag TAG for the current line.
13265 If ONOFF is `on' or `off', don't toggle but set to this state."
13266 (let (res current)
13267 (save-excursion
13268 (org-back-to-heading t)
13270 (point-at-eol) t)
13271 (progn
13272 (setq current (match-string 1))
13273 (replace-match ""))
13274 (setq current ""))
13275 (setq current (nreverse (org-split-string current ":")))
13276 (cond
13277 ((eq onoff 'on)
13278 (setq res t)
13279 (or (member tag current) (push tag current)))
13280 ((eq onoff 'off)
13281 (or (not (member tag current)) (setq current (delete tag current))))
13282 (t (if (member tag current)
13283 (setq current (delete tag current))
13284 (setq res t)
13285 (push tag current))))
13286 (end-of-line 1)
13287 (if current
13288 (progn
13289 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13290 (org-set-tags nil t))
13291 (delete-horizontal-space))
13292 (run-hooks 'org-after-tags-change-hook))
13293 res))
13295 (defun org-align-tags-here (to-col)
13296 ;; Assumes that this is a headline
13297 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13298 (beginning-of-line 1)
13300 (< pos (match-beginning 2)))
13301 (progn
13302 (setq tags-l (- (match-end 2) (match-beginning 2)))
13303 (goto-char (match-beginning 1))
13304 (insert " ")
13305 (delete-region (point) (1+ (match-beginning 2)))
13306 (setq ncol (max (current-column)
13307 (1+ col)
13308 (if (> to-col 0)
13309 to-col
13310 (- (abs to-col) tags-l))))
13311 (setq p (point))
13312 (insert (make-string (- ncol (current-column)) ?\ ))
13313 (setq ncol (current-column))
13314 (when indent-tabs-mode (tabify p (point-at-eol)))
13315 (org-move-to-column (min ncol col) t))
13316 (goto-char pos))))
13318 (defun org-set-tags-command (&optional arg just-align)
13319 "Call the set-tags command for the current entry."
13320 (interactive "P")
13321 (if (org-at-heading-p)
13322 (org-set-tags arg just-align)
13323 (save-excursion
13324 (org-back-to-heading t)
13325 (org-set-tags arg just-align))))
13327 (defun org-set-tags-to (data)
13328 "Set the tags of the current entry to DATA, replacing the current tags.
13329 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13330 If DATA is nil or the empty string, any tags will be removed."
13331 (interactive "sTags: ")
13332 (setq data
13333 (cond
13334 ((eq data nil) "")
13335 ((equal data "") "")
13336 ((stringp data)
13337 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13338 ":"))
13339 ((listp data)
13340 (concat ":" (mapconcat 'identity data ":") ":"))
13341 (t nil)))
13342 (when data
13343 (save-excursion
13344 (org-back-to-heading t)
13345 (when (looking-at org-complex-heading-regexp)
13346 (if (match-end 5)
13347 (progn
13348 (goto-char (match-beginning 5))
13349 (insert data)
13350 (delete-region (point) (point-at-eol))
13351 (org-set-tags nil 'align))
13352 (goto-char (point-at-eol))
13353 (insert " " data)
13354 (org-set-tags nil 'align)))
13355 (beginning-of-line 1)
13357 (delete-region (match-beginning 1) (match-end 1))))))
13359 (defun org-align-all-tags ()
13360 "Align the tags i all headings."
13361 (interactive)
13362 (save-excursion
13363 (or (ignore-errors (org-back-to-heading t))
13364 (outline-next-heading))
13365 (if (org-at-heading-p)
13366 (org-set-tags t)
13367 (message "No headings"))))
13369 (defvar org-indent-indentation-per-level)
13370 (defun org-set-tags (&optional arg just-align)
13371 "Set the tags for the current headline.
13372 With prefix ARG, realign all tags in headings in the current buffer."
13373 (interactive "P")
13374 (let* ((re org-outline-regexp-bol)
13375 (current (org-get-tags-string))
13376 (col (current-column))
13377 (org-setting-tags t)
13378 table current-tags inherited-tags ; computed below when needed
13379 tags p0 c0 c1 rpl di tc level)
13380 (if arg
13381 (save-excursion
13382 (goto-char (point-min))
13383 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13384 (while (re-search-forward re nil t)
13385 (org-set-tags nil t)
13386 (end-of-line 1)))
13387 (message "All tags realigned to column %d" org-tags-column))
13388 (if just-align
13389 (setq tags current)
13390 ;; Get a new set of tags from the user
13391 (save-excursion
13392 (setq table (append org-tag-persistent-alist
13393 org-tag-alist
13394 (org-get-buffer-tags)
13395 (and
13396 org-complete-tags-always-offer-all-agenda-tags
13397 (org-global-tags-completion-table
13398 (org-agenda-files))))
13399 org-last-tags-completion-table table
13400 current-tags (org-split-string current ":")
13401 inherited-tags (nreverse
13402 (nthcdr (length current-tags)
13403 (nreverse (org-get-tags-at))))
13404 tags
13405 (if (or (eq t org-use-fast-tag-selection)
13406 (and org-use-fast-tag-selection
13407 (delq nil (mapcar 'cdr table))))
13408 (org-fast-tag-selection
13409 current-tags inherited-tags table
13410 (if org-fast-tag-selection-include-todo
13411 org-todo-key-alist))
13412 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13413 (org-trim
13414 (org-icompleting-read "Tags: "
13415 'org-tags-completion-function
13416 nil nil current 'org-tags-history))))))
13417 (while (string-match "[-+&]+" tags)
13418 ;; No boolean logic, just a list
13419 (setq tags (replace-match ":" t t tags))))
13421 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13423 (if org-tags-sort-function
13424 (setq tags (mapconcat 'identity
13425 (sort (org-split-string
13426 tags (org-re "[^[:alnum:]_@#%]+"))
13427 org-tags-sort-function) ":")))
13430 (setq tags "")
13431 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13432 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13434 ;; Insert new tags at the correct column
13435 (beginning-of-line 1)
13436 (setq level (or (and (looking-at org-outline-regexp)
13437 (- (match-end 0) (point) 1))
13438 1))
13439 (cond
13440 ((and (equal current "") (equal tags "")))
13441 ((re-search-forward
13443 (point-at-eol) t)
13444 (if (equal tags "")
13445 (setq rpl "")
13446 (goto-char (match-beginning 0))
13447 (setq c0 (current-column)
13448 ;; compute offset for the case of org-indent-mode active
13449 di (if org-indent-mode
13450 (* (1- org-indent-indentation-per-level) (1- level))
13451 0)
13452 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13453 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13454 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13455 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13456 (replace-match rpl t t)
13457 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13458 tags)
13459 (t (error "Tags alignment failed")))
13460 (org-move-to-column col)
13461 (unless just-align
13462 (run-hooks 'org-after-tags-change-hook)))))
13464 (defun org-change-tag-in-region (beg end tag off)
13465 "Add or remove TAG for each entry in the region.
13466 This works in the agenda, and also in an org-mode buffer."
13467 (interactive
13468 (list (region-beginning) (region-end)
13469 (let ((org-last-tags-completion-table
13470 (if (eq major-mode 'org-mode)
13471 (org-get-buffer-tags)
13472 (org-global-tags-completion-table))))
13473 (org-icompleting-read
13474 "Tag: " 'org-tags-completion-function nil nil nil
13475 'org-tags-history))
13476 (progn
13478 (equal (read-char-exclusive) ?r))))
13479 (if (fboundp 'deactivate-mark) (deactivate-mark))
13480 (let ((agendap (equal major-mode 'org-agenda-mode))
13481 l1 l2 m buf pos newhead (cnt 0))
13482 (goto-char end)
13483 (setq l2 (1- (org-current-line)))
13484 (goto-char beg)
13485 (setq l1 (org-current-line))
13486 (loop for l from l1 to l2 do
13487 (org-goto-line l)
13488 (setq m (get-text-property (point) 'org-hd-marker))
13489 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13490 (and agendap m))
13491 (setq buf (if agendap (marker-buffer m) (current-buffer))
13492 pos (if agendap m (point)))
13493 (with-current-buffer buf
13494 (save-excursion
13495 (save-restriction
13496 (goto-char pos)
13497 (setq cnt (1+ cnt))
13498 (org-toggle-tag tag (if off 'off 'on))
13499 (setq newhead (org-get-heading)))))
13500 (and agendap (org-agenda-change-all-lines newhead m))))
13501 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13503 (defun org-tags-completion-function (string predicate &optional flag)
13504 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13505 (confirm (lambda (x) (stringp (car x)))))
13507 (setq s1 (match-string 1 string)
13508 s2 (match-string 2 string))
13509 (setq s1 "" s2 string))
13510 (cond
13511 ((eq flag nil)
13512 ;; try completion
13513 (setq rtn (try-completion s2 ctable confirm))
13514 (if (stringp rtn)
13515 (setq rtn
13516 (concat s1 s2 (substring rtn (length s2))
13517 (if (and org-add-colon-after-tag-completion
13518 (assoc rtn ctable))
13519 ":" ""))))
13520 rtn)
13521 ((eq flag t)
13522 ;; all-completions
13523 (all-completions s2 ctable confirm)
13524 )
13525 ((eq flag 'lambda)
13526 ;; exact match?
13527 (assoc s2 ctable)))
13528 ))
13530 (defun org-fast-tag-insert (kwd tags face &optional end)
13531 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13532 (insert (format "%-12s" (concat kwd ":"))
13533 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13534 (or end "")))
13536 (defun org-fast-tag-show-exit (flag)
13537 (save-excursion
13538 (org-goto-line 3)
13540 (replace-match ""))
13541 (when flag
13542 (end-of-line 1)
13543 (org-move-to-column (- (window-width) 19) t)
13544 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13546 (defun org-set-current-tags-overlay (current prefix)
13547 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13548 (if (featurep 'xemacs)
13549 (org-overlay-display org-tags-overlay (concat prefix s)
13550 'secondary-selection)
13551 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13552 (org-overlay-display org-tags-overlay (concat prefix s)))))
13554 (defvar org-last-tag-selection-key nil)
13555 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13556 "Fast tag selection with single keys.
13557 CURRENT is the current list of tags in the headline, INHERITED is the
13558 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13559 possibly with grouping information. TODO-TABLE is a similar table with
13560 TODO keywords, should these have keys assigned to them.
13561 If the keys are nil, a-z are automatically assigned.
13562 Returns the new tags string, or nil to not change the current settings."
13563 (let* ((fulltable (append table todo-table))
13564 (maxlen (apply 'max (mapcar
13565 (lambda (x)
13566 (if (stringp (car x)) (string-width (car x)) 0))
13567 fulltable)))
13568 (buf (current-buffer))
13569 (expert (eq org-fast-tag-selection-single-key 'expert))
13570 (buffer-tags nil)
13571 (fwidth (+ maxlen 3 1 3))
13572 (ncol (/ (- (window-width) 4) fwidth))
13573 (i-face 'org-done)
13574 (c-face 'org-todo)
13575 tg cnt e c char c1 c2 ntable tbl rtn
13576 ov-start ov-end ov-prefix
13577 (exit-after-next org-fast-tag-selection-single-key)
13578 (done-keywords org-done-keywords)
13579 groups ingroup)
13580 (save-excursion
13581 (beginning-of-line 1)
13582 (if (looking-at
13584 (setq ov-start (match-beginning 1)
13585 ov-end (match-end 1)
13586 ov-prefix "")
13587 (setq ov-start (1- (point-at-eol))
13588 ov-end (1+ ov-start))
13590 (setq ov-prefix
13591 (concat
13592 (buffer-substring (1- (point)) (point))
13593 (if (> (current-column) org-tags-column)
13594 " "
13595 (make-string (- org-tags-column (current-column)) ?\ ))))))
13596 (move-overlay org-tags-overlay ov-start ov-end)
13597 (save-window-excursion
13598 (if expert
13599 (set-buffer (get-buffer-create " *Org tags*"))
13600 (delete-other-windows)
13601 (split-window-vertically)
13602 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13603 (erase-buffer)
13604 (org-set-local 'org-done-keywords done-keywords)
13607 (org-fast-tag-show-exit exit-after-next)
13608 (org-set-current-tags-overlay current ov-prefix)
13609 (setq tbl fulltable char ?a cnt 0)
13610 (while (setq e (pop tbl))
13611 (cond
13612 ((equal (car e) :startgroup)
13613 (push '() groups) (setq ingroup t)
13614 (when (not (= cnt 0))
13615 (setq cnt 0)
13617 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13618 ((equal (car e) :endgroup)
13619 (setq ingroup nil cnt 0)
13621 ((equal e '(:newline))
13622 (when (not (= cnt 0))
13623 (setq cnt 0)
13625 (setq e (car tbl))
13626 (while (equal (car tbl) '(:newline))
13628 (setq tbl (cdr tbl)))))
13629 (t
13630 (setq tg (copy-sequence (car e)) c2 nil)
13631 (if (cdr e)
13632 (setq c (cdr e))
13633 ;; automatically assign a character.
13634 (setq c1 (string-to-char
13635 (downcase (substring
13636 tg (if (= (string-to-char tg) ?@) 1 0)))))
13637 (if (or (rassoc c1 ntable) (rassoc c1 table))
13638 (while (or (rassoc char ntable) (rassoc char table))
13639 (setq char (1+ char)))
13640 (setq c2 c1))
13641 (setq c (or c2 char)))
13642 (if ingroup (push tg (car groups)))
13643 (setq tg (org-add-props tg nil 'face
13644 (cond
13645 ((not (assoc tg table))
13646 (org-get-todo-face tg))
13647 ((member tg current) c-face)
13648 ((member tg inherited) i-face)
13649 (t nil))))
13650 (if (and (= cnt 0) (not ingroup)) (insert " "))
13651 (insert "[" c "] " tg (make-string
13652 (- fwidth 4 (length tg)) ?\ ))
13653 (push (cons tg c) ntable)
13654 (when (= (setq cnt (1+ cnt)) ncol)
13656 (if ingroup (insert " "))
13657 (setq cnt 0)))))
13658 (setq ntable (nreverse ntable))
13660 (goto-char (point-min))
13661 (if (not expert) (org-fit-window-to-buffer))
13662 (setq rtn
13663 (catch 'exit
13664 (while t
13665 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13666 (if (not groups) "no " "")
13667 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13668 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13669 (setq org-last-tag-selection-key c)
13670 (cond
13672 ((= c ?!)
13673 (setq groups (not groups))
13674 (goto-char (point-min))
13675 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13676 ((= c ?\C-c)
13677 (if (not expert)
13678 (org-fast-tag-show-exit
13679 (setq exit-after-next (not exit-after-next)))
13680 (setq expert nil)
13681 (delete-other-windows)
13682 (set-window-buffer (split-window-vertically) " *Org tags*")
13683 (org-switch-to-buffer-other-window " *Org tags*")
13684 (org-fit-window-to-buffer)))
13685 ((or (= c ?\C-g)
13686 (and (= c ?q) (not (rassoc c ntable))))
13687 (org-detach-overlay org-tags-overlay)
13688 (setq quit-flag t))
13689 ((= c ?\ )
13690 (setq current nil)
13691 (if exit-after-next (setq exit-after-next 'now)))
13693 (condition-case nil
13694 (setq tg (org-icompleting-read
13695 "Tag: "
13696 (append (or buffer-tags
13697 (with-current-buffer buf
13698 (org-get-buffer-tags)))
13699 (mapcar 'car table))))
13700 (quit (setq tg "")))
13702 (add-to-list 'buffer-tags (list tg))
13703 (if (member tg current)
13704 (setq current (delete tg current))
13705 (push tg current)))
13706 (if exit-after-next (setq exit-after-next 'now)))
13707 ((setq e (rassoc c todo-table) tg (car e))
13708 (with-current-buffer buf
13709 (save-excursion (org-todo tg)))
13710 (if exit-after-next (setq exit-after-next 'now)))
13711 ((setq e (rassoc c ntable) tg (car e))
13712 (if (member tg current)
13713 (setq current (delete tg current))
13714 (loop for g in groups do
13715 (if (member tg g)
13716 (mapc (lambda (x)
13717 (setq current (delete x current)))
13718 g)))
13719 (push tg current))
13720 (if exit-after-next (setq exit-after-next 'now))))
13722 ;; Create a sorted list
13723 (setq current
13724 (sort current
13725 (lambda (a b)
13726 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13727 (if (eq exit-after-next 'now) (throw 'exit t))
13728 (goto-char (point-min))
13729 (beginning-of-line 2)
13730 (delete-region (point) (point-at-eol))
13731 (org-fast-tag-insert "Current" current c-face)
13732 (org-set-current-tags-overlay current ov-prefix)
13733 (while (re-search-forward
13735 (setq tg (match-string 1))
13736 (add-text-properties
13737 (match-beginning 1) (match-end 1)
13738 (list 'face
13739 (cond
13740 ((member tg current) c-face)
13741 ((member tg inherited) i-face)
13742 (t (get-text-property (match-beginning 1) 'face))))))
13743 (goto-char (point-min)))))
13744 (org-detach-overlay org-tags-overlay)
13745 (if rtn
13746 (mapconcat 'identity current ":")
13747 nil))))
13749 (defun org-get-tags-string ()
13750 "Get the TAGS string in the current headline."
13751 (unless (org-at-heading-p t)
13752 (error "Not on a heading"))
13753 (save-excursion
13754 (beginning-of-line 1)
13756 (org-match-string-no-properties 1)
13757 "")))
13759 (defun org-get-tags ()
13760 "Get the list of tags specified in the current headline."
13761 (org-split-string (org-get-tags-string) ":"))
13763 (defun org-get-buffer-tags ()
13764 "Get a table of all tags used in the buffer, for completion."
13765 (let (tags)
13766 (save-excursion
13767 (goto-char (point-min))
13768 (while (re-search-forward
13770 (when (equal (char-after (point-at-bol 0)) ?*)
13771 (mapc (lambda (x) (add-to-list 'tags x))
13772 (org-split-string (org-match-string-no-properties 1) ":")))))
13773 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13774 (mapcar 'list tags)))
13776 ;;;; The mapping API
13778 ;;;###autoload
13779 (defun org-map-entries (func &optional match scope &rest skip)
13780 "Call FUNC at each headline selected by MATCH in SCOPE.
13782 FUNC is a function or a lisp form. The function will be called without
13783 arguments, with the cursor positioned at the beginning of the headline.
13784 The return values of all calls to the function will be collected and
13785 returned as a list.
13787 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13788 does not need to preserve point. After evaluation, the cursor will be
13789 moved to the end of the line (presumably of the headline of the
13790 processed entry) and search continues from there. Under some
13791 circumstances, this may not produce the wanted results. For example,
13792 if you have removed (e.g. archived) the current (sub)tree it could
13793 mean that the next entry will be skipped entirely. In such cases, you
13794 can specify the position from where search should continue by making
13795 FUNC set the variable `org-map-continue-from' to the desired buffer
13796 position.
13798 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13799 Only headlines that are matched by this query will be considered during
13800 the iteration. When MATCH is nil or t, all headlines will be
13801 visited by the iteration.
13803 SCOPE determines the scope of this command. It can be any of:
13805 nil The current buffer, respecting the restriction if any
13806 tree The subtree started with the entry at point
13807 region The entries within the active region, if any
13808 region-start-level
13809 The entries within the active region, but only those at
13810 the same level than the first one.
13811 file The current buffer, without restriction
13812 file-with-archives
13813 The current buffer, and any archives associated with it
13814 agenda All agenda files
13815 agenda-with-archives
13816 All agenda files with any archive files associated with them
13817 \(file1 file2 ...)
13818 If this is a list, all files in the list will be scanned
13820 The remaining args are treated as settings for the skipping facilities of
13821 the scanner. The following items can be given here:
13823 archive skip trees with the archive tag.
13824 comment skip trees with the COMMENT keyword
13825 function or Emacs Lisp form:
13826 will be used as value for `org-agenda-skip-function', so whenever
13827 the function returns t, FUNC will not be called for that
13828 entry and search will continue from the point where the
13829 function leaves it.
13831 If your function needs to retrieve the tags including inherited tags
13832 at the *current* entry, you can use the value of the variable
13833 `org-scanner-tags' which will be much faster than getting the value
13834 with `org-get-tags-at'. If your function gets properties with
13835 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13836 to t around the call to `org-entry-properties' to get the same speedup.
13837 Note that if your function moves around to retrieve tags and properties at
13838 a *different* entry, you cannot use these techniques."
13839 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13840 (not (org-region-active-p)))
13841 (let* ((org-agenda-archives-mode nil) ; just to make sure
13842 (org-agenda-skip-archived-trees (memq 'archive skip))
13843 (org-agenda-skip-comment-trees (memq 'comment skip))
13844 (org-agenda-skip-function
13845 (car (org-delete-all '(comment archive) skip)))
13846 (org-tags-match-list-sublevels t)
13847 (start-level (eq scope 'region-start-level))
13848 matcher file res
13849 org-todo-keywords-for-agenda
13850 org-done-keywords-for-agenda
13851 org-todo-keyword-alist-for-agenda
13852 org-drawers-for-agenda
13853 org-tag-alist-for-agenda
13854 todo-only)
13856 (cond
13857 ((eq match t) (setq matcher t))
13858 ((eq match nil) (setq matcher t))
13859 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13861 (save-excursion
13862 (save-restriction
13863 (cond ((eq scope 'tree)
13864 (org-back-to-heading t)
13865 (org-narrow-to-subtree)
13866 (setq scope nil))
13867 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13868 (org-region-active-p))
13869 ;; If needed, set start-level to a string like "2"
13870 (when start-level
13871 (save-excursion
13872 (goto-char (region-beginning))
13873 (unless (org-at-heading-p) (outline-next-heading))
13874 (setq start-level (org-current-level))))
13875 (narrow-to-region (region-beginning)
13876 (save-excursion
13877 (goto-char (region-end))
13878 (unless (and (bolp) (org-at-heading-p))
13879 (outline-next-heading))
13880 (point)))
13881 (setq scope nil)))
13883 (if (not scope)
13884 (progn
13885 (org-prepare-agenda-buffers
13886 (list (buffer-file-name (current-buffer))))
13887 (setq res (org-scan-tags func matcher todo-only start-level)))
13888 ;; Get the right scope
13889 (cond
13890 ((and scope (listp scope) (symbolp (car scope)))
13891 (setq scope (eval scope)))
13892 ((eq scope 'agenda)
13893 (setq scope (org-agenda-files t)))
13894 ((eq scope 'agenda-with-archives)
13895 (setq scope (org-agenda-files t))
13896 (setq scope (org-add-archive-files scope)))
13897 ((eq scope 'file)
13898 (setq scope (list (buffer-file-name))))
13899 ((eq scope 'file-with-archives)
13900 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13901 (org-prepare-agenda-buffers scope)
13902 (while (setq file (pop scope))
13903 (with-current-buffer (org-find-base-buffer-visiting file)
13904 (save-excursion
13905 (save-restriction
13906 (widen)
13907 (goto-char (point-min))
13908 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
13909 res)))
13911 ;;;; Properties
13913 ;;; Setting and retrieving properties
13915 (defconst org-special-properties
13916 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13917 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13918 "The special properties valid in Org-mode.
13920 These are properties that are not defined in the property drawer,
13921 but in some other way.")
13923 (defconst org-default-properties
13924 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13925 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13926 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13927 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13928 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13929 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13930 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13931 "Some properties that are used by Org-mode for various purposes.
13932 Being in this list makes sure that they are offered for completion.")
13935 "Regular expression matching the first line of a property drawer.")
13938 "Regular expression matching the last line of a property drawer.")
13941 "Regular expression matching the first line of a property drawer.")
13944 "Regular expression matching the first line of a property drawer.")
13946 (defconst org-property-drawer-re
13949 "Matches an entire property drawer.")
13951 (defconst org-clock-drawer-re
13954 "Matches an entire clock drawer.")
13956 (defsubst org-re-property (property)
13957 "Return a regexp matching PROPERTY.
13958 Match group 1 will be set to the value "
13961 (defun org-property-action ()
13962 "Do an action on properties."
13963 (interactive)
13964 (let (c)
13965 (org-at-property-p)
13966 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13967 (setq c (read-char-exclusive))
13968 (cond
13969 ((equal c ?s)
13970 (call-interactively 'org-set-property))
13971 ((equal c ?d)
13972 (call-interactively 'org-delete-property))
13973 ((equal c ?D)
13974 (call-interactively 'org-delete-property-globally))
13975 ((equal c ?c)
13976 (call-interactively 'org-compute-property-at-point))
13977 (t (error "No such property action %c" c)))))
13979 (defun org-set-effort (&optional value)
13980 "Set the effort property of the current entry.
13981 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13982 allowed value."
13983 (interactive "P")
13984 (if (equal value 0) (setq value 10))
13985 (let* ((completion-ignore-case t)
13986 (prop org-effort-property)
13987 (cur (org-entry-get nil prop))
13988 (allowed (org-property-get-allowed-values nil prop 'table))
13989 (existing (mapcar 'list (org-property-values prop)))
13990 rpl
13991 (val (cond
13992 ((stringp value) value)
13993 ((and allowed (integerp value))
13994 (or (car (nth (1- value) allowed))
13995 (car (org-last allowed))))
13996 (allowed
13997 (message "Select 1-9,0, [RET%s]: %s"
13998 (if cur (concat "=" cur) "")
13999 (mapconcat 'car allowed " "))
14000 (setq rpl (read-char-exclusive))
14002 cur
14003 (setq rpl (- rpl ?0))
14004 (if (equal rpl 0) (setq rpl 10))
14005 (if (and (> rpl 0) (<= rpl (length allowed)))
14006 (car (nth (1- rpl) allowed))
14007 (org-completing-read "Effort: " allowed nil))))
14008 (t
14009 (let (org-completion-use-ido org-completion-use-iswitchb)
14010 (org-completing-read
14012 (concat "[" cur "]") "")
14013 ": ")
14014 existing nil nil "" nil cur))))))
14015 (unless (equal (org-entry-get nil prop) val)
14016 (org-entry-put nil prop val))
14017 (message "%s is now %s" prop val)))
14019 (defun org-at-property-p ()
14020 "Is cursor inside a property drawer?"
14021 (save-excursion
14022 (beginning-of-line 1)
14024 (save-match-data ;; Used by calling procedures
14025 (let ((p (point))
14026 (range (unless (org-before-first-heading-p)
14027 (org-get-property-block))))
14028 (and range (<= (car range) p) (< p (cdr range))))))))
14030 (defun org-get-property-block (&optional beg end force)
14031 "Return the (beg . end) range of the body of the property drawer.
14032 BEG and END can be beginning and end of subtree, if not given
14033 they will be found.
14034 If the drawer does not exist and FORCE is non-nil, create the drawer."
14035 (catch 'exit
14036 (save-excursion
14037 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14038 (end (or end (progn (outline-next-heading) (point)))))
14039 (goto-char beg)
14040 (if (re-search-forward org-property-start-re end t)
14041 (setq beg (1+ (match-end 0)))
14042 (if force
14043 (save-excursion
14044 (org-insert-property-drawer)
14045 (setq end (progn (outline-next-heading) (point))))
14046 (throw 'exit nil))
14047 (goto-char beg)
14048 (if (re-search-forward org-property-start-re end t)
14049 (setq beg (1+ (match-end 0)))))
14050 (if (re-search-forward org-property-end-re end t)
14051 (setq end (match-beginning 0))
14052 (or force (throw 'exit nil))
14053 (goto-char beg)
14054 (setq end beg)
14055 (org-indent-line-function)
14057 (cons beg end)))))
14059 (defun org-entry-properties (&optional pom which specific)
14060 "Get all properties of the entry at point-or-marker POM.
14061 This includes the TODO keyword, the tags, time strings for deadline,
14062 scheduled, and clocking, and any additional properties defined in the
14063 entry. The return value is an alist, keys may occur multiple times
14064 if the property key was used several times.
14065 POM may also be nil, in which case the current entry is used.
14066 If WHICH is nil or `all', get all properties. If WHICH is
14067 `special' or `standard', only get that subclass. If WHICH
14068 is a string only get exactly this property. SPECIFIC can be a string, the
14069 specific property we are interested in. Specifying it can speed
14070 things up because then unnecessary parsing is avoided."
14071 (setq which (or which 'all))
14072 (org-with-point-at pom
14073 (let ((clockstr (substring org-clock-string 0 -1))
14074 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14075 (case-fold-search nil)
14076 beg end range props sum-props key key1 value string clocksum)
14077 (save-excursion
14078 (when (condition-case nil
14079 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14080 (error nil))
14081 (setq beg (point))
14082 (setq sum-props (get-text-property (point) 'org-summaries))
14083 (setq clocksum (get-text-property (point) :org-clock-minutes))
14084 (outline-next-heading)
14085 (setq end (point))
14086 (when (memq which '(all special))
14087 ;; Get the special properties, like TODO and tags
14088 (goto-char beg)
14089 (when (and (or (not specific) (string= specific "TODO"))
14090 (looking-at org-todo-line-regexp) (match-end 2))
14091 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14092 (when (and (or (not specific) (string= specific "PRIORITY"))
14093 (looking-at org-priority-regexp))
14094 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14095 (when (or (not specific) (string= specific "FILE"))
14096 (push (cons "FILE" buffer-file-name) props))
14097 (when (and (or (not specific) (string= specific "TAGS"))
14098 (setq value (org-get-tags-string))
14100 (push (cons "TAGS" value) props))
14101 (when (and (or (not specific) (string= specific "ALLTAGS"))
14102 (setq value (org-get-tags-at)))
14103 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14104 ":"))
14105 props))
14106 (when (or (not specific) (string= specific "BLOCKED"))
14107 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14108 (when (or (not specific)
14109 (member specific
14110 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14111 "TIMESTAMP" "TIMESTAMP_IA")))
14112 (catch 'match
14113 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14114 (setq key (if (match-end 1)
14115 (substring (org-match-string-no-properties 1)
14116 0 -1))
14117 string (if (equal key clockstr)
14118 (org-no-properties
14119 (org-trim
14120 (buffer-substring
14121 (match-beginning 3) (goto-char
14122 (point-at-eol)))))
14123 (substring (org-match-string-no-properties 3)
14124 1 -1)))
14125 ;; Get the correct property name from the key. This is
14126 ;; necessary if the user has configured time keywords.
14127 (setq key1 (concat key ":"))
14128 (cond
14129 ((not key)
14130 (setq key
14131 (if (= (char-after (match-beginning 3)) ?\[)
14132 "TIMESTAMP_IA" "TIMESTAMP")))
14133 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14134 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14135 ((equal key1 org-closed-string) (setq key "CLOSED"))
14136 ((equal key1 org-clock-string) (setq key "CLOCK")))
14137 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14138 (progn
14139 (push (cons key string) props)
14140 ;; no need to search further if match is found
14141 (throw 'match t))
14142 (when (or (equal key "CLOCK") (not (assoc key props)))
14143 (push (cons key string) props))))))
14144 )
14146 (when (memq which '(all standard))
14147 ;; Get the standard properties, like :PROP: ...
14148 (setq range (org-get-property-block beg end))
14149 (when range
14150 (goto-char (car range))
14151 (while (re-search-forward
14153 (cdr range) t)
14154 (setq key (org-match-string-no-properties 1)
14155 value (org-trim (or (org-match-string-no-properties 2) "")))
14156 (unless (member key excluded)
14157 (push (cons key (or value "")) props)))))
14158 (if clocksum
14159 (push (cons "CLOCKSUM"
14160 (org-columns-number-to-string (/ (float clocksum) 60.)
14161 'add_times))
14162 props))
14163 (unless (assoc "CATEGORY" props)
14164 (push (cons "CATEGORY" (org-get-category)) props))
14165 (append sum-props (nreverse props)))))))
14167 (defun org-entry-get (pom property &optional inherit literal-nil)
14168 "Get value of PROPERTY for entry at point-or-marker POM.
14169 If INHERIT is non-nil and the entry does not have the property,
14170 then also check higher levels of the hierarchy.
14171 If INHERIT is the symbol `selective', use inheritance only if the setting
14172 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14173 If the property is present but empty, the return value is the empty string.
14174 If the property is not present at all, nil is returned.
14177 do not interpret it as the list atom nil. This is used for inheritance
14179 (org-with-point-at pom
14180 (if (and inherit (if (eq inherit 'selective)
14181 (org-property-inherit-p property)
14182 t))
14183 (org-entry-get-with-inheritance property literal-nil)
14184 (if (member property org-special-properties)
14185 ;; We need a special property. Use `org-entry-properties' to
14186 ;; retrieve it, but specify the wanted property
14187 (cdr (assoc property (org-entry-properties nil 'special property)))
14188 (let ((range (unless (org-before-first-heading-p)
14189 (org-get-property-block)))
14190 (props (list (or (assoc property org-file-properties)
14191 (assoc property org-global-properties)
14192 (assoc property org-global-properties-fixed))))
14193 val)
14194 (flet ((ap (key)
14195 (when (re-search-forward
14196 (org-re-property key) (cdr range) t)
14197 (setq props
14198 (org-update-property-plist
14199 key
14200 (if (match-end 1)
14201 (org-match-string-no-properties 1) "")
14202 props)))))
14203 (when (and range (goto-char (car range)))
14204 (ap property)
14205 (goto-char (car range))
14206 (while (ap (concat property "+")))
14207 (setq val (cdr (assoc property props)))
14208 (when val (if literal-nil val (org-not-nil val))))))))))
14210 (defun org-property-or-variable-value (var &optional inherit)
14211 "Check if there is a property fixing the value of VAR.
14212 If yes, return this value. If not, return the current value of the variable."
14213 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14215 (read prop)
14216 (symbol-value var))))
14218 (defun org-entry-delete (pom property)
14219 "Delete the property PROPERTY from entry at point-or-marker POM."
14220 (org-with-point-at pom
14221 (if (member property org-special-properties)
14222 nil ; cannot delete these properties.
14223 (let ((range (org-get-property-block)))
14224 (if (and range
14225 (goto-char (car range))
14226 (re-search-forward
14227 (org-re-property property)
14228 (cdr range) t))
14229 (progn
14230 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14231 t)
14232 nil)))))
14234 ;; Multi-values properties are properties that contain multiple values
14235 ;; These values are assumed to be single words, separated by whitespace.
14236 (defun org-entry-add-to-multivalued-property (pom property value)
14237 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14238 (let* ((old (org-entry-get pom property))
14240 (setq value (org-entry-protect-space value))
14241 (unless (member value values)
14242 (setq values (cons value values))
14243 (org-entry-put pom property
14244 (mapconcat 'identity values " ")))))
14246 (defun org-entry-remove-from-multivalued-property (pom property value)
14247 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14248 (let* ((old (org-entry-get pom property))
14250 (setq value (org-entry-protect-space value))
14251 (when (member value values)
14252 (setq values (delete value values))
14253 (org-entry-put pom property
14254 (mapconcat 'identity values " ")))))
14256 (defun org-entry-member-in-multivalued-property (pom property value)
14257 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14258 (let* ((old (org-entry-get pom property))
14260 (setq value (org-entry-protect-space value))
14261 (member value values)))
14263 (defun org-entry-get-multivalued-property (pom property)
14264 "Return a list of values in a multivalued property."
14265 (let* ((value (org-entry-get pom property))
14267 (mapcar 'org-entry-restore-space values)))
14269 (defun org-entry-put-multivalued-property (pom property &rest values)
14270 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14271 VALUES should be a list of strings. Spaces will be protected."
14272 (org-entry-put pom property
14273 (mapconcat 'org-entry-protect-space values " "))
14274 (let* ((value (org-entry-get pom property))
14276 (mapcar 'org-entry-restore-space values)))
14278 (defun org-entry-protect-space (s)
14279 "Protect spaces and newline in string S."
14280 (while (string-match " " s)
14281 (setq s (replace-match "%20" t t s)))
14283 (setq s (replace-match "%0A" t t s)))
14284 s)
14286 (defun org-entry-restore-space (s)
14287 "Restore spaces and newline in string S."
14288 (while (string-match "%20" s)
14289 (setq s (replace-match " " t t s)))
14290 (while (string-match "%0A" s)
14292 s)
14294 (defvar org-entry-property-inherited-from (make-marker)
14295 "Marker pointing to the entry from where a property was inherited.
14296 Each call to `org-entry-get-with-inheritance' will set this marker to the
14297 location of the entry where the inheritance search matched. If there was
14298 no match, the marker will point nowhere.
14299 Note that also `org-entry-get' calls this function, if the INHERIT flag
14300 is set.")
14302 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14303 "Get entry property, and search higher levels if not present.
14304 The search will stop at the first ancestor which has the property defined.
14306 should be considered as undefined (this is the meaning of nil here).
14308 (move-marker org-entry-property-inherited-from nil)
14309 (let (tmp)
14310 (unless (org-before-first-heading-p)
14311 (save-excursion
14312 (save-restriction
14313 (widen)
14314 (catch 'ex
14315 (while t
14316 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14317 (org-back-to-heading t)
14318 (move-marker org-entry-property-inherited-from (point))
14319 (throw 'ex tmp))
14320 (or (org-up-heading-safe) (throw 'ex nil)))))))
14321 (setq tmp (or tmp
14322 (cdr (assoc property org-file-properties))
14323 (cdr (assoc property org-global-properties))
14324 (cdr (assoc property org-global-properties-fixed))))
14325 (if literal-nil tmp (org-not-nil tmp))))
14327 (defvar org-property-changed-functions nil
14328 "Hook called when the value of a property has changed.
14329 Each hook function should accept two arguments, the name of the property
14330 and the new value.")
14332 (defun org-entry-put (pom property value)
14333 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14334 (org-with-point-at pom
14335 (org-back-to-heading t)
14336 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14337 range)
14338 (cond
14339 ((equal property "TODO")
14341 (not (member value org-todo-keywords-1)))
14343 (if (or (not value)
14345 (setq value 'none))
14346 (org-todo value)
14347 (org-set-tags nil 'align))
14348 ((equal property "PRIORITY")
14350 (string-to-char value) ?\ ))
14351 (org-set-tags nil 'align))
14352 ((equal property "SCHEDULED")
14353 (if (re-search-forward org-scheduled-time-regexp end t)
14354 (cond
14355 ((eq value 'earlier) (org-timestamp-change -1 'day))
14356 ((eq value 'later) (org-timestamp-change 1 'day))
14357 (t (call-interactively 'org-schedule)))
14358 (call-interactively 'org-schedule)))
14359 ((equal property "DEADLINE")
14360 (if (re-search-forward org-deadline-time-regexp end t)
14361 (cond
14362 ((eq value 'earlier) (org-timestamp-change -1 'day))
14363 ((eq value 'later) (org-timestamp-change 1 'day))
14364 (t (call-interactively 'org-deadline)))
14365 (call-interactively 'org-deadline)))
14366 ((member property org-special-properties)
14367 (error "The %s property can not yet be set with `org-entry-put'"
14368 property))
14369 (t ; a non-special property
14370 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14371 (setq range (org-get-property-block beg end 'force))
14372 (goto-char (car range))
14373 (if (re-search-forward
14374 (org-re-property property) (cdr range) t)
14375 (progn
14376 (delete-region (match-beginning 0) (match-end 0))
14377 (goto-char (match-beginning 0)))
14378 (goto-char (cdr range))
14380 (backward-char 1)
14381 (org-indent-line-function))
14382 (insert ":" property ":")
14383 (and value (insert " " value))
14384 (org-indent-line-function)))))
14385 (run-hook-with-args 'org-property-changed-functions property value)))
14387 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14388 "Get all property keys in the current buffer.
14389 With INCLUDE-SPECIALS, also list the special properties that reflect things
14390 like tags and TODO state.
14391 With INCLUDE-DEFAULTS, also include properties that has special meaning
14392 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14393 and others.
14394 With INCLUDE-COLUMNS, also include property names given in COLUMN
14395 formats in the current buffer."
14396 (let (rtn range cfmt s p)
14397 (save-excursion
14398 (save-restriction
14399 (widen)
14400 (goto-char (point-min))
14401 (while (re-search-forward org-property-start-re nil t)
14402 (setq range (org-get-property-block))
14403 (goto-char (car range))
14404 (while (re-search-forward
14406 (cdr range) t)
14407 (add-to-list 'rtn (org-match-string-no-properties 1)))
14408 (outline-next-heading))))
14410 (when include-specials
14411 (setq rtn (append org-special-properties rtn)))
14413 (when include-defaults
14414 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14415 (add-to-list 'rtn org-effort-property))
14417 (when include-columns
14418 (save-excursion
14419 (save-restriction
14420 (widen)
14421 (goto-char (point-min))
14422 (while (re-search-forward
14424 nil t)
14425 (setq cfmt (match-string 2) s 0)
14427 cfmt s)
14428 (setq s (match-end 0)
14429 p (match-string 1 cfmt))
14430 (unless (or (equal p "ITEM")
14431 (member p org-special-properties))
14432 (add-to-list 'rtn (match-string 1 cfmt))))))))
14434 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14436 (defun org-property-values (key)
14437 "Return a list of all values of property KEY in the current buffer."
14438 (save-excursion
14439 (save-restriction
14440 (widen)
14441 (goto-char (point-min))
14442 (let ((re (org-re-property key))
14443 values)
14444 (while (re-search-forward re nil t)
14445 (add-to-list 'values (org-trim (match-string 1))))
14446 (delete "" values)))))
14448 (defun org-insert-property-drawer ()
14449 "Insert a property drawer into the current entry."
14450 (interactive)
14451 (org-back-to-heading t)
14452 (looking-at org-outline-regexp)
14453 (let ((indent (if org-adapt-indentation
14454 (- (match-end 0)(match-beginning 0))
14455 0))
14456 (beg (point))
14458 end hiddenp)
14459 (outline-next-heading)
14460 (setq end (point))
14461 (goto-char beg)
14462 (while (re-search-forward re end t))
14463 (setq hiddenp (outline-invisible-p))
14464 (end-of-line 1)
14467 (if (member (match-string 1) '("CLOCK:" ":END:"))
14468 ;; just skip this line
14469 (beginning-of-line 2)
14470 ;; Drawer start, find the end
14472 (beginning-of-line 1)))
14473 (org-skip-over-state-notes)
14475 (if (eq (char-before) ?*) (forward-char 1))
14477 (beginning-of-line 0)
14478 (org-indent-to-column indent)
14479 (beginning-of-line 2)
14480 (org-indent-to-column indent)
14481 (beginning-of-line 0)
14482 (if hiddenp
14483 (save-excursion
14484 (org-back-to-heading t)
14485 (hide-entry))
14486 (org-flag-drawer t))))
14488 (defvar org-property-set-functions-alist nil
14489 "Property set function alist.
14490 Each entry should have the following format:
14492 (PROPERTY . READ-FUNCTION)
14494 The read function will be called with the same argument as
14495 `org-completing-read'.")
14497 (defun org-set-property-function (property)
14498 "Get the function that should be used to set PROPERTY.
14499 This is computed according to `org-property-set-functions-alist'."
14500 (or (cdr (assoc property org-property-set-functions-alist))
14501 'org-completing-read))
14503 (defun org-read-property-value (property)
14504 "Read PROPERTY value from user."
14505 (let* ((completion-ignore-case t)
14506 (allowed (org-property-get-allowed-values nil property 'table))
14507 (cur (org-entry-get nil property))
14508 (prompt (concat property " value"
14510 (concat " [" cur "]") "") ": "))
14511 (set-function (org-set-property-function property))
14512 (val (if allowed
14513 (funcall set-function prompt allowed nil
14514 (not (get-text-property 0 'org-unrestricted
14515 (caar allowed))))
14516 (let (org-completion-use-ido org-completion-use-iswitchb)
14517 (funcall set-function prompt
14518 (mapcar 'list (org-property-values property))
14519 nil nil "" nil cur)))))
14520 (if (equal val "")
14521 cur
14522 val)))
14524 (defvar org-last-set-property nil)
14525 (defun org-read-property-name ()
14526 "Read a property name."
14527 (let* ((completion-ignore-case t)
14528 (keys (org-buffer-property-keys nil t t))
14529 (default-prop (or (save-excursion
14530 (save-match-data
14531 (beginning-of-line)
14533 (null (string= (match-string 1) "END"))
14534 (match-string 1))))
14535 org-last-set-property))
14536 (property (org-icompleting-read
14537 (concat "Property"
14538 (if default-prop (concat " [" default-prop "]") "")
14539 ": ")
14540 (mapcar 'list keys)
14541 nil nil nil nil
14542 default-prop
14543 )))
14544 (if (member property keys)
14545 property
14546 (or (cdr (assoc (downcase property)
14547 (mapcar (lambda (x) (cons (downcase x) x))
14548 keys)))
14549 property))))
14551 (defun org-set-property (property value)
14552 "In the current entry, set PROPERTY to VALUE.
14553 When called interactively, this will prompt for a property name, offering
14554 completion on existing and default properties. And then it will prompt
14555 for a value, offering completion either on allowed values (via an inherited
14556 xxx_ALL property) or on existing values in other instances of this property
14557 in the current file."
14558 (interactive (list nil nil))
14559 (let* ((property (or property (org-read-property-name)))
14560 (value (or value (org-read-property-value property)))
14561 (fn (assoc property org-properties-postprocess-alist)))
14562 (setq org-last-set-property property)
14563 ;; Possibly postprocess the inserted value:
14564 (when fn (setq value (funcall (cadr fn) value)))
14565 (unless (equal (org-entry-get nil property) value)
14566 (org-entry-put nil property value))))
14568 (defun org-delete-property (property)
14569 "In the current entry, delete PROPERTY."
14570 (interactive
14571 (let* ((completion-ignore-case t)
14572 (prop (org-icompleting-read "Property: "
14573 (org-entry-properties nil 'standard))))
14574 (list prop)))
14575 (message "Property %s %s" property
14576 (if (org-entry-delete nil property)
14577 "deleted"
14578 "was not present in the entry")))
14580 (defun org-delete-property-globally (property)
14581 "Remove PROPERTY globally, from all entries."
14582 (interactive
14583 (let* ((completion-ignore-case t)
14584 (prop (org-icompleting-read
14585 "Globally remove property: "
14586 (mapcar 'list (org-buffer-property-keys)))))
14587 (list prop)))
14588 (save-excursion
14589 (save-restriction
14590 (widen)
14591 (goto-char (point-min))
14592 (let ((cnt 0))
14593 (while (re-search-forward
14594 (org-re-property property)
14595 nil t)
14596 (setq cnt (1+ cnt))
14597 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14600 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14602 (defun org-compute-property-at-point ()
14603 "Compute the property at point.
14604 This looks for an enclosing column format, extracts the operator and
14605 then applies it to the property in the column format's scope."
14606 (interactive)
14607 (unless (org-at-property-p)
14608 (error "Not at a property"))
14609 (let ((prop (org-match-string-no-properties 2)))
14610 (org-columns-get-format-and-top-level)
14611 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14612 (error "No operator defined for property %s" prop))
14613 (org-columns-compute prop)))
14615 (defvar org-property-allowed-value-functions nil
14616 "Hook for functions supplying allowed values for a specific property.
14617 The functions must take a single argument, the name of the property, and
14619 the values, this means that these values are intended as defaults for
14620 completion, but that other values should be allowed too.
14621 The functions must return nil if they are not responsible for this
14622 property.")
14624 (defun org-property-get-allowed-values (pom property &optional table)
14625 "Get allowed values for the property PROPERTY.
14626 When TABLE is non-nil, return an alist that can directly be used for
14627 completion."
14628 (let (vals)
14629 (cond
14630 ((equal property "TODO")
14631 (setq vals (org-with-point-at pom
14632 (append org-todo-keywords-1 '("")))))
14633 ((equal property "PRIORITY")
14634 (let ((n org-lowest-priority))
14635 (while (>= n org-highest-priority)
14636 (push (char-to-string n) vals)
14637 (setq n (1- n)))))
14638 ((member property org-special-properties))
14639 ((setq vals (run-hook-with-args-until-success
14640 'org-property-allowed-value-functions property)))
14641 (t
14642 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14644 (setq vals (car (read-from-string (concat "(" vals ")"))))
14645 (setq vals (mapcar (lambda (x)
14646 (cond ((stringp x) x)
14647 ((numberp x) (number-to-string x))
14648 ((symbolp x) (symbol-name x))
14649 (t "???")))
14650 vals)))))
14651 (when (member ":ETC" vals)
14652 (setq vals (remove ":ETC" vals))
14653 (org-add-props (car vals) '(org-unrestricted t)))
14654 (if table (mapcar 'list vals) vals)))
14656 (defun org-property-previous-allowed-value (&optional previous)
14657 "Switch to the next allowed value for this property."
14658 (interactive)
14659 (org-property-next-allowed-value t))
14661 (defun org-property-next-allowed-value (&optional previous)
14662 "Switch to the next allowed value for this property."
14663 (interactive)
14664 (unless (org-at-property-p)
14665 (error "Not at a property"))
14666 (let* ((key (match-string 2))
14667 (value (match-string 3))
14668 (allowed (or (org-property-get-allowed-values (point) key)
14669 (and (member value '("[ ]" "[-]" "[X]"))
14670 '("[ ]" "[X]"))))
14671 nval)
14672 (unless allowed
14673 (error "Allowed values for this property have not been defined"))
14674 (if previous (setq allowed (reverse allowed)))
14675 (if (member value allowed)
14676 (setq nval (car (cdr (member value allowed)))))
14677 (setq nval (or nval (car allowed)))
14678 (if (equal nval value)
14679 (error "Only one allowed value for this property"))
14680 (org-at-property-p)
14681 (replace-match (concat " :" key ": " nval) t t)
14682 (org-indent-line-function)
14683 (beginning-of-line 1)
14685 (run-hook-with-args 'org-property-changed-functions key nval)))
14687 (defun org-find-olp (path &optional this-buffer)
14688 "Return a marker pointing to the entry at outline path OLP.
14689 If anything goes wrong, throw an error.
14690 You can wrap this call to catch the error like this:
14692 (condition-case msg
14693 (org-mobile-locate-entry (match-string 4))
14694 (error (nth 1 msg)))
14696 The return value will then be either a string with the error message,
14697 or a marker if everything is OK.
14699 If THIS-BUFFER is set, the outline path does not contain a file,
14700 only headings."
14701 (let* ((file (if this-buffer buffer-file-name (pop path)))
14702 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14703 (level 1)
14704 (lmin 1)
14705 (lmax 1)
14706 limit re end found pos heading cnt flevel)
14707 (unless buffer (error "File not found :%s" file))
14708 (with-current-buffer buffer
14709 (save-excursion
14710 (save-restriction
14711 (widen)
14712 (setq limit (point-max))
14713 (goto-char (point-min))
14714 (while (setq heading (pop path))
14715 (setq re (format org-complex-heading-regexp-format
14716 (regexp-quote heading)))
14717 (setq cnt 0 pos (point))
14718 (while (re-search-forward re end t)
14719 (setq level (- (match-end 1) (match-beginning 1)))
14720 (if (and (>= level lmin) (<= level lmax))
14721 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14722 (when (= cnt 0) (error "Heading not found on level %d: %s"
14723 lmax heading))
14724 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14725 lmax heading))
14726 (goto-char found)
14727 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14728 (setq end (save-excursion (org-end-of-subtree t t))))
14729 (when (org-at-heading-p)
14730 (move-marker (make-marker) (point))))))))
14732 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14733 "Find node HEADING in BUFFER.
14734 Return a marker to the heading if it was found, or nil if not.
14735 If POS-ONLY is set, return just the position instead of a marker.
14737 The heading text must match exact, but it may have a TODO keyword,
14738 a priority cookie and tags in the standard locations."
14739 (with-current-buffer (or buffer (current-buffer))
14740 (save-excursion
14741 (save-restriction
14742 (widen)
14743 (goto-char (point-min))
14744 (let (case-fold-search)
14745 (if (re-search-forward
14746 (format org-complex-heading-regexp-format
14747 (regexp-quote heading)) nil t)
14748 (if pos-only
14749 (match-beginning 0)
14750 (move-marker (make-marker) (match-beginning 0)))))))))
14752 (defun org-find-exact-heading-in-directory (heading &optional dir)
14753 "Find Org node headline HEADING in all .org files in directory DIR.
14754 When the target headline is found, return a marker to this location."
14755 (let ((files (directory-files (or dir default-directory)
14757 file visiting m buffer)
14758 (catch 'found
14759 (while (setq file (pop files))
14760 (message "trying %s" file)
14761 (setq visiting (org-find-base-buffer-visiting file))
14762 (setq buffer (or visiting (find-file-noselect file)))
14763 (setq m (org-find-exact-headline-in-buffer
14764 heading buffer))
14765 (when (and (not m) (not visiting)) (kill-buffer buffer))
14766 (and m (throw 'found m))))))
14768 (defun org-find-entry-with-id (ident)
14769 "Locate the entry that contains the ID property with exact value IDENT.
14770 IDENT can be a string, a symbol or a number, this function will search for
14771 the string representation of it.
14772 Return the position where this entry starts, or nil if there is no such entry."
14773 (interactive "sID: ")
14774 (let ((id (cond
14775 ((stringp ident) ident)
14776 ((symbol-name ident) (symbol-name ident))
14777 ((numberp ident) (number-to-string ident))
14778 (t (error "IDENT %s must be a string, symbol or number" ident))))
14779 (case-fold-search nil))
14780 (save-excursion
14781 (save-restriction
14782 (widen)
14783 (goto-char (point-min))
14784 (when (re-search-forward
14786 nil t)
14787 (org-back-to-heading t)
14788 (point))))))
14790 ;;;; Timestamps
14792 (defvar org-last-changed-timestamp nil)
14793 (defvar org-last-inserted-timestamp nil
14794 "The last time stamp inserted with `org-insert-time-stamp'.")
14795 (defvar org-time-was-given) ; dynamically scoped parameter
14796 (defvar org-end-time-was-given) ; dynamically scoped parameter
14797 (defvar org-ts-what) ; dynamically scoped parameter
14799 (defun org-time-stamp (arg &optional inactive)
14800 "Prompt for a date/time and insert a time stamp.
14801 If the user specifies a time like HH:MM, or if this command is called
14802 with a prefix argument, the time stamp will contain date and time.
14803 Otherwise, only the date will be included. All parts of a date not
14804 specified by the user will be filled in from the current date/time.
14805 So if you press just return without typing anything, the time stamp
14806 will represent the current date/time. If there is already a timestamp
14807 at the cursor, it will be modified."
14808 (interactive "P")
14809 (let* ((ts nil)
14810 (default-time
14811 ;; Default time is either today, or, when entering a range,
14812 ;; the range start.
14813 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14814 (save-excursion
14815 (re-search-backward
14817 (- (point) 20) t)))
14818 (apply 'encode-time (org-parse-time-string (match-string 1)))
14819 (current-time)))
14820 (default-input (and ts (org-get-compact-tod ts)))
14821 (repeater (save-excursion
14822 (save-match-data
14823 (beginning-of-line)
14824 (when (re-search-forward
14826 (save-excursion (progn (end-of-line) (point))) t)
14827 (match-string 0)))))
14828 org-time-was-given org-end-time-was-given time)
14829 (cond
14830 ((and (org-at-timestamp-p t)
14831 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14832 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14833 (insert "--")
14834 (setq time (let ((this-command this-command))
14835 (org-read-date arg 'totime nil nil
14836 default-time default-input)))
14837 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14838 ((org-at-timestamp-p t)
14839 (setq time (let ((this-command this-command))
14840 (org-read-date arg 'totime nil nil default-time default-input)))
14841 (when (org-at-timestamp-p t) ; just to get the match data
14842 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14843 (replace-match "")
14844 (setq org-last-changed-timestamp
14845 (org-insert-time-stamp
14846 time (or org-time-was-given arg)
14847 inactive nil nil (list org-end-time-was-given)))
14848 (when repeater (goto-char (1- (point))) (insert " " repeater)
14849 (setq org-last-changed-timestamp
14850 (concat (substring org-last-inserted-timestamp 0 -1)
14851 " " repeater ">"))))
14852 (message "Timestamp updated"))
14853 (t
14854 (setq time (let ((this-command this-command))
14855 (org-read-date arg 'totime nil nil default-time default-input)))
14856 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14857 nil nil (list org-end-time-was-given))))))
14859 ;; FIXME: can we use this for something else, like computing time differences?
14860 (defun org-get-compact-tod (s)
14861 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14862 (let* ((t1 (match-string 1 s))
14863 (h1 (string-to-number (match-string 2 s)))
14864 (m1 (string-to-number (match-string 3 s)))
14865 (t2 (and (match-end 4) (match-string 5 s)))
14866 (h2 (and t2 (string-to-number (match-string 6 s))))
14867 (m2 (and t2 (string-to-number (match-string 7 s))))
14868 dh dm)
14869 (if (not t2)
14870 t1
14871 (setq dh (- h2 h1) dm (- m2 m1))
14872 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14873 (concat t1 "+" (number-to-string dh)
14874 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14876 (defun org-time-stamp-inactive (&optional arg)
14877 "Insert an inactive time stamp.
14878 An inactive time stamp is enclosed in square brackets instead of angle
14879 brackets. It is inactive in the sense that it does not trigger agenda entries,
14880 does not link to the calendar and cannot be changed with the S-cursor keys.
14881 So these are more for recording a certain time/date."
14882 (interactive "P")
14883 (org-time-stamp arg 'inactive))
14885 (defvar org-date-ovl (make-overlay 1 1))
14886 (overlay-put org-date-ovl 'face 'org-warning)
14887 (org-detach-overlay org-date-ovl)
14889 (defvar org-ans1) ; dynamically scoped parameter
14890 (defvar org-ans2) ; dynamically scoped parameter
14892 (defvar org-plain-time-of-day-regexp) ; defined below
14894 (defvar org-overriding-default-time nil) ; dynamically scoped
14895 (defvar org-read-date-overlay nil)
14896 (defvar org-dcst nil) ; dynamically scoped
14897 (defvar org-read-date-history nil)
14898 (defvar org-read-date-final-answer nil)
14899 (defvar org-read-date-analyze-futurep nil)
14900 (defvar org-read-date-analyze-forced-year nil)
14902 (defun org-read-date (&optional with-time to-time from-string prompt
14903 default-time default-input)
14904 "Read a date, possibly a time, and make things smooth for the user.
14905 The prompt will suggest to enter an ISO date, but you can also enter anything
14906 which will at least partially be understood by `parse-time-string'.
14907 Unrecognized parts of the date will default to the current day, month, year,
14908 hour and minute. If this command is called to replace a timestamp at point,
14909 or to enter the second timestamp of a range, the default time is taken
14910 from the existing stamp. Furthermore, the command prefers the future,
14911 so if you are giving a date where the year is not given, and the day-month
14912 combination is already past in the current year, it will assume you
14913 mean next year. For details, see the manual. A few examples:
14915 3-2-5 --> 2003-02-05
14916 feb 15 --> currentyear-02-15
14917 2/15 --> currentyear-02-15
14918 sep 12 9 --> 2009-09-12
14919 12:45 --> today 12:45
14920 22 sept 0:34 --> currentyear-09-22 0:34
14921 12 --> currentyear-currentmonth-12
14922 Fri --> nearest Friday (today or later)
14923 etc.
14925 Furthermore you can specify a relative date by giving, as the *first* thing
14926 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14927 change in days weeks, months, years.
14928 With a single plus or minus, the date is relative to today. With a double
14929 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14930 +4d --> four days from today
14931 +4 --> same as above
14932 +2w --> two weeks from today
14933 ++5 --> five days from default date
14935 The function understands only English month and weekday abbreviations.
14937 While prompting, a calendar is popped up - you can also select the
14938 date with the mouse (button 1). The calendar shows a period of three
14939 months. To scroll it to other months, use the keys `>' and `<'.
14940 If you don't like the calendar, turn it off with
14941 \(setq org-read-date-popup-calendar nil)
14943 With optional argument TO-TIME, the date will immediately be converted
14944 to an internal time.
14945 With an optional argument WITH-TIME, the prompt will suggest to also
14946 insert a time. Note that when WITH-TIME is not set, you can still
14947 enter a time, and this function will inform the calling routine about
14948 this change. The calling routine may then choose to change the format
14949 used to insert the time stamp into the buffer to include the time.
14950 With optional argument FROM-STRING, read from this string instead from
14951 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14952 the time/date that is used for everything that is not specified by the
14953 user."
14954 (require 'parse-time)
14955 (let* ((org-time-stamp-rounding-minutes
14956 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14957 (org-dcst org-display-custom-times)
14958 (ct (org-current-time))
14959 (def (or org-overriding-default-time default-time ct))
14960 (defdecode (decode-time def))
14961 (dummy (progn
14962 (when (< (nth 2 defdecode) org-extend-today-until)
14963 (setcar (nthcdr 2 defdecode) -1)
14964 (setcar (nthcdr 1 defdecode) 59)
14965 (setq def (apply 'encode-time defdecode)
14966 defdecode (decode-time def)))))
14967 (calendar-frame-setup nil)
14968 (calendar-setup nil)
14969 (calendar-move-hook nil)
14970 (calendar-view-diary-initially-flag nil)
14971 (calendar-view-holidays-initially-flag nil)
14972 (timestr (format-time-string
14973 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14974 (prompt (concat (if prompt (concat prompt " ") "")
14975 (format "Date+time [%s]: " timestr)))
14976 ans (org-ans0 "") org-ans1 org-ans2 final)
14978 (cond
14979 (from-string (setq ans from-string))
14980 (org-read-date-popup-calendar
14981 (save-excursion
14982 (save-window-excursion
14983 (calendar)
14984 (unwind-protect
14985 (progn
14986 (calendar-forward-day (- (time-to-days def)
14987 (calendar-absolute-from-gregorian
14988 (calendar-current-date))))
14989 (org-eval-in-calendar nil t)
14990 (let* ((old-map (current-local-map))
14991 (map (copy-keymap calendar-mode-map))
14992 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14993 (org-defkey map (kbd "RET") 'org-calendar-select)
14994 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14995 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14996 (org-defkey minibuffer-local-map [(meta shift left)]
14997 (lambda () (interactive)
14998 (org-eval-in-calendar '(calendar-backward-month 1))))
14999 (org-defkey minibuffer-local-map [(meta shift right)]
15000 (lambda () (interactive)
15001 (org-eval-in-calendar '(calendar-forward-month 1))))
15002 (org-defkey minibuffer-local-map [(meta shift up)]
15003 (lambda () (interactive)
15004 (org-eval-in-calendar '(calendar-backward-year 1))))
15005 (org-defkey minibuffer-local-map [(meta shift down)]
15006 (lambda () (interactive)
15007 (org-eval-in-calendar '(calendar-forward-year 1))))
15008 (org-defkey minibuffer-local-map [?\e (shift left)]
15009 (lambda () (interactive)
15010 (org-eval-in-calendar '(calendar-backward-month 1))))
15011 (org-defkey minibuffer-local-map [?\e (shift right)]
15012 (lambda () (interactive)
15013 (org-eval-in-calendar '(calendar-forward-month 1))))
15014 (org-defkey minibuffer-local-map [?\e (shift up)]
15015 (lambda () (interactive)
15016 (org-eval-in-calendar '(calendar-backward-year 1))))
15017 (org-defkey minibuffer-local-map [?\e (shift down)]
15018 (lambda () (interactive)
15019 (org-eval-in-calendar '(calendar-forward-year 1))))
15020 (org-defkey minibuffer-local-map [(shift up)]
15021 (lambda () (interactive)
15022 (org-eval-in-calendar '(calendar-backward-week 1))))
15023 (org-defkey minibuffer-local-map [(shift down)]
15024 (lambda () (interactive)
15025 (org-eval-in-calendar '(calendar-forward-week 1))))
15026 (org-defkey minibuffer-local-map [(shift left)]
15027 (lambda () (interactive)
15028 (org-eval-in-calendar '(calendar-backward-day 1))))
15029 (org-defkey minibuffer-local-map [(shift right)]
15030 (lambda () (interactive)
15031 (org-eval-in-calendar '(calendar-forward-day 1))))
15032 (org-defkey minibuffer-local-map ">"
15033 (lambda () (interactive)
15034 (org-eval-in-calendar '(scroll-calendar-left 1))))
15035 (org-defkey minibuffer-local-map "<"
15036 (lambda () (interactive)
15037 (org-eval-in-calendar '(scroll-calendar-right 1))))
15038 (org-defkey minibuffer-local-map "\C-v"
15039 (lambda () (interactive)
15040 (org-eval-in-calendar
15041 '(calendar-scroll-left-three-months 1))))
15042 (org-defkey minibuffer-local-map "\M-v"
15043 (lambda () (interactive)
15044 (org-eval-in-calendar
15045 '(calendar-scroll-right-three-months 1))))
15046 (run-hooks 'org-read-date-minibuffer-setup-hook)
15047 (unwind-protect
15048 (progn
15049 (use-local-map map)
15050 (add-hook 'post-command-hook 'org-read-date-display)
15051 (setq org-ans0 (read-string prompt default-input
15052 'org-read-date-history nil))
15053 ;; org-ans0: from prompt
15054 ;; org-ans1: from mouse click
15055 ;; org-ans2: from calendar motion
15056 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15057 (remove-hook 'post-command-hook 'org-read-date-display)
15058 (use-local-map old-map)
15059 (when org-read-date-overlay
15060 (delete-overlay org-read-date-overlay)
15061 (setq org-read-date-overlay nil)))))
15062 (bury-buffer "*Calendar*")))))
15064 (t ; Naked prompt only
15065 (unwind-protect
15066 (setq ans (read-string prompt default-input
15067 'org-read-date-history timestr))
15068 (when org-read-date-overlay
15069 (delete-overlay org-read-date-overlay)
15070 (setq org-read-date-overlay nil)))))
15072 (setq final (org-read-date-analyze ans def defdecode))
15074 (when org-read-date-analyze-forced-year
15075 (message "Year was forced into %s"
15076 (if org-read-date-force-compatible-dates
15077 "compatible range (1970-2037)"
15078 "range representable on this machine"))
15079 (ding))
15081 ;; One round trip to get rid of 34th of August and stuff like that....
15082 (setq final (decode-time (apply 'encode-time final)))
15084 (setq org-read-date-final-answer ans)
15086 (if to-time
15087 (apply 'encode-time final)
15088 (if (and (boundp 'org-time-was-given) org-time-was-given)
15089 (format "%04d-%02d-%02d %02d:%02d"
15090 (nth 5 final) (nth 4 final) (nth 3 final)
15091 (nth 2 final) (nth 1 final))
15092 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15094 (defvar def)
15095 (defvar defdecode)
15096 (defvar with-time)
15097 (defun org-read-date-display ()
15098 "Display the current date prompt interpretation in the minibuffer."
15099 (when org-read-date-display-live
15100 (when org-read-date-overlay
15101 (delete-overlay org-read-date-overlay))
15102 (let ((p (point)))
15103 (end-of-line 1)
15104 (while (not (equal (buffer-substring
15105 (max (point-min) (- (point) 4)) (point))
15106 " "))
15107 (insert " "))
15108 (goto-char p))
15109 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15110 " " (or org-ans1 org-ans2)))
15111 (org-end-time-was-given nil)
15112 (f (org-read-date-analyze ans def defdecode))
15113 (fmts (if org-dcst
15114 org-time-stamp-custom-formats
15115 org-time-stamp-formats))
15116 (fmt (if (or with-time
15117 (and (boundp 'org-time-was-given) org-time-was-given))
15118 (cdr fmts)
15119 (car fmts)))
15120 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15121 (when (and org-end-time-was-given
15122 (string-match org-plain-time-of-day-regexp txt))
15123 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15124 org-end-time-was-given
15125 (substring txt (match-end 0)))))
15126 (when org-read-date-analyze-futurep
15127 (setq txt (concat txt " (=>F)")))
15128 (setq org-read-date-overlay
15129 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15130 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15132 (defun org-read-date-analyze (ans def defdecode)
15133 "Analyze the combined answer of the date prompt."
15134 ;; FIXME: cleanup and comment
15135 (let ((nowdecode (decode-time (current-time)))
15136 delta deltan deltaw deltadef year month day
15137 hour minute second wday pm h2 m2 tl wday1
15138 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15139 (setq org-read-date-analyze-futurep nil
15140 org-read-date-analyze-forced-year nil)
15142 (setq ans "+0"))
15144 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15145 (setq ans (replace-match "" t t ans)
15146 deltan (car delta)
15147 deltaw (nth 1 delta)
15148 deltadef (nth 2 delta)))
15150 ;; Check if there is an iso week date in there
15151 ;; If yes, store the info and postpone interpreting it until the rest
15152 ;; of the parsing is done
15153 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15154 (setq iso-year (if (match-end 1)
15155 (org-small-year-to-year
15156 (string-to-number (match-string 1 ans))))
15157 iso-weekday (if (match-end 3)
15158 (string-to-number (match-string 3 ans)))
15159 iso-week (string-to-number (match-string 2 ans)))
15160 (setq ans (replace-match "" t t ans)))
15162 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15163 (when (string-match
15165 (setq year (if (match-end 2)
15166 (string-to-number (match-string 2 ans))
15167 (progn (setq kill-year t)
15168 (string-to-number (format-time-string "%Y"))))
15169 month (string-to-number (match-string 3 ans))
15170 day (string-to-number (match-string 4 ans)))
15171 (if (< year 100) (setq year (+ 2000 year)))
15173 t nil ans)))
15175 ;; Help matching dotted european dates
15176 (when (string-match
15177 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15178 (setq year (if (match-end 3)
15179 (string-to-number (match-string 3 ans))
15180 (progn (setq kill-year t)
15181 (string-to-number (format-time-string "%Y"))))
15182 day (string-to-number (match-string 1 ans))
15183 month (string-to-number (match-string 2 ans))
15185 t nil ans)))
15187 ;; Help matching american dates, like 5/30 or 5/30/7
15188 (when (string-match
15189 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15190 (setq year (if (match-end 4)
15191 (string-to-number (match-string 4 ans))
15192 (progn (setq kill-year t)
15193 (string-to-number (format-time-string "%Y"))))
15194 month (string-to-number (match-string 1 ans))
15195 day (string-to-number (match-string 2 ans)))
15196 (if (< year 100) (setq year (+ 2000 year)))
15198 t nil ans)))
15199 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15200 ;; If there is a time with am/pm, and *no* time without it, we convert
15201 ;; so that matching will be successful.
15202 (loop for i from 1 to 2 do ; twice, for end time as well
15205 (setq hour (string-to-number (match-string 1 ans))
15206 minute (if (match-end 3)
15207 (string-to-number (match-string 3 ans))
15208 0)
15209 pm (equal ?p
15210 (string-to-char (downcase (match-string 4 ans)))))
15211 (if (and (= hour 12) (not pm))
15212 (setq hour 0)
15213 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15214 (setq ans (replace-match (format "%02d:%02d" hour minute)
15215 t t ans))))
15217 ;; Check if a time range is given as a duration
15218 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15219 (setq hour (string-to-number (match-string 1 ans))
15220 h2 (+ hour (string-to-number (match-string 3 ans)))
15221 minute (string-to-number (match-string 2 ans))
15222 m2 (+ minute (if (match-end 5) (string-to-number
15223 (match-string 5 ans))0)))
15224 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15225 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15226 t t ans)))
15228 ;; Check if there is a time range
15229 (when (boundp 'org-end-time-was-given)
15230 (setq org-time-was-given nil)
15231 (when (and (string-match org-plain-time-of-day-regexp ans)
15232 (match-end 8))
15233 (setq org-end-time-was-given (match-string 8 ans))
15234 (setq ans (concat (substring ans 0 (match-beginning 7))
15235 (substring ans (match-end 7))))))
15237 (setq tl (parse-time-string ans)
15238 day (or (nth 3 tl) (nth 3 defdecode))
15239 month (or (nth 4 tl)
15240 (if (and org-read-date-prefer-future
15241 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15242 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15243 (nth 4 defdecode)))
15244 year (or (and (not kill-year) (nth 5 tl))
15245 (if (and org-read-date-prefer-future
15246 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15247 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15248 (nth 5 defdecode)))
15249 hour (or (nth 2 tl) (nth 2 defdecode))
15250 minute (or (nth 1 tl) (nth 1 defdecode))
15251 second (or (nth 0 tl) 0)
15252 wday (nth 6 tl))
15254 (when (and (eq org-read-date-prefer-future 'time)
15255 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15256 (equal day (nth 3 nowdecode))
15257 (equal month (nth 4 nowdecode))
15258 (equal year (nth 5 nowdecode))
15259 (nth 2 tl)
15260 (or (< (nth 2 tl) (nth 2 nowdecode))
15261 (and (= (nth 2 tl) (nth 2 nowdecode))
15262 (nth 1 tl)
15263 (< (nth 1 tl) (nth 1 nowdecode)))))
15264 (setq day (1+ day)
15265 futurep t))
15267 ;; Special date definitions below
15268 (cond
15269 (iso-week
15270 ;; There was an iso week
15271 (require 'cal-iso)
15272 (setq futurep nil)
15273 (setq year (or iso-year year)
15274 day (or iso-weekday wday 1)
15275 wday nil ; to make sure that the trigger below does not match
15276 iso-date (calendar-gregorian-from-absolute
15277 (calendar-absolute-from-iso
15278 (list iso-week day year))))
15279 ; FIXME: Should we also push ISO weeks into the future?
15280 ; (when (and org-read-date-prefer-future
15281 ; (not iso-year)
15282 ; (< (calendar-absolute-from-gregorian iso-date)
15283 ; (time-to-days (current-time))))
15284 ; (setq year (1+ year)
15285 ; iso-date (calendar-gregorian-from-absolute
15286 ; (calendar-absolute-from-iso
15287 ; (list iso-week day year)))))
15288 (setq month (car iso-date)
15289 year (nth 2 iso-date)
15290 day (nth 1 iso-date)))
15291 (deltan
15292 (setq futurep nil)
15293 (unless deltadef
15294 (let ((now (decode-time (current-time))))
15295 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15296 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15297 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15298 ((equal deltaw "m") (setq month (+ month deltan)))
15299 ((equal deltaw "y") (setq year (+ year deltan)))))
15300 ((and wday (not (nth 3 tl)))
15301 (setq futurep nil)
15302 ;; Weekday was given, but no day, so pick that day in the week
15303 ;; on or after the derived date.
15304 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15305 (unless (equal wday wday1)
15306 (setq day (+ day (% (- wday wday1 -7) 7))))))
15307 (if (and (boundp 'org-time-was-given)
15308 (nth 2 tl))
15309 (setq org-time-was-given t))
15310 (if (< year 100) (setq year (+ 2000 year)))
15311 ;; Check of the date is representable
15312 (if org-read-date-force-compatible-dates
15313 (progn
15314 (if (< year 1970)
15315 (setq year 1970 org-read-date-analyze-forced-year t))
15316 (if (> year 2037)
15317 (setq year 2037 org-read-date-analyze-forced-year t)))
15318 (condition-case nil
15319 (ignore (encode-time second minute hour day month year))
15320 (error
15321 (setq year (nth 5 defdecode))
15322 (setq org-read-date-analyze-forced-year t))))
15323 (setq org-read-date-analyze-futurep futurep)
15324 (list second minute hour day month year)))
15326 (defvar parse-time-weekdays)
15327 (defun org-read-date-get-relative (s today default)
15328 "Check string S for special relative date string.
15329 TODAY and DEFAULT are internal times, for today and for a default.
15330 Return shift list (N what def-flag)
15332 N is the number of WHATs to shift.
15333 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15334 the DEFAULT date rather than TODAY."
15335 (require 'parse-time)
15336 (when (and
15337 (string-match
15338 (concat
15343 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15344 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15345 (string-to-char (substring (match-string 1 s) -1))
15346 ?+))
15347 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15348 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15349 (what (if (match-end 3) (match-string 3 s) "d"))
15350 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15351 (date (if rel default today))
15352 (wday (nth 6 (decode-time date)))
15353 delta)
15354 (if wday1
15355 (progn
15356 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15357 (if (= dir ?-) (setq delta (- delta 7)))
15358 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15359 (list delta "d" rel))
15360 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15362 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15363 "Turn a user-specified date into the internal representation.
15364 The internal representation needed by the calendar is (month day year).
15365 This is a wrapper to handle the brain-dead convention in calendar that
15366 user function argument order change dependent on argument order."
15367 (if (boundp 'calendar-date-style)
15368 (cond
15369 ((eq calendar-date-style 'american)
15370 (list arg1 arg2 arg3))
15371 ((eq calendar-date-style 'european)
15372 (list arg2 arg1 arg3))
15373 ((eq calendar-date-style 'iso)
15374 (list arg2 arg3 arg1)))
15375 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15376 (if (org-bound-and-true-p european-calendar-style)
15377 (list arg2 arg1 arg3)
15378 (list arg1 arg2 arg3)))))
15380 (defun org-eval-in-calendar (form &optional keepdate)
15381 "Eval FORM in the calendar window and return to current window.
15382 Also, store the cursor date in variable org-ans2."
15383 (let ((sf (selected-frame))
15384 (sw (selected-window)))
15385 (select-window (get-buffer-window "*Calendar*" t))
15386 (eval form)
15387 (when (and (not keepdate) (calendar-cursor-to-date))
15388 (let* ((date (calendar-cursor-to-date))
15389 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15390 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15391 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15392 (select-window sw)
15393 (org-select-frame-set-input-focus sf)))
15395 (defun org-calendar-select ()
15396 "Return to `org-read-date' with the date currently selected.
15397 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15398 (interactive)
15399 (when (calendar-cursor-to-date)
15400 (let* ((date (calendar-cursor-to-date))
15401 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15402 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15403 (if (active-minibuffer-window) (exit-minibuffer))))
15405 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15406 "Insert a date stamp for the date given by the internal TIME.
15407 WITH-HM means use the stamp format that includes the time of the day.
15408 INACTIVE means use square brackets instead of angular ones, so that the
15409 stamp will not contribute to the agenda.
15410 PRE and POST are optional strings to be inserted before and after the
15411 stamp.
15412 The command returns the inserted time stamp."
15413 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15414 stamp)
15415 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15416 (insert-before-markers (or pre ""))
15417 (when (listp extra)
15418 (setq extra (car extra))
15419 (if (and (stringp extra)
15421 (setq extra (format "-%02d:%02d"
15422 (string-to-number (match-string 1 extra))
15423 (string-to-number (match-string 2 extra))))
15424 (setq extra nil)))
15425 (when extra
15426 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15427 (insert-before-markers (setq stamp (format-time-string fmt time)))
15428 (insert-before-markers (or post ""))
15429 (setq org-last-inserted-timestamp stamp)))
15431 (defun org-toggle-time-stamp-overlays ()
15432 "Toggle the use of custom time stamp formats."
15433 (interactive)
15434 (setq org-display-custom-times (not org-display-custom-times))
15435 (unless org-display-custom-times
15436 (let ((p (point-min)) (bmp (buffer-modified-p)))
15437 (while (setq p (next-single-property-change p 'display))
15438 (if (and (get-text-property p 'display)
15439 (eq (get-text-property p 'face) 'org-date))
15440 (remove-text-properties
15441 p (setq p (next-single-property-change p 'display))
15442 '(display t))))
15443 (set-buffer-modified-p bmp)))
15444 (if (featurep 'xemacs)
15445 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15446 (org-restart-font-lock)
15447 (setq org-table-may-need-update t)
15448 (if org-display-custom-times
15449 (message "Time stamps are overlaid with custom format")
15450 (message "Time stamp overlays removed")))
15452 (defun org-display-custom-time (beg end)
15453 "Overlay modified time stamp format over timestamp between BEG and END."
15454 (let* ((ts (buffer-substring beg end))
15455 t1 w1 with-hm tf time str w2 (off 0))
15456 (save-match-data
15457 (setq t1 (org-parse-time-string ts t))
15458 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15459 (setq off (- (match-end 0) (match-beginning 0)))))
15460 (setq end (- end off))
15461 (setq w1 (- end beg)
15462 with-hm (and (nth 1 t1) (nth 2 t1))
15463 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15464 time (org-fix-decoded-time t1)
15465 str (org-add-props
15466 (format-time-string
15467 (substring tf 1 -1) (apply 'encode-time time))
15468 nil 'mouse-face 'highlight)
15469 w2 (length str))
15470 (if (not (= w2 w1))
15471 (add-text-properties (1+ beg) (+ 2 beg)
15472 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15473 (if (featurep 'xemacs)
15474 (progn
15475 (put-text-property beg end 'invisible t)
15476 (put-text-property beg end 'end-glyph (make-glyph str)))
15477 (put-text-property beg end 'display str))))
15479 (defun org-translate-time (string)
15480 "Translate all timestamps in STRING to custom format.
15481 But do this only if the variable `org-display-custom-times' is set."
15482 (when org-display-custom-times
15483 (save-match-data
15484 (let* ((start 0)
15485 (re org-ts-regexp-both)
15486 t1 with-hm inactive tf time str beg end)
15487 (while (setq start (string-match re string start))
15488 (setq beg (match-beginning 0)
15489 end (match-end 0)
15490 t1 (save-match-data
15491 (org-parse-time-string (substring string beg end) t))
15492 with-hm (and (nth 1 t1) (nth 2 t1))
15493 inactive (equal (substring string beg (1+ beg)) "[")
15494 tf (funcall (if with-hm 'cdr 'car)
15495 org-time-stamp-custom-formats)
15496 time (org-fix-decoded-time t1)
15497 str (format-time-string
15498 (concat
15499 (if inactive "[" "<") (substring tf 1 -1)
15500 (if inactive "]" ">"))
15501 (apply 'encode-time time))
15502 string (replace-match str t t string)
15503 start (+ start (length str)))))))
15504 string)
15506 (defun org-fix-decoded-time (time)
15507 "Set 0 instead of nil for the first 6 elements of time.
15508 Don't touch the rest."
15509 (let ((n 0))
15510 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15512 (defun org-days-to-time (timestamp-string)
15513 "Difference between TIMESTAMP-STRING and now in days."
15514 (- (time-to-days (org-time-string-to-time timestamp-string))
15515 (time-to-days (current-time))))
15517 (defun org-deadline-close (timestamp-string &optional ndays)
15518 "Is the time in TIMESTAMP-STRING close to the current date?"
15519 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15520 (and (< (org-days-to-time timestamp-string) ndays)
15521 (not (org-entry-is-done-p))))
15523 (defun org-get-wdays (ts)
15524 "Get the deadline lead time appropriate for timestring TS."
15525 (cond
15526 ((<= org-deadline-warning-days 0)
15527 ;; 0 or negative, enforce this value no matter what
15528 (- org-deadline-warning-days))
15530 ;; lead time is specified.
15531 (floor (* (string-to-number (match-string 1 ts))
15532 (cdr (assoc (match-string 2 ts)
15533 '(("d" . 1) ("w" . 7)
15534 ("m" . 30.4) ("y" . 365.25)))))))
15535 ;; go for the default.
15536 (t org-deadline-warning-days)))
15538 (defun org-calendar-select-mouse (ev)
15539 "Return to `org-read-date' with the date currently selected.
15540 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15541 (interactive "e")
15542 (mouse-set-point ev)
15543 (when (calendar-cursor-to-date)
15544 (let* ((date (calendar-cursor-to-date))
15545 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15546 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15547 (if (active-minibuffer-window) (exit-minibuffer))))
15549 (defun org-check-deadlines (ndays)
15550 "Check if there are any deadlines due or past due.
15551 A deadline is considered due if it happens within `org-deadline-warning-days'
15552 days from today's date. If the deadline appears in an entry marked DONE,
15553 it is not shown. The prefix arg NDAYS can be used to test that many
15555 (interactive "P")
15556 (let* ((org-warn-days
15557 (cond
15558 ((equal ndays '(4)) 100000)
15559 (ndays (prefix-numeric-value ndays))
15560 (t (abs org-deadline-warning-days))))
15561 (case-fold-search nil)
15563 (callback
15564 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15566 (message "%d deadlines past-due or due within %d days"
15567 (org-occur regexp nil callback)
15568 org-warn-days)))
15570 (defun org-check-before-date (date)
15571 "Check if there are deadlines or scheduled entries before DATE."
15572 (interactive (list (org-read-date)))
15573 (let ((case-fold-search nil)
15577 (callback
15578 (lambda () (time-less-p
15579 (org-time-string-to-time (match-string 2))
15580 (org-time-string-to-time date)))))
15581 (message "%d entries before %s"
15582 (org-occur regexp nil callback) date)))
15584 (defun org-check-after-date (date)
15585 "Check if there are deadlines or scheduled entries after DATE."
15586 (interactive (list (org-read-date)))
15587 (let ((case-fold-search nil)
15591 (callback
15592 (lambda () (not
15593 (time-less-p
15594 (org-time-string-to-time (match-string 2))
15595 (org-time-string-to-time date))))))
15596 (message "%d entries after %s"
15597 (org-occur regexp nil callback) date)))
15599 (defun org-check-dates-range (start-date end-date)
15600 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15601 (interactive (list (org-read-date nil nil nil "Range starts")
15602 (org-read-date nil nil nil "Range end")))
15603 (let ((case-fold-search nil)
15607 (callback
15608 (lambda ()
15609 (let ((match (match-string 2)))
15610 (and
15611 (not (time-less-p
15612 (org-time-string-to-time match)
15613 (org-time-string-to-time start-date)))
15614 (time-less-p
15615 (org-time-string-to-time match)
15616 (org-time-string-to-time end-date)))))))
15617 (message "%d entries between %s and %s"
15618 (org-occur regexp nil callback) start-date end-date)))
15620 (defun org-evaluate-time-range (&optional to-buffer)
15621 "Evaluate a time range by computing the difference between start and end.
15622 Normally the result is just printed in the echo area, but with prefix arg
15623 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15624 If the time range is actually in a table, the result is inserted into the
15625 next column.
15626 For time difference computation, a year is assumed to be exactly 365
15627 days in order to avoid rounding problems."
15628 (interactive "P")
15629 (or
15630 (org-clock-update-time-maybe)
15631 (save-excursion
15632 (unless (org-at-date-range-p t)
15633 (goto-char (point-at-bol))
15634 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15635 (if (not (org-at-date-range-p t))
15636 (error "Not at a time-stamp range, and none found in current line")))
15637 (let* ((ts1 (match-string 1))
15638 (ts2 (match-string 2))
15639 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15640 (match-end (match-end 0))
15641 (time1 (org-time-string-to-time ts1))
15642 (time2 (org-time-string-to-time ts2))
15643 (t1 (org-float-time time1))
15644 (t2 (org-float-time time2))
15645 (diff (abs (- t2 t1)))
15646 (negative (< (- t2 t1) 0))
15647 ;; (ys (floor (* 365 24 60 60)))
15648 (ds (* 24 60 60))
15649 (hs (* 60 60))
15650 (fy "%dy %dd %02d:%02d")
15651 (fy1 "%dy %dd")
15652 (fd "%dd %02d:%02d")
15653 (fd1 "%dd")
15654 (fh "%02d:%02d")
15655 y d h m align)
15656 (if havetime
15657 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15658 y 0
15659 d (floor (/ diff ds)) diff (mod diff ds)
15660 h (floor (/ diff hs)) diff (mod diff hs)
15661 m (floor (/ diff 60)))
15662 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15663 y 0
15664 d (floor (+ (/ diff ds) 0.5))
15665 h 0 m 0))
15666 (if (not to-buffer)
15667 (message "%s" (org-make-tdiff-string y d h m))
15668 (if (org-at-table-p)
15669 (progn
15670 (goto-char match-end)
15671 (setq align t)
15672 (and (looking-at " *|") (goto-char (match-end 0))))
15673 (goto-char match-end))
15674 (if (looking-at
15676 (replace-match ""))
15677 (if negative (insert " -"))
15678 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15679 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15680 (insert " " (format fh h m))))
15681 (if align (org-table-align))
15682 (message "Time difference inserted")))))
15684 (defun org-make-tdiff-string (y d h m)
15685 (let ((fmt "")
15686 (l nil))
15687 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15688 l (push y l)))
15689 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15690 l (push d l)))
15691 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15692 l (push h l)))
15693 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15694 l (push m l)))
15695 (apply 'format fmt (nreverse l))))
15697 (defun org-time-string-to-time (s &optional buffer pos)
15698 (condition-case errdata
15699 (apply 'encode-time (org-parse-time-string s))
15701 s (if (not (and buffer pos))
15702 ""
15703 (format " at %d in buffer `%s'" pos buffer))
15704 (cdr errdata)))))
15706 (defun org-time-string-to-seconds (s)
15707 (org-float-time (org-time-string-to-time s)))
15709 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15710 "Convert a time stamp to an absolute day number.
15711 If there is a specifier for a cyclic time stamp, get the closest date to
15712 DAYNR.
15713 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15714 The variable date is bound by the calendar when this is called."
15715 (cond
15717 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15718 daynr
15719 (+ daynr 1000)))
15721 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15722 (time-to-days (current-time))) (match-string 0 s)
15723 prefer show-all))
15724 (t (time-to-days
15725 (condition-case errdata
15726 (apply 'encode-time (org-parse-time-string s))
15728 s (if (not (and buffer pos))
15729 ""
15730 (format " at %d in buffer `%s'" pos buffer))
15731 (cdr errdata))))))))
15733 (defun org-days-to-iso-week (days)
15734 "Return the iso week number."
15735 (require 'cal-iso)
15736 (car (calendar-iso-from-absolute days)))
15738 (defun org-small-year-to-year (year)
15739 "Convert 2-digit years into 4-digit years.
15740 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15741 The year 2000 cannot be abbreviated. Any year larger than 99
15742 is returned unchanged."
15743 (if (< year 38)
15744 (setq year (+ 2000 year))
15745 (if (< year 100)
15746 (setq year (+ 1900 year))))
15747 year)
15749 (defun org-time-from-absolute (d)
15750 "Return the time corresponding to date D.
15751 D may be an absolute day number, or a calendar-type list (month day year)."
15752 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15753 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15755 (defun org-calendar-holiday ()
15756 "List of holidays, for Diary display in Org-mode."
15757 (require 'holidays)
15758 (let ((hl (funcall
15759 (if (fboundp 'calendar-check-holidays)
15760 'calendar-check-holidays 'check-calendar-holidays) date)))
15761 (if hl (mapconcat 'identity hl "; "))))
15763 (defun org-diary-sexp-entry (sexp entry date)
15764 "Process a SEXP diary ENTRY for DATE."
15765 (require 'diary-lib)
15766 (let ((result (if calendar-debug-sexp
15767 (let ((stack-trace-on-error t))
15768 (eval (car (read-from-string sexp))))
15769 (condition-case nil
15770 (eval (car (read-from-string sexp)))
15771 (error
15772 (beep)
15773 (message "Bad sexp at line %d in %s: %s"
15774 (org-current-line)
15775 (buffer-file-name) sexp)
15776 (sleep-for 2))))))
15777 (cond ((stringp result) (split-string result "; "))
15778 ((and (consp result)
15779 (not (consp (cdr result)))
15780 (stringp (cdr result))) (cdr result))
15781 ((and (consp result)
15782 (stringp (car result))) result)
15783 (result entry)
15784 (t nil))))
15786 (defun org-diary-to-ical-string (frombuf)
15787 "Get iCalendar entries from diary entries in buffer FROMBUF.
15788 This uses the icalendar.el library."
15789 (let* ((tmpdir (if (featurep 'xemacs)
15790 (temp-directory)
15791 temporary-file-directory))
15792 (tmpfile (make-temp-name
15793 (expand-file-name "orgics" tmpdir)))
15794 buf rtn b e)
15795 (with-current-buffer frombuf
15796 (icalendar-export-region (point-min) (point-max) tmpfile)
15797 (setq buf (find-buffer-visiting tmpfile))
15798 (set-buffer buf)
15799 (goto-char (point-min))
15800 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15801 (setq b (match-beginning 0)))
15802 (goto-char (point-max))
15803 (if (re-search-backward "^END:VEVENT" nil t)
15804 (setq e (match-end 0)))
15806 (kill-buffer buf)
15807 (delete-file tmpfile)
15808 rtn))
15810 (defun org-closest-date (start current change prefer show-all)
15811 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15812 When PREFER is `past', return a date that is either CURRENT or past.
15813 When PREFER is `future', return a date that is either CURRENT or future.
15814 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15815 ;; Make the proper lists from the dates
15816 (catch 'exit
15817 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15818 dn dw sday cday n1 n2 n0
15819 d m y y1 y2 date1 date2 nmonths nm ny m2)
15821 (setq start (org-date-to-gregorian start)
15822 current (org-date-to-gregorian
15823 (if show-all
15824 current
15825 (time-to-days (current-time))))
15826 sday (calendar-absolute-from-gregorian start)
15827 cday (calendar-absolute-from-gregorian current))
15829 (if (<= cday sday) (throw 'exit sday))
15832 (setq dn (string-to-number (match-string 1 change))
15833 dw (cdr (assoc (match-string 2 change) a1)))
15834 (error "Invalid change specifier: %s" change))
15835 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15836 (cond
15837 ((eq dw 'day)
15838 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15839 n2 (+ n1 dn)))
15840 ((eq dw 'year)
15841 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15842 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15843 (setq date1 (list m d y1)
15844 n1 (calendar-absolute-from-gregorian date1)
15845 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15846 n2 (calendar-absolute-from-gregorian date2)))
15847 ((eq dw 'month)
15848 ;; approx number of month between the two dates
15849 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15850 ;; How often does dn fit in there?
15851 (setq d (nth 1 start) m (car start) y (nth 2 start)
15852 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15853 m (+ m nm)
15854 ny (floor (/ m 12))
15855 y (+ y ny)
15856 m (- m (* ny 12)))
15857 (while (> m 12) (setq m (- m 12) y (1+ y)))
15858 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15859 (setq m2 (+ m dn) y2 y)
15860 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15861 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15862 (while (<= n2 cday)
15863 (setq n1 n2 m m2 y y2)
15864 (setq m2 (+ m dn) y2 y)
15865 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15866 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15867 ;; Make sure n1 is the earlier date
15868 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15869 (if show-all
15870 (cond
15871 ((eq prefer 'past) (if (= cday n2) n2 n1))
15872 ((eq prefer 'future) (if (= cday n1) n1 n2))
15873 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15874 (cond
15875 ((eq prefer 'past) (if (= cday n2) n2 n1))
15876 ((eq prefer 'future) (if (= cday n1) n1 n2))
15877 (t (if (= cday n1) n1 n2)))))))
15879 (defun org-date-to-gregorian (date)
15880 "Turn any specification of DATE into a Gregorian date for the calendar."
15881 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15882 ((and (listp date) (= (length date) 3)) date)
15883 ((stringp date)
15884 (setq date (org-parse-time-string date))
15885 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15886 ((listp date)
15887 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15889 (defun org-parse-time-string (s &optional nodefault)
15890 "Parse the standard Org-mode time string.
15891 This should be a lot faster than the normal `parse-time-string'.
15892 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15893 hour and minute fields will be nil if not given."
15894 (if (string-match org-ts-regexp0 s)
15895 (list 0
15896 (if (or (match-beginning 8) (not nodefault))
15897 (string-to-number (or (match-string 8 s) "0")))
15898 (if (or (match-beginning 7) (not nodefault))
15899 (string-to-number (or (match-string 7 s) "0")))
15900 (string-to-number (match-string 4 s))
15901 (string-to-number (match-string 3 s))
15902 (string-to-number (match-string 2 s))
15903 nil nil nil)
15904 (error "Not a standard Org-mode time string: %s" s)))
15906 (defun org-timestamp-up (&optional arg)
15907 "Increase the date item at the cursor by one.
15908 If the cursor is on the year, change the year. If it is on the month,
15909 the day or the time, change that.
15910 With prefix ARG, change by that many units."
15911 (interactive "p")
15912 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15914 (defun org-timestamp-down (&optional arg)
15915 "Decrease the date item at the cursor by one.
15916 If the cursor is on the year, change the year. If it is on the month,
15917 the day or the time, change that.
15918 With prefix ARG, change by that many units."
15919 (interactive "p")
15920 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15922 (defun org-timestamp-up-day (&optional arg)
15923 "Increase the date in the time stamp by one day.
15924 With prefix ARG, change that many days."
15925 (interactive "p")
15926 (if (and (not (org-at-timestamp-p t))
15927 (org-at-heading-p))
15928 (org-todo 'up)
15929 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15931 (defun org-timestamp-down-day (&optional arg)
15932 "Decrease the date in the time stamp by one day.
15933 With prefix ARG, change that many days."
15934 (interactive "p")
15935 (if (and (not (org-at-timestamp-p t))
15936 (org-at-heading-p))
15937 (org-todo 'down)
15938 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15940 (defun org-at-timestamp-p (&optional inactive-ok)
15941 "Determine if the cursor is in or at a timestamp."
15942 (interactive)
15943 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15944 (pos (point))
15945 (ans (or (looking-at tsr)
15946 (save-excursion
15948 (if (> (point) (point-min)) (backward-char 1))
15949 (and (looking-at tsr)
15950 (> (- (match-end 0) pos) -1))))))
15951 (and ans
15952 (boundp 'org-ts-what)
15953 (setq org-ts-what
15954 (cond
15955 ((= pos (match-beginning 0)) 'bracket)
15956 ;; Point is considered to be "on the bracket" whether
15957 ;; it's really on it or right after it.
15958 ((or (= pos (1- (match-end 0)))
15959 (= pos (match-end 0))) 'bracket)
15960 ((org-pos-in-match-range pos 2) 'year)
15961 ((org-pos-in-match-range pos 3) 'month)
15962 ((org-pos-in-match-range pos 7) 'hour)
15963 ((org-pos-in-match-range pos 8) 'minute)
15964 ((or (org-pos-in-match-range pos 4)
15965 (org-pos-in-match-range pos 5)) 'day)
15966 ((and (> pos (or (match-end 8) (match-end 5)))
15967 (< pos (match-end 0)))
15968 (- pos (or (match-end 8) (match-end 5))))
15969 (t 'day))))
15970 ans))
15972 (defun org-toggle-timestamp-type ()
15973 "Toggle the type (<active> or [inactive]) of a time stamp."
15974 (interactive)
15975 (when (org-at-timestamp-p t)
15976 (let ((beg (match-beginning 0)) (end (match-end 0))
15977 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15978 (save-excursion
15979 (goto-char beg)
15980 (while (re-search-forward "[][<>]" end t)
15981 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15982 t t)))
15983 (message "Timestamp is now %sactive"
15984 (if (equal (char-after beg) ?<) "" "in")))))
15986 (defun org-timestamp-change (n &optional what updown)
15987 "Change the date in the time stamp at point.
15988 The date will be changed by N times WHAT. WHAT can be `day', `month',
15989 `year', `minute', `second'. If WHAT is not given, the cursor position
15990 in the timestamp determines what will be changed."
15991 (let ((origin (point)) origin-cat
15992 with-hm inactive
15993 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15994 org-ts-what
15995 extra rem
15996 ts time time0)
15997 (if (not (org-at-timestamp-p t))
15998 (error "Not at a timestamp"))
15999 (if (and (not what) (eq org-ts-what 'bracket))
16000 (org-toggle-timestamp-type)
16001 ;; Point isn't on brackets. Remember the part of the time-stamp
16002 ;; the point was in. Indeed, size of time-stamps may change,
16003 ;; but point must be kept in the same category nonetheless.
16004 (setq origin-cat org-ts-what)
16005 (if (and (not what) (not (eq org-ts-what 'day))
16006 org-display-custom-times
16007 (get-text-property (point) 'display)
16008 (not (get-text-property (1- (point)) 'display)))
16009 (setq org-ts-what 'day))
16010 (setq org-ts-what (or what org-ts-what)
16011 inactive (= (char-after (match-beginning 0)) ?\[)
16012 ts (match-string 0))
16013 (replace-match "")
16014 (if (string-match
16016 ts)
16017 (setq extra (match-string 1 ts)))
16019 (setq with-hm t))
16020 (setq time0 (org-parse-time-string ts))
16021 (when (and updown
16022 (eq org-ts-what 'minute)
16023 (not current-prefix-arg))
16024 ;; This looks like s-up and s-down. Change by one rounding step.
16025 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16026 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16027 (setcar (cdr time0) (+ (nth 1 time0)
16028 (if (> n 0) (- rem) (- dm rem))))))
16029 (setq time
16030 (encode-time (or (car time0) 0)
16031 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16032 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16033 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16034 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16035 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16036 (nthcdr 6 time0)))
16037 (when (and (member org-ts-what '(hour minute))
16038 extra
16040 (setq extra (org-modify-ts-extra
16041 extra
16042 (if (eq org-ts-what 'hour) 2 5)
16043 n dm)))
16044 (when (integerp org-ts-what)
16045 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16046 (if (eq what 'calendar)
16047 (let ((cal-date (org-get-date-from-calendar)))
16048 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16049 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16050 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16051 (setcar time0 (or (car time0) 0))
16052 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16053 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16054 (setq time (apply 'encode-time time0))))
16055 ;; Insert the new time-stamp, and ensure point stays in the same
16056 ;; category as before (i.e. not after the last position in that
16057 ;; category).
16058 (let ((pos (point)))
16059 ;; Stay before inserted string. `save-excursion' is of no use.
16060 (setq org-last-changed-timestamp
16061 (org-insert-time-stamp time with-hm inactive nil nil extra))
16062 (goto-char pos))
16063 (save-match-data
16064 (looking-at org-ts-regexp3)
16065 (goto-char (cond
16066 ;; `day' category ends before `hour' if any, or at
16067 ;; the end of the day name.
16068 ((eq origin-cat 'day)
16069 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16070 ((eq origin-cat 'hour) (min (match-end 7) origin))
16071 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16072 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16073 ;; `year' and `month' have both fixed size: point
16074 ;; couldn't have moved into another part.
16075 (t origin))))
16076 ;; Update clock if on a CLOCK line.
16077 (org-clock-update-time-maybe)
16078 ;; Try to recenter the calendar window, if any.
16079 (if (and org-calendar-follow-timestamp-change
16080 (get-buffer-window "*Calendar*" t)
16081 (memq org-ts-what '(day month year)))
16082 (org-recenter-calendar (time-to-days time))))))
16084 (defun org-modify-ts-extra (s pos n dm)
16085 "Change the different parts of the lead-time and repeat fields in timestamp."
16086 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16087 ng h m new rem)
16088 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16089 (cond
16090 ((or (org-pos-in-match-range pos 2)
16091 (org-pos-in-match-range pos 3))
16092 (setq m (string-to-number (match-string 3 s))
16093 h (string-to-number (match-string 2 s)))
16094 (if (org-pos-in-match-range pos 2)
16095 (setq h (+ h n))
16096 (setq n (* dm (org-no-warnings (signum n))))
16097 (when (not (= 0 (setq rem (% m dm))))
16098 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16099 (setq m (+ m n)))
16100 (if (< m 0) (setq m (+ m 60) h (1- h)))
16101 (if (> m 59) (setq m (- m 60) h (1+ h)))
16102 (setq h (min 24 (max 0 h)))
16103 (setq ng 1 new (format "-%02d:%02d" h m)))
16104 ((org-pos-in-match-range pos 6)
16105 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16106 ((org-pos-in-match-range pos 5)
16107 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16109 ((org-pos-in-match-range pos 9)
16110 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16111 ((org-pos-in-match-range pos 8)
16112 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16114 (when ng
16115 (setq s (concat
16116 (substring s 0 (match-beginning ng))
16117 new
16118 (substring s (match-end ng))))))
16119 s))
16121 (defun org-recenter-calendar (date)
16122 "If the calendar is visible, recenter it to DATE."
16123 (let ((cwin (get-buffer-window "*Calendar*" t)))
16124 (when cwin
16125 (let ((calendar-move-hook nil))
16126 (with-selected-window cwin
16127 (calendar-goto-date (if (listp date) date
16128 (calendar-gregorian-from-absolute date))))))))
16130 (defun org-goto-calendar (&optional arg)
16131 "Go to the Emacs calendar at the current date.
16132 If there is a time stamp in the current line, go to that date.
16133 A prefix ARG can be used to force the current date."
16134 (interactive "P")
16135 (let ((tsr org-ts-regexp) diff
16136 (calendar-move-hook nil)
16137 (calendar-view-holidays-initially-flag nil)
16138 (calendar-view-diary-initially-flag nil))
16139 (if (or (org-at-timestamp-p)
16140 (save-excursion
16141 (beginning-of-line 1)
16142 (looking-at (concat ".*" tsr))))
16143 (let ((d1 (time-to-days (current-time)))
16144 (d2 (time-to-days
16145 (org-time-string-to-time (match-string 1)))))
16146 (setq diff (- d2 d1))))
16147 (calendar)
16148 (calendar-goto-today)
16149 (if (and diff (not arg)) (calendar-forward-day diff))))
16151 (defun org-get-date-from-calendar ()
16152 "Return a list (month day year) of date at point in calendar."
16153 (with-current-buffer "*Calendar*"
16154 (save-match-data
16155 (calendar-cursor-to-date))))
16157 (defun org-date-from-calendar ()
16158 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16159 If there is already a time stamp at the cursor position, update it."
16160 (interactive)
16161 (if (org-at-timestamp-p t)
16162 (org-timestamp-change 0 'calendar)
16163 (let ((cal-date (org-get-date-from-calendar)))
16164 (org-insert-time-stamp
16165 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16167 (defun org-minutes-to-hh:mm-string (m)
16168 "Compute H:MM from a number of minutes."
16169 (let ((h (/ m 60)))
16170 (setq m (- m (* 60 h)))
16171 (format org-time-clocksum-format h m)))
16173 (defun org-hh:mm-string-to-minutes (s)
16174 "Convert a string H:MM to a number of minutes.
16175 If the string is just a number, interpret it as minutes.
16176 In fact, the first hh:mm or number in the string will be taken,
16177 there can be extra stuff in the string.
16178 If no number is found, the return value is 0."
16179 (cond
16180 ((integerp s) s)
16182 (+ (* (string-to-number (match-string 1 s)) 60)
16183 (string-to-number (match-string 2 s))))
16185 (string-to-number (match-string 1 s)))
16186 (t 0)))
16188 (defcustom org-effort-durations
16189 `(("h" . 60)
16190 ("d" . ,(* 60 8))
16191 ("w" . ,(* 60 8 5))
16192 ("m" . ,(* 60 8 5 4))
16193 ("y" . ,(* 60 8 5 40)))
16194 "Conversion factor to minutes for an effort modifier.
16196 Each entry has the form (MODIFIER . MINUTES).
16198 In an effort string, a number followed by MODIFIER is multiplied
16199 by the specified number of MINUTES to obtain an effort in
16200 minutes.
16204 :group 'org-agenda
16205 :type '(alist :key-type (string :tag "Modifier")
16206 :value-type (number :tag "Minutes")))
16208 (defun org-duration-string-to-minutes (s)
16209 "Convert a duration string S to minutes.
16211 A bare number is interpreted as minutes, modifiers can be set by
16212 customizing `org-effort-durations' (which see).
16214 Entries containing a colon are interpreted as H:MM by
16215 `org-hh:mm-string-to-minutes'."
16216 (let ((result 0)
16218 (regexp-opt (mapcar 'car org-effort-durations))
16220 (while (string-match re s)
16221 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16222 (string-to-number (match-string 1 s))))
16223 (setq s (replace-match "" nil t s)))
16224 (incf result (org-hh:mm-string-to-minutes s))
16225 result))
16227 ;;;; Files
16229 (defun org-save-all-org-buffers ()
16230 "Save all Org-mode buffers without user confirmation."
16231 (interactive)
16232 (message "Saving all Org-mode buffers...")
16233 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16234 (when (featurep 'org-id) (org-id-locations-save))
16235 (message "Saving all Org-mode buffers... done"))
16237 (defun org-revert-all-org-buffers ()
16238 "Revert all Org-mode buffers.
16239 Prompt for confirmation when there are unsaved changes.
16240 Be sure you know what you are doing before letting this function
16241 overwrite your changes.
16243 This function is useful in a setup where one tracks org files
16244 with a version control system, to revert on one machine after pulling
16245 changes from another. I believe the procedure must be like this:
16247 1. M-x org-save-all-org-buffers
16248 2. Pull changes from the other machine, resolve conflicts
16249 3. M-x org-revert-all-org-buffers"
16250 (interactive)
16251 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16252 (error "Abort"))
16253 (save-excursion
16254 (save-window-excursion
16255 (mapc
16256 (lambda (b)
16257 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16258 (with-current-buffer b buffer-file-name))
16259 (org-pop-to-buffer-same-window b)
16260 (revert-buffer t 'no-confirm)))
16261 (buffer-list))
16262 (when (and (featurep 'org-id) org-id-track-globally)
16263 (org-id-locations-load)))))
16265 ;;;; Agenda files
16267 ;;;###autoload
16268 (defun org-switchb (&optional arg)
16269 "Switch between Org buffers.
16270 With one prefix argument, restrict available buffers to files.
16271 With two prefix arguments, restrict available buffers to agenda files.
16273 Defaults to `iswitchb' for buffer name completion.
16274 Set `org-completion-use-ido' to make it use ido instead."
16275 (interactive "P")
16276 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16277 ((equal arg '(16)) (org-buffer-list 'agenda))
16278 (t (org-buffer-list))))
16279 (org-completion-use-iswitchb org-completion-use-iswitchb)
16280 (org-completion-use-ido org-completion-use-ido))
16281 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16282 (setq org-completion-use-iswitchb t))
16283 (org-pop-to-buffer-same-window
16284 (org-icompleting-read "Org buffer: "
16285 (mapcar 'list (mapcar 'buffer-name blist))
16286 nil t))))
16288 ;;; Define some older names previously used for this functionality
16289 ;;;###autoload
16290 (defalias 'org-ido-switchb 'org-switchb)
16291 ;;;###autoload
16292 (defalias 'org-iswitchb 'org-switchb)
16294 (defun org-buffer-list (&optional predicate exclude-tmp)
16295 "Return a list of Org buffers.
16296 PREDICATE can be `export', `files' or `agenda'.
16298 export restrict the list to Export buffers.
16299 files restrict the list to buffers visiting Org files.
16300 agenda restrict the list to buffers visiting agenda files.
16302 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16303 (let* ((bfn nil)
16304 (agenda-files (and (eq predicate 'agenda)
16305 (mapcar 'file-truename (org-agenda-files t))))
16306 (filter
16307 (cond
16308 ((eq predicate 'files)
16309 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16310 ((eq predicate 'export)
16311 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16312 ((eq predicate 'agenda)
16313 (lambda (b)
16314 (with-current-buffer b
16315 (and (eq major-mode 'org-mode)
16316 (setq bfn (buffer-file-name b))
16317 (member (file-truename bfn) agenda-files)))))
16318 (t (lambda (b) (with-current-buffer b
16319 (or (eq major-mode 'org-mode)
16320 (string-match "\*Org .*Export"
16321 (buffer-name b)))))))))
16322 (delq nil
16323 (mapcar
16324 (lambda(b)
16325 (if (and (funcall filter b)
16326 (or (not exclude-tmp)
16327 (not (string-match "tmp" (buffer-name b)))))
16328 b
16329 nil))
16330 (buffer-list)))))
16332 (defun org-agenda-files (&optional unrestricted archives)
16333 "Get the list of agenda files.
16334 Optional UNRESTRICTED means return the full list even if a restriction
16335 is currently in place.
16336 When ARCHIVES is t, include all archive files that are really being
16337 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16338 `org-agenda-archives-mode' is t."
16339 (let ((files
16340 (cond
16341 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16342 ((stringp org-agenda-files) (org-read-agenda-file-list))
16343 ((listp org-agenda-files) org-agenda-files)
16344 (t (error "Invalid value of `org-agenda-files'")))))
16345 (setq files (apply 'append
16346 (mapcar (lambda (f)
16347 (if (file-directory-p f)
16348 (directory-files
16349 f t org-agenda-file-regexp)
16350 (list f)))
16351 files)))
16352 (when org-agenda-skip-unavailable-files
16353 (setq files (delq nil
16354 (mapcar (function
16355 (lambda (file)
16356 (and (file-readable-p file) file)))
16357 files))))
16358 (when (or (eq archives t)
16359 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16360 (setq files (org-add-archive-files files)))
16361 files))
16363 (defun org-agenda-file-p (&optional file)
16364 "Return non-nil, if FILE is an agenda file.
16365 If FILE is omitted, use the file associated with the current
16366 buffer."
16367 (member (or file (buffer-file-name))
16368 (org-agenda-files t)))
16370 (defun org-edit-agenda-file-list ()
16371 "Edit the list of agenda files.
16372 Depending on setup, this either uses customize to edit the variable
16373 `org-agenda-files', or it visits the file that is holding the list. In the
16374 latter case, the buffer is set up in a way that saving it automatically kills
16375 the buffer and restores the previous window configuration."
16376 (interactive)
16377 (if (stringp org-agenda-files)
16378 (let ((cw (current-window-configuration)))
16379 (find-file org-agenda-files)
16380 (org-set-local 'org-window-configuration cw)
16381 (org-add-hook 'after-save-hook
16382 (lambda ()
16383 (set-window-configuration
16384 (prog1 org-window-configuration
16385 (kill-buffer (current-buffer))))
16386 (org-install-agenda-files-menu)
16387 (message "New agenda file list installed"))
16388 nil 'local)
16389 (message "%s" (substitute-command-keys
16391 (customize-variable 'org-agenda-files)))
16393 (defun org-store-new-agenda-file-list (list)
16394 "Set new value for the agenda file list and save it correctly."
16395 (if (stringp org-agenda-files)
16396 (let ((fe (org-read-agenda-file-list t)) b u)
16397 (while (setq b (find-buffer-visiting org-agenda-files))
16398 (kill-buffer b))
16399 (with-temp-file org-agenda-files
16400 (insert
16401 (mapconcat
16402 (lambda (f) ;; Keep un-expanded entries.
16403 (if (setq u (assoc f fe))
16404 (cdr u)
16405 f))
16408 (let ((org-mode-hook nil) (org-inhibit-startup t)
16409 (org-insert-mode-line-in-empty-file nil))
16410 (setq org-agenda-files list)
16411 (customize-save-variable 'org-agenda-files org-agenda-files))))
16413 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16414 "Read the list of agenda files from a file.
16415 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16416 filenames, used by `org-store-new-agenda-file-list' to write back
16417 un-expanded file names."
16418 (when (file-directory-p org-agenda-files)
16419 (error "`org-agenda-files' cannot be a single directory"))
16420 (when (stringp org-agenda-files)
16421 (with-temp-buffer
16422 (insert-file-contents org-agenda-files)
16423 (mapcar
16424 (lambda (f)
16425 (let ((e (expand-file-name (substitute-in-file-name f)
16426 org-directory)))
16427 (if pair-with-expansion
16428 (cons e f)
16429 e)))
16432 ;;;###autoload
16433 (defun org-cycle-agenda-files ()
16434 "Cycle through the files in `org-agenda-files'.
16435 If the current buffer visits an agenda file, find the next one in the list.
16436 If the current buffer does not, find the first agenda file."
16437 (interactive)
16438 (let* ((fs (org-agenda-files t))
16439 (files (append fs (list (car fs))))
16440 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16441 file)
16442 (unless files (error "No agenda files"))
16443 (catch 'exit
16444 (while (setq file (pop files))
16445 (if (equal (file-truename file) tcf)
16446 (when (car files)
16447 (find-file (car files))
16448 (throw 'exit t))))
16449 (find-file (car fs)))
16450 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16452 (defun org-agenda-file-to-front (&optional to-end)
16453 "Move/add the current file to the top of the agenda file list.
16454 If the file is not present in the list, it is added to the front. If it is
16455 present, it is moved there. With optional argument TO-END, add/move to the
16456 end of the list."
16457 (interactive "P")
16458 (let ((org-agenda-skip-unavailable-files nil)
16459 (file-alist (mapcar (lambda (x)
16460 (cons (file-truename x) x))
16461 (org-agenda-files t)))
16462 (ctf (file-truename buffer-file-name))
16463 x had)
16464 (setq x (assoc ctf file-alist) had x)
16466 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16467 (if to-end
16468 (setq file-alist (append (delq x file-alist) (list x)))
16469 (setq file-alist (cons x (delq x file-alist))))
16470 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16471 (org-install-agenda-files-menu)
16472 (message "File %s to %s of agenda file list"
16473 (if had "moved" "added") (if to-end "end" "front"))))
16475 (defun org-remove-file (&optional file)
16476 "Remove current file from the list of files in variable `org-agenda-files'.
16477 These are the files which are being checked for agenda entries.
16478 Optional argument FILE means use this file instead of the current."
16479 (interactive)
16480 (let* ((org-agenda-skip-unavailable-files nil)
16481 (file (or file buffer-file-name))
16482 (true-file (file-truename file))
16483 (afile (abbreviate-file-name file))
16484 (files (delq nil (mapcar
16485 (lambda (x)
16486 (if (equal true-file
16487 (file-truename x))
16488 nil x))
16489 (org-agenda-files t)))))
16490 (if (not (= (length files) (length (org-agenda-files t))))
16491 (progn
16492 (org-store-new-agenda-file-list files)
16493 (org-install-agenda-files-menu)
16494 (message "Removed file: %s" afile))
16495 (message "File was not in list: %s (not removed)" afile))))
16497 (defun org-file-menu-entry (file)
16498 (vector file (list 'find-file file) t))
16500 (defun org-check-agenda-file (file)
16501 "Make sure FILE exists. If not, ask user what to do."
16502 (when (not (file-exists-p file))
16503 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16504 (abbreviate-file-name file))
16505 (let ((r (downcase (read-char-exclusive))))
16506 (cond
16507 ((equal r ?r)
16508 (org-remove-file file)
16509 (throw 'nextfile t))
16510 (t (error "Abort"))))))
16512 (defun org-get-agenda-file-buffer (file)
16513 "Get a buffer visiting FILE. If the buffer needs to be created, add
16514 it to the list of buffers which might be released later."
16515 (let ((buf (org-find-base-buffer-visiting file)))
16516 (if buf
16517 buf ; just return it
16518 ;; Make a new buffer and remember it
16519 (setq buf (find-file-noselect file))
16520 (if buf (push buf org-agenda-new-buffers))
16521 buf)))
16523 (defun org-release-buffers (blist)
16524 "Release all buffers in list, asking the user for confirmation when needed.
16525 When a buffer is unmodified, it is just killed. When modified, it is saved
16526 \(if the user agrees) and then killed."
16527 (let (buf file)
16528 (while (setq buf (pop blist))
16529 (setq file (buffer-file-name buf))
16530 (when (and (buffer-modified-p buf)
16531 file
16532 (y-or-n-p (format "Save file %s? " file)))
16533 (with-current-buffer buf (save-buffer)))
16534 (kill-buffer buf))))
16536 (defun org-prepare-agenda-buffers (files)
16537 "Create buffers for all agenda files, protect archived trees and comments."
16538 (interactive)
16539 (let ((pa '(:org-archived t))
16540 (pc '(:org-comment t))
16541 (pall '(:org-archived t :org-comment t))
16542 (inhibit-read-only t)
16543 (rea (concat ":" org-archive-tag ":"))
16544 bmp file re)
16545 (save-excursion
16546 (save-restriction
16547 (while (setq file (pop files))
16548 (catch 'nextfile
16549 (if (bufferp file)
16550 (set-buffer file)
16551 (org-check-agenda-file file)
16552 (set-buffer (org-get-agenda-file-buffer file)))
16553 (widen)
16554 (setq bmp (buffer-modified-p))
16555 (org-refresh-category-properties)
16556 (setq org-todo-keywords-for-agenda
16557 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16558 (setq org-done-keywords-for-agenda
16559 (append org-done-keywords-for-agenda org-done-keywords))
16560 (setq org-todo-keyword-alist-for-agenda
16561 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16562 (setq org-drawers-for-agenda
16563 (append org-drawers-for-agenda org-drawers))
16564 (setq org-tag-alist-for-agenda
16565 (append org-tag-alist-for-agenda org-tag-alist))
16567 (save-excursion
16568 (remove-text-properties (point-min) (point-max) pall)
16569 (when org-agenda-skip-archived-trees
16570 (goto-char (point-min))
16571 (while (re-search-forward rea nil t)
16572 (if (org-at-heading-p t)
16573 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16574 (goto-char (point-min))
16575 (setq re (format org-heading-keyword-regexp-format
16576 org-comment-string))
16577 (while (re-search-forward re nil t)
16578 (add-text-properties
16579 (match-beginning 0) (org-end-of-subtree t) pc)))
16580 (set-buffer-modified-p bmp)))))
16581 (setq org-todo-keywords-for-agenda
16582 (org-uniquify org-todo-keywords-for-agenda))
16583 (setq org-todo-keyword-alist-for-agenda
16584 (org-uniquify org-todo-keyword-alist-for-agenda)
16585 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16587 ;;;; Embedded LaTeX
16589 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16590 "Keymap for the minor `org-cdlatex-mode'.")
16592 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16593 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16594 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16595 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16596 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16598 (defvar org-cdlatex-texmathp-advice-is-done nil
16599 "Flag remembering if we have applied the advice to texmathp already.")
16601 (define-minor-mode org-cdlatex-mode
16602 "Toggle the minor `org-cdlatex-mode'.
16603 This mode supports entering LaTeX environment and math in LaTeX fragments
16604 in Org-mode.
16606 nil " OCDL" nil
16607 (when org-cdlatex-mode
16608 (require 'cdlatex)
16609 (run-hooks 'cdlatex-mode-hook)
16610 (cdlatex-compute-tables))
16611 (unless org-cdlatex-texmathp-advice-is-done
16612 (setq org-cdlatex-texmathp-advice-is-done t)
16613 (defadvice texmathp (around org-math-always-on activate)
16614 "Always return t in org-mode buffers.
16615 This is because we want to insert math symbols without dollars even outside
16616 the LaTeX math segments. If Orgmode thinks that point is actually inside
16617 an embedded LaTeX fragment, let texmathp do its job.
16619 (interactive)
16620 (let (p)
16621 (cond
16622 ((not (eq major-mode 'org-mode)) ad-do-it)
16623 ((eq this-command 'cdlatex-math-symbol)
16624 (setq ad-return-value t
16625 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16626 (t
16627 (let ((p (org-inside-LaTeX-fragment-p)))
16628 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16629 (setq ad-return-value t
16630 texmathp-why '("Org-mode embedded math" . 0))
16631 (if p ad-do-it)))))))))
16633 (defun turn-on-org-cdlatex ()
16634 "Unconditionally turn on `org-cdlatex-mode'."
16635 (org-cdlatex-mode 1))
16637 (defun org-inside-LaTeX-fragment-p ()
16638 "Test if point is inside a LaTeX fragment.
16640 sequence appearing also before point.
16641 Even though the matchers for math are configurable, this function assumes
16643 delimiters are skipped when they have been removed by customization.
16644 The return value is nil, or a cons cell with the delimiter and the
16645 position of this delimiter.
16647 This function does a reasonably good job, but can locally be fooled by
16648 for example currency specifications. For example it will assume being in
16650 fragments that are properly closed, but during editing, we have to live
16651 with the uncertainty caused by missing closing delimiters. This function
16652 looks only before point, not after."
16653 (catch 'exit
16654 (let ((pos (point))
16655 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16656 (lim (progn
16658 (point)))
16659 dd-on str (start 0) m re)
16660 (goto-char pos)
16661 (when dodollar
16663 re (nth 1 (assoc "$" org-latex-regexps)))
16664 (while (string-match re str start)
16665 (cond
16666 ((= (match-end 0) (length str))
16667 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16668 ((= (match-end 0) (- (length str) 5))
16669 (throw 'exit nil))
16670 (t (setq start (match-end 0))))))
16671 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16672 (goto-char pos)
16673 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16674 (and (match-beginning 2) (throw 'exit nil))
16675 ;; count $$
16677 (setq dd-on (not dd-on)))
16678 (goto-char pos)
16679 (if dd-on (cons "$$" m))))))
16681 (defun org-inside-latex-macro-p ()
16682 "Is point inside a LaTeX macro or its arguments?"
16683 (save-match-data
16684 (org-in-regexp
16687 (defun org-try-cdlatex-tab ()
16688 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16689 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16690 - inside a LaTeX fragment, or
16691 - after the first word in a line, where an abbreviation expansion could
16692 insert a LaTeX environment."
16693 (when org-cdlatex-mode
16694 (cond
16695 ;; Before any word on the line: No expansion possible.
16697 ;; Just after first word on the line: Expand it. Make sure it
16698 ;; cannot happen on headlines, though.
16699 ((save-excursion
16700 (skip-chars-backward "a-zA-Z0-9*")
16702 (and (bolp) (not (org-at-heading-p))))
16703 (cdlatex-tab) t)
16704 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16706 (defun org-cdlatex-underscore-caret (&optional arg)
16707 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16708 Revert to the normal definition outside of these fragments."
16709 (interactive "P")
16710 (if (org-inside-LaTeX-fragment-p)
16711 (call-interactively 'cdlatex-sub-superscript)
16712 (let (org-cdlatex-mode)
16713 (call-interactively (key-binding (vector last-input-event))))))
16715 (defun org-cdlatex-math-modify (&optional arg)
16716 "Execute `cdlatex-math-modify' in LaTeX fragments.
16717 Revert to the normal definition outside of these fragments."
16718 (interactive "P")
16719 (if (org-inside-LaTeX-fragment-p)
16720 (call-interactively 'cdlatex-math-modify)
16721 (let (org-cdlatex-mode)
16722 (call-interactively (key-binding (vector last-input-event))))))
16724 (defvar org-latex-fragment-image-overlays nil
16725 "List of overlays carrying the images of latex fragments.")
16726 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16728 (defun org-remove-latex-fragment-image-overlays ()
16729 "Remove all overlays with LaTeX fragment images in current buffer."
16730 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16731 (setq org-latex-fragment-image-overlays nil))
16733 (defun org-preview-latex-fragment (&optional subtree)
16734 "Preview the LaTeX fragment at point, or all locally or globally.
16735 If the cursor is in a LaTeX fragment, create the image and overlay
16736 it over the source code. If there is no fragment at point, display
16737 all fragments in the current text, from one headline to the next. With
16738 prefix SUBTREE, display all fragments in the current subtree. With a
16740 the cursor is before the first headline,
16741 display all fragments in the buffer.
16743 (interactive "P")
16744 (unless buffer-file-name
16745 (error "Can't preview LaTeX fragment in a non-file buffer"))
16746 (org-remove-latex-fragment-image-overlays)
16747 (save-excursion
16748 (save-restriction
16749 (let (beg end at msg)
16750 (cond
16751 ((or (equal subtree '(16))
16752 (not (save-excursion
16753 (re-search-backward org-outline-regexp-bol nil t))))
16754 (setq beg (point-min) end (point-max)
16755 msg "Creating images for buffer...%s"))
16756 ((equal subtree '(4))
16757 (org-back-to-heading)
16758 (setq beg (point) end (org-end-of-subtree t)
16759 msg "Creating images for subtree...%s"))
16760 (t
16761 (if (setq at (org-inside-LaTeX-fragment-p))
16762 (goto-char (max (point-min) (- (cdr at) 2)))
16763 (org-back-to-heading))
16764 (setq beg (point) end (progn (outline-next-heading) (point))
16765 msg (if at "Creating image...%s"
16766 "Creating images for entry...%s"))))
16767 (message msg "")
16768 (narrow-to-region beg end)
16769 (goto-char beg)
16770 (org-format-latex
16771 (concat "ltxpng/" (file-name-sans-extension
16772 (file-name-nondirectory
16773 buffer-file-name)))
16774 default-directory 'overlays msg at 'forbuffer 'dvipng)
16775 (message msg "done. Use `C-c C-c' to remove images.")))))
16777 (defvar org-latex-regexps
16779 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16782 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16786 "Regular expressions for matching embedded LaTeX.")
16788 (defvar org-export-have-math nil) ;; dynamic scoping
16789 (defun org-format-latex (prefix &optional dir overlays msg at
16790 forbuffer processing-type)
16791 "Replace LaTeX fragments with links to an image, and produce images.
16792 Some of the options can be changed using the variable
16793 `org-format-latex-options'."
16794 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16795 (let* ((prefixnodir (file-name-nondirectory prefix))
16796 (absprefix (expand-file-name prefix dir))
16797 (todir (file-name-directory absprefix))
16798 (opt org-format-latex-options)
16799 (matchers (plist-get opt :matchers))
16800 (re-list org-latex-regexps)
16801 (org-format-latex-header-extra
16802 (plist-get (org-infile-export-plist) :latex-header-extra))
16803 (cnt 0) txt hash link beg end re e checkdir
16804 executables-checked string
16805 m n block-type block linkfile movefile ov)
16806 ;; Check the different regular expressions
16807 (while (setq e (pop re-list))
16808 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16810 (when (member m matchers)
16811 (goto-char (point-min))
16812 (while (re-search-forward re nil t)
16813 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16814 (not (get-text-property (match-beginning n)
16815 'org-protected))
16816 (or (not overlays)
16817 (not (eq (get-char-property (match-beginning n)
16818 'org-overlay-type)
16819 'org-latex-overlay))))
16820 (setq org-export-have-math t)
16821 (cond
16822 ((eq processing-type 'verbatim)
16823 ;; Leave the text verbatim, just protect it
16824 (add-text-properties (match-beginning n) (match-end n)
16825 '(org-protected t)))
16826 ((eq processing-type 'mathjax)
16827 ;; Prepare for MathJax processing
16828 (setq string (match-string n))
16829 (if (member m '("$" "$1"))
16830 (save-excursion
16831 (delete-region (match-beginning n) (match-end n))
16832 (goto-char (match-beginning n))
16835 '(org-protected t))))
16836 (add-text-properties (match-beginning n) (match-end n)
16837 '(org-protected t))))
16838 ((eq processing-type 'dvipng)
16839 ;; Process to an image
16840 (setq txt (match-string n)
16841 beg (match-beginning n) end (match-end n)
16842 cnt (1+ cnt))
16843 (let (print-length print-level) ; make sure full list is printed
16844 (setq hash (sha1 (prin1-to-string
16845 (list org-format-latex-header
16846 org-format-latex-header-extra
16847 org-export-latex-default-packages-alist
16848 org-export-latex-packages-alist
16849 org-format-latex-options
16850 forbuffer txt)))
16851 linkfile (format "%s_%s.png" prefix hash)
16852 movefile (format "%s_%s.png" absprefix hash)))
16853 (setq link (concat block "[[file:" linkfile "]]" block))
16854 (if msg (message msg cnt))
16855 (goto-char beg)
16856 (unless checkdir ; make sure the directory exists
16857 (setq checkdir t)
16858 (or (file-directory-p todir) (make-directory todir t)))
16860 (unless executables-checked
16861 (org-check-external-command
16862 "latex" "needed to convert LaTeX fragments to images")
16863 (org-check-external-command
16864 "dvipng" "needed to convert LaTeX fragments to images")
16865 (setq executables-checked t))
16867 (unless (file-exists-p movefile)
16868 (org-create-formula-image
16869 txt movefile opt forbuffer))
16870 (if overlays
16871 (progn
16872 (mapc (lambda (o)
16873 (if (eq (overlay-get o 'org-overlay-type)
16874 'org-latex-overlay)
16875 (delete-overlay o)))
16876 (overlays-in beg end))
16877 (setq ov (make-overlay beg end))
16878 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16879 (if (featurep 'xemacs)
16880 (progn
16881 (overlay-put ov 'invisible t)
16882 (overlay-put
16883 ov 'end-glyph
16884 (make-glyph (vector 'png :file movefile))))
16885 (overlay-put
16886 ov 'display
16887 (list 'image :type 'png :file movefile :ascent 'center)))
16888 (push ov org-latex-fragment-image-overlays)
16889 (goto-char end))
16890 (delete-region beg end)
16891 (insert (org-add-props link
16892 (list 'org-latex-src
16893 (replace-regexp-in-string
16895 'org-latex-src-embed-type
16896 (if block-type 'paragraph 'character))))))
16897 ((eq processing-type 'mathml)
16898 ;; Process to MathML
16899 (unless executables-checked
16900 (unless (save-match-data (org-format-latex-mathml-available-p))
16901 (error "LaTeX to MathML converter not configured"))
16902 (setq executables-checked t))
16903 (setq txt (match-string n)
16904 beg (match-beginning n) end (match-end n)
16905 cnt (1+ cnt))
16906 (if msg (message msg cnt))
16907 (goto-char beg)
16908 (delete-region beg end)
16909 (insert (org-format-latex-as-mathml
16910 txt block-type prefix dir)))
16911 (t
16912 (error "Unknown conversion type %s for latex fragments"
16913 processing-type)))))))))
16915 (defun org-create-math-formula (latex-frag &optional mathml-file)
16916 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16917 Use `org-latex-to-mathml-convert-command'. If the conversion is
16919 elements otherwise return nil. When MATHML-FILE is specified,
16920 write the results in to that file. When invoked as an
16921 interactive command, prompt for LATEX-FRAG, with initial value
16922 set to the current active region and echo the results for user
16923 inspection."
16924 (interactive (list (let ((frag (when (region-active-p)
16925 (buffer-substring-no-properties
16926 (region-beginning) (region-end)))))
16927 (read-string "LaTeX Fragment: " frag nil frag))))
16928 (unless latex-frag (error "Invalid latex-frag"))
16929 (let* ((tmp-in-file (file-relative-name
16930 (make-temp-name (expand-file-name "ltxmathml-in"))))
16931 (ignore (write-region latex-frag nil tmp-in-file))
16932 (tmp-out-file (file-relative-name
16933 (make-temp-name (expand-file-name "ltxmathml-out"))))
16934 (cmd (format-spec
16935 org-latex-to-mathml-convert-command
16936 `((?j . ,(shell-quote-argument
16937 (expand-file-name org-latex-to-mathml-jar-file)))
16938 (?I . ,(shell-quote-argument tmp-in-file))
16939 (?o . ,(shell-quote-argument tmp-out-file)))))
16940 mathml shell-command-output)
16941 (when (org-called-interactively-p 'any)
16942 (unless (org-format-latex-mathml-available-p)
16943 (error "LaTeX to MathML converter not configured")))
16944 (message "Running %s" cmd)
16945 (setq shell-command-output (shell-command-to-string cmd))
16946 (setq mathml
16947 (when (file-readable-p tmp-out-file)
16948 (with-current-buffer (find-file-noselect tmp-out-file t)
16949 (goto-char (point-min))
16950 (when (re-search-forward
16951 (concat
16952 (regexp-quote
16955 (regexp-quote "</math>")) nil t)
16956 (prog1 (match-string 0) (kill-buffer))))))
16957 (cond
16958 (mathml
16959 (setq mathml
16961 (when mathml-file
16962 (write-region mathml nil mathml-file))
16963 (when (org-called-interactively-p 'any)
16964 (message mathml)))
16965 ((message "LaTeX to MathML conversion failed")
16966 (message shell-command-output)))
16967 (delete-file tmp-in-file)
16968 (when (file-exists-p tmp-out-file)
16969 (delete-file tmp-out-file))
16970 mathml))
16972 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16973 prefix &optional dir)
16974 "Use `org-create-math-formula' but check local cache first."
16975 (let* ((absprefix (expand-file-name prefix dir))
16976 (print-length nil) (print-level nil)
16977 (formula-id (concat
16978 "formula-"
16979 (sha1
16980 (prin1-to-string
16981 (list latex-frag
16982 org-latex-to-mathml-convert-command)))))
16983 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16984 (formula-cache-dir (file-name-directory formula-cache)))
16986 (unless (file-directory-p formula-cache-dir)
16987 (make-directory formula-cache-dir t))
16989 (unless (file-exists-p formula-cache)
16990 (org-create-math-formula latex-frag formula-cache))
16992 (if (file-exists-p formula-cache)
16993 ;; Successful conversion. Return the link to MathML file.
16994 (org-add-props
16995 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16997 'org-latex-src-embed-type (if latex-frag-type
16998 'paragraph 'character)))
16999 ;; Failed conversion. Return the LaTeX fragment verbatim
17000 (add-text-properties
17001 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17002 latex-frag)))
17004 ;; This function borrows from Ganesh Swami's latex2png.el
17005 (defun org-create-formula-image (string tofile options buffer)
17006 "This calls dvipng."
17007 (require 'org-latex)
17008 (let* ((tmpdir (if (featurep 'xemacs)
17009 (temp-directory)
17010 temporary-file-directory))
17011 (texfilebase (make-temp-name
17012 (expand-file-name "orgtex" tmpdir)))
17013 (texfile (concat texfilebase ".tex"))
17014 (dvifile (concat texfilebase ".dvi"))
17015 (pngfile (concat texfilebase ".png"))
17016 (fnh (if (featurep 'xemacs)
17017 (font-height (face-font 'default))
17018 (face-attribute 'default :height nil)))
17019 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17020 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17021 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17022 "Black"))
17023 (bg (or (plist-get options (if buffer :background :html-background))
17024 "Transparent")))
17025 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17026 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17027 (with-temp-file texfile
17028 (insert (org-splice-latex-header
17029 org-format-latex-header
17030 org-export-latex-default-packages-alist
17031 org-export-latex-packages-alist t
17032 org-format-latex-header-extra))
17034 (require 'org-latex)
17035 (org-export-latex-fix-inputenc))
17036 (let ((dir default-directory))
17037 (condition-case nil
17038 (progn
17039 (cd tmpdir)
17040 (call-process "latex" nil nil nil texfile))
17041 (error nil))
17042 (cd dir))
17043 (if (not (file-exists-p dvifile))
17044 (progn (message "Failed to create dvi file from %s" texfile) nil)
17045 (condition-case nil
17046 (if (featurep 'xemacs)
17047 (call-process "dvipng" nil nil nil
17048 "-fg" fg "-bg" bg
17049 "-T" "tight"
17050 "-o" pngfile
17051 dvifile)
17052 (call-process "dvipng" nil nil nil
17053 "-fg" fg "-bg" bg
17054 "-D" dpi
17055 ;;"-x" scale "-y" scale
17056 "-T" "tight"
17057 "-o" pngfile
17058 dvifile))
17059 (error nil))
17060 (if (not (file-exists-p pngfile))
17061 (if org-format-latex-signal-error
17062 (error "Failed to create png file from %s" texfile)
17063 (message "Failed to create png file from %s" texfile)
17064 nil)
17065 ;; Use the requested file name and clean up
17066 (copy-file pngfile tofile 'replace)
17067 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17068 (delete-file (concat texfilebase e)))
17069 pngfile))))
17071 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17072 "Fill a LaTeX header template TPL.
17073 In the template, the following place holders will be recognized:
17076 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17078 [NO-PACKAGES] do not include PKG
17079 [EXTRA] the string EXTRA
17080 [NO-EXTRA] do not include EXTRA
17082 For backward compatibility, if both the positive and the negative place
17084 assumed to be present at the end of the template.
17085 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17086 EXTRA is a string.
17087 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17088 (let (rpl (end ""))
17090 (setq rpl (if (or (match-end 1) (not def-pkg))
17091 "" (org-latex-packages-to-string def-pkg snippets-p t))
17092 tpl (replace-match rpl t t tpl))
17093 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17096 (setq rpl (if (or (match-end 1) (not pkg))
17097 "" (org-latex-packages-to-string pkg snippets-p t))
17098 tpl (replace-match rpl t t tpl))
17099 (if pkg (setq end
17101 (org-latex-packages-to-string pkg snippets-p)))))
17104 (setq rpl (if (or (match-end 1) (not extra))
17106 tpl (replace-match rpl t t tpl))
17112 tpl)))
17114 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17116 (setq pkg (mapconcat (lambda(p)
17117 (cond
17118 ((stringp p) p)
17119 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17120 (format "%% Package %s omitted" (cadr p)))
17121 ((equal "" (car p))
17123 (t
17125 (car p) (cadr p)))))
17126 pkg
17130 (defun org-dvipng-color (attr)
17131 "Return an rgb color specification for dvipng."
17132 (apply 'format "rgb %s %s %s"
17133 (mapcar 'org-normalize-color
17134 (if (featurep 'xemacs)
17135 (color-rgb-components
17136 (face-property 'default
17137 (cond ((eq attr :foreground) 'foreground)
17138 ((eq attr :background) 'background))))
17139 (color-values (face-attribute 'default attr nil))))))
17141 (defun org-normalize-color (value)
17142 "Return string to be used as color value for an RGB component."
17143 (format "%g" (/ value 65535.0)))
17145 ;; Image display
17148 (defvar org-inline-image-overlays nil)
17149 (make-variable-buffer-local 'org-inline-image-overlays)
17151 (defun org-toggle-inline-images (&optional include-linked)
17152 "Toggle the display of inline images.
17153 INCLUDE-LINKED is passed to `org-display-inline-images'."
17154 (interactive "P")
17155 (if org-inline-image-overlays
17156 (progn
17157 (org-remove-inline-images)
17158 (message "Inline image display turned off"))
17159 (org-display-inline-images include-linked)
17160 (if org-inline-image-overlays
17161 (message "%d images displayed inline"
17162 (length org-inline-image-overlays))
17163 (message "No images to display inline"))))
17165 (defun org-display-inline-images (&optional include-linked refresh beg end)
17166 "Display inline images.
17167 Normally only links without a description part are inlined, because this
17168 is how it will work for export. When INCLUDE-LINKED is set, also links
17169 with a description part will be inlined. This can be nice for a quick
17170 look at those images, but it does not reflect what exported files will look
17171 like.
17172 When REFRESH is set, refresh existing images between BEG and END.
17173 This will create new image displays only if necessary.
17174 BEG and END default to the buffer boundaries."
17175 (interactive "P")
17176 (unless refresh
17177 (org-remove-inline-images)
17178 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17179 (save-excursion
17180 (save-restriction
17181 (widen)
17182 (setq beg (or beg (point-min)) end (or end (point-max)))
17183 (goto-char beg)
17185 (substring (org-image-file-name-regexp) 0 -2)
17187 old file ov img)
17188 (while (re-search-forward re end t)
17189 (setq old (get-char-property-and-overlay (match-beginning 1)
17190 'org-image-overlay))
17191 (setq file (expand-file-name
17192 (concat (or (match-string 3) "") (match-string 4))))
17193 (when (file-exists-p file)
17194 (if (and (car-safe old) refresh)
17195 (image-refresh (overlay-get (cdr old) 'display))
17196 (setq img (save-match-data (create-image file)))
17197 (when img
17198 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17199 (overlay-put ov 'display img)
17200 (overlay-put ov 'face 'default)
17201 (overlay-put ov 'org-image-overlay t)
17202 (overlay-put ov 'modification-hooks
17203 (list 'org-display-inline-modification-hook))
17204 (push ov org-inline-image-overlays)))))))))
17206 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17207 "Remove inline-display overlay if a corresponding region is modified."
17208 (let ((inhibit-modification-hooks t))
17209 (when (and ov after)
17210 (delete ov org-inline-image-overlays)
17211 (delete-overlay ov))))
17213 (defun org-remove-inline-images ()
17214 "Remove inline display of images."
17215 (interactive)
17216 (mapc 'delete-overlay org-inline-image-overlays)
17217 (setq org-inline-image-overlays nil))
17219 ;;;; Key bindings
17221 ;; Outline functions from `outline-mode-prefix-map'
17222 ;; that can be remapped in Org:
17223 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17224 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17225 (define-key org-mode-map [remap outline-forward-same-level]
17226 'org-forward-same-level)
17227 (define-key org-mode-map [remap outline-backward-same-level]
17228 'org-backward-same-level)
17229 (define-key org-mode-map [remap show-branches]
17230 'org-kill-note-or-show-branches)
17231 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17232 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17233 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17235 ;; Outline functions from `outline-mode-prefix-map'
17236 ;; that can not be remapped in Org:
17237 ;; - the column "key binding" shows whether the Outline function is still
17238 ;; available in Org mode on the same key that it has been bound to in
17239 ;; Outline mode:
17240 ;; - "overridden": key used for a different functionality in Org mode
17241 ;; - else: key still bound to the same Outline function in Org mode
17242 ;; | Outline function | key binding | Org replacement |
17243 ;; |------------------------------------+-------------+-----------------------|
17244 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17245 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17246 ;; | `show-children' | `C-c C-i' | visibility cycling |
17247 ;; | `hide-subtree' | overridden | visibility cycling |
17248 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17249 ;; | `hide-body' | overridden | no replacement |
17250 ;; | `show-all' | overridden | no replacement |
17251 ;; | `hide-entry' | overridden | visibility cycling |
17252 ;; | `show-entry' | overridden | no replacement |
17253 ;; | `hide-leaves' | overridden | no replacement |
17254 ;; | `hide-sublevels' | overridden | no replacement |
17255 ;; | `hide-other' | overridden | no replacement |
17256 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17257 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17259 ;; Make `C-c C-x' a prefix key
17260 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17262 ;; TAB key with modifiers
17263 (org-defkey org-mode-map "\C-i" 'org-cycle)
17264 (org-defkey org-mode-map [(tab)] 'org-cycle)
17265 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17267 ;; The following line is necessary under Suse GNU/Linux
17268 (unless (featurep 'xemacs)
17269 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17270 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17271 (define-key org-mode-map [backtab] 'org-shifttab)
17273 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17274 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17275 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17277 ;; Cursor keys with modifiers
17278 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17279 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17280 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17281 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17283 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17284 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17285 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17286 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17288 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17289 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17290 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17291 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17293 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17294 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17295 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17296 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17298 ;; Babel keys
17299 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17300 (mapc (lambda (pair)
17301 (define-key org-babel-map (car pair) (cdr pair)))
17302 org-babel-key-bindings)
17304 ;;; Extra keys for tty access.
17305 ;; We only set them when really needed because otherwise the
17306 ;; menus don't show the simple keys
17308 (when (or org-use-extra-keys
17309 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17310 (not window-system))
17311 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17312 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17313 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17314 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17315 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17316 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17317 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17318 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17319 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17320 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17321 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17322 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17323 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17324 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17325 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17326 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17327 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17328 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17329 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17330 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17331 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17332 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17333 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17334 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17335 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17336 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17337 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17338 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17340 ;; All the other keys
17342 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17343 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17344 (if (boundp 'narrow-map)
17345 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17346 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17347 (if (boundp 'narrow-map)
17348 (org-defkey narrow-map "b" 'org-narrow-to-block)
17349 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17350 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17351 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17352 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17353 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17354 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17355 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17356 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17357 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17358 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17359 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17360 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17361 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17362 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17363 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17364 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17365 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17367 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17368 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17369 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17370 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17371 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17372 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17373 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17374 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17375 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17376 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17377 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17378 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17379 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17380 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17381 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17382 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17383 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17384 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17385 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17386 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17388 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17389 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17390 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17391 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17392 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17393 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17394 (org-defkey org-mode-map "\C-c^" 'org-sort)
17395 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17396 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17397 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17398 (org-defkey org-mode-map "\C-m" 'org-return)
17399 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17400 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17401 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17402 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17403 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17404 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17405 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17406 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17407 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17408 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17409 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17410 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17411 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17412 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17413 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17414 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17415 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17416 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17417 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17418 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17419 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17420 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17422 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17423 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17424 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17425 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17427 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17428 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17429 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17430 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17431 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17432 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17433 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17434 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17435 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17436 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17438 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17439 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17440 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17441 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17442 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17443 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17444 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17446 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17447 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17448 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17449 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17450 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17452 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17454 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17456 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17457 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17459 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17462 (when (featurep 'xemacs)
17463 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17466 (defconst org-speed-commands-default
17467 '(
17468 ("Outline Navigation")
17469 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17470 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17471 ("f" . (org-speed-move-safe 'org-forward-same-level))
17472 ("b" . (org-speed-move-safe 'org-backward-same-level))
17473 ("u" . (org-speed-move-safe 'outline-up-heading))
17474 ("j" . org-goto)
17475 ("g" . (org-refile t))
17476 ("Outline Visibility")
17477 ("c" . org-cycle)
17478 ("C" . org-shifttab)
17479 (" " . org-display-outline-path)
17480 ("Outline Structure Editing")
17481 ("U" . org-shiftmetaup)
17482 ("D" . org-shiftmetadown)
17483 ("r" . org-metaright)
17484 ("l" . org-metaleft)
17485 ("R" . org-shiftmetaright)
17486 ("L" . org-shiftmetaleft)
17487 ("i" . (progn (forward-char 1) (call-interactively
17488 'org-insert-heading-respect-content)))
17489 ("^" . org-sort)
17490 ("w" . org-refile)
17491 ("a" . org-archive-subtree-default-with-confirmation)
17492 ("." . org-mark-subtree)
17493 ("Clock Commands")
17494 ("I" . org-clock-in)
17495 ("O" . org-clock-out)
17496 ("Meta Data Editing")
17497 ("t" . org-todo)
17498 ("0" . (org-priority ?\ ))
17499 ("1" . (org-priority ?A))
17500 ("2" . (org-priority ?B))
17501 ("3" . (org-priority ?C))
17502 (";" . org-set-tags-command)
17503 ("e" . org-set-effort)
17504 ("Agenda Views etc")
17505 ("v" . org-agenda)
17506 ("/" . org-sparse-tree)
17507 ("Misc")
17508 ("o" . org-open-at-point)
17509 ("?" . org-speed-command-help)
17510 ("<" . (org-agenda-set-restriction-lock 'subtree))
17511 (">" . (org-agenda-remove-restriction-lock))
17512 )
17513 "The default speed commands.")
17515 (defun org-print-speed-command (e)
17516 (if (> (length (car e)) 1)
17517 (progn
17519 (princ (car e))
17521 (princ (make-string (length (car e)) ?-))
17523 (princ (car e))
17524 (princ " ")
17525 (if (symbolp (cdr e))
17526 (princ (symbol-name (cdr e)))
17527 (prin1 (cdr e)))
17530 (defun org-speed-command-help ()
17531 "Show the available speed commands."
17532 (interactive)
17533 (if (not org-use-speed-commands)
17534 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17535 (with-output-to-temp-buffer "*Help*"
17537 (mapc 'org-print-speed-command org-speed-commands-user)
17540 (mapc 'org-print-speed-command org-speed-commands-default))
17541 (with-current-buffer "*Help*"
17542 (setq truncate-lines t))))
17544 (defun org-speed-move-safe (cmd)
17545 "Execute CMD, but make sure that the cursor always ends up in a headline.
17546 If not, return to the original position and throw an error."
17547 (interactive)
17548 (let ((pos (point)))
17549 (call-interactively cmd)
17550 (unless (and (bolp) (org-at-heading-p))
17551 (goto-char pos)
17552 (error "Boundary reached while executing %s" cmd))))
17554 (defvar org-self-insert-command-undo-counter 0)
17556 (defvar org-table-auto-blank-field) ; defined in org-table.el
17557 (defvar org-speed-command nil)
17559 (defun org-speed-command-default-hook (keys)
17560 "Hook for activating single-letter speed commands.
17561 `org-speed-commands-default' specifies a minimal command set.
17562 Use `org-speed-commands-user' for further customization."
17563 (when (or (and (bolp) (looking-at org-outline-regexp))
17564 (and (functionp org-use-speed-commands)
17565 (funcall org-use-speed-commands)))
17566 (cdr (assoc keys (append org-speed-commands-user
17567 org-speed-commands-default)))))
17569 (defun org-babel-speed-command-hook (keys)
17570 "Hook for activating single-letter code block commands."
17571 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17572 (cdr (assoc keys org-babel-key-bindings))))
17574 (defcustom org-speed-command-hook
17575 '(org-speed-command-default-hook org-babel-speed-command-hook)
17576 "Hook for activating speed commands at strategic locations.
17577 Hook functions are called in sequence until a valid handler is
17578 found.
17580 Each hook takes a single argument, a user-pressed command key
17581 which is also a `self-insert-command' from the global map.
17583 Within the hook, examine the cursor position and the command key
17584 and return nil or a valid handler as appropriate. Handler could
17585 be one of an interactive command, a function, or a form.
17587 Set `org-use-speed-commands' to non-nil value to enable this
17588 hook. The default setting is `org-speed-command-default-hook'."
17589 :group 'org-structure
17590 :type 'hook)
17592 (defun org-self-insert-command (N)
17593 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17594 If the cursor is in a table looking at whitespace, the whitespace is
17595 overwritten, and the table is not marked as requiring realignment."
17596 (interactive "p")
17597 (org-check-before-invisible-edit 'insert)
17598 (cond
17599 ((and org-use-speed-commands
17600 (setq org-speed-command
17601 (run-hook-with-args-until-success
17602 'org-speed-command-hook (this-command-keys))))
17603 (cond
17604 ((commandp org-speed-command)
17605 (setq this-command org-speed-command)
17606 (call-interactively org-speed-command))
17607 ((functionp org-speed-command)
17608 (funcall org-speed-command))
17609 ((and org-speed-command (listp org-speed-command))
17610 (eval org-speed-command))
17611 (t (let (org-use-speed-commands)
17612 (call-interactively 'org-self-insert-command)))))
17613 ((and
17614 (org-table-p)
17615 (progn
17616 ;; check if we blank the field, and if that triggers align
17617 (and (featurep 'org-table) org-table-auto-blank-field
17618 (member last-command
17619 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17621 ;; got extra space, this field does not determine column width
17622 (let (org-table-may-need-update) (org-table-blank-field))
17623 ;; no extra space, this field may determine column width
17624 (org-table-blank-field)))
17625 t)
17626 (eq N 1)
17628 (let (org-table-may-need-update)
17629 (goto-char (1- (match-end 0)))
17630 (backward-delete-char 1)
17631 (goto-char (match-beginning 0))
17632 (self-insert-command N)))
17633 (t
17634 (setq org-table-may-need-update t)
17635 (self-insert-command N)
17636 (org-fix-tags-on-the-fly)
17637 (if org-self-insert-cluster-for-undo
17638 (if (not (eq last-command 'org-self-insert-command))
17639 (setq org-self-insert-command-undo-counter 1)
17640 (if (>= org-self-insert-command-undo-counter 20)
17641 (setq org-self-insert-command-undo-counter 1)
17642 (and (> org-self-insert-command-undo-counter 0)
17643 buffer-undo-list (listp buffer-undo-list)
17644 (not (cadr buffer-undo-list)) ; remove nil entry
17645 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17646 (setq org-self-insert-command-undo-counter
17647 (1+ org-self-insert-command-undo-counter))))))))
17649 (defun org-check-before-invisible-edit (kind)
17650 "Check is editing if kind KIND would be dangerous with invisible text around.
17651 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17652 ;; First, try to get out of here as quickly as possible, to reduce overhead
17653 (if (and org-catch-invisible-edits
17654 (or (not (boundp 'visible-mode)) (not visible-mode))
17655 (or (get-char-property (point) 'invisible)
17656 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17657 ;; OK, we need to take a closer look
17658 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17659 (invisible-before-point (if (bobp) nil (get-char-property
17660 (1- (point)) 'invisible)))
17661 (border-and-ok-direction
17662 (or
17663 ;; Check if we are acting predictably before invisible text
17664 (and invisible-at-point (not invisible-before-point)
17665 (memq kind '(insert delete-backward)))
17666 ;; Check if we are acting predictably after invisible text
17667 ;; This works not well, and I have turned it off. It seems
17668 ;; better to always show and stop after invisible text.
17669 ;; (and (not invisible-at-point) invisible-before-point
17670 ;; (memq kind '(insert delete)))
17671 )))
17673 (when (or (memq invisible-at-point '(outline org-hide-block))
17674 (memq invisible-before-point '(outline org-hide-block)))
17675 (if (eq org-catch-invisible-edits 'error)
17676 (error "Editing in invisible areas is prohibited - make visible first"))
17677 ;; Make the area visible
17678 (save-excursion
17679 (if invisible-before-point
17680 (goto-char (previous-single-char-property-change
17681 (point) 'invisible)))
17682 (org-cycle))
17683 (cond
17684 ((eq org-catch-invisible-edits 'show)
17685 ;; That's it, we do the edit after showing
17686 (message
17687 "Unfolding invisible region around point before editing")
17688 (sit-for 1))
17689 ((and (eq org-catch-invisible-edits 'smart)
17690 border-and-ok-direction)
17691 (message "Unfolding invisible region around point before editing"))
17692 (t
17693 ;; Don't do the edit, make the user repeat it in full visibility
17694 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17696 (defun org-fix-tags-on-the-fly ()
17697 (when (and (equal (char-after (point-at-bol)) ?*)
17698 (org-at-heading-p))
17699 (org-align-tags-here org-tags-column)))
17701 (defun org-delete-backward-char (N)
17702 "Like `delete-backward-char', insert whitespace at field end in tables.
17703 When deleting backwards, in tables this function will insert whitespace in
17705 still be marked for re-alignment if the field did fill the entire column,
17706 because, in this case the deletion might narrow the column."
17707 (interactive "p")
17708 (org-check-before-invisible-edit 'delete-backward)
17709 (if (and (org-table-p)
17710 (eq N 1)
17711 (string-match "|" (buffer-substring (point-at-bol) (point)))
17712 (looking-at ".*?|"))
17713 (let ((pos (point))
17715 (c org-table-may-need-update))
17716 (backward-delete-char N)
17717 (if (not overwrite-mode)
17718 (progn
17719 (skip-chars-forward "^|")
17720 (insert " ")
17721 (goto-char (1- pos))))
17722 ;; noalign: if there were two spaces at the end, this field
17723 ;; does not determine the width of the column.
17724 (if noalign (setq org-table-may-need-update c)))
17725 (backward-delete-char N)
17726 (org-fix-tags-on-the-fly)))
17728 (defun org-delete-char (N)
17729 "Like `delete-char', but insert whitespace at field end in tables.
17730 When deleting characters, in tables this function will insert whitespace in
17732 still be marked for re-alignment if the field did fill the entire column,
17733 because, in this case the deletion might narrow the column."
17734 (interactive "p")
17735 (org-check-before-invisible-edit 'delete)
17736 (if (and (org-table-p)
17737 (not (bolp))
17738 (not (= (char-after) ?|))
17739 (eq N 1))
17740 (if (looking-at ".*?|")
17741 (let ((pos (point))
17743 (c org-table-may-need-update))
17744 (replace-match (concat
17745 (substring (match-string 0) 1 -1)
17746 " |"))
17747 (goto-char pos)
17748 ;; noalign: if there were two spaces at the end, this field
17749 ;; does not determine the width of the column.
17750 (if noalign (setq org-table-may-need-update c)))
17751 (delete-char N))
17752 (delete-char N)
17753 (org-fix-tags-on-the-fly)))
17755 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17756 (put 'org-self-insert-command 'delete-selection t)
17757 (put 'orgtbl-self-insert-command 'delete-selection t)
17758 (put 'org-delete-char 'delete-selection 'supersede)
17759 (put 'org-delete-backward-char 'delete-selection 'supersede)
17760 (put 'org-yank 'delete-selection 'yank)
17762 ;; Make `flyspell-mode' delay after some commands
17763 (put 'org-self-insert-command 'flyspell-delayed t)
17764 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17765 (put 'org-delete-char 'flyspell-delayed t)
17766 (put 'org-delete-backward-char 'flyspell-delayed t)
17768 ;; Make pabbrev-mode expand after org-mode commands
17769 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17770 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17772 ;; How to do this: Measure non-white length of current string
17773 ;; If equal to column width, we should realign.
17775 (defun org-remap (map &rest commands)
17776 "In MAP, remap the functions given in COMMANDS.
17777 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17778 (let (new old)
17779 (while commands
17780 (setq old (pop commands) new (pop commands))
17781 (if (fboundp 'command-remapping)
17782 (org-defkey map (vector 'remap old) new)
17783 (substitute-key-definition old new map global-map)))))
17785 (when (eq org-enable-table-editor 'optimized)
17786 ;; If the user wants maximum table support, we need to hijack
17787 ;; some standard editing functions
17788 (org-remap org-mode-map
17789 'self-insert-command 'org-self-insert-command
17790 'delete-char 'org-delete-char
17791 'delete-backward-char 'org-delete-backward-char)
17792 (org-defkey org-mode-map "|" 'org-force-self-insert))
17794 (defvar org-ctrl-c-ctrl-c-hook nil
17795 "Hook for functions attaching themselves to `C-c C-c'.
17797 This can be used to add additional functionality to the C-c C-c
17798 key which executes context-dependent commands. This hook is run
17799 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17800 run after the last test.
17802 Each function will be called with no arguments. The function
17803 must check if the context is appropriate for it to act. If yes,
17804 it should do its thing and then return a non-nil value. If the
17805 context is wrong, just do nothing and return nil.")
17807 (defvar org-ctrl-c-ctrl-c-final-hook nil
17808 "Hook for functions attaching themselves to `C-c C-c'.
17810 This can be used to add additional functionality to the C-c C-c
17811 key which executes context-dependent commands. This hook is run
17812 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17813 before the first test.
17815 Each function will be called with no arguments. The function
17816 must check if the context is appropriate for it to act. If yes,
17817 it should do its thing and then return a non-nil value. If the
17818 context is wrong, just do nothing and return nil.")
17820 (defvar org-tab-first-hook nil
17821 "Hook for functions to attach themselves to TAB.
17822 See `org-ctrl-c-ctrl-c-hook' for more information.
17823 This hook runs as the first action when TAB is pressed, even before
17824 `org-cycle' messes around with the `outline-regexp' to cater for
17825 inline tasks and plain list item folding.
17826 If any function in this hook returns t, any other actions that
17827 would have been caused by TAB (such as table field motion or visibility
17828 cycling) will not occur.")
17830 (defvar org-tab-after-check-for-table-hook nil
17831 "Hook for functions to attach themselves to TAB.
17832 See `org-ctrl-c-ctrl-c-hook' for more information.
17833 This hook runs after it has been established that the cursor is not in a
17834 table, but before checking if the cursor is in a headline or if global cycling
17835 should be done.
17836 If any function in this hook returns t, not other actions like visibility
17837 cycling will be done.")
17839 (defvar org-tab-after-check-for-cycling-hook nil
17840 "Hook for functions to attach themselves to TAB.
17841 See `org-ctrl-c-ctrl-c-hook' for more information.
17842 This hook runs after it has been established that not table field motion and
17843 not visibility should be done because of current context. This is probably
17844 the place where a package like yasnippets can hook in.")
17846 (defvar org-tab-before-tab-emulation-hook nil
17847 "Hook for functions to attach themselves to TAB.
17848 See `org-ctrl-c-ctrl-c-hook' for more information.
17849 This hook runs after every other options for TAB have been exhausted, but
17852 (defvar org-metaleft-hook nil
17853 "Hook for functions attaching themselves to `M-left'.
17854 See `org-ctrl-c-ctrl-c-hook' for more information.")
17855 (defvar org-metaright-hook nil
17856 "Hook for functions attaching themselves to `M-right'.
17857 See `org-ctrl-c-ctrl-c-hook' for more information.")
17858 (defvar org-metaup-hook nil
17859 "Hook for functions attaching themselves to `M-up'.
17860 See `org-ctrl-c-ctrl-c-hook' for more information.")
17861 (defvar org-metadown-hook nil
17862 "Hook for functions attaching themselves to `M-down'.
17863 See `org-ctrl-c-ctrl-c-hook' for more information.")
17864 (defvar org-shiftmetaleft-hook nil
17865 "Hook for functions attaching themselves to `M-S-left'.
17866 See `org-ctrl-c-ctrl-c-hook' for more information.")
17867 (defvar org-shiftmetaright-hook nil
17868 "Hook for functions attaching themselves to `M-S-right'.
17869 See `org-ctrl-c-ctrl-c-hook' for more information.")
17870 (defvar org-shiftmetaup-hook nil
17871 "Hook for functions attaching themselves to `M-S-up'.
17872 See `org-ctrl-c-ctrl-c-hook' for more information.")
17873 (defvar org-shiftmetadown-hook nil
17874 "Hook for functions attaching themselves to `M-S-down'.
17875 See `org-ctrl-c-ctrl-c-hook' for more information.")
17876 (defvar org-metareturn-hook nil
17877 "Hook for functions attaching themselves to `M-RET'.
17878 See `org-ctrl-c-ctrl-c-hook' for more information.")
17879 (defvar org-shiftup-hook nil
17880 "Hook for functions attaching themselves to `S-up'.
17881 See `org-ctrl-c-ctrl-c-hook' for more information.")
17882 (defvar org-shiftup-final-hook nil
17883 "Hook for functions attaching themselves to `S-up'.
17884 This one runs after all other options except shift-select have been excluded.
17885 See `org-ctrl-c-ctrl-c-hook' for more information.")
17886 (defvar org-shiftdown-hook nil
17887 "Hook for functions attaching themselves to `S-down'.
17888 See `org-ctrl-c-ctrl-c-hook' for more information.")
17889 (defvar org-shiftdown-final-hook nil
17890 "Hook for functions attaching themselves to `S-down'.
17891 This one runs after all other options except shift-select have been excluded.
17892 See `org-ctrl-c-ctrl-c-hook' for more information.")
17893 (defvar org-shiftleft-hook nil
17894 "Hook for functions attaching themselves to `S-left'.
17895 See `org-ctrl-c-ctrl-c-hook' for more information.")
17896 (defvar org-shiftleft-final-hook nil
17897 "Hook for functions attaching themselves to `S-left'.
17898 This one runs after all other options except shift-select have been excluded.
17899 See `org-ctrl-c-ctrl-c-hook' for more information.")
17900 (defvar org-shiftright-hook nil
17901 "Hook for functions attaching themselves to `S-right'.
17902 See `org-ctrl-c-ctrl-c-hook' for more information.")
17903 (defvar org-shiftright-final-hook nil
17904 "Hook for functions attaching themselves to `S-right'.
17905 This one runs after all other options except shift-select have been excluded.
17906 See `org-ctrl-c-ctrl-c-hook' for more information.")
17908 (defun org-modifier-cursor-error ()
17909 "Throw an error, a modified cursor command was applied in wrong context."
17910 (error "This command is active in special context like tables, headlines or items"))
17912 (defun org-shiftselect-error ()
17913 "Throw an error because Shift-Cursor command was applied in wrong context."
17914 (if (and (boundp 'shift-select-mode) shift-select-mode)
17915 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17916 (error "This command works only in special context like headlines or timestamps")))
17918 (defun org-call-for-shift-select (cmd)
17919 (let ((this-command-keys-shift-translated t))
17920 (call-interactively cmd)))
17922 (defun org-shifttab (&optional arg)
17923 "Global visibility cycling or move to previous table field.
17924 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17925 on context.
17926 See the individual commands for more information."
17927 (interactive "P")
17928 (cond
17929 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17930 ((integerp arg)
17931 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17932 (message "Content view to level: %d" arg)
17933 (org-content (prefix-numeric-value arg2))
17934 (setq org-cycle-global-status 'overview)))
17935 (t (call-interactively 'org-global-cycle))))
17937 (defun org-shiftmetaleft ()
17938 "Promote subtree or delete table column.
17939 Calls `org-promote-subtree', `org-outdent-item',
17940 or `org-table-delete-column', depending on context.
17941 See the individual commands for more information."
17942 (interactive)
17943 (cond
17944 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17945 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17946 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17947 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17948 (t (org-modifier-cursor-error))))
17950 (defun org-shiftmetaright ()
17951 "Demote subtree or insert table column.
17952 Calls `org-demote-subtree', `org-indent-item',
17953 or `org-table-insert-column', depending on context.
17954 See the individual commands for more information."
17955 (interactive)
17956 (cond
17957 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17958 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17959 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17960 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17961 (t (org-modifier-cursor-error))))
17963 (defun org-shiftmetaup (&optional arg)
17964 "Move subtree up or kill table row.
17965 Calls `org-move-subtree-up' or `org-table-kill-row' or
17966 `org-move-item-up' depending on context. See the individual commands
17967 for more information."
17968 (interactive "P")
17969 (cond
17970 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17971 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17972 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17973 ((org-at-item-p) (call-interactively 'org-move-item-up))
17974 (t (org-modifier-cursor-error))))
17976 (defun org-shiftmetadown (&optional arg)
17977 "Move subtree down or insert table row.
17978 Calls `org-move-subtree-down' or `org-table-insert-row' or
17979 `org-move-item-down', depending on context. See the individual
17980 commands for more information."
17981 (interactive "P")
17982 (cond
17983 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17984 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17985 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17986 ((org-at-item-p) (call-interactively 'org-move-item-down))
17987 (t (org-modifier-cursor-error))))
17989 (defsubst org-hidden-tree-error ()
17990 (error
17991 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17993 (defun org-metaleft (&optional arg)
17994 "Promote heading or move table column to left.
17995 Calls `org-do-promote' or `org-table-move-column', depending on context.
17996 With no specific context, calls the Emacs default `backward-word'.
17997 See the individual commands for more information."
17998 (interactive "P")
17999 (cond
18000 ((run-hook-with-args-until-success 'org-metaleft-hook))
18001 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18002 ((org-with-limited-levels
18003 (or (org-at-heading-p)
18004 (and (org-region-active-p)
18005 (save-excursion
18006 (goto-char (region-beginning))
18007 (org-at-heading-p)))))
18008 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18009 (call-interactively 'org-do-promote))
18010 ;; At an inline task.
18011 ((org-at-heading-p)
18012 (call-interactively 'org-inlinetask-promote))
18013 ((or (org-at-item-p)
18014 (and (org-region-active-p)
18015 (save-excursion
18016 (goto-char (region-beginning))
18017 (org-at-item-p))))
18018 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18019 (call-interactively 'org-outdent-item))
18020 (t (call-interactively 'backward-word))))
18022 (defun org-metaright (&optional arg)
18023 "Demote subtree or move table column to right.
18024 Calls `org-do-demote' or `org-table-move-column', depending on context.
18025 With no specific context, calls the Emacs default `forward-word'.
18026 See the individual commands for more information."
18027 (interactive "P")
18028 (cond
18029 ((run-hook-with-args-until-success 'org-metaright-hook))
18030 ((org-at-table-p) (call-interactively 'org-table-move-column))
18031 ((org-with-limited-levels
18032 (or (org-at-heading-p)
18033 (and (org-region-active-p)
18034 (save-excursion
18035 (goto-char (region-beginning))
18036 (org-at-heading-p)))))
18037 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18038 (call-interactively 'org-do-demote))
18039 ;; At an inline task.
18040 ((org-at-heading-p)
18041 (call-interactively 'org-inlinetask-demote))
18042 ((or (org-at-item-p)
18043 (and (org-region-active-p)
18044 (save-excursion
18045 (goto-char (region-beginning))
18046 (org-at-item-p))))
18047 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18048 (call-interactively 'org-indent-item))
18049 (t (call-interactively 'forward-word))))
18051 (defun org-check-for-hidden (what)
18052 "Check if there are hidden headlines/items in the current visual line.
18053 WHAT can be either `headlines' or `items'. If the current line is
18054 an outline or item heading and it has a folded subtree below it,
18055 this function returns t, nil otherwise."
18056 (let ((re (cond
18057 ((eq what 'headlines) org-outline-regexp-bol)
18058 ((eq what 'items) (org-item-beginning-re))
18059 (t (error "This should not happen"))))
18060 beg end)
18061 (save-excursion
18062 (catch 'exit
18063 (unless (org-region-active-p)
18064 (setq beg (point-at-bol))
18065 (beginning-of-line 2)
18066 (while (and (not (eobp)) ;; this is like `next-line'
18067 (get-char-property (1- (point)) 'invisible))
18068 (beginning-of-line 2))
18069 (setq end (point))
18070 (goto-char beg)
18071 (goto-char (point-at-eol))
18072 (setq end (max end (point)))
18073 (while (re-search-forward re end t)
18074 (if (get-char-property (match-beginning 0) 'invisible)
18075 (throw 'exit t))))
18076 nil))))
18078 (defun org-metaup (&optional arg)
18079 "Move subtree up or move table row up.
18080 Calls `org-move-subtree-up' or `org-table-move-row' or
18081 `org-move-item-up', depending on context. See the individual commands
18082 for more information."
18083 (interactive "P")
18084 (cond
18085 ((run-hook-with-args-until-success 'org-metaup-hook))
18086 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18087 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18088 ((org-at-item-p) (call-interactively 'org-move-item-up))
18089 (t (transpose-lines 1) (beginning-of-line -1))))
18091 (defun org-metadown (&optional arg)
18092 "Move subtree down or move table row down.
18093 Calls `org-move-subtree-down' or `org-table-move-row' or
18094 `org-move-item-down', depending on context. See the individual
18095 commands for more information."
18096 (interactive "P")
18097 (cond
18098 ((run-hook-with-args-until-success 'org-metadown-hook))
18099 ((org-at-table-p) (call-interactively 'org-table-move-row))
18100 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18101 ((org-at-item-p) (call-interactively 'org-move-item-down))
18102 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18104 (defun org-shiftup (&optional arg)
18105 "Increase item in timestamp or increase priority of current headline.
18106 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18107 depending on context. See the individual commands for more information."
18108 (interactive "P")
18109 (cond
18110 ((run-hook-with-args-until-success 'org-shiftup-hook))
18111 ((and org-support-shift-select (org-region-active-p))
18112 (org-call-for-shift-select 'previous-line))
18113 ((org-at-timestamp-p t)
18114 (call-interactively (if org-edit-timestamp-down-means-later
18115 'org-timestamp-down 'org-timestamp-up)))
18116 ((and (not (eq org-support-shift-select 'always))
18117 org-enable-priority-commands
18118 (org-at-heading-p))
18119 (call-interactively 'org-priority-up))
18120 ((and (not org-support-shift-select) (org-at-item-p))
18121 (call-interactively 'org-previous-item))
18122 ((org-clocktable-try-shift 'up arg))
18123 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18124 (org-support-shift-select
18125 (org-call-for-shift-select 'previous-line))
18126 (t (org-shiftselect-error))))
18128 (defun org-shiftdown (&optional arg)
18129 "Decrease item in timestamp or decrease priority of current headline.
18130 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18131 depending on context. See the individual commands for more information."
18132 (interactive "P")
18133 (cond
18134 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18135 ((and org-support-shift-select (org-region-active-p))
18136 (org-call-for-shift-select 'next-line))
18137 ((org-at-timestamp-p t)
18138 (call-interactively (if org-edit-timestamp-down-means-later
18139 'org-timestamp-up 'org-timestamp-down)))
18140 ((and (not (eq org-support-shift-select 'always))
18141 org-enable-priority-commands
18142 (org-at-heading-p))
18143 (call-interactively 'org-priority-down))
18144 ((and (not org-support-shift-select) (org-at-item-p))
18145 (call-interactively 'org-next-item))
18146 ((org-clocktable-try-shift 'down arg))
18147 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18148 (org-support-shift-select
18149 (org-call-for-shift-select 'next-line))
18150 (t (org-shiftselect-error))))
18152 (defun org-shiftright (&optional arg)
18153 "Cycle the thing at point or in the current line, depending on context.
18154 Depending on context, this does one of the following:
18156 - switch a timestamp at point one day into the future
18157 - on a headline, switch to the next TODO keyword.
18158 - on an item, switch entire list to the next bullet type
18159 - on a property line, switch to the next allowed value
18160 - on a clocktable definition line, move time block into the future"
18161 (interactive "P")
18162 (cond
18163 ((run-hook-with-args-until-success 'org-shiftright-hook))
18164 ((and org-support-shift-select (org-region-active-p))
18165 (org-call-for-shift-select 'forward-char))
18166 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18167 ((and (not (eq org-support-shift-select 'always))
18168 (org-at-heading-p))
18169 (let ((org-inhibit-logging
18170 (not org-treat-S-cursor-todo-selection-as-state-change))
18171 (org-inhibit-blocking
18172 (not org-treat-S-cursor-todo-selection-as-state-change)))
18173 (org-call-with-arg 'org-todo 'right)))
18174 ((or (and org-support-shift-select
18175 (not (eq org-support-shift-select 'always))
18176 (org-at-item-bullet-p))
18177 (and (not org-support-shift-select) (org-at-item-p)))
18178 (org-call-with-arg 'org-cycle-list-bullet nil))
18179 ((and (not (eq org-support-shift-select 'always))
18180 (org-at-property-p))
18181 (call-interactively 'org-property-next-allowed-value))
18182 ((org-clocktable-try-shift 'right arg))
18183 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18184 (org-support-shift-select
18185 (org-call-for-shift-select 'forward-char))
18186 (t (org-shiftselect-error))))
18188 (defun org-shiftleft (&optional arg)
18189 "Cycle the thing at point or in the current line, depending on context.
18190 Depending on context, this does one of the following:
18192 - switch a timestamp at point one day into the past
18193 - on a headline, switch to the previous TODO keyword.
18194 - on an item, switch entire list to the previous bullet type
18195 - on a property line, switch to the previous allowed value
18196 - on a clocktable definition line, move time block into the past"
18197 (interactive "P")
18198 (cond
18199 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18200 ((and org-support-shift-select (org-region-active-p))
18201 (org-call-for-shift-select 'backward-char))
18202 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18203 ((and (not (eq org-support-shift-select 'always))
18204 (org-at-heading-p))
18205 (let ((org-inhibit-logging
18206 (not org-treat-S-cursor-todo-selection-as-state-change))
18207 (org-inhibit-blocking
18208 (not org-treat-S-cursor-todo-selection-as-state-change)))
18209 (org-call-with-arg 'org-todo 'left)))
18210 ((or (and org-support-shift-select
18211 (not (eq org-support-shift-select 'always))
18212 (org-at-item-bullet-p))
18213 (and (not org-support-shift-select) (org-at-item-p)))
18214 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18215 ((and (not (eq org-support-shift-select 'always))
18216 (org-at-property-p))
18217 (call-interactively 'org-property-previous-allowed-value))
18218 ((org-clocktable-try-shift 'left arg))
18219 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18220 (org-support-shift-select
18221 (org-call-for-shift-select 'backward-char))
18222 (t (org-shiftselect-error))))
18224 (defun org-shiftcontrolright ()
18225 "Switch to next TODO set."
18226 (interactive)
18227 (cond
18228 ((and org-support-shift-select (org-region-active-p))
18229 (org-call-for-shift-select 'forward-word))
18230 ((and (not (eq org-support-shift-select 'always))
18231 (org-at-heading-p))
18232 (org-call-with-arg 'org-todo 'nextset))
18233 (org-support-shift-select
18234 (org-call-for-shift-select 'forward-word))
18235 (t (org-shiftselect-error))))
18237 (defun org-shiftcontrolleft ()
18238 "Switch to previous TODO set."
18239 (interactive)
18240 (cond
18241 ((and org-support-shift-select (org-region-active-p))
18242 (org-call-for-shift-select 'backward-word))
18243 ((and (not (eq org-support-shift-select 'always))
18244 (org-at-heading-p))
18245 (org-call-with-arg 'org-todo 'previousset))
18246 (org-support-shift-select
18247 (org-call-for-shift-select 'backward-word))
18248 (t (org-shiftselect-error))))
18250 (defun org-shiftcontrolup ()
18251 "Change timestamps synchronously up in CLOCK log lines."
18252 (interactive)
18253 (cond ((and (not org-support-shift-select)
18254 (org-at-clock-log-p)
18255 (org-at-timestamp-p t))
18256 (org-clock-timestamps-up))
18257 (t (org-shiftselect-error))))
18259 (defun org-shiftcontroldown ()
18260 "Change timestamps synchronously down in CLOCK log lines."
18261 (interactive)
18262 (cond ((and (not org-support-shift-select)
18263 (org-at-clock-log-p)
18264 (org-at-timestamp-p t))
18265 (org-clock-timestamps-down))
18266 (t (org-shiftselect-error))))
18268 (defun org-ctrl-c-ret ()
18269 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18270 (interactive)
18271 (cond
18272 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18273 (t (call-interactively 'org-insert-heading))))
18275 (defun org-find-visible ()
18276 (let ((s (point)))
18277 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18278 (get-char-property s 'invisible)))
18279 s))
18280 (defun org-find-invisible ()
18281 (let ((s (point)))
18282 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18283 (not (get-char-property s 'invisible))))
18284 s))
18286 (defun org-copy-visible (beg end)
18287 "Copy the visible parts of the region."
18288 (interactive "r")
18289 (let (snippets s)
18290 (save-excursion
18291 (save-restriction
18292 (narrow-to-region beg end)
18293 (setq s (goto-char (point-min)))
18294 (while (not (= (point) (point-max)))
18295 (goto-char (org-find-invisible))
18296 (push (buffer-substring s (point)) snippets)
18297 (setq s (goto-char (org-find-visible))))))
18298 (kill-new (apply 'concat (nreverse snippets)))))
18300 (defun org-copy-special ()
18301 "Copy region in table or copy current subtree.
18302 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18303 See the individual commands for more information."
18304 (interactive)
18305 (call-interactively
18306 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18308 (defun org-cut-special ()
18309 "Cut region in table or cut current subtree.
18310 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18311 See the individual commands for more information."
18312 (interactive)
18313 (call-interactively
18314 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18316 (defun org-paste-special (arg)
18317 "Paste rectangular region into table, or past subtree relative to level.
18318 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18319 See the individual commands for more information."
18320 (interactive "P")
18321 (if (org-at-table-p)
18322 (org-table-paste-rectangle)
18323 (org-paste-subtree arg)))
18325 (defun org-edit-special (&optional arg)
18326 "Call a special editor for the stuff at point.
18327 When at a table, call the formula editor with `org-table-edit-formulas'.
18328 When at the first line of an src example, call `org-edit-src-code'.
18329 When in an #+include line, visit the include file. Otherwise call
18330 `ffap' to visit the file at point."
18331 (interactive)
18332 ;; possibly prep session before editing source
18333 (when arg
18334 (let* ((info (org-babel-get-src-block-info))
18335 (lang (nth 0 info))
18336 (params (nth 2 info))
18337 (session (cdr (assoc :session params))))
18338 (when (and info session) ;; we are in a source-code block with a session
18339 (funcall
18340 (intern (concat "org-babel-prep-session:" lang)) session params))))
18341 (cond ;; proceed with `org-edit-special'
18342 ((save-excursion
18343 (beginning-of-line 1)
18344 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18345 (find-file (org-trim (match-string 1))))
18346 ((org-edit-src-code))
18347 ((org-edit-fixed-width-region))
18348 ((org-at-table.el-p)
18349 (org-edit-src-code))
18350 ((or (org-at-table-p)
18351 (save-excursion
18352 (beginning-of-line 1)
18354 (call-interactively 'org-table-edit-formulas))
18355 (t (call-interactively 'ffap))))
18357 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18358 (defun org-ctrl-c-ctrl-c (&optional arg)
18359 "Set tags in headline, or update according to changed information at point.
18361 This command does many different things, depending on context:
18363 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18364 this is what we do.
18366 - If the cursor is on a statistics cookie, update it.
18368 - If the cursor is in a headline, prompt for tags and insert them
18369 into the current line, aligned to `org-tags-column'. When called
18370 with prefix arg, realign all tags in the current buffer.
18372 - If the cursor is in one of the special #+KEYWORD lines, this
18373 triggers scanning the buffer for these lines and updating the
18374 information.
18376 - If the cursor is inside a table, realign the table. This command
18377 works even if the automatic table editor has been turned off.
18379 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18380 the entire table.
18382 - If the cursor is at a footnote reference or definition, jump to
18383 the corresponding definition or references, respectively.
18385 - If the cursor is a the beginning of a dynamic block, update it.
18387 - If the current buffer is a capture buffer, close note and file it.
18389 - If the cursor is on a <<<target>>>, update radio targets and
18390 corresponding links in this buffer.
18392 - If the cursor is on a numbered item in a plain list, renumber the
18393 ordered list.
18395 - If the cursor is on a checkbox, toggle it.
18397 - If the cursor is on a code block, evaluate it. The variable
18398 `org-confirm-babel-evaluate' can be used to control prompting
18399 before code block evaluation, by default every code block
18400 evaluation requires confirmation. Code block evaluation can be
18401 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18402 (interactive "P")
18403 (let ((org-enable-table-editor t))
18404 (cond
18405 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18406 org-occur-highlights
18407 org-latex-fragment-image-overlays)
18408 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18409 (org-remove-occur-highlights)
18410 (org-remove-latex-fragment-image-overlays)
18411 (message "Temporary highlights/overlays removed from current buffer"))
18412 ((and (local-variable-p 'org-finish-function (current-buffer))
18413 (fboundp org-finish-function))
18414 (funcall org-finish-function))
18415 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18416 ((org-in-regexp org-ts-regexp-both)
18417 (org-timestamp-change 0 'day))
18418 ((or (looking-at org-property-start-re)
18419 (org-at-property-p))
18420 (call-interactively 'org-property-action))
18421 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18423 (or (org-at-heading-p) (org-at-item-p)))
18424 (call-interactively 'org-update-statistics-cookies))
18425 ((org-at-heading-p) (call-interactively 'org-set-tags))
18426 ((org-at-table.el-p)
18427 (message "Use C-c ' to edit table.el tables"))
18428 ((org-at-table-p)
18429 (org-table-maybe-eval-formula)
18430 (if arg
18431 (call-interactively 'org-table-recalculate)
18432 (org-table-maybe-recalculate-line))
18433 (call-interactively 'org-table-align)
18434 (orgtbl-send-table 'maybe))
18435 ((or (org-footnote-at-reference-p)
18436 (org-footnote-at-definition-p))
18437 (call-interactively 'org-footnote-action))
18438 ((org-at-item-checkbox-p)
18439 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18440 ;; list only if at top item.
18441 (let* ((cbox (match-string 1))
18442 (struct (org-list-struct))
18443 (old-struct (copy-tree struct))
18444 (parents (org-list-parents-alist struct))
18445 (orderedp (org-entry-get nil "ORDERED"))
18446 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18447 block-item)
18448 ;; Use a light version of `org-toggle-checkbox' to avoid
18449 ;; computing list structure twice.
18450 (let ((new-box (cond
18451 ((equal arg '(16)) "[-]")
18452 ((equal arg '(4)) nil)
18453 ((equal "[X]" cbox) "[ ]")
18454 (t "[X]"))))
18455 (if (and firstp arg)
18456 ;; If at first item of sub-list, remove check-box from
18457 ;; every item at the same level.
18458 (mapc
18459 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18460 (org-list-get-all-items
18461 (point-at-bol) struct (org-list-prevs-alist struct)))
18462 (org-list-set-checkbox (point-at-bol) struct new-box)))
18463 ;; Replicate `org-list-write-struct', while grabbing a return
18464 ;; value from `org-list-struct-fix-box'.
18465 (org-list-struct-fix-ind struct parents 2)
18466 (org-list-struct-fix-item-end struct)
18467 (let ((prevs (org-list-prevs-alist struct)))
18468 (org-list-struct-fix-bul struct prevs)
18469 (org-list-struct-fix-ind struct parents)
18470 (setq block-item
18471 (org-list-struct-fix-box struct parents prevs orderedp)))
18472 (org-list-struct-apply-struct struct old-struct)
18473 (org-update-checkbox-count-maybe)
18474 (when block-item
18475 (message
18476 "Checkboxes were removed due to unchecked box at line %d"
18477 (org-current-line block-item)))
18478 (when firstp (org-list-send-list 'maybe))))
18479 ((org-at-item-p)
18480 ;; Cursor at an item: repair list. Do checkbox related actions
18481 ;; only if function was called with an argument. Send list only
18482 ;; if at top item.
18483 (let* ((struct (org-list-struct))
18484 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18485 old-struct)
18486 (when arg
18487 (setq old-struct (copy-tree struct))
18488 (if firstp
18489 ;; If at first item of sub-list, add check-box to every
18490 ;; item at the same level.
18491 (mapc
18492 (lambda (pos)
18493 (unless (org-list-get-checkbox pos struct)
18494 (org-list-set-checkbox pos struct "[ ]")))
18495 (org-list-get-all-items
18496 (point-at-bol) struct (org-list-prevs-alist struct)))
18497 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18498 (org-list-write-struct
18499 struct (org-list-parents-alist struct) old-struct)
18500 (when arg (org-update-checkbox-count-maybe))
18501 (when firstp (org-list-send-list 'maybe))))
18502 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18503 ;; Dynamic block
18504 (beginning-of-line 1)
18505 (save-excursion (org-update-dblock)))
18506 ((save-excursion
18507 (beginning-of-line 1)
18509 (cond
18510 ((equal (match-string 1) "TBLFM")
18511 ;; Recalculate the table before this line
18512 (save-excursion
18513 (beginning-of-line 1)
18515 (if (org-at-table-p)
18516 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18517 (t
18518 (let ((org-inhibit-startup-visibility-stuff t)
18519 (org-startup-align-all-tables nil))
18520 (when (boundp 'org-table-coordinate-overlays)
18521 (mapc 'delete-overlay org-table-coordinate-overlays)
18522 (setq org-table-coordinate-overlays nil))
18523 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18524 (message "Local setup has been refreshed"))))
18525 ((org-clock-update-time-maybe))
18526 (t
18527 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18528 (error "C-c C-c can do nothing useful at this location"))))))
18530 (defun org-mode-restart ()
18531 "Restart Org-mode, to scan again for special lines.
18532 Also updates the keyword regular expressions."
18533 (interactive)
18534 (org-mode)
18535 (message "Org-mode restarted"))
18537 (defun org-kill-note-or-show-branches ()
18538 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18539 (interactive)
18540 (if (not org-finish-function)
18541 (progn
18542 (hide-subtree)
18543 (call-interactively 'show-branches))
18544 (let ((org-note-abort t))
18545 (funcall org-finish-function))))
18547 (defun org-return (&optional indent)
18548 "Goto next table row or insert a newline.
18549 Calls `org-table-next-row' or `newline', depending on context.
18550 See the individual commands for more information."
18551 (interactive)
18552 (cond
18553 ((bobp) (if indent (newline-and-indent) (newline)))
18554 ((org-at-table-p)
18555 (org-table-justify-field-maybe)
18556 (call-interactively 'org-table-next-row))
18557 ;; when `newline-and-indent' is called within a list, make sure
18558 ;; text moved stays inside the item.
18559 ((and (org-in-item-p) indent)
18560 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18561 (progn
18562 (save-match-data (newline))
18563 (org-indent-line-to (length (match-string 0))))
18564 (let ((ind (org-get-indentation)))
18565 (newline)
18566 (if (org-looking-back org-list-end-re)
18567 (org-indent-line-function)
18568 (org-indent-line-to ind)))))
18569 ((and org-return-follows-link
18570 (let ((tprop (get-text-property (point) 'face)))
18571 (or (eq tprop 'org-link)
18572 (and (listp tprop) (memq 'org-link tprop)))))
18573 (call-interactively 'org-open-at-point))
18574 ((and (org-at-heading-p)
18575 (looking-at
18577 (org-show-entry)
18578 (end-of-line 1)
18579 (newline))
18580 (t (if indent (newline-and-indent) (newline)))))
18582 (defun org-return-indent ()
18583 "Goto next table row or insert a newline and indent.
18584 Calls `org-table-next-row' or `newline-and-indent', depending on
18585 context. See the individual commands for more information."
18586 (interactive)
18587 (org-return t))
18589 (defun org-ctrl-c-star ()
18590 "Compute table, or change heading status of lines.
18591 Calls `org-table-recalculate' or `org-toggle-heading',
18592 depending on context."
18593 (interactive)
18594 (cond
18595 ((org-at-table-p)
18596 (call-interactively 'org-table-recalculate))
18597 (t
18598 ;; Convert all lines in region to list items
18599 (call-interactively 'org-toggle-heading))))
18601 (defun org-ctrl-c-minus ()
18602 "Insert separator line in table or modify bullet status of line.
18603 Also turns a plain line or a region of lines into list items.
18604 Calls `org-table-insert-hline', `org-toggle-item', or
18605 `org-cycle-list-bullet', depending on context."
18606 (interactive)
18607 (cond
18608 ((org-at-table-p)
18609 (call-interactively 'org-table-insert-hline))
18610 ((org-region-active-p)
18611 (call-interactively 'org-toggle-item))
18612 ((org-in-item-p)
18613 (call-interactively 'org-cycle-list-bullet))
18614 (t
18615 (call-interactively 'org-toggle-item))))
18617 (defun org-toggle-item (arg)
18618 "Convert headings or normal lines to items, items to normal lines.
18619 If there is no active region, only the current line is considered.
18621 If the first non blank line in the region is an headline, convert
18622 all headlines to items, shifting text accordingly.
18624 If it is an item, convert all items to normal lines.
18626 If it is normal text, change region into an item. With a prefix
18627 argument ARG, change each line in region into an item."
18628 (interactive "P")
18629 (let ((shift-text
18630 (function
18631 ;; Shift text in current section to IND, from point to END.
18632 ;; The function leaves point to END line.
18633 (lambda (ind end)
18634 (let ((min-i 1000) (end (copy-marker end)))
18635 ;; First determine the minimum indentation (MIN-I) of
18636 ;; the text.
18637 (save-excursion
18638 (catch 'exit
18639 (while (< (point) end)
18640 (let ((i (org-get-indentation)))
18641 (cond
18642 ;; Skip blank lines and inline tasks.
18644 ((looking-at org-outline-regexp-bol))
18645 ;; We can't find less than 0 indentation.
18646 ((zerop i) (throw 'exit (setq min-i 0)))
18647 ((< i min-i) (setq min-i i))))
18648 (forward-line))))
18649 ;; Then indent each line so that a line indented to
18650 ;; MIN-I becomes indented to IND. Ignore blank lines
18651 ;; and inline tasks in the process.
18652 (let ((delta (- ind min-i)))
18653 (while (< (point) end)
18655 (looking-at org-outline-regexp-bol))
18656 (org-indent-line-to (+ (org-get-indentation) delta)))
18657 (forward-line)))))))
18658 (skip-blanks
18659 (function
18660 ;; Return beginning of first non-blank line, starting from
18661 ;; line at POS.
18662 (lambda (pos)
18663 (save-excursion
18664 (goto-char pos)
18666 (point-at-bol)))))
18667 beg end)
18668 ;; Determine boundaries of changes.
18669 (if (org-region-active-p)
18670 (setq beg (funcall skip-blanks (region-beginning))
18671 end (copy-marker (region-end)))
18672 (setq beg (funcall skip-blanks (point-at-bol))
18673 end (copy-marker (point-at-eol))))
18674 ;; Depending on the starting line, choose an action on the text
18675 ;; between BEG and END.
18676 (org-with-limited-levels
18677 (save-excursion
18678 (goto-char beg)
18679 (cond
18680 ;; Case 1. Start at an item: de-itemize. Note that it only
18681 ;; happens when a region is active: `org-ctrl-c-minus'
18682 ;; would call `org-cycle-list-bullet' otherwise.
18683 ((org-at-item-p)
18684 (while (< (point) end)
18685 (when (org-at-item-p)
18687 (delete-region (point) (match-end 0)))
18688 (forward-line)))
18689 ;; Case 2. Start at an heading: convert to items.
18690 ((org-at-heading-p)
18691 (let* ((bul (org-list-bullet-string "-"))
18692 (bul-len (length bul))
18693 ;; Indentation of the first heading. It should be
18694 ;; relative to the indentation of its parent, if any.
18695 (start-ind (save-excursion
18696 (cond
18697 ((not org-adapt-indentation) 0)
18698 ((not (outline-previous-heading)) 0)
18699 (t (length (match-string 0))))))
18700 ;; Level of first heading. Further headings will be
18701 ;; compared to it to determine hierarchy in the list.
18702 (ref-level (org-reduced-level (org-outline-level))))
18703 (while (< (point) end)
18704 (let* ((level (org-reduced-level (org-outline-level)))
18705 (delta (max 0 (- level ref-level))))
18706 ;; If current headline is less indented than the first
18707 ;; one, set it as reference, in order to preserve
18708 ;; subtrees.
18709 (when (< level ref-level) (setq ref-level level))
18710 (replace-match bul t t)
18711 (org-indent-line-to (+ start-ind (* delta bul-len)))
18712 ;; Ensure all text down to END (or SECTION-END) belongs
18713 ;; to the newly created item.
18714 (let ((section-end (save-excursion
18715 (or (outline-next-heading) (point)))))
18716 (forward-line)
18717 (funcall shift-text
18718 (+ start-ind (* (1+ delta) bul-len))
18719 (min end section-end)))))))
18720 ;; Case 3. Normal line with ARG: turn each non-item line into
18721 ;; an item.
18722 (arg
18723 (while (< (point) end)
18724 (unless (or (org-at-heading-p) (org-at-item-p))
18726 (replace-match
18728 (forward-line)))
18729 ;; Case 4. Normal line without ARG: make the first line of
18730 ;; region an item, and shift indentation of others
18731 ;; lines to set them as item's body.
18732 (t (let* ((bul (org-list-bullet-string "-"))
18733 (bul-len (length bul))
18734 (ref-ind (org-get-indentation)))
18736 (insert bul)
18737 (forward-line)
18738 (while (< (point) end)
18739 ;; Ensure that lines less indented than first one
18740 ;; still get included in item body.
18741 (funcall shift-text
18742 (+ ref-ind bul-len)
18743 (min end (save-excursion (or (outline-next-heading)
18744 (point)))))
18745 (forward-line)))))))))
18747 (defun org-toggle-heading (&optional nstars)
18748 "Convert headings to normal text, or items or text to headings.
18749 If there is no active region, only the current line is considered.
18751 If the first non blank line is an headline, remove the stars from
18752 all headlines in the region.
18754 If it is a plain list item, turn all plain list items into headings.
18756 If it is a normal line, turn each and every normal line (i.e. not
18757 an heading or an item) in the region into a heading.
18759 When converting a line into a heading, the number of stars is chosen
18760 such that the lines become children of the current entry. However,
18761 when a prefix argument is given, its value determines the number of
18762 stars to add."
18763 (interactive "P")
18764 (let ((skip-blanks
18765 (function
18766 ;; Return beginning of first non-blank line, starting from
18767 ;; line at POS.
18768 (lambda (pos)
18769 (save-excursion
18770 (goto-char pos)
18772 (point-at-bol)))))
18773 beg end)
18774 ;; Determine boundaries of changes. If region ends at a bol, do
18775 ;; not consider the last line to be in the region.
18776 (if (org-region-active-p)
18777 (setq beg (funcall skip-blanks (region-beginning))
18778 end (copy-marker (save-excursion
18779 (goto-char (region-end))
18780 (if (bolp) (point) (point-at-eol)))))
18781 (setq beg (funcall skip-blanks (point-at-bol))
18782 end (copy-marker (point-at-eol))))
18783 ;; Ensure inline tasks don't count as headings.
18784 (org-with-limited-levels
18785 (save-excursion
18786 (goto-char beg)
18787 (cond
18788 ;; Case 1. Started at an heading: de-star headings.
18789 ((org-at-heading-p)
18790 (while (< (point) end)
18791 (when (org-at-heading-p t)
18792 (looking-at org-outline-regexp) (replace-match ""))
18793 (forward-line)))
18794 ;; Case 2. Started at an item: change items into headlines.
18795 ;; One star will be added by `org-list-to-subtree'.
18796 ((org-at-item-p)
18797 (let* ((stars (make-string
18798 (if nstars
18799 ;; subtract the star that will be added again by
18800 ;; `org-list-to-subtree'
18801 (1- (prefix-numeric-value current-prefix-arg))
18802 (or (org-current-level) 0))
18803 ?*))
18804 (add-stars
18805 (cond (nstars "") ; stars from prefix only
18806 ((equal stars "") "") ; before first heading
18807 (org-odd-levels-only "*") ; inside heading, odd
18808 (t "")))) ; inside heading, oddeven
18809 (while (< (point) end)
18810 (when (org-at-item-p)
18811 ;; Pay attention to cases when region ends before list.
18812 (let* ((struct (org-list-struct))
18813 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18814 (save-restriction
18815 (narrow-to-region (point) list-end)
18816 (insert
18817 (org-list-to-subtree
18818 (org-list-parse-list t)
18819 '(:istart (concat stars add-stars (funcall get-stars depth))
18820 :icount (concat stars add-stars (funcall get-stars depth))))))))
18821 (forward-line))))
18822 ;; Case 3. Started at normal text: make every line an heading,
18823 ;; skipping headlines and items.
18824 (t (let* ((stars (make-string
18825 (if nstars
18826 (prefix-numeric-value current-prefix-arg)
18827 (or (org-current-level) 0))
18828 ?*))
18829 (add-stars
18830 (cond (nstars "") ; stars from prefix only
18831 ((equal stars "") "*") ; before first heading
18832 (org-odd-levels-only "**") ; inside heading, odd
18833 (t "*"))) ; inside heading, oddeven
18834 (rpl (concat stars add-stars " ")))
18835 (while (< (point) end)
18836 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18838 (replace-match (concat rpl (match-string 2))))
18839 (forward-line)))))))))
18841 (defun org-meta-return (&optional arg)
18842 "Insert a new heading or wrap a region in a table.
18843 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18844 See the individual commands for more information."
18845 (interactive "P")
18846 (cond
18847 ((run-hook-with-args-until-success 'org-metareturn-hook))
18848 ((org-at-table-p)
18849 (call-interactively 'org-table-wrap-region))
18850 (t (call-interactively 'org-insert-heading))))
18852 ;;; Menu entries
18854 ;; Define the Org-mode menus
18855 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18856 '("Tbl"
18857 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18858 ["Next Field" org-cycle (org-at-table-p)]
18859 ["Previous Field" org-shifttab (org-at-table-p)]
18860 ["Next Row" org-return (org-at-table-p)]
18861 "--"
18862 ["Blank Field" org-table-blank-field (org-at-table-p)]
18863 ["Edit Field" org-table-edit-field (org-at-table-p)]
18864 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18865 "--"
18866 ("Column"
18867 ["Move Column Left" org-metaleft (org-at-table-p)]
18868 ["Move Column Right" org-metaright (org-at-table-p)]
18869 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18870 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18871 ("Row"
18872 ["Move Row Up" org-metaup (org-at-table-p)]
18873 ["Move Row Down" org-metadown (org-at-table-p)]
18874 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18875 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18876 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18877 "--"
18878 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18879 ("Rectangle"
18880 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18881 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18882 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18883 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18884 "--"
18885 ("Calculate"
18886 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18887 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18888 ["Edit Formulas" org-edit-special (org-at-table-p)]
18889 "--"
18890 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18891 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18892 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18893 "--"
18894 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18895 "--"
18896 ["Sum Column/Rectangle" org-table-sum
18897 (or (org-at-table-p) (org-region-active-p))]
18898 ["Which Column?" org-table-current-column (org-at-table-p)])
18899 ["Debug Formulas"
18900 org-table-toggle-formula-debugger
18901 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18902 ["Show Col/Row Numbers"
18903 org-table-toggle-coordinate-overlays
18904 :style toggle
18905 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18906 "--"
18907 ["Create" org-table-create (and (not (org-at-table-p))
18908 org-enable-table-editor)]
18909 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18910 ["Import from File" org-table-import (not (org-at-table-p))]
18911 ["Export to File" org-table-export (org-at-table-p)]
18912 "--"
18913 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18915 (easy-menu-define org-org-menu org-mode-map "Org menu"
18916 '("Org"
18917 ("Show/Hide"
18918 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18919 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18920 ["Sparse Tree..." org-sparse-tree t]
18921 ["Reveal Context" org-reveal t]
18922 ["Show All" show-all t]
18923 "--"
18924 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18925 "--"
18926 ["New Heading" org-insert-heading t]
18927 ("Navigate Headings"
18928 ["Up" outline-up-heading t]
18929 ["Next" outline-next-visible-heading t]
18930 ["Previous" outline-previous-visible-heading t]
18931 ["Next Same Level" outline-forward-same-level t]
18932 ["Previous Same Level" outline-backward-same-level t]
18933 "--"
18934 ["Jump" org-goto t])
18935 ("Edit Structure"
18936 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18937 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18938 "--"
18939 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18940 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18941 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18942 "--"
18943 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18944 "--"
18945 ["Copy visible text" org-copy-visible t]
18946 "--"
18947 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18948 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18949 ["Demote Heading" org-metaright (not (org-at-table-p))]
18950 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18951 "--"
18952 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18953 "--"
18954 ["Convert to odd levels" org-convert-to-odd-levels t]
18955 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18956 ("Editing"
18957 ["Emphasis..." org-emphasize t]
18958 ["Edit Source Example" org-edit-special t]
18959 "--"
18960 ["Footnote new/jump" org-footnote-action t]
18961 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18962 ("Archive"
18963 ["Archive (default method)" org-archive-subtree-default t]
18964 "--"
18965 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18966 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18967 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18968 )
18969 "--"
18970 ("Hyperlinks"
18971 ["Store Link (Global)" org-store-link t]
18972 ["Find existing link to here" org-occur-link-in-agenda-files t]
18973 ["Insert Link" org-insert-link t]
18974 ["Follow Link" org-open-at-point t]
18975 "--"
18976 ["Next link" org-next-link t]
18977 ["Previous link" org-previous-link t]
18978 "--"
18979 ["Descriptive Links"
18980 org-toggle-link-display
18981 :style radio
18982 :selected org-descriptive-links
18983 ]
18984 ["Literal Links"
18985 org-toggle-link-display
18986 :style radio
18987 :selected (not org-descriptive-links)])
18988 "--"
18989 ("TODO Lists"
18990 ["TODO/DONE/-" org-todo t]
18991 ("Select keyword"
18992 ["Next keyword" org-shiftright (org-at-heading-p)]
18993 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18994 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18995 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18996 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18997 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18998 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18999 "--"
19000 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19001 :selected org-enforce-todo-dependencies :style toggle :active t]
19002 "Settings for tree at point"
19003 ["Do Children sequentially" org-toggle-ordered-property :style radio
19004 :selected (org-entry-get nil "ORDERED")
19005 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19006 ["Do Children parallel" org-toggle-ordered-property :style radio
19007 :selected (not (org-entry-get nil "ORDERED"))
19008 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19009 "--"
19010 ["Set Priority" org-priority t]
19011 ["Priority Up" org-shiftup t]
19012 ["Priority Down" org-shiftdown t]
19013 "--"
19014 ["Get news from all feeds" org-feed-update-all t]
19015 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19016 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19017 ("TAGS and Properties"
19018 ["Set Tags" org-set-tags-command t]
19019 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19020 "--"
19021 ["Set property" org-set-property t]
19022 ["Column view of properties" org-columns t]
19023 ["Insert Column View DBlock" org-insert-columns-dblock t])
19024 ("Dates and Scheduling"
19025 ["Timestamp" org-time-stamp t]
19026 ["Timestamp (inactive)" org-time-stamp-inactive t]
19027 ("Change Date"
19028 ["1 Day Later" org-shiftright t]
19029 ["1 Day Earlier" org-shiftleft t]
19030 ["1 ... Later" org-shiftup t]
19031 ["1 ... Earlier" org-shiftdown t])
19032 ["Compute Time Range" org-evaluate-time-range t]
19033 ["Schedule Item" org-schedule t]
19034 ["Deadline" org-deadline t]
19035 "--"
19036 ["Custom time format" org-toggle-time-stamp-overlays
19037 :style radio :selected org-display-custom-times]
19038 "--"
19039 ["Goto Calendar" org-goto-calendar t]
19040 ["Date from Calendar" org-date-from-calendar t]
19041 "--"
19042 ["Start/Restart Timer" org-timer-start t]
19043 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19044 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19045 ["Insert Timer String" org-timer t]
19046 ["Insert Timer Item" org-timer-item t])
19047 ("Logging work"
19048 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19049 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19050 ["Clock out" org-clock-out t]
19051 ["Clock cancel" org-clock-cancel t]
19052 "--"
19053 ["Mark as default task" org-clock-mark-default-task t]
19054 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19055 ["Goto running clock" org-clock-goto t]
19056 "--"
19057 ["Display times" org-clock-display t]
19058 ["Create clock table" org-clock-report t]
19059 "--"
19060 ["Record DONE time"
19061 (progn (setq org-log-done (not org-log-done))
19062 (message "Switching to %s will %s record a timestamp"
19063 (car org-done-keywords)
19064 (if org-log-done "automatically" "not")))
19065 :style toggle :selected org-log-done])
19066 "--"
19067 ["Agenda Command..." org-agenda t]
19068 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19069 ("File List for Agenda")
19070 ("Special views current file"
19071 ["TODO Tree" org-show-todo-tree t]
19072 ["Check Deadlines" org-check-deadlines t]
19073 ["Timeline" org-timeline t]
19074 ["Tags/Property tree" org-match-sparse-tree t])
19075 "--"
19076 ["Export/Publish..." org-export t]
19077 ("LaTeX"
19078 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19079 :selected org-cdlatex-mode]
19080 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19081 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19082 ["Modify math symbol" org-cdlatex-math-modify
19083 (org-inside-LaTeX-fragment-p)]
19084 ["Insert citation" org-reftex-citation t]
19085 "--"
19086 ["Template for BEAMER" (progn (require 'org-beamer)
19087 (org-insert-beamer-options-template)) t])
19088 "--"
19089 ("MobileOrg"
19090 ["Push Files and Views" org-mobile-push t]
19091 ["Get Captured and Flagged" org-mobile-pull t]
19092 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19093 "--"
19094 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19095 "--"
19096 ("Documentation"
19097 ["Show Version" org-version t]
19098 ["Info Documentation" org-info t])
19099 ("Customize"
19100 ["Browse Org Group" org-customize t]
19101 "--"
19102 ["Expand This Menu" org-create-customize-menu
19103 (fboundp 'customize-menu-create)])
19104 ["Send bug report" org-submit-bug-report t]
19105 "--"
19106 ("Refresh/Reload"
19107 ["Refresh setup current buffer" org-mode-restart t]
19108 ["Reload Org (after update)" org-reload t]
19109 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19110 ))
19112 (defun org-info (&optional node)
19113 "Read documentation for Org-mode in the info system.
19114 With optional NODE, go directly to that node."
19115 (interactive)
19116 (info (format "(org)%s" (or node ""))))
19118 ;;;###autoload
19119 (defun org-submit-bug-report ()
19120 "Submit a bug report on Org-mode via mail.
19122 Don't hesitate to report any problems or inaccurate documentation.
19124 If you don't have setup sending mail from (X)Emacs, please copy the
19125 output buffer into your mail program, as it gives us important
19126 information about your Org-mode version and configuration."
19127 (interactive)
19128 (require 'reporter)
19129 (org-load-modules-maybe)
19130 (org-require-autoloaded-modules)
19131 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19132 (reporter-submit-bug-report
19133 "emacs-orgmode@gnu.org"
19134 (org-version)
19135 (let (list)
19136 (save-window-excursion
19137 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19138 (delete-other-windows)
19139 (erase-buffer)
19140 (insert "You are about to submit a bug report to the Org-mode mailing list.
19142 We would like to add your full Org-mode and Outline configuration to the
19143 bug report. This greatly simplifies the work of the maintainer and
19144 other experts on the mailing list.
19146 HOWEVER, some variables you have customized may contain private
19147 information. The names of customers, colleagues, or friends, might
19148 appear in the form of file names, tags, todo states, or search strings.
19149 If you answer yes to the prompt, you might want to check and remove
19150 such private information before sending the email.")
19151 (add-text-properties (point-min) (point-max) '(face org-warning))
19152 (when (yes-or-no-p "Include your Org-mode configuration ")
19153 (mapatoms
19154 (lambda (v)
19155 (and (boundp v)
19157 (or (and (symbol-value v)
19159 (and
19160 (get v 'custom-type) (get v 'standard-value)
19161 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19162 (push v list)))))
19163 (kill-buffer (get-buffer "*Warn about privacy*"))
19164 list))
19165 nil nil
19166 "Remember to cover the basics, that is, what you expected to happen and
19167 what in fact did happen. You don't know how to make a good report? See
19169 http://orgmode.org/manual/Feedback.html#Feedback
19171 Your bug report will be posted to the Org-mode mailing list.
19172 ------------------------------------------------------------------------")
19173 (save-excursion
19178 (defun org-install-agenda-files-menu ()
19179 (let ((bl (buffer-list)))
19180 (save-excursion
19181 (while bl
19182 (set-buffer (pop bl))
19183 (if (eq major-mode 'org-mode) (setq bl nil)))
19184 (when (eq major-mode 'org-mode)
19185 (easy-menu-change
19186 '("Org") "File List for Agenda"
19187 (append
19188 (list
19189 ["Edit File List" (org-edit-agenda-file-list) t]
19190 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19191 ["Remove Current File from List" org-remove-file t]
19192 ["Cycle through agenda files" org-cycle-agenda-files t]
19193 ["Occur in all agenda files" org-occur-in-agenda-files t]
19194 "--")
19195 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19197 ;;;; Documentation
19199 ;;;###autoload
19200 (defun org-require-autoloaded-modules ()
19201 (interactive)
19202 (mapc 'require
19203 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19204 org-docbook org-exp org-html org-icalendar
19205 org-id org-latex
19206 org-publish org-remember org-table
19207 org-timer org-xoxo)))
19209 ;;;###autoload
19210 (defun org-reload (&optional uncompiled)
19211 "Reload all org lisp files.
19212 With prefix arg UNCOMPILED, load the uncompiled versions."
19213 (interactive "P")
19214 (require 'find-func)
19216 (dir-org (file-name-directory (org-find-library-name "org")))
19217 (dir-org-contrib (ignore-errors
19218 (file-name-directory
19219 (org-find-library-name "org-contribdir"))))
19220 (babel-files
19221 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19222 (append (list nil "comint" "eval" "exp" "keys"
19223 "lob" "ref" "table" "tangle")
19224 (delq nil
19225 (mapcar
19226 (lambda (lang)
19227 (when (cdr lang) (symbol-name (car lang))))
19228 org-babel-load-languages)))))
19229 (files
19230 (append (directory-files dir-org t file-re)
19231 babel-files
19232 (and dir-org-contrib
19233 (directory-files dir-org-contrib t file-re))))
19234 (remove-re (concat (if (featurep 'xemacs)
19235 "org-colview" "org-colview-xemacs")
19237 (setq files (mapcar 'file-name-sans-extension files))
19238 (setq files (mapcar
19239 (lambda (x) (if (string-match remove-re x) nil x))
19240 files))
19241 (setq files (delq nil files))
19242 (mapc
19243 (lambda (f)
19244 (when (featurep (intern (file-name-nondirectory f)))
19245 (if (and (not uncompiled)
19246 (file-exists-p (concat f ".elc")))
19247 (load (concat f ".elc") nil nil t)
19248 (load (concat f ".el") nil nil t))))
19249 files))
19250 (org-version))
19252 ;;;###autoload
19253 (defun org-customize ()
19254 "Call the customize function with org as argument."
19255 (interactive)
19256 (org-load-modules-maybe)
19257 (org-require-autoloaded-modules)
19258 (customize-browse 'org))
19260 (defun org-create-customize-menu ()
19261 "Create a full customization menu for Org-mode, insert it into the menu."
19262 (interactive)
19263 (org-load-modules-maybe)
19264 (org-require-autoloaded-modules)
19265 (if (fboundp 'customize-menu-create)
19266 (progn
19267 (easy-menu-change
19268 '("Org") "Customize"
19269 `(["Browse Org group" org-customize t]
19270 "--"
19271 ,(customize-menu-create 'org)
19272 ["Set" Custom-set t]
19273 ["Save" Custom-save t]
19274 ["Reset to Current" Custom-reset-current t]
19275 ["Reset to Saved" Custom-reset-saved t]
19276 ["Reset to Standard Settings" Custom-reset-standard t]))
19278 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19280 ;;;; Miscellaneous stuff
19282 ;;; Generally useful functions
19284 (defun org-get-at-bol (property)
19285 "Get text property PROPERTY at beginning of line."
19286 (get-text-property (point-at-bol) property))
19288 (defun org-find-text-property-in-string (prop s)
19289 "Return the first non-nil value of property PROP in string S."
19290 (or (get-text-property 0 prop s)
19291 (get-text-property (or (next-single-property-change 0 prop s) 0)
19292 prop s)))
19294 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19295 "Display the given MESSAGE as a warning."
19296 (if (fboundp 'display-warning)
19297 (display-warning 'org message
19298 (if (featurep 'xemacs) 'warning :warning))
19299 (let ((buf (get-buffer-create "*Org warnings*")))
19300 (with-current-buffer buf
19301 (goto-char (point-max))
19302 (insert "Warning (Org): " message)
19303 (unless (bolp)
19304 (newline)))
19305 (display-buffer buf)
19306 (sit-for 0))))
19308 (defun org-eval (form)
19309 "Eval FORM and return result."
19310 (condition-case error
19311 (eval form)
19312 (error (format "%%![Error: %s]" error))))
19314 (defun org-in-clocktable-p ()
19315 "Check if the cursor is in a clocktable."
19316 (let ((pos (point)) start)
19317 (save-excursion
19318 (end-of-line 1)
19320 (setq start (match-beginning 0))
19322 (>= (match-end 0) pos)
19323 start))))
19325 (defun org-in-commented-line ()
19326 "Is point in a line starting with `#'?"
19327 (equal (char-after (point-at-bol)) ?#))
19329 (defun org-in-indented-comment-line ()
19330 "Is point in a line starting with `#' after some white space?"
19331 (save-excursion
19332 (save-match-data
19333 (goto-char (point-at-bol))
19336 (defun org-in-verbatim-emphasis ()
19337 (save-match-data
19338 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19340 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19341 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19342 (if (and marker (marker-buffer marker)
19343 (buffer-live-p (marker-buffer marker)))
19344 (progn
19345 (org-pop-to-buffer-same-window (marker-buffer marker))
19346 (if (or (> marker (point-max)) (< marker (point-min)))
19347 (widen))
19348 (goto-char marker)
19349 (org-show-context 'org-goto))
19350 (if bookmark
19351 (bookmark-jump bookmark)
19352 (error "Cannot find location"))))
19354 (defun org-quote-csv-field (s)
19355 "Quote field for inclusion in CSV material."
19358 s))
19360 (defun org-force-self-insert (N)
19361 "Needed to enforce self-insert under remapping."
19362 (interactive "p")
19363 (self-insert-command N))
19365 (defun org-string-width (s)
19366 "Compute width of string, ignoring invisible characters.
19367 This ignores character with invisibility property `org-link', and also
19368 characters with property `org-cwidth', because these will become invisible
19369 upon the next fontification round."
19370 (let (b l)
19371 (when (or (eq t buffer-invisibility-spec)
19372 (assq 'org-link buffer-invisibility-spec))
19373 (while (setq b (text-property-any 0 (length s)
19374 'invisible 'org-link s))
19375 (setq s (concat (substring s 0 b)
19376 (substring s (or (next-single-property-change
19377 b 'invisible s) (length s)))))))
19378 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19379 (setq s (concat (substring s 0 b)
19380 (substring s (or (next-single-property-change
19381 b 'org-cwidth s) (length s))))))
19382 (setq l (string-width s) b -1)
19383 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19384 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19385 l))
19387 (defun org-shorten-string (s maxlength)
19388 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19389 If the string is shorter or has length MAXLENGTH, just return the
19390 original string. If it is longer, the functions finds a space in the
19391 string, breaks this string off at that locations and adds three dots
19392 as ellipsis. Including the ellipsis, the string will not be longer
19393 than MAXLENGTH. If finding a good breaking point in the string does
19394 not work, the string is just chopped off in the middle of a word
19395 if necessary."
19396 (if (<= (length s) maxlength)
19397 s
19398 (let* ((n (max (- maxlength 4) 1))
19400 (if (string-match re s)
19401 (concat (match-string 1 s) "...")
19402 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19404 (defun org-get-indentation (&optional line)
19405 "Get the indentation of the current line, interpreting tabs.
19406 When LINE is given, assume it represents a line and compute its indentation."
19407 (if line
19408 (if (string-match "^ *" (org-remove-tabs line))
19409 (match-end 0))
19410 (save-excursion
19411 (beginning-of-line 1)
19413 (current-column))))
19415 (defun org-get-string-indentation (s)
19416 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19417 (let ((n -1) (i 0) (w tab-width) c)
19418 (catch 'exit
19419 (while (< (setq n (1+ n)) (length s))
19420 (setq c (aref s n))
19421 (cond ((= c ?\ ) (setq i (1+ i)))
19423 (t (throw 'exit t)))))
19424 i))
19426 (defun org-remove-tabs (s &optional width)
19427 "Replace tabulators in S with spaces.
19428 Assumes that s is a single line, starting in column 0."
19429 (setq width (or width tab-width))
19431 (setq s (replace-match
19432 (make-string
19433 (- (* width (/ (+ (match-beginning 0) width) width))
19434 (match-beginning 0)) ?\ )
19435 t t s)))
19436 s)
19438 (defun org-fix-indentation (line ind)
19439 "Fix indentation in LINE.
19440 IND is a cons cell with target and minimum indentation.
19441 If the current indentation in LINE is smaller than the minimum,
19442 leave it alone. If it is larger than ind, set it to the target."
19443 (let* ((l (org-remove-tabs line))
19444 (i (org-get-indentation l))
19445 (i1 (car ind)) (i2 (cdr ind)))
19446 (if (>= i i2) (setq l (substring line i2)))
19447 (if (> i1 0)
19448 (concat (make-string i1 ?\ ) l)
19449 l)))
19451 (defun org-remove-indentation (code &optional n)
19452 "Remove the maximum common indentation from the lines in CODE.
19453 N may optionally be the number of spaces to remove."
19454 (with-temp-buffer
19455 (insert code)
19456 (org-do-remove-indentation n)
19457 (buffer-string)))
19459 (defun org-do-remove-indentation (&optional n)
19460 "Remove the maximum common indentation from the buffer."
19461 (untabify (point-min) (point-max))
19462 (let ((min 10000) re)
19463 (if n
19464 (setq min n)
19465 (goto-char (point-min))
19467 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19468 (unless (or (= min 0) (= min 10000))
19470 (goto-char (point-min))
19471 (while (re-search-forward re nil t)
19472 (replace-match "")
19473 (end-of-line 1))
19474 min)))
19476 (defun org-fill-template (template alist)
19477 "Find each %key of ALIST in TEMPLATE and replace it."
19478 (let ((case-fold-search nil)
19479 entry key value)
19480 (setq alist (sort (copy-sequence alist)
19481 (lambda (a b) (< (length (car a)) (length (car b))))))
19482 (while (setq entry (pop alist))
19483 (setq template
19484 (replace-regexp-in-string
19485 (concat "%" (regexp-quote (car entry)))
19486 (cdr entry) template t t)))
19487 template))
19489 (defun org-base-buffer (buffer)
19490 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19491 (if (not buffer)
19492 buffer
19493 (or (buffer-base-buffer buffer)
19494 buffer)))
19496 (defun org-trim (s)
19497 "Remove whitespace at beginning and end of string."
19500 s)
19502 (defun org-wrap (string &optional width lines)
19503 "Wrap string to either a number of lines, or a width in characters.
19504 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19505 that costs. If there is a word longer than WIDTH, the text is actually
19506 wrapped to the length of that word.
19507 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19508 many lines, whatever width that takes.
19509 The return value is a list of lines, without newlines at the end."
19511 (maxword (apply 'max (mapcar 'org-string-width words)))
19512 w ll)
19513 (cond (width
19514 (org-do-wrap words (max maxword width)))
19515 (lines
19516 (setq w maxword)
19517 (setq ll (org-do-wrap words maxword))
19518 (if (<= (length ll) lines)
19519 ll
19520 (setq ll words)
19521 (while (> (length ll) lines)
19522 (setq w (1+ w))
19523 (setq ll (org-do-wrap words w)))
19524 ll))
19525 (t (error "Cannot wrap this")))))
19527 (defun org-do-wrap (words width)
19528 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19529 (let (lines line)
19530 (while words
19531 (setq line (pop words))
19532 (while (and words (< (+ (length line) (length (car words))) width))
19533 (setq line (concat line " " (pop words))))
19534 (setq lines (push line lines)))
19535 (nreverse lines)))
19537 (defun org-split-string (string &optional separators)
19538 "Splits STRING into substrings at SEPARATORS.
19539 No empty strings are returned if there are matches at the beginning
19540 and end of string."
19542 (start 0)
19543 notfirst
19544 (list nil))
19545 (while (and (string-match rexp string
19546 (if (and notfirst
19547 (= start (match-beginning 0))
19548 (< start (length string)))
19549 (1+ start) start))
19550 (< (match-beginning 0) (length string)))
19551 (setq notfirst t)
19552 (or (eq (match-beginning 0) 0)
19553 (and (eq (match-beginning 0) (match-end 0))
19554 (eq (match-beginning 0) start))
19555 (setq list
19556 (cons (substring string start (match-beginning 0))
19557 list)))
19558 (setq start (match-end 0)))
19559 (or (eq start (length string))
19560 (setq list
19561 (cons (substring string start)
19562 list)))
19563 (nreverse list)))
19565 (defun org-quote-vert (s)
19567 (while (string-match "|" s)
19569 s)
19571 (defun org-uuidgen-p (s)
19572 "Is S an ID created by UUIDGEN?"
19573 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19575 (defun org-context ()
19576 "Return a list of contexts of the current cursor position.
19577 If several contexts apply, all are returned.
19578 Each context entry is a list with a symbol naming the context, and
19579 two positions indicating start and end of the context. Possible
19580 contexts are:
19582 :headline anywhere in a headline
19583 :headline-stars on the leading stars in a headline
19584 :todo-keyword on a TODO keyword (including DONE) in a headline
19585 :tags on the TAGS in a headline
19586 :priority on the priority cookie in a headline
19587 :item on the first line of a plain list item
19588 :item-bullet on the bullet/number of a plain list item
19589 :checkbox on the checkbox in a plain list item
19590 :table in an org-mode table
19591 :table-special on a special filed in a table
19592 :table-table in a table.el table
19593 :link on a hyperlink
19594 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19595 :target on a <<target>>
19596 :radio-target on a <<<radio-target>>>
19597 :latex-fragment on a LaTeX fragment
19598 :latex-preview on a LaTeX fragment with overlaid preview image
19600 This function expects the position to be visible because it uses font-lock
19601 faces as a help to recognize the following contexts: :table-special, :link,
19602 and :keyword."
19603 (let* ((f (get-text-property (point) 'face))
19604 (faces (if (listp f) f (list f)))
19605 (p (point)) clist o)
19606 ;; First the large context
19607 (cond
19608 ((org-at-heading-p t)
19609 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19610 (when (progn
19611 (beginning-of-line 1)
19612 (looking-at org-todo-line-tags-regexp))
19613 (push (org-point-in-group p 1 :headline-stars) clist)
19614 (push (org-point-in-group p 2 :todo-keyword) clist)
19615 (push (org-point-in-group p 4 :tags) clist))
19616 (goto-char p)
19619 (push (org-point-in-group p 0 :priority) clist)))
19621 ((org-at-item-p)
19622 (push (org-point-in-group p 2 :item-bullet) clist)
19623 (push (list :item (point-at-bol)
19624 (save-excursion (org-end-of-item) (point)))
19625 clist)
19626 (and (org-at-item-checkbox-p)
19627 (push (org-point-in-group p 0 :checkbox) clist)))
19629 ((org-at-table-p)
19630 (push (list :table (org-table-begin) (org-table-end)) clist)
19631 (if (memq 'org-formula faces)
19632 (push (list :table-special
19633 (previous-single-property-change p 'face)
19634 (next-single-property-change p 'face)) clist)))
19635 ((org-at-table-p 'any)
19636 (push (list :table-table) clist)))
19637 (goto-char p)
19639 ;; Now the small context
19640 (cond
19641 ((org-at-timestamp-p)
19642 (push (org-point-in-group p 0 :timestamp) clist))
19643 ((memq 'org-link faces)
19644 (push (list :link
19645 (previous-single-property-change p 'face)
19646 (next-single-property-change p 'face)) clist))
19647 ((memq 'org-special-keyword faces)
19648 (push (list :keyword
19649 (previous-single-property-change p 'face)
19650 (next-single-property-change p 'face)) clist))
19651 ((org-at-target-p)
19652 (push (org-point-in-group p 0 :target) clist)
19653 (goto-char (1- (match-beginning 0)))
19654 (if (looking-at org-radio-target-regexp)
19655 (push (org-point-in-group p 0 :radio-target) clist))
19656 (goto-char p))
19657 ((setq o (car (delq nil
19658 (mapcar
19659 (lambda (x)
19660 (if (memq x org-latex-fragment-image-overlays) x))
19661 (overlays-at (point))))))
19662 (push (list :latex-fragment
19663 (overlay-start o) (overlay-end o)) clist)
19664 (push (list :latex-preview
19665 (overlay-start o) (overlay-end o)) clist))
19666 ((org-inside-LaTeX-fragment-p)
19667 ;; FIXME: positions wrong.
19668 (push (list :latex-fragment (point) (point)) clist)))
19670 (setq clist (nreverse (delq nil clist)))
19671 clist))
19673 ;; FIXME: Compare with at-regexp-p Do we need both?
19674 (defun org-in-regexp (re &optional nlines visually)
19675 "Check if point is inside a match of regexp.
19676 Normally only the current line is checked, but you can include NLINES extra
19677 lines both before and after point into the search.
19678 If VISUALLY is set, require that the cursor is not after the match but
19679 really on, so that the block visually is on the match."
19680 (catch 'exit
19681 (let ((pos (point))
19682 (eol (point-at-eol (+ 1 (or nlines 0))))
19683 (inc (if visually 1 0)))
19684 (save-excursion
19685 (beginning-of-line (- 1 (or nlines 0)))
19686 (while (re-search-forward re eol t)
19687 (if (and (<= (match-beginning 0) pos)
19688 (>= (+ inc (match-end 0)) pos))
19689 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19691 (defun org-at-regexp-p (regexp)
19692 "Is point inside a match of REGEXP in the current line?"
19693 (catch 'exit
19694 (save-excursion
19695 (let ((pos (point)) (end (point-at-eol)))
19696 (beginning-of-line 1)
19697 (while (re-search-forward regexp end t)
19698 (if (and (<= (match-beginning 0) pos)
19699 (>= (match-end 0) pos))
19700 (throw 'exit t)))
19701 nil))))
19703 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19704 "Non-nil when point is between matches of START-RE and END-RE.
19706 Also return a non-nil value when point is on one of the matches.
19708 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19709 buffer positions. Default values are the positions of headlines
19710 surrounding the point.
19712 The functions returns a cons cell whose car (resp. cdr) is the
19713 position before START-RE (resp. after END-RE)."
19714 (save-match-data
19715 (let ((pos (point))
19716 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19717 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19718 beg end)
19719 (save-excursion
19720 ;; Point is on a block when on START-RE or if START-RE can be
19721 ;; found before it...
19722 (and (or (org-at-regexp-p start-re)
19723 (re-search-backward start-re limit-up t))
19724 (setq beg (match-beginning 0))
19725 ;; ... and END-RE after it...
19726 (goto-char (match-end 0))
19727 (re-search-forward end-re limit-down t)
19728 (> (setq end (match-end 0)) pos)
19729 ;; ... without another START-RE in-between.
19730 (goto-char (match-beginning 0))
19731 (not (re-search-backward start-re (1+ beg) t))
19732 ;; Return value.
19733 (cons beg end))))))
19735 (defun org-in-block-p (names)
19736 "Non-nil when point belongs to a block whose name belongs to NAMES.
19738 NAMES is a list of strings containing names of blocks.
19740 Return first block name matched, or nil. Beware that in case of
19741 nested blocks, the returned name may not belong to the closest
19742 block from point."
19743 (save-match-data
19744 (catch 'exit
19745 (let ((case-fold-search t)
19746 (lim-up (save-excursion (outline-previous-heading)))
19747 (lim-down (save-excursion (outline-next-heading))))
19748 (mapc (lambda (name)
19749 (let ((n (regexp-quote name)))
19750 (when (org-between-regexps-p
19753 lim-up lim-down)
19754 (throw 'exit n))))
19755 names))
19756 nil)))
19758 (defun org-occur-in-agenda-files (regexp &optional nlines)
19759 "Call `multi-occur' with buffers for all agenda files."
19761 (let* ((files (org-agenda-files))
19762 (tnames (mapcar 'file-truename files))
19763 (extra org-agenda-text-search-extra-files)
19764 f)
19765 (when (eq (car extra) 'agenda-archives)
19766 (setq extra (cdr extra))
19767 (setq files (org-add-archive-files files)))
19768 (while (setq f (pop extra))
19769 (unless (member (file-truename f) tnames)
19770 (add-to-list 'files f 'append)
19771 (add-to-list 'tnames (file-truename f) 'append)))
19772 (multi-occur
19773 (mapcar (lambda (x)
19774 (with-current-buffer
19775 (or (get-file-buffer x) (find-file-noselect x))
19776 (widen)
19777 (current-buffer)))
19778 files)
19779 regexp)))
19781 (if (boundp 'occur-mode-find-occurrence-hook)
19782 ;; Emacs 23
19783 (add-hook 'occur-mode-find-occurrence-hook
19784 (lambda ()
19785 (when (eq major-mode 'org-mode)
19786 (org-reveal))))
19787 ;; Emacs 22
19788 (defadvice occur-mode-goto-occurrence
19789 (after org-occur-reveal activate)
19790 (and (eq major-mode 'org-mode) (org-reveal)))
19791 (defadvice occur-mode-goto-occurrence-other-window
19792 (after org-occur-reveal activate)
19793 (and (eq major-mode 'org-mode) (org-reveal)))
19794 (defadvice occur-mode-display-occurrence
19795 (after org-occur-reveal activate)
19796 (when (eq major-mode 'org-mode)
19797 (let ((pos (occur-mode-find-occurrence)))
19798 (with-current-buffer (marker-buffer pos)
19799 (save-excursion
19800 (goto-char pos)
19801 (org-reveal)))))))
19803 (defun org-occur-link-in-agenda-files ()
19804 "Create a link and search for it in the agendas.
19805 The link is not stored in `org-stored-links', it is just created
19806 for the search purpose."
19807 (interactive)
19808 (let ((link (condition-case nil
19809 (org-store-link nil)
19810 (error "Unable to create a link to here"))))
19811 (org-occur-in-agenda-files (regexp-quote link))))
19813 (defun org-uniquify (list)
19814 "Remove duplicate elements from LIST."
19815 (let (res)
19816 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19817 res))
19819 (defun org-delete-all (elts list)
19820 "Remove all elements in ELTS from LIST."
19821 (while elts
19822 (setq list (delete (pop elts) list)))
19823 list)
19825 (defun org-count (cl-item cl-seq)
19826 "Count the number of occurrences of ITEM in SEQ.
19827 Taken from `count' in cl-seq.el with all keyword arguments removed."
19828 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19829 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19830 (while (< cl-start cl-end)
19831 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19832 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19833 (setq cl-start (1+ cl-start)))
19834 cl-count))
19836 (defun org-remove-if (predicate seq)
19837 "Remove everything from SEQ that fulfills PREDICATE."
19838 (let (res e)
19839 (while seq
19840 (setq e (pop seq))
19841 (if (not (funcall predicate e)) (push e res)))
19842 (nreverse res)))
19844 (defun org-remove-if-not (predicate seq)
19845 "Remove everything from SEQ that does not fulfill PREDICATE."
19846 (let (res e)
19847 (while seq
19848 (setq e (pop seq))
19849 (if (funcall predicate e) (push e res)))
19850 (nreverse res)))
19852 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19853 "Reduce two-argument FUNCTION across SEQ.
19854 Taken from `reduce' in cl-seq.el with all keyword arguments but
19856 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19857 (cadr (memq :initial-value cl-keys)))
19858 (cl-seq (pop cl-seq))
19859 (t (funcall cl-func)))))
19860 (while cl-seq
19861 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19862 cl-accum))
19864 (defun org-back-over-empty-lines ()
19865 "Move backwards over whitespace, to the beginning of the first empty line.
19866 Returns the number of empty lines passed."
19867 (let ((pos (point)))
19868 (if (cdr (assoc 'heading org-blank-before-new-entry))
19870 (unless (eobp)
19871 (forward-line -1)))
19872 (beginning-of-line 2)
19873 (goto-char (min (point) pos))
19874 (count-lines (point) pos)))
19876 (defun org-skip-whitespace ()
19879 (defun org-point-in-group (point group &optional context)
19880 "Check if POINT is in match-group GROUP.
19881 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19882 match. If the match group does not exist or point is not inside it,
19883 return nil."
19884 (and (match-beginning group)
19885 (>= point (match-beginning group))
19886 (<= point (match-end group))
19887 (if context
19888 (list context (match-beginning group) (match-end group))
19889 t)))
19891 (defun org-switch-to-buffer-other-window (&rest args)
19892 "Switch to buffer in a second window on the current frame.
19893 In particular, do not allow pop-up frames.
19894 Returns the newly created buffer."
19895 (let (pop-up-frames special-display-buffer-names special-display-regexps
19896 special-display-function)
19897 (apply 'switch-to-buffer-other-window args)))
19899 (defun org-combine-plists (&rest plists)
19900 "Create a single property list from all plists in PLISTS.
19901 The process starts by copying the first list, and then setting properties
19902 from the other lists. Settings in the last list are the most significant
19903 ones and overrule settings in the other lists."
19904 (let ((rtn (copy-sequence (pop plists)))
19905 p v ls)
19906 (while plists
19907 (setq ls (pop plists))
19908 (while ls
19909 (setq p (pop ls) v (pop ls))
19910 (setq rtn (plist-put rtn p v))))
19911 rtn))
19913 (defun org-move-line-down (arg)
19914 "Move the current line down. With prefix argument, move it past ARG lines."
19915 (interactive "p")
19916 (let ((col (current-column))
19917 beg end pos)
19918 (beginning-of-line 1) (setq beg (point))
19919 (beginning-of-line 2) (setq end (point))
19920 (beginning-of-line (+ 1 arg))
19921 (setq pos (move-marker (make-marker) (point)))
19922 (insert (delete-and-extract-region beg end))
19923 (goto-char pos)
19924 (org-move-to-column col)))
19926 (defun org-move-line-up (arg)
19927 "Move the current line up. With prefix argument, move it past ARG lines."
19928 (interactive "p")
19929 (let ((col (current-column))
19930 beg end pos)
19931 (beginning-of-line 1) (setq beg (point))
19932 (beginning-of-line 2) (setq end (point))
19933 (beginning-of-line (- arg))
19934 (setq pos (move-marker (make-marker) (point)))
19935 (insert (delete-and-extract-region beg end))
19936 (goto-char pos)
19937 (org-move-to-column col)))
19939 (defun org-replace-escapes (string table)
19940 "Replace %-escapes in STRING with values in TABLE.
19942 The sequences in STRING may contain normal field width and padding information,
19944 so values can contain further %-escapes if they are define later in TABLE."
19945 (let ((tbl (copy-alist table))
19946 (case-fold-search nil)
19947 (pchg 0)
19948 e re rpl)
19949 (while (setq e (pop tbl))
19950 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19951 (when (and (cdr e) (string-match re (cdr e)))
19952 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19953 (safe "SREF"))
19954 (add-text-properties 0 3 (list 'sref sref) safe)
19955 (setcdr e (replace-match safe t t (cdr e)))))
19956 (while (string-match re string)
19957 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19958 (cdr e)))
19959 (setq string (replace-match rpl t t string))))
19960 (while (setq pchg (next-property-change pchg string))
19961 (let ((sref (get-text-property pchg 'sref string)))
19962 (when (and sref (string-match "SREF" string pchg))
19963 (setq string (replace-match sref t t string)))))
19964 string))
19966 (defun org-sublist (list start end)
19967 "Return a section of LIST, from START to END.
19968 Counting starts at 1."
19969 (let (rtn (c start))
19970 (setq list (nthcdr (1- start) list))
19971 (while (and list (<= c end))
19972 (push (pop list) rtn)
19973 (setq c (1+ c)))
19974 (nreverse rtn)))
19976 (defun org-find-base-buffer-visiting (file)
19977 "Like `find-buffer-visiting' but always return the base buffer and
19978 not an indirect buffer."
19979 (let ((buf (or (get-file-buffer file)
19980 (find-buffer-visiting file))))
19981 (if buf
19982 (or (buffer-base-buffer buf) buf)
19983 nil)))
19985 (defun org-image-file-name-regexp (&optional extensions)
19986 "Return regexp matching the file names of images.
19987 If EXTENSIONS is given, only match these."
19988 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19989 (image-file-name-regexp)
19990 (let ((image-file-name-extensions
19991 (or extensions
19992 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19993 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19995 (regexp-opt (nconc (mapcar 'upcase
19996 image-file-name-extensions)
19997 image-file-name-extensions)
19998 t)
20001 (defun org-file-image-p (file &optional extensions)
20002 "Return non-nil if FILE is an image."
20003 (save-match-data
20004 (string-match (org-image-file-name-regexp extensions) file)))
20006 (defun org-get-cursor-date ()
20007 "Return the date at cursor in as a time.
20008 This works in the calendar and in the agenda, anywhere else it just
20009 returns the current time."
20010 (let (date day defd)
20011 (cond
20012 ((eq major-mode 'calendar-mode)
20013 (setq date (calendar-cursor-to-date)
20014 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20015 ((eq major-mode 'org-agenda-mode)
20016 (setq day (get-text-property (point) 'day))
20017 (if day
20018 (setq date (calendar-gregorian-from-absolute day)
20019 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20020 (nth 2 date))))))
20021 (or defd (current-time))))
20023 (defvar org-agenda-action-marker (make-marker)
20024 "Marker pointing to the entry for the next agenda action.")
20026 (defun org-mark-entry-for-agenda-action ()
20027 "Mark the current entry as target of an agenda action.
20028 Agenda actions are actions executed from the agenda with the key `k',
20029 which make use of the date at the cursor."
20030 (interactive)
20031 (move-marker org-agenda-action-marker
20032 (save-excursion (org-back-to-heading t) (point))
20033 (current-buffer))
20034 (message
20035 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20037 (defun org-mark-subtree ()
20038 "Mark the current subtree.
20039 This puts point at the start of the current subtree, and mark at the end.
20041 If point is in an inline task, mark that task instead."
20042 (interactive)
20043 (let ((inline-task-p
20044 (and (featurep 'org-inlinetask)
20045 (org-inlinetask-in-task-p)))
20046 (beg))
20047 ;; Get beginning of subtree
20048 (cond
20049 (inline-task-p (org-inlinetask-goto-beginning))
20050 ((org-at-heading-p) (beginning-of-line))
20051 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20052 (setq beg (point))
20053 ;; Get end of it
20054 (if inline-task-p
20055 (org-inlinetask-goto-end)
20056 (org-end-of-subtree))
20057 ;; Mark zone
20058 (push-mark (point) nil t)
20059 (goto-char beg)))
20061 ;;; Paragraph filling stuff.
20062 ;; We want this to be just right, so use the full arsenal.
20064 (defun org-indent-line-function ()
20065 "Indent line depending on context."
20066 (interactive)
20067 (let* ((pos (point))
20068 (itemp (org-at-item-p))
20069 (case-fold-search t)
20071 (inline-task-p (and (featurep 'org-inlinetask)
20072 (org-inlinetask-in-task-p)))
20073 (inline-re (and inline-task-p
20074 (org-inlinetask-outline-regexp)))
20075 column)
20076 (beginning-of-line 1)
20077 (cond
20078 ;; Comments
20079 ((looking-at "# ") (setq column 0))
20080 ;; Headings
20081 ((looking-at org-outline-regexp) (setq column 0))
20082 ;; Included files
20084 ;; Footnote definition
20085 ((looking-at org-footnote-definition-re) (setq column 0))
20086 ;; Literal examples
20088 (setq column (org-get-indentation))) ; do nothing
20089 ;; Lists
20090 ((ignore-errors (goto-char (org-in-item-p)))
20091 (setq column (if itemp
20092 (org-get-indentation)
20093 (org-list-item-body-column (point))))
20094 (goto-char pos))
20095 ;; Drawers
20097 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20098 (save-excursion
20099 (goto-char (1- (match-beginning 1)))
20100 (setq column (current-column))))
20101 ;; Special blocks
20103 (save-excursion
20104 (re-search-backward
20106 (setq column (org-get-indentation (match-string 0))))
20109 (save-excursion
20111 (setq column
20112 (cond ((equal (downcase (match-string 1)) "src")
20113 ;; src blocks: let `org-edit-src-exit' handle them
20114 (org-get-indentation))
20115 ((equal (downcase (match-string 1)) "example")
20116 (max (org-get-indentation)
20117 (org-get-indentation (match-string 0))))
20118 (t
20119 (org-get-indentation (match-string 0))))))
20120 ;; This line has nothing special, look at the previous relevant
20121 ;; line to compute indentation
20122 (t
20123 (beginning-of-line 0)
20124 (while (and (not (bobp))
20125 (not (looking-at org-drawer-regexp))
20126 ;; When point started in an inline task, do not move
20127 ;; above task starting line.
20128 (not (and inline-task-p (looking-at inline-re)))
20129 ;; Skip drawers, blocks, empty lines, verbatim,
20130 ;; comments, tables, footnotes definitions, lists,
20131 ;; inline tasks.
20133 (re-search-backward org-drawer-regexp nil t))
20137 (looking-at org-footnote-definition-re)
20138 (and (ignore-errors (goto-char (org-in-item-p)))
20139 (goto-char
20140 (org-list-get-top-point (org-list-struct))))
20141 (and (not inline-task-p)
20142 (featurep 'org-inlinetask)
20143 (org-inlinetask-in-task-p)
20144 (or (org-inlinetask-goto-beginning) t))))
20145 (beginning-of-line 0))
20146 (cond
20147 ;; There was an heading above.
20149 (if (not org-adapt-indentation)
20150 (setq column 0)
20151 (goto-char (match-end 0))
20152 (setq column (current-column))))
20153 ;; A drawer had started and is unfinished
20154 ((looking-at org-drawer-regexp)
20155 (goto-char (1- (match-beginning 1)))
20156 (setq column (current-column)))
20157 ;; Else, nothing noticeable found: get indentation and go on.
20158 (t (setq column (org-get-indentation))))))
20159 ;; Now apply indentation and move cursor accordingly
20160 (goto-char pos)
20161 (if (<= (current-column) (current-indentation))
20162 (org-indent-line-to column)
20163 (save-excursion (org-indent-line-to column)))
20164 ;; Special polishing for properties, see `org-property-format'
20165 (setq column (current-column))
20166 (beginning-of-line 1)
20167 (if (looking-at
20169 (replace-match (concat (match-string 1)
20170 (format org-property-format
20171 (match-string 2) (match-string 3)))
20172 t t))
20173 (org-move-to-column column)))
20175 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20176 "Variable to store copy of `adaptive-fill-regexp'.
20177 Since `adaptive-fill-regexp' is set to never match, we need to
20178 store a backup of its value before entering `org-mode' so that
20179 the functionality can be provided as a fall-back.")
20181 (defun org-set-autofill-regexps ()
20182 (interactive)
20183 ;; In the paragraph separator we include headlines, because filling
20184 ;; text in a line directly attached to a headline would otherwise
20185 ;; fill the headline as well.
20188 ;; The paragraph starter includes hand-formatted lists.
20189 (org-set-local
20190 'paragraph-start
20191 (concat
20200 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20201 ;; But only if the user has not turned off tables or fixed-width regions
20202 (org-set-local
20203 'auto-fill-inhibit-regexp
20204 (concat org-outline-regexp
20207 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20208 (concat
20210 (if org-enable-table-editor "|" "")
20211 (if org-enable-fixed-width-editor ":" "")
20212 "]"))))
20213 ;; We use our own fill-paragraph function, to make sure that tables
20214 ;; and fixed-width regions are not wrapped. That function will pass
20215 ;; through to `fill-paragraph' when appropriate.
20216 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20217 ;; Prevent auto-fill from inserting unwanted new items.
20218 (if (boundp 'fill-nobreak-predicate)
20219 (org-set-local 'fill-nobreak-predicate
20220 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20221 fill-nobreak-predicate
20222 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20223 ;; Adaptive filling: To get full control, first make sure that
20224 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20225 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20226 (org-set-local 'org-adaptive-fill-regexp-backup
20227 adaptive-fill-regexp))
20229 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20230 (org-set-local 'adaptive-fill-function
20231 'org-adaptive-fill-function)
20232 (org-set-local
20233 'align-mode-rules-list
20234 '((org-in-buffer-settings
20236 (modes . '(org-mode))))))
20238 (defun org-fill-item-nobreak-p ()
20239 "Non-nil when a line break at point would insert a new item."
20240 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20242 (defun org-fill-paragraph (&optional justify)
20243 "Re-align a table, pass through to fill-paragraph if no table."
20244 (let ((table-p (org-at-table-p))
20245 (table.el-p (org-at-table.el-p))
20246 (itemp (org-in-item-p)))
20247 (cond ((and (equal (char-after (point-at-bol)) ?*)
20248 (save-excursion (goto-char (point-at-bol))
20249 (looking-at org-outline-regexp)))
20250 t) ; skip headlines
20251 (table.el-p t) ; skip table.el tables
20252 (table-p (org-table-align) t) ; align Org tables
20253 (itemp ; align text in items
20254 (let* ((struct (save-excursion (goto-char itemp)
20255 (org-list-struct)))
20256 (parents (org-list-parents-alist struct))
20257 (children (org-list-get-children itemp struct parents))
20258 beg end prev next prefix)
20259 ;; Determine in which part of item point is: before
20260 ;; first child, after last child, between two
20261 ;; sub-lists, or simply in item if there's no child.
20262 (cond
20263 ((not children)
20264 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20265 beg itemp
20266 end (org-list-get-item-end itemp struct)))
20267 ((< (point) (setq next (car children)))
20268 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20269 beg itemp
20270 end next))
20271 ((> (point) (setq prev (car (last children))))
20272 (setq beg (org-list-get-item-end prev struct)
20273 end (org-list-get-item-end itemp struct)
20274 prefix (save-excursion
20275 (goto-char beg)
20277 (make-string (current-column) ?\ ))))
20278 (t (catch 'exit
20279 (while (setq next (pop children))
20280 (if (> (point) next)
20281 (setq prev next)
20282 (setq beg (org-list-get-item-end prev struct)
20283 end next
20284 prefix (save-excursion
20285 (goto-char beg)
20287 (make-string (current-column) ?\ )))
20288 (throw 'exit nil))))))
20289 ;; Use `fill-paragraph' with buffer narrowed to item
20290 ;; without any child, and with our computed PREFIX.
20291 (flet ((fill-context-prefix (from to &optional flr) prefix))
20292 (save-restriction
20293 (narrow-to-region beg end)
20294 (save-excursion (fill-paragraph justify)))) t))
20295 ;; Special case where point is not in a list but is on
20296 ;; a paragraph adjacent to a list: make sure this paragraph
20297 ;; doesn't get merged with the end of the list by narrowing
20298 ;; buffer first.
20299 ((save-excursion (forward-paragraph -1)
20300 (setq itemp (org-in-item-p)))
20301 (let ((struct (save-excursion (goto-char itemp)
20302 (org-list-struct))))
20303 (save-restriction
20304 (narrow-to-region (org-list-get-bottom-point struct)
20305 (save-excursion (forward-paragraph 1)
20306 (point)))
20307 (fill-paragraph justify) t)))
20308 ;; Else simply call `fill-paragraph'.
20309 (t nil))))
20311 ;; For reference, this is the default value of adaptive-fill-regexp
20314 (defun org-adaptive-fill-function ()
20315 "Return a fill prefix for org-mode files."
20316 (let (itemp)
20317 (save-excursion
20318 (cond
20319 ;; Comment line
20321 (match-string-no-properties 0))
20322 ;; Plain list item
20323 ((org-at-item-p)
20324 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20325 ;; Point is in a list after `backward-paragraph': original
20326 ;; point wasn't in the list, or filling would have been taken
20327 ;; care of by `org-auto-fill-function', but the list and the
20328 ;; real paragraph are not separated by a blank line. Thus, move
20329 ;; point after the list to go back to real paragraph and
20330 ;; determine fill-prefix.
20331 ((setq itemp (org-in-item-p))
20332 (goto-char itemp)
20333 (let* ((struct (org-list-struct))
20334 (bottom (org-list-get-bottom-point struct)))
20335 (goto-char bottom)
20336 (make-string (org-get-indentation) ?\ )))
20337 ;; Other text
20338 ((looking-at org-adaptive-fill-regexp-backup)
20339 (match-string-no-properties 0))))))
20341 (defun org-auto-fill-function ()
20342 "Auto-fill function."
20343 (let (itemp prefix)
20344 ;; When in a list, compute an appropriate fill-prefix and make
20345 ;; sure it will be used by `do-auto-fill'.
20346 (if (setq itemp (org-in-item-p))
20347 (progn
20348 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20349 (flet ((fill-context-prefix (from to &optional flr) prefix))
20350 (do-auto-fill)))
20351 ;; Else just use `do-auto-fill'.
20352 (do-auto-fill))))
20354 ;;; Other stuff.
20356 (defun org-toggle-fixed-width-section (arg)
20357 "Toggle the fixed-width export.
20358 If there is no active region, the QUOTE keyword at the current headline is
20359 inserted or removed. When present, it causes the text between this headline
20360 and the next to be exported as fixed-width text, and unmodified.
20361 If there is an active region, this command adds or removes a colon as the
20362 first character of this line. If the first character of a line is a colon,
20363 this line is also exported in fixed-width font."
20364 (interactive "P")
20365 (let* ((cc 0)
20366 (regionp (org-region-active-p))
20367 (beg (if regionp (region-beginning) (point)))
20368 (end (if regionp (region-end)))
20369 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20370 (case-fold-search nil)
20372 off)
20373 (if regionp
20374 (save-excursion
20375 (goto-char beg)
20376 (setq cc (current-column))
20377 (beginning-of-line 1)
20378 (setq off (looking-at re))
20379 (while (> nlines 0)
20380 (setq nlines (1- nlines))
20381 (beginning-of-line 1)
20382 (cond
20383 (arg
20384 (org-move-to-column cc t)
20386 (forward-line -1))
20387 ((and off (looking-at re))
20388 (replace-match "" t t nil 1))
20389 ((not off) (org-move-to-column cc t) (insert ": ")))
20390 (forward-line 1)))
20391 (save-excursion
20392 (org-back-to-heading)
20393 (cond
20394 ((looking-at (format org-heading-keyword-regexp-format
20395 org-quote-string))
20396 (goto-char (match-end 1))
20397 (looking-at (concat " +" org-quote-string))
20398 (replace-match "" t t)
20399 (when (eolp) (insert " ")))
20400 ((looking-at org-outline-regexp)
20401 (goto-char (match-end 0))
20402 (insert org-quote-string " ")))))))
20404 (defun org-reftex-citation ()
20405 "Use reftex-citation to insert a citation into the buffer.
20406 This looks for a line like
20408 #+BIBLIOGRAPHY: foo plain option:-d
20410 and derives from it that foo.bib is the bibliography file relevant
20411 for this document. It then installs the necessary environment for RefTeX
20412 to work in this buffer and calls `reftex-citation' to insert a citation
20413 into the buffer.
20415 Export of such citations to both LaTeX and HTML is handled by the contributed
20416 package org-exp-bibtex by Taru Karttunen."
20417 (interactive)
20418 (let ((reftex-docstruct-symbol 'rds)
20420 rds bib)
20421 (save-excursion
20422 (save-restriction
20423 (widen)
20424 (let ((case-fold-search t)
20426 (if (not (save-excursion
20427 (or (re-search-forward re nil t)
20428 (re-search-backward re nil t))))
20429 (error "No bibliography defined in file")
20430 (setq bib (concat (match-string 1) ".bib")
20431 rds (list (list 'bib bib)))))))
20432 (call-interactively 'reftex-citation)))
20434 ;;;; Functions extending outline functionality
20436 (defun org-beginning-of-line (&optional arg)
20437 "Go to the beginning of the current line. If that is invisible, continue
20438 to a visible line beginning. This makes the function of C-a more intuitive.
20439 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20440 first attempt, and only move to after the tags when the cursor is already
20441 beyond the end of the headline."
20442 (interactive "P")
20443 (let ((pos (point))
20444 (special (if (consp org-special-ctrl-a/e)
20445 (car org-special-ctrl-a/e)
20446 org-special-ctrl-a/e))
20447 refpos)
20448 (if (org-bound-and-true-p line-move-visual)
20449 (beginning-of-visual-line 1)
20450 (beginning-of-line 1))
20451 (if (and arg (fboundp 'move-beginning-of-line))
20452 (call-interactively 'move-beginning-of-line)
20453 (if (bobp)
20454 nil
20455 (backward-char 1)
20456 (if (org-truely-invisible-p)
20457 (while (and (not (bobp)) (org-truely-invisible-p))
20458 (backward-char 1)
20459 (beginning-of-line 1))
20460 (forward-char 1))))
20461 (when special
20462 (cond
20463 ((and (looking-at org-complex-heading-regexp)
20464 (= (char-after (match-end 1)) ?\ ))
20465 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20466 (point-at-eol)))
20467 (goto-char
20468 (if (eq special t)
20469 (cond ((> pos refpos) refpos)
20470 ((= pos (point)) refpos)
20471 (t (point)))
20472 (cond ((> pos (point)) (point))
20473 ((not (eq last-command this-command)) (point))
20474 (t refpos)))))
20475 ((org-at-item-p)
20476 ;; Being at an item and not looking at an the item means point
20477 ;; was previously moved to beginning of a visual line, whiche
20478 ;; doesn't contain the item. Therefore, do nothing special,
20479 ;; just stay here.
20480 (when (looking-at org-list-full-item-re)
20481 ;; Set special position at first white space character after
20482 ;; bullet, and check-box, if any.
20483 (let ((after-bullet
20484 (let ((box (match-end 3)))
20485 (if (not box) (match-end 1)
20486 (let ((after (char-after box)))
20487 (if (and after (= after ? )) (1+ box) box))))))
20488 ;; Special case: Move point to special position when
20489 ;; currently after it or at beginning of line.
20490 (if (eq special t)
20491 (when (or (> pos after-bullet) (= (point) pos))
20492 (goto-char after-bullet))
20493 ;; Reversed case: Move point to special position when
20494 ;; point was already at beginning of line and command is
20495 ;; repeated.
20496 (when (and (= (point) pos) (eq last-command this-command))
20497 (goto-char after-bullet))))))))
20498 (org-no-warnings
20499 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20501 (defun org-end-of-line (&optional arg)
20502 "Go to the end of the line.
20503 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20504 first attempt, and only move to after the tags when the cursor is already
20505 beyond the end of the headline."
20506 (interactive "P")
20507 (let ((special (if (consp org-special-ctrl-a/e)
20508 (cdr org-special-ctrl-a/e)
20509 org-special-ctrl-a/e)))
20510 (cond
20511 ((or (not special) arg
20512 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20513 (call-interactively
20514 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20515 ((fboundp 'move-end-of-line) 'move-end-of-line)
20516 (t 'end-of-line))))
20517 ((org-at-heading-p)
20518 (let ((pos (point)))
20519 (beginning-of-line 1)
20521 (if (eq special t)
20522 (if (or (< pos (match-beginning 1))
20523 (= pos (match-end 0)))
20524 (goto-char (match-beginning 1))
20525 (goto-char (match-end 0)))
20526 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20527 (goto-char (match-end 0))
20528 (goto-char (match-beginning 1))))
20529 (call-interactively (if (fboundp 'move-end-of-line)
20530 'move-end-of-line
20531 'end-of-line)))))
20532 ((org-at-drawer-p)
20533 (move-end-of-line 1)
20534 (when (overlays-at (1- (point))) (backward-char 1)))
20535 ;; At an item: Move before any hidden text.
20536 (t (call-interactively
20537 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20538 ((fboundp 'move-end-of-line) 'move-end-of-line)
20539 (t 'end-of-line)))))
20540 (org-no-warnings
20541 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20543 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20544 (define-key org-mode-map "\C-e" 'org-end-of-line)
20546 (defun org-backward-sentence (&optional arg)
20547 "Go to beginning of sentence, or beginning of table field.
20548 This will call `backward-sentence' or `org-table-beginning-of-field',
20549 depending on context."
20550 (interactive "P")
20551 (cond
20552 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20553 (t (call-interactively 'backward-sentence))))
20555 (defun org-forward-sentence (&optional arg)
20556 "Go to end of sentence, or end of table field.
20557 This will call `forward-sentence' or `org-table-end-of-field',
20558 depending on context."
20559 (interactive "P")
20560 (cond
20561 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20562 (t (call-interactively 'forward-sentence))))
20564 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20565 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20567 (defun org-kill-line (&optional arg)
20568 "Kill line, to tags or end of line."
20569 (interactive "P")
20570 (cond
20571 ((or (not org-special-ctrl-k)
20572 (bolp)
20573 (not (org-at-heading-p)))
20574 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20575 org-ctrl-k-protect-subtree)
20576 (if (or (eq org-ctrl-k-protect-subtree 'error)
20577 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20578 (error "C-k aborted - would kill hidden subtree")))
20579 (call-interactively 'kill-line))
20581 (kill-region (point) (match-beginning 1))
20582 (org-set-tags nil t))
20583 (t (kill-region (point) (point-at-eol)))))
20585 (define-key org-mode-map "\C-k" 'org-kill-line)
20587 (defun org-yank (&optional arg)
20588 "Yank. If the kill is a subtree, treat it specially.
20589 This command will look at the current kill and check if is a single
20590 subtree, or a series of subtrees[1]. If it passes the test, and if the
20591 cursor is at the beginning of a line or after the stars of a currently
20592 empty headline, then the yank is handled specially. How exactly depends
20593 on the value of the following variables, both set by default.
20595 org-yank-folded-subtrees
20596 When set, the subtree(s) will be folded after insertion, but only
20597 if doing so would now swallow text after the yanked text.
20599 org-yank-adjusted-subtrees
20600 When set, the subtree will be promoted or demoted in order to
20601 fit into the local outline tree structure, which means that the level
20602 will be adjusted so that it becomes the smaller one of the two
20603 *visible* surrounding headings.
20605 Any prefix to this command will cause `yank' to be called directly with
20607 will just
20608 plainly yank the text as it is.
20610 \[1] The test checks if the first non-white line is a heading
20611 and if there are no other headings with fewer stars."
20612 (interactive "P")
20613 (org-yank-generic 'yank arg))
20615 (defun org-yank-generic (command arg)
20616 "Perform some yank-like command.
20618 This function implements the behavior described in the `org-yank'
20619 documentation. However, it has been generalized to work for any
20620 interactive command with similar behavior."
20622 ;; pretend to be command COMMAND
20623 (setq this-command command)
20625 (if arg
20626 (call-interactively command)
20628 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20629 (and (org-kill-is-subtree-p)
20630 (or (bolp)
20632 (string-match
20634 (buffer-substring (point-at-bol) (point)))))))
20635 swallowp)
20636 (cond
20637 ((and subtreep org-yank-folded-subtrees)
20638 (let ((beg (point))
20639 end)
20640 (if (and subtreep org-yank-adjusted-subtrees)
20641 (org-paste-subtree nil nil 'for-yank)
20642 (call-interactively command))
20644 (setq end (point))
20645 (goto-char beg)
20646 (when (and (bolp) subtreep
20647 (not (setq swallowp
20648 (org-yank-folding-would-swallow-text beg end))))
20649 (org-with-limited-levels
20650 (or (looking-at org-outline-regexp)
20651 (re-search-forward org-outline-regexp-bol end t))
20652 (while (and (< (point) end) (looking-at org-outline-regexp))
20653 (hide-subtree)
20654 (org-cycle-show-empty-lines 'folded)
20655 (condition-case nil
20656 (outline-forward-same-level 1)
20657 (error (goto-char end))))))
20658 (when swallowp
20659 (message
20660 "Inserted text not folded because that would swallow text"))
20662 (goto-char end)
20664 (beginning-of-line 1)
20665 (push-mark beg 'nomsg)))
20666 ((and subtreep org-yank-adjusted-subtrees)
20667 (let ((beg (point-at-bol)))
20668 (org-paste-subtree nil nil 'for-yank)
20669 (push-mark beg 'nomsg)))
20670 (t
20671 (call-interactively command))))))
20673 (defun org-yank-folding-would-swallow-text (beg end)
20674 "Would hide-subtree at BEG swallow any text after END?"
20675 (let (level)
20676 (org-with-limited-levels
20677 (save-excursion
20678 (goto-char beg)
20679 (when (or (looking-at org-outline-regexp)
20680 (re-search-forward org-outline-regexp-bol end t))
20681 (setq level (org-outline-level)))
20682 (goto-char end)
20684 (if (or (eobp)
20685 (and (bolp) (looking-at org-outline-regexp)
20686 (<= (org-outline-level) level)))
20687 nil ; Nothing would be swallowed
20688 t))))) ; something would swallow
20690 (define-key org-mode-map "\C-y" 'org-yank)
20692 (defun org-truely-invisible-p ()
20693 "Check if point is at a character currently not visible.
20694 This version does not only check the character property, but also
20695 `visible-mode'."
20696 ;; Early versions of noutline don't have `outline-invisible-p'.
20697 (if (org-bound-and-true-p visible-mode)
20698 nil
20699 (outline-invisible-p)))
20701 (defun org-invisible-p2 ()
20702 "Check if point is at a character currently not visible."
20703 (save-excursion
20704 (if (and (eolp) (not (bobp))) (backward-char 1))
20705 ;; Early versions of noutline don't have `outline-invisible-p'.
20706 (outline-invisible-p)))
20708 (defun org-back-to-heading (&optional invisible-ok)
20709 "Call `outline-back-to-heading', but provide a better error message."
20710 (condition-case nil
20711 (outline-back-to-heading invisible-ok)
20712 (error (error "Before first headline at position %d in buffer %s"
20713 (point) (current-buffer)))))
20715 (defun org-beginning-of-defun ()
20716 "Go to the beginning of the subtree, i.e. back to the heading."
20717 (org-back-to-heading))
20718 (defun org-end-of-defun ()
20719 "Go to the end of the subtree."
20720 (org-end-of-subtree nil t))
20722 (defun org-before-first-heading-p ()
20723 "Before first heading?"
20724 (save-excursion
20725 (end-of-line)
20726 (null (re-search-backward org-outline-regexp-bol nil t))))
20728 (defun org-at-heading-p (&optional ignored)
20729 (outline-on-heading-p t))
20730 ;; Compatibility alias with Org versions < 7.8.03
20731 (defalias 'org-on-heading-p 'org-at-heading-p)
20733 (defun org-at-drawer-p nil
20734 "Whether point is at a drawer."
20735 (save-excursion
20736 (move-beginning-of-line 1)
20737 (looking-at org-drawer-regexp)))
20739 (defun org-point-at-end-of-empty-headline ()
20740 "If point is at the end of an empty headline, return t, else nil.
20741 If the heading only contains a TODO keyword, it is still still considered
20742 empty."
20744 (save-excursion
20745 (beginning-of-line 1)
20746 (let ((case-fold-search nil))
20747 (looking-at org-todo-line-regexp)))
20748 (string= (match-string 3) "")))
20750 (defun org-at-heading-or-item-p ()
20751 (or (org-at-heading-p) (org-at-item-p)))
20753 (defun org-at-target-p ()
20754 (or (org-in-regexp org-radio-target-regexp)
20755 (org-in-regexp org-target-regexp)))
20756 ;; Compatibility alias with Org versions < 7.8.03
20757 (defalias 'org-on-target-p 'org-at-target-p)
20759 (defun org-up-heading-all (arg)
20760 "Move to the heading line of which the present line is a subheading.
20761 This function considers both visible and invisible heading lines.
20762 With argument, move up ARG levels."
20763 (if (fboundp 'outline-up-heading-all)
20764 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20765 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20767 (defun org-up-heading-safe ()
20768 "Move to the heading line of which the present line is a subheading.
20769 This version will not throw an error. It will return the level of the
20770 headline found, or nil if no higher level is found.
20772 Also, this function will be a lot faster than `outline-up-heading',
20773 because it relies on stars being the outline starters. This can really
20774 make a significant difference in outlines with very many siblings."
20775 (let (start-level re)
20776 (org-back-to-heading t)
20777 (setq start-level (funcall outline-level))
20778 (if (equal start-level 1)
20779 nil
20781 (if (re-search-backward re nil t)
20782 (funcall outline-level)))))
20784 (defun org-first-sibling-p ()
20785 "Is this heading the first child of its parents?"
20786 (interactive)
20787 (let ((re org-outline-regexp-bol)
20788 level l)
20789 (unless (org-at-heading-p t)
20790 (error "Not at a heading"))
20791 (setq level (funcall outline-level))
20792 (save-excursion
20793 (if (not (re-search-backward re nil t))
20794 t
20795 (setq l (funcall outline-level))
20796 (< l level)))))
20798 (defun org-goto-sibling (&optional previous)
20799 "Goto the next sibling, even if it is invisible.
20800 When PREVIOUS is set, go to the previous sibling instead. Returns t
20801 when a sibling was found. When none is found, return nil and don't
20802 move point."
20803 (let ((fun (if previous 're-search-backward 're-search-forward))
20804 (pos (point))
20805 (re org-outline-regexp-bol)
20806 level l)
20807 (when (condition-case nil (org-back-to-heading t) (error nil))
20808 (setq level (funcall outline-level))
20809 (catch 'exit
20810 (or previous (forward-char 1))
20811 (while (funcall fun re nil t)
20812 (setq l (funcall outline-level))
20813 (when (< l level) (goto-char pos) (throw 'exit nil))
20814 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20815 (goto-char pos)
20816 nil))))
20818 (defun org-show-siblings ()
20819 "Show all siblings of the current headline."
20820 (save-excursion
20821 (while (org-goto-sibling) (org-flag-heading nil)))
20822 (save-excursion
20823 (while (org-goto-sibling 'previous)
20824 (org-flag-heading nil))))
20826 (defun org-goto-first-child ()
20827 "Goto the first child, even if it is invisible.
20828 Return t when a child was found. Otherwise don't move point and
20829 return nil."
20830 (let (level (pos (point)) (re org-outline-regexp-bol))
20831 (when (condition-case nil (org-back-to-heading t) (error nil))
20832 (setq level (outline-level))
20833 (forward-char 1)
20834 (if (and (re-search-forward re nil t) (> (outline-level) level))
20835 (progn (goto-char (match-beginning 0)) t)
20836 (goto-char pos) nil))))
20838 (defun org-show-hidden-entry ()
20839 "Show an entry where even the heading is hidden."
20840 (save-excursion
20841 (org-show-entry)))
20843 (defun org-flag-heading (flag &optional entry)
20844 "Flag the current heading. FLAG non-nil means make invisible.
20845 When ENTRY is non-nil, show the entire entry."
20846 (save-excursion
20847 (org-back-to-heading t)
20848 ;; Check if we should show the entire entry
20849 (if entry
20850 (progn
20851 (org-show-entry)
20852 (save-excursion
20853 (and (outline-next-heading)
20854 (org-flag-heading nil))))
20855 (outline-flag-region (max (point-min) (1- (point)))
20856 (save-excursion (outline-end-of-heading) (point))
20857 flag))))
20859 (defun org-get-next-sibling ()
20860 "Move to next heading of the same level, and return point.
20861 If there is no such heading, return nil.
20862 This is like outline-next-sibling, but invisible headings are ok."
20863 (let ((level (funcall outline-level)))
20864 (outline-next-heading)
20865 (while (and (not (eobp)) (> (funcall outline-level) level))
20866 (outline-next-heading))
20867 (if (or (eobp) (< (funcall outline-level) level))
20868 nil
20869 (point))))
20871 (defun org-get-last-sibling ()
20872 "Move to previous heading of the same level, and return point.
20873 If there is no such heading, return nil."
20874 (let ((opoint (point))
20875 (level (funcall outline-level)))
20876 (outline-previous-heading)
20877 (when (and (/= (point) opoint) (outline-on-heading-p t))
20878 (while (and (> (funcall outline-level) level)
20879 (not (bobp)))
20880 (outline-previous-heading))
20881 (if (< (funcall outline-level) level)
20882 nil
20883 (point)))))
20885 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20886 ;; This contains an exact copy of the original function, but it uses
20887 ;; `org-back-to-heading', to make it work also in invisible
20888 ;; trees. And is uses an invisible-OK argument.
20889 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20890 ;; Furthermore, when used inside Org, finding the end of a large subtree
20891 ;; with many children and grandchildren etc, this can be much faster
20892 ;; than the outline version.
20893 (org-back-to-heading invisible-OK)
20894 (let ((first t)
20895 (level (funcall outline-level)))
20896 (if (and (eq major-mode 'org-mode) (< level 1000))
20897 ;; A true heading (not a plain list item), in Org-mode
20898 ;; This means we can easily find the end by looking
20899 ;; only for the right number of stars. Using a regexp to do
20900 ;; this is so much faster than using a Lisp loop.
20902 (forward-char 1)
20903 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20904 ;; something else, do it the slow way
20905 (while (and (not (eobp))
20906 (or first (> (funcall outline-level) level)))
20907 (setq first nil)
20908 (outline-next-heading)))
20909 (unless to-heading
20911 (progn
20912 ;; Go to end of line before heading
20913 (forward-char -1)
20915 ;; leave blank line before heading
20916 (forward-char -1))))))
20917 (point))
20919 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20920 "Use Org version in org-mode, for dramatic speed-up."
20921 (if (eq major-mode 'org-mode)
20922 (progn
20923 (org-end-of-subtree nil t)
20924 (unless (eobp) (backward-char 1)))
20925 ad-do-it))
20927 (defun org-end-of-meta-data-and-drawers ()
20928 "Jump to the first text after meta data and drawers in the current entry.
20929 This will move over empty lines, lines with planning time stamps,
20930 clocking lines, and drawers."
20931 (org-back-to-heading t)
20932 (let ((end (save-excursion (outline-next-heading) (point)))
20935 (forward-line 1)
20936 (while (re-search-forward re end t)
20937 (if (not (match-end 1))
20938 ;; empty or planning line
20939 (forward-line 1)
20940 ;; a drawer, find the end
20942 (forward-line 1)))
20944 (point)))
20946 (defun org-forward-same-level (arg &optional invisible-ok)
20947 "Move forward to the arg'th subheading at same level as this one.
20948 Stop at the first and last subheadings of a superior heading.
20949 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20950 it wil also look at invisible ones."
20951 (interactive "p")
20952 (org-back-to-heading invisible-ok)
20953 (org-at-heading-p)
20954 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20956 l)
20957 (forward-char 1)
20958 (while (> arg 0)
20959 (while (and (re-search-forward re nil 'move)
20960 (setq l (- (match-end 0) (match-beginning 0) 1))
20961 (= l level)
20962 (not invisible-ok)
20963 (progn (backward-char 1) (outline-invisible-p)))
20964 (if (< l level) (setq arg 1)))
20965 (setq arg (1- arg)))
20966 (beginning-of-line 1)))
20968 (defun org-backward-same-level (arg &optional invisible-ok)
20969 "Move backward to the arg'th subheading at same level as this one.
20970 Stop at the first and last subheadings of a superior heading."
20971 (interactive "p")
20972 (org-back-to-heading)
20973 (org-at-heading-p)
20974 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20976 l)
20977 (while (> arg 0)
20978 (while (and (re-search-backward re nil 'move)
20979 (setq l (- (match-end 0) (match-beginning 0) 1))
20980 (= l level)
20981 (not invisible-ok)
20982 (outline-invisible-p))
20983 (if (< l level) (setq arg 1)))
20984 (setq arg (1- arg)))))
20986 (defun org-show-subtree ()
20987 "Show everything after this heading at deeper levels."
20988 (interactive)
20989 (outline-flag-region
20990 (point)
20991 (save-excursion
20992 (org-end-of-subtree t t))
20993 nil))
20995 (defun org-show-entry ()
20996 "Show the body directly following this heading.
20997 Show the heading too, if it is currently invisible."
20998 (interactive)
20999 (save-excursion
21000 (condition-case nil
21001 (progn
21002 (org-back-to-heading t)
21003 (outline-flag-region
21004 (max (point-min) (1- (point)))
21005 (save-excursion
21006 (if (re-search-forward
21008 (match-beginning 1)
21009 (point-max)))
21010 nil)
21011 (org-cycle-hide-drawers 'children))
21012 (error nil))))
21014 (defun org-make-options-regexp (kwds &optional extra)
21015 "Make a regular expression for keyword lines."
21016 (concat
21017 "^"
21024 ;; Make isearch reveal the necessary context
21025 (defun org-isearch-end ()
21026 "Reveal context after isearch exits."
21027 (when isearch-success ; only if search was successful
21028 (if (featurep 'xemacs)
21029 ;; Under XEmacs, the hook is run in the correct place,
21030 ;; we directly show the context.
21031 (org-show-context 'isearch)
21032 ;; In Emacs the hook runs *before* restoring the overlays.
21033 ;; So we have to use a one-time post-command-hook to do this.
21034 ;; (Emacs 22 has a special variable, see function `org-mode')
21035 (unless (and (boundp 'isearch-mode-end-hook-quit)
21036 isearch-mode-end-hook-quit)
21037 ;; Only when the isearch was not quitted.
21038 (org-add-hook 'post-command-hook 'org-isearch-post-command
21039 'append 'local)))))
21041 (defun org-isearch-post-command ()
21042 "Remove self from hook, and show context."
21043 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21044 (org-show-context 'isearch))
21047 ;;;; Integration with and fixes for other packages
21049 ;;; Imenu support
21051 (defvar org-imenu-markers nil
21052 "All markers currently used by Imenu.")
21053 (make-variable-buffer-local 'org-imenu-markers)
21055 (defun org-imenu-new-marker (&optional pos)
21056 "Return a new marker for use by Imenu, and remember the marker."
21057 (let ((m (make-marker)))
21058 (move-marker m (or pos (point)))
21059 (push m org-imenu-markers)
21060 m))
21062 (defun org-imenu-get-tree ()
21063 "Produce the index for Imenu."
21064 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21065 (setq org-imenu-markers nil)
21066 (let* ((n org-imenu-depth)
21067 (re (concat "^" (org-get-limited-outline-regexp)))
21068 (subs (make-vector (1+ n) nil))
21069 (last-level 0)
21070 m level head)
21071 (save-excursion
21072 (save-restriction
21073 (widen)
21074 (goto-char (point-max))
21075 (while (re-search-backward re nil t)
21076 (setq level (org-reduced-level (funcall outline-level)))
21077 (when (and (<= level n)
21078 (looking-at org-complex-heading-regexp))
21079 (setq head (org-link-display-format
21080 (org-match-string-no-properties 4))
21081 m (org-imenu-new-marker))
21082 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21083 (if (>= level last-level)
21084 (push (cons head m) (aref subs level))
21085 (push (cons head (aref subs (1+ level))) (aref subs level))
21086 (loop for i from (1+ level) to n do (aset subs i nil)))
21087 (setq last-level level)))))
21088 (aref subs 1)))
21090 (eval-after-load "imenu"
21091 '(progn
21092 (add-hook 'imenu-after-jump-hook
21093 (lambda ()
21094 (if (eq major-mode 'org-mode)
21095 (org-show-context 'org-goto))))))
21097 (defun org-link-display-format (link)
21098 "Replace a link with either the description, or the link target
21099 if no description is present"
21100 (save-match-data
21101 (if (string-match org-bracket-link-analytic-regexp link)
21102 (replace-match (if (match-end 5)
21103 (match-string 5 link)
21104 (concat (match-string 1 link)
21105 (match-string 3 link)))
21106 nil t link)
21107 link)))
21109 (defun org-toggle-link-display ()
21110 "Toggle the literal or descriptive display of links."
21111 (interactive)
21112 (if org-descriptive-links
21113 (progn (org-remove-from-invisibility-spec '(org-link))
21114 (org-restart-font-lock)
21115 (setq org-descriptive-links nil))
21116 (progn (add-to-invisibility-spec '(org-link))
21117 (org-restart-font-lock)
21118 (setq org-descriptive-links t))))
21120 ;; Speedbar support
21122 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21123 "Overlay marking the agenda restriction line in speedbar.")
21124 (overlay-put org-speedbar-restriction-lock-overlay
21125 'face 'org-agenda-restriction-lock)
21126 (overlay-put org-speedbar-restriction-lock-overlay
21127 'help-echo "Agendas are currently limited to this item.")
21128 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21130 (defun org-speedbar-set-agenda-restriction ()
21131 "Restrict future agenda commands to the location at point in speedbar.
21133 (interactive)
21134 (require 'org-agenda)
21135 (let (p m tp np dir txt)
21136 (cond
21137 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21138 'org-imenu t))
21139 (setq m (get-text-property p 'org-imenu-marker))
21140 (with-current-buffer (marker-buffer m)
21141 (goto-char m)
21142 (org-agenda-set-restriction-lock 'subtree)))
21143 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21144 'speedbar-function 'speedbar-find-file))
21145 (setq tp (previous-single-property-change
21146 (1+ p) 'speedbar-function)
21147 np (next-single-property-change
21148 tp 'speedbar-function)
21149 dir (speedbar-line-directory)
21150 txt (buffer-substring-no-properties (or tp (point-min))
21151 (or np (point-max))))
21152 (with-current-buffer (find-file-noselect
21153 (let ((default-directory dir))
21154 (expand-file-name txt)))
21155 (unless (eq major-mode 'org-mode)
21156 (error "Cannot restrict to non-Org-mode file"))
21157 (org-agenda-set-restriction-lock 'file)))
21158 (t (error "Don't know how to restrict Org-mode's agenda")))
21159 (move-overlay org-speedbar-restriction-lock-overlay
21160 (point-at-bol) (point-at-eol))
21161 (setq current-prefix-arg nil)
21162 (org-agenda-maybe-redo)))
21164 (eval-after-load "speedbar"
21165 '(progn
21166 (speedbar-add-supported-extension ".org")
21167 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21168 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21169 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21170 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21171 (add-hook 'speedbar-visiting-tag-hook
21172 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21174 ;;; Fixes and Hacks for problems with other packages
21176 ;; Make flyspell not check words in links, to not mess up our keymap
21177 (defun org-mode-flyspell-verify ()
21178 "Don't let flyspell put overlays at active buttons, or on
21179 {todo,all-time,additional-option-like}-keywords."
21180 (let ((pos (max (1- (point)) (point-min)))
21181 (word (thing-at-point 'word)))
21182 (and (not (get-text-property pos 'keymap))
21183 (not (get-text-property pos 'org-no-flyspell))
21184 (not (member word org-todo-keywords-1))
21185 (not (member word org-all-time-keywords))
21186 (not (member word org-additional-option-like-keywords)))))
21188 (defun org-remove-flyspell-overlays-in (beg end)
21189 "Remove flyspell overlays in region."
21190 (and (org-bound-and-true-p flyspell-mode)
21191 (fboundp 'flyspell-delete-region-overlays)
21192 (flyspell-delete-region-overlays beg end))
21193 (add-text-properties beg end '(org-no-flyspell t)))
21195 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21196 (eval-after-load "bookmark"
21197 '(if (boundp 'bookmark-after-jump-hook)
21198 ;; We can use the hook
21199 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21200 ;; Hook not available, use advice
21201 (defadvice bookmark-jump (after org-make-visible activate)
21202 "Make the position visible."
21203 (org-bookmark-jump-unhide))))
21205 ;; Make sure saveplace shows the location if it was hidden
21206 (eval-after-load "saveplace"
21207 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21208 "Make the position visible."
21209 (org-bookmark-jump-unhide)))
21211 ;; Make sure ecb shows the location if it was hidden
21212 (eval-after-load "ecb"
21213 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21214 "Make hierarchy visible when jumping into location from ECB tree buffer."
21215 (if (eq major-mode 'org-mode)
21216 (org-show-context))))
21218 (defun org-bookmark-jump-unhide ()
21219 "Unhide the current position, to show the bookmark location."
21220 (and (eq major-mode 'org-mode)
21221 (or (outline-invisible-p)
21222 (save-excursion (goto-char (max (point-min) (1- (point))))
21223 (outline-invisible-p)))
21224 (org-show-context 'bookmark-jump)))
21226 ;; Make session.el ignore our circular variable
21227 (eval-after-load "session"
21228 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21230 ;;;; Experimental code
21232 (defun org-closed-in-range ()
21233 "Sparse tree of items closed in a certain time range.
21234 Still experimental, may disappear in the future."
21235 (interactive)
21236 ;; Get the time interval from the user.
21237 (let* ((time1 (org-float-time
21238 (org-read-date nil 'to-time nil "Starting date: ")))
21239 (time2 (org-float-time
21240 (org-read-date nil 'to-time nil "End date:")))
21241 ;; callback function
21242 (callback (lambda ()
21243 (let ((time
21244 (org-float-time
21245 (apply 'encode-time
21246 (org-parse-time-string
21247 (match-string 1))))))
21248 ;; check if time in interval
21249 (and (>= time time1) (<= time time2))))))
21250 ;; make tree, check each match with the callback
21253 ;;;; Finish up
21255 (provide 'org)
21257 (run-hooks 'org-load-hook)
21259 ;;; org.el ends here