| blob | cc90b053204355cf6128f3811b6257084e2c9375 |
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.07
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.
4897 ;;;###autoload
4899 "Outline-based notes management and organizer, alias
4902 Org-mode develops organizational tasks around a NOTES file which
4903 contains information about projects as plain text. Org-mode is
4904 implemented on top of outline-mode, which is ideal to keep the content
4905 of large files well structured. It supports ToDo items, deadlines and
4906 time stamps, which magically appear in the diary listing of the Emacs
4907 calendar. Tables are easily created with a built-in table editor.
4908 Plain text URL-like links connect to websites, emails (VM), Usenet
4909 messages (Gnus), BBDB entries, and any files related to the project.
4910 For printing and sharing of notes, an Org-mode file (or a part of it)
4911 can be exported as a structured ASCII or HTML file.
4913 The following commands are available:
4917 ;; Get rid of Outline menus, they are not needed
4918 ;; Need to do this here because define-derived-mode sets up
4919 ;; the keymap so late. Still, it is a waste to call this each time
4920 ;; we switch another buffer into org-mode.
4923 ;; Assume this is Greg's port, it uses easymenu
4949 org-display-table 4
4952 org-ellipsis)))
4957 ;; tag faces set outside customize.... force initialization.
4959 ;; Calc embedded
4965 ;; Activate before-change-function
4969 ;; Check for running clock before killing a buffer
4971 ;; Paragraphs and auto-filling
4975 ;; Beginning/end of defun
4978 ;; Next error for sparse trees
4980 ;; Make sure dependence stuff works reliably, even for users who set it
4981 ;; too late :-(
4993 ;; Comment characters
4997 ;; Align options lines
4999 'align-mode-rules-list
5004 ;; Imenu
5008 ;; Make isearch reveal context
5011 ;; Emacs 21 and XEmacs make use of the hook
5013 ;; Emacs 22 deals with this through a special variable
5017 ;; Turn on org-beamer-mode?
5020 ;; Setup the pcomplete hooks
5034 ;; If empty file that did not turn on org-mode automatically, make it to.
5059 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5069 "Return today date, considering `org-extend-today-until'."
5074 ;;;; Font-Lock stuff, including the activators
5105 "Regular expression used to analyze links.
5106 Here is what the match groups contain after a match:
5107 1: http:
5108 2: http
5109 3: path
5110 4: [desc]
5118 "Number of stacked braces for sub/superscript matching.
5119 This has to be set before loading org.el to be effective."
5124 "Create a regular expression which will match a balanced sexp.
5125 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5126 as single character strings.
5127 The regexp returned will match the entire expression including the
5128 delimiters. It will also define a single group which contains the
5129 match except for the outermost delimiters. The maximum depth of
5130 stacked delimiters is N. Escaping delimiters is not possible."
5159 "Update the link regular expressions.
5160 This should be called after the variable `org-link-types' has changed."
5164 org-link-re-with-space
5170 org-link-re-with-space2
5176 org-link-re-with-space3
5181 org-angle-link-re
5187 org-plain-link-re
5191 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5192 org-bracket-link-regexp
5194 org-bracket-link-analytic-regexp
5202 org-bracket-link-analytic-regexp++
5210 org-any-link-re
5219 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5221 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5222 "Regular expression matching time strings for analysis.
5223 This one does not require the space after the date, so it can be used
5225 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5241 "Regular expression matching a time stamp or time stamp range.
5247 "Run through the buffer and add overlays to emphasized strings."
5256 'face
5269 rtn))
5272 "Insert or change an emphasis, i.e. a font like bold or italic.
5273 If there is an active region, change that region to a new emphasis.
5274 If there is no region, just insert the marker characters and position
5275 the cursor between them.
5276 CHAR should be either the marker character, or the first character of the
5277 HTML tag associated with that emphasis. If CHAR is a space, the means
5278 to remove the emphasis of the selected region.
5279 If char is not given (for example in an interactive call) it
5280 will be prompted for."
5331 "Run through the buffer and add overlays to links."
5340 nil
5346 t)))))
5354 t)))
5357 "When non-nil, fontify code in code blocks."
5368 "Fontify #+ lines and blocks, in the correct ways."
5371 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5372 limit t)
5380 end end1 quoting block-type ovl)
5383 ;; a single line of backend-specific content
5391 ; for backend-specific code
5392 t)
5394 ;; Truly a block
5406 beg end
5414 ;; remove old background overlays
5419 ;; add a background overlay
5433 t))
5446 ;; just any other in-buffer setting, but not indented
5450 t)
5458 t)
5466 "Strip protective commas between BEG and END in the current buffer."
5482 "Run through the buffer and add overlays to links."
5490 t)))
5493 "Run through the buffer and add overlays to footnotes."
5500 'keymap org-mouse-map
5501 'help-echo
5503 "Footnote definition"
5505 'font-lock-fontified t
5506 'font-lock-multiline t
5510 "Run through the buffer and add overlays to bracketed links."
5514 ;; FIXME: above we should remove the escapes.
5515 ;; but that requires another match, protecting match data,
5516 ;; a lot of overhead for font-lock.
5523 ;; We need to remove the invisible property here. Table narrowing
5524 ;; may have made some of this invisible.
5542 t)))
5545 "Run through the buffer and add overlays to dates."
5557 t)))
5566 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5570 "Run through the buffer and add overlays to target matches."
5578 'keymap org-mouse-map
5582 t)))))
5585 "Find all radio targets in this file and update the regular expression."
5600 t)))
5607 ;; This should be with the exporter code, but we also use if for font-locking
5617 "Compute regular expression for stuff treated specially by exporters."
5624 org-latex-regexps)))
5652 org-entities)))
5656 org-latex-entities)
5657 nil))
5659 ))
5660 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5663 org-export-html-special-string-regexps)))
5668 ))))
5670 'org-latex-and-specials-regexp
5675 "Run through the buffer and add overlays to links."
5679 limit t))
5693 rtn)))
5696 "Restart `font-lock-mode', to force refontification."
5702 "Return a list of all targets in this file.
5703 With optional argument RADIO, only find radio targets."
5705 rtn)
5710 rtn)))
5713 "Make regular expression matching all strings in TARGETS.
5714 The regular expression finds the targets also if there is a line break
5715 between words."
5724 x)
5725 targets
5737 t)))
5740 "Compute the outline level of the heading at point.
5741 This function assumes that the cursor is at the beginning of a line matched
5742 by `outline-regexp'. Otherwise it returns garbage.
5743 If this is called at a normal headline, the level is the number of stars.
5744 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5751 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5758 "Functions that can manipulate `org-font-lock-extra-keywords'.
5759 This is called after `org-font-lock-extra-keywords' is defined, but before
5760 it is installed to be used by font lock. This can be useful if something
5771 ;; Call the hook
5773 ;; Headlines
5780 ;; Table lines
5783 ;; Table internals
5788 ;; Drawers
5791 ;; Properties
5795 ;; Links
5805 ;; TODO keyword
5807 org-todo-regexp)
5809 ;; DONE
5817 nil)
5818 ;; Priorities
5820 ;; Tags
5822 ;; Special keywords
5827 ;; Emphasis
5832 ;; Checkboxes
5833 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5838 ;; Description list items
5841 ;; ARCHIVEd headings
5843 org-outline-regexp-bol
5846 ;; Specials
5850 ;; Code
5852 ;; COMMENT
5859 ;; Blocks and meta lines
5861 )))
5864 ;; Now set the full font-lock-keywords
5871 "Toggle the composition display of entities as UTF8 characters."
5883 "Find an entity to fontify."
5889 limit t)
5901 nil))))
5904 "Fontify string S like in Org-mode."
5916 "Get the right face for match N in font-lock matching of headlines."
5929 "Get the right face for a TODO keyword KWD.
5930 If KWD is a number, get the corresponding match group."
5938 "Create a face list that inherits INHERIT, but sets the foreground color.
5939 When FACE-OR-COLOR is not a string, just return it."
5943 face-or-color)
5944 face-or-color))
5947 "Add the special tag faces."
5956 "Add the special priority faces."
5963 org-priority-faces)))
5968 "Get the right face for a TODO keyword KWD.
5969 If KWD is a number, get the corresponding match group."
5976 "Remove fontification and activation overlays from links."
5981 deactivate-mark buffer-file-name buffer-file-truename)
5985 invisible t intangible t
5986 org-no-flyspell t org-emphasis t))
5996 "Remove specific display properties that have been added by font lock.
5997 The will remove the raise properties that are used to show superscripts
5998 and subscripts."
6008 "Add raise properties to sub/superscripts."
6012 org-match-substring-regexp
6013 org-match-substring-with-braces-regexp)
6014 limit t)
6024 ;; FIXME: Should we go back one character here, for a_b^c
6025 ;; (goto-char (1- pos)) ;????????????????????
6027 t
6029 'display
6045 t)))))
6047 ;;;; Visibility cycling, including org-goto and indirect buffer
6049 ;;; Cycling
6056 ;;;###autoload
6061 "TAB-action and visibility cycling for Org-mode.
6063 This is the command invoked in Org-mode by the TAB key. Its main purpose
6064 is outline visibility cycling, but it also invokes other actions
6065 in special contexts.
6067 - When this function is called with a prefix argument, rotate the entire
6068 buffer through 3 states (global cycling)
6069 1. OVERVIEW: Show only top-level headlines.
6070 2. CONTENTS: Show all headlines of all levels, but no body text.
6071 3. SHOW ALL: Show everything.
6072 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6073 determined by the variable `org-startup-folded', and by any VISIBILITY
6074 properties in the buffer.
6075 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6076 including any drawers.
6078 - When inside a table, re-align the table and move to the next field.
6080 - When point is at the beginning of a headline, rotate the subtree started
6081 by this line through 3 different states (local cycling)
6082 1. FOLDED: Only the main headline is shown.
6083 2. CHILDREN: The main headline and the direct children are shown.
6084 From this state, you can move to one of the children
6085 and zoom in further.
6086 3. SUBTREE: Show the entire subtree, including body text.
6087 If there is no subtree, switch directly from CHILDREN to FOLDED.
6089 - When point is at the beginning of an empty headline and the variable
6090 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6091 of the headline by demoting and promoting it to likely levels. This
6092 speeds up creation document structure by pressing TAB once or several
6093 times right after creating a new headline.
6095 - When there is a numeric prefix, go up to a heading with level ARG, do
6096 a `show-subtree' and return to the previous cursor position. If ARG
6097 is negative, go up that many levels.
6099 - When point is not at the beginning of a headline, execute the global
6100 binding for TAB, which is re-indenting the line. See the option
6101 `org-cycle-emulate-tab' for details.
6103 - Special case: if point is at the beginning of the buffer and there is
6104 no headline in line 1, this function will act as if called with prefix arg
6105 (C-u TAB, same as S-TAB) also when called without prefix arg.
6106 But only if also the variable `org-cycle-global-at-bob' is t."
6116 org-inlinetask-min-level
6121 limit-level)))
6124 outline-regexp
6132 org-cycle-hook))
6136 ;; special case: use global cycling
6150 ;; Table: enter it or move to the next field.
6161 ;; Global cycling: delegate to `org-cycle-internal-global'.
6164 ;; Drawers: delegate to `org-flag-drawer'.
6172 ;; Show-subtree, ARG levels up from here.
6180 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6188 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6195 ;; From there: TAB emulation and template completion.
6217 t
6226 "Do the global cycling action."
6230 ;; We just created the overview - now do table of contents
6231 ;; This can be slow in very large buffers, so indicate action
6241 ;; We just showed the table of contents - now show everything
6249 ;; Default action: go to overview
6257 "Do the local cycling action."
6259 ;; First, determine end of headline (EOH), end of subtree or item
6260 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6284 ;; Determine end invisible part of buffer (EOL)
6286 ;; XEmacs doesn't have `next-single-char-property-change'
6296 ;; Find out what to do next and set `this-command'
6299 ;; Nothing is hidden behind this heading
6311 org-cycle-skip-children-state-if-no-children))))
6312 ;; Entire subtree is hidden in one line: children view
6318 ;; FIXME: This slows down the func way too much.
6319 ;; How keep drawers hidden in subtree anyway?
6320 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6321 ;; (org-cycle-hide-drawers 'subtree))
6323 ;; Fold every list in subtree to top-level items.
6345 ;; We just showed the children, or no children are there,
6346 ;; now show everything.
6353 ;; Default action: hide the subtree.
6360 ;;;###autoload
6362 "Cycle the global visibility. For details see `org-cycle'.
6364 With a numeric prefix, show all headlines up to that level."
6380 "Set the visibility required by startup options and properties."
6395 "Switch subtree visibilities according to :VISIBILITY: property."
6402 nil t)
6426 ;; This function uses outline-regexp instead of the more fundamental
6427 ;; org-outline-regexp so that org-cycle-global works outside of Org
6428 ;; buffers, where outline-regexp is needed.
6430 "Switch to overview mode, showing only top-level headlines.
6431 Really, this shows all headlines with level equal or greater than the level
6432 of the first headline in the buffer. This is important, because if the
6433 first headline is not level one, then (hide-sublevels 1) gives confusing
6434 results."
6445 "Show all headlines in the buffer, like a table of contents.
6446 With numerical argument N, show content up to level N."
6449 ;; Visit all headings and show their offspring
6456 t)
6465 "Adjust the window after a change in outline visibility.
6466 This function is the default value of the hook `org-cycle-hook'."
6476 "Remove outline overlays that do not contain non-white stuff."
6486 "Fix visibility issues after moving a subtree."
6487 ;; First, find a reasonable region to look at:
6488 ;; Start two siblings above, end three below
6506 ;; Properly fold already folded siblings
6517 "Show empty lines above all visible headlines.
6518 The region to be covered depends on STATE when called through
6519 `org-cycle-hook'. Lisp program can use t for STATE to get the
6520 entire buffer covered. Note that an empty line is only shown if there
6521 are at least `org-cycle-separator-lines' empty lines before the headline."
6531 beg end b e)
6555 ;; Never hide empty lines at the end of the file.
6565 "Move to the parent and re-show empty lines before visible headlines."
6571 "Return `org-agenda-files' list, plus all open org-mode files.
6572 This is useful for operations that need to scan all of a user's
6573 open and agenda-wise Org files."
6581 files))
6584 "Return the beginning position of the current entry."
6588 "Return the end position of the current entry."
6592 "Re-hide all drawers after a visibility state change."
6618 "Is the end of the current subtree visible?"
6623 "Move cursor to the first headline and recenter the headline.
6624 Optional argument N means put the headline into the Nth line of the window."
6630 ;;; Saving and restoring visibility
6633 "Return a list of the locations of all outline overlays.
6634 These are overlays with the `invisible' property value `outline'.
6635 The return value is a list of cons cells, with start and stop
6636 positions for each overlay.
6637 If USE-MARKERS is set, return the positions as markers."
6655 "Create visibility overlays for all positions in DATA.
6656 DATA should have been made by `org-outline-overlay-data'."
6664 data)))))
6666 ;;; Folding of blocks
6673 "Call FUNCTION at the head of all source blocks in the current buffer.
6674 Optional arguments START and END can be used to limit the range."
6686 "Toggle the visibility of all blocks in the current buffer."
6690 "Fold all blocks in the current buffer."
6696 "Unfold all blocks in the current buffer."
6702 "Toggle visibility of block at point."
6713 "Toggle the visibility of the current block."
6720 ov)
6736 ;; make the block accessible to isearch
6738 ov 'isearch-open-invisible
6749 ;; org-tab-after-check-for-cycling-hook
6751 ;; Remove overlays when changing major mode
6756 ;;; Org-goto
6762 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6778 nil)
6779 (org-defkey map "q" 'org-goto-quit)
6780 (org-defkey map "n" 'outline-next-visible-heading)
6781 (org-defkey map "p" 'outline-previous-visible-heading)
6782 (org-defkey map "f" 'outline-forward-same-level)
6783 (org-defkey map "b" 'outline-backward-same-level)
6784 (org-defkey map "u" 'outline-up-heading))
6785 (org-defkey map "/" 'org-occur)
6786 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6787 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6788 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6789 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6790 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6791 map))
6793 (defconst org-goto-help
6794 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6795 RET=jump to location [Q]uit and return to previous location
6796 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6798 (defvar org-goto-start-pos) ; dynamically scoped parameter
6800 ;; FIXME: Docstring does not mention both interfaces
6801 (defun org-goto (&optional alternative-interface)
6802 "Look up a different location in the current file, keeping current visibility.
6804 When you want look-up or go to a different location in a document, the
6805 fastest way is often to fold the entire buffer and then dive into the tree.
6806 This method has the disadvantage, that the previous location will be folded,
6807 which may not be what you want.
6809 This command works around this by showing a copy of the current buffer
6810 in an indirect buffer, in overview mode. You can dive into the tree in
6811 that copy, use org-occur and incremental search to find a location.
6812 When pressing RET or `Q', the command returns to the original buffer in
6813 which the visibility is still unchanged. After RET it will also jump to
6814 the location selected in the indirect buffer and expose the headline
6815 hierarchy above."
6816 (interactive "P")
6817 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6818 (org-refile-use-outline-path t)
6819 (org-refile-target-verify-function nil)
6820 (interface
6821 (if (not alternative-interface)
6822 org-goto-interface
6823 (if (eq org-goto-interface 'outline)
6824 'outline-path-completion
6825 'outline)))
6826 (org-goto-start-pos (point))
6827 (selected-point
6828 (if (eq interface 'outline)
6829 (car (org-get-location (current-buffer) org-goto-help))
6830 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6831 (org-refile-check-position pa)
6832 (nth 3 pa)))))
6833 (if selected-point
6834 (progn
6835 (org-mark-ring-push org-goto-start-pos)
6836 (goto-char selected-point)
6837 (if (or (outline-invisible-p) (org-invisible-p2))
6838 (org-show-context 'org-goto)))
6839 (message "Quit"))))
6841 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6842 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6843 (defvar org-goto-local-auto-isearch-map) ; defined below
6845 (defun org-get-location (buf help)
6846 "Let the user select a location in the Org-mode buffer BUF.
6847 This function uses a recursive edit. It returns the selected position
6848 or nil."
6849 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6850 (isearch-hide-immediately nil)
6851 (isearch-search-fun-function
6852 (lambda () 'org-goto-local-search-headings))
6853 (org-goto-selected-point org-goto-exit-command)
6854 (pop-up-frames nil)
6855 (special-display-buffer-names nil)
6856 (special-display-regexps nil)
6857 (special-display-function nil))
6858 (save-excursion
6859 (save-window-excursion
6860 (delete-other-windows)
6861 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6862 (org-pop-to-buffer-same-window
6863 (condition-case nil
6864 (make-indirect-buffer (current-buffer) "*org-goto*")
6865 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6866 (with-output-to-temp-buffer "*Help*"
6867 (princ help))
6868 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6869 (setq buffer-read-only nil)
6870 (let ((org-startup-truncated t)
6871 (org-startup-folded nil)
6872 (org-startup-align-all-tables nil))
6873 (org-mode)
6874 (org-overview))
6875 (setq buffer-read-only t)
6876 (if (and (boundp 'org-goto-start-pos)
6877 (integer-or-marker-p org-goto-start-pos))
6878 (let ((org-show-hierarchy-above t)
6879 (org-show-siblings t)
6880 (org-show-following-heading t))
6881 (goto-char org-goto-start-pos)
6882 (and (outline-invisible-p) (org-show-context)))
6883 (goto-char (point-min)))
6884 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6885 (message "Select location and press RET")
6886 (use-local-map org-goto-map)
6887 (recursive-edit)
6888 ))
6889 (kill-buffer "*org-goto*")
6890 (cons org-goto-selected-point org-goto-exit-command)))
6892 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6893 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6894 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6895 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6897 (defun org-goto-local-search-headings (string bound noerror)
6898 "Search and make sure that any matches are in headlines."
6899 (catch 'return
6900 (while (if isearch-forward
6901 (search-forward string bound noerror)
6902 (search-backward string bound noerror))
6903 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6904 (and (member :headline context)
6905 (not (member :tags context))))
6906 (throw 'return (point))))))
6908 (defun org-goto-local-auto-isearch ()
6909 "Start isearch."
6910 (interactive)
6911 (goto-char (point-min))
6912 (let ((keys (this-command-keys)))
6913 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6914 (isearch-mode t)
6915 (isearch-process-search-char (string-to-char keys)))))
6917 (defun org-goto-ret (&optional arg)
6918 "Finish `org-goto' by going to the new location."
6919 (interactive "P")
6920 (setq org-goto-selected-point (point)
6921 org-goto-exit-command 'return)
6922 (throw 'exit nil))
6924 (defun org-goto-left ()
6925 "Finish `org-goto' by going to the new location."
6926 (interactive)
6927 (if (org-at-heading-p)
6928 (progn
6929 (beginning-of-line 1)
6930 (setq org-goto-selected-point (point)
6931 org-goto-exit-command 'left)
6932 (throw 'exit nil))
6933 (error "Not on a heading")))
6935 (defun org-goto-right ()
6936 "Finish `org-goto' by going to the new location."
6937 (interactive)
6938 (if (org-at-heading-p)
6939 (progn
6940 (setq org-goto-selected-point (point)
6941 org-goto-exit-command 'right)
6942 (throw 'exit nil))
6943 (error "Not on a heading")))
6945 (defun org-goto-quit ()
6946 "Finish `org-goto' without cursor motion."
6947 (interactive)
6948 (setq org-goto-selected-point nil)
6949 (setq org-goto-exit-command 'quit)
6950 (throw 'exit nil))
6952 ;;; Indirect buffer display of subtrees
6954 (defvar org-indirect-dedicated-frame nil
6955 "This is the frame being used for indirect tree display.")
6956 (defvar org-last-indirect-buffer nil)
6958 (defun org-tree-to-indirect-buffer (&optional arg)
6959 "Create indirect buffer and narrow it to current subtree.
6960 With numerical prefix ARG, go up to this level and then take that tree.
6961 If ARG is negative, go up that many levels.
6962 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6963 indirect buffer previously made with this command, to avoid proliferation of
6964 indirect buffers. However, when you call the command with a \
6966 when `org-indirect-buffer-display' is `new-frame', the last buffer
6967 is kept so that you can work with several indirect buffers at the same time.
6968 If `org-indirect-buffer-display' is `dedicated-frame', the \
6970 requests that a new frame be made for the new buffer, so that the dedicated
6971 frame is not changed."
6972 (interactive "P")
6973 (let ((cbuf (current-buffer))
6974 (cwin (selected-window))
6975 (pos (point))
6976 beg end level heading ibuf)
6977 (save-excursion
6978 (org-back-to-heading t)
6979 (when (numberp arg)
6980 (setq level (org-outline-level))
6981 (if (< arg 0) (setq arg (+ level arg)))
6982 (while (> (setq level (org-outline-level)) arg)
6983 (outline-up-heading 1 t)))
6984 (setq beg (point)
6985 heading (org-get-heading))
6986 (org-end-of-subtree t t)
6987 (if (org-at-heading-p) (backward-char 1))
6988 (setq end (point)))
6989 (if (and (buffer-live-p org-last-indirect-buffer)
6990 (not (eq org-indirect-buffer-display 'new-frame))
6991 (not arg))
6992 (kill-buffer org-last-indirect-buffer))
6993 (setq ibuf (org-get-indirect-buffer cbuf)
6994 org-last-indirect-buffer ibuf)
6995 (cond
6996 ((or (eq org-indirect-buffer-display 'new-frame)
6997 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6998 (select-frame (make-frame))
6999 (delete-other-windows)
7000 (org-pop-to-buffer-same-window ibuf)
7001 (org-set-frame-title heading))
7002 ((eq org-indirect-buffer-display 'dedicated-frame)
7003 (raise-frame
7004 (select-frame (or (and org-indirect-dedicated-frame
7005 (frame-live-p org-indirect-dedicated-frame)
7006 org-indirect-dedicated-frame)
7007 (setq org-indirect-dedicated-frame (make-frame)))))
7008 (delete-other-windows)
7009 (org-pop-to-buffer-same-window ibuf)
7010 (org-set-frame-title (concat "Indirect: " heading)))
7011 ((eq org-indirect-buffer-display 'current-window)
7012 (org-pop-to-buffer-same-window ibuf))
7013 ((eq org-indirect-buffer-display 'other-window)
7014 (pop-to-buffer ibuf))
7015 (t (error "Invalid value")))
7016 (if (featurep 'xemacs)
7017 (save-excursion (org-mode) (turn-on-font-lock)))
7018 (narrow-to-region beg end)
7019 (show-all)
7020 (goto-char pos)
7021 (run-hook-with-args 'org-cycle-hook 'all)
7022 (and (window-live-p cwin) (select-window cwin))))
7024 (defun org-get-indirect-buffer (&optional buffer)
7025 (setq buffer (or buffer (current-buffer)))
7026 (let ((n 1) (base (buffer-name buffer)) bname)
7027 (while (buffer-live-p
7028 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7029 (setq n (1+ n)))
7030 (condition-case nil
7031 (make-indirect-buffer buffer bname 'clone)
7032 (error (make-indirect-buffer buffer bname)))))
7034 (defun org-set-frame-title (title)
7035 "Set the title of the current frame to the string TITLE."
7036 ;; FIXME: how to name a single frame in XEmacs???
7037 (unless (featurep 'xemacs)
7038 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7040 ;;;; Structure editing
7042 ;;; Inserting headlines
7044 (defun org-previous-line-empty-p ()
7045 (save-excursion
7046 (and (not (bobp))
7047 (or (beginning-of-line 0) t)
7048 (save-match-data
7051 (defun org-insert-heading (&optional force-heading invisible-ok)
7052 "Insert a new heading or item with same depth at point.
7053 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7054 If point is at the beginning of a headline, insert a sibling before the
7055 current headline. If point is not at the beginning, split the line,
7056 create the new headline with the text in the current line after point
7057 \(but see also the variable `org-M-RET-may-split-line').
7059 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7060 This is important for non-interactive uses of the command."
7061 (interactive "P")
7062 (if (or (= (buffer-size) 0)
7063 (and (not (save-excursion
7064 (and (ignore-errors (org-back-to-heading invisible-ok))
7065 (org-at-heading-p))))
7066 (or force-heading (not (org-in-item-p)))))
7067 (progn
7069 (run-hooks 'org-insert-heading-hook))
7070 (when (or force-heading (not (org-insert-item)))
7071 (let* ((empty-line-p nil)
7072 (level nil)
7073 (on-heading (org-at-heading-p))
7074 (head (save-excursion
7075 (condition-case nil
7076 (progn
7077 (org-back-to-heading invisible-ok)
7078 (when (and (not on-heading)
7079 (featurep 'org-inlinetask)
7080 (integerp org-inlinetask-min-level)
7081 (>= (length (match-string 0))
7082 org-inlinetask-min-level))
7083 ;; Find a heading level before the inline task
7084 (while (and (setq level (org-up-heading-safe))
7085 (>= level org-inlinetask-min-level)))
7086 (if (org-at-heading-p)
7087 (org-back-to-heading invisible-ok)
7088 (error "This should not happen")))
7089 (setq empty-line-p (org-previous-line-empty-p))
7090 (match-string 0))
7091 (error "*"))))
7092 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7093 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7094 pos hide-previous previous-pos)
7095 (cond
7096 ((and (org-at-heading-p) (bolp)
7097 (or (bobp)
7098 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7099 ;; insert before the current line
7100 (open-line (if blank 2 1)))
7101 ((and (bolp)
7102 (not org-insert-heading-respect-content)
7103 (or (bobp)
7104 (save-excursion
7105 (backward-char 1) (not (outline-invisible-p)))))
7106 ;; insert right here
7107 nil)
7108 (t
7109 ;; somewhere in the line
7110 (save-excursion
7111 (setq previous-pos (point-at-bol))
7112 (end-of-line)
7113 (setq hide-previous (outline-invisible-p)))
7114 (and org-insert-heading-respect-content (org-show-subtree))
7115 (let ((split
7116 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7117 (save-excursion
7118 (let ((p (point)))
7119 (goto-char (point-at-bol))
7120 (and (looking-at org-complex-heading-regexp)
7121 (match-beginning 4)
7122 (> p (match-beginning 4)))))))
7123 tags pos)
7124 (cond
7125 (org-insert-heading-respect-content
7126 (org-end-of-subtree nil t)
7127 (when (featurep 'org-inlinetask)
7128 (while (and (not (eobp))
7130 (>= (length (match-string 1))
7131 org-inlinetask-min-level))
7132 (org-end-of-subtree nil t)))
7133 (or (bolp) (newline))
7134 (or (org-previous-line-empty-p)
7135 (and blank (newline)))
7136 (open-line 1))
7137 ((org-at-heading-p)
7138 (when hide-previous
7139 (show-children)
7140 (org-show-entry))
7142 (setq tags (and (match-end 2) (match-string 2)))
7143 (and (match-end 1)
7144 (delete-region (match-beginning 1) (match-end 1)))
7145 (setq pos (point-at-bol))
7146 (or split (end-of-line 1))
7147 (delete-horizontal-space)
7149 (buffer-substring (point-at-bol) (point)))
7150 (insert " "))
7151 (newline (if blank 2 1))
7152 (when tags
7153 (save-excursion
7154 (goto-char pos)
7155 (end-of-line 1)
7156 (insert " " tags)
7157 (org-set-tags nil 'align))))
7158 (t
7159 (or split (end-of-line 1))
7160 (newline (if blank 2 1)))))))
7161 (insert head) (just-one-space)
7162 (setq pos (point))
7163 (end-of-line 1)
7164 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7165 (when (and org-insert-heading-respect-content hide-previous)
7166 (save-excursion
7167 (goto-char previous-pos)
7168 (hide-subtree)))
7169 (run-hooks 'org-insert-heading-hook)))))
7171 (defun org-get-heading (&optional no-tags no-todo)
7172 "Return the heading of the current entry, without the stars.
7173 When NO-TAGS is non-nil, don't include tags.
7174 When NO-TODO is non-nil, don't include TODO keywords."
7175 (save-excursion
7176 (org-back-to-heading t)
7177 (cond
7178 ((and no-tags no-todo)
7179 (looking-at org-complex-heading-regexp)
7180 (match-string 4))
7181 (no-tags
7182 (looking-at (concat org-outline-regexp
7185 (match-string 1))
7186 (no-todo
7187 (looking-at org-todo-line-regexp)
7188 (match-string 3))
7189 (t (looking-at org-heading-regexp)
7190 (match-string 2)))))
7192 (defun org-heading-components ()
7193 "Return the components of the current heading.
7194 This is a list with the following elements:
7195 - the level as an integer
7196 - the reduced level, different if `org-odd-levels-only' is set.
7197 - the TODO keyword, or nil
7198 - the priority character, like ?A, or nil if no priority is given
7199 - the headline text itself, or the tags string if no headline text
7200 - the tags string, or nil."
7201 (save-excursion
7202 (org-back-to-heading t)
7203 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7204 (list (length (match-string 1))
7205 (org-reduced-level (length (match-string 1)))
7206 (org-match-string-no-properties 2)
7207 (and (match-end 3) (aref (match-string 3) 2))
7208 (org-match-string-no-properties 4)
7209 (org-match-string-no-properties 5)))))
7211 (defun org-get-entry ()
7212 "Get the entry text, after heading, entire subtree."
7213 (save-excursion
7214 (org-back-to-heading t)
7215 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7217 (defun org-insert-heading-after-current ()
7218 "Insert a new heading with same level as current, after current subtree."
7219 (interactive)
7220 (org-back-to-heading)
7221 (org-insert-heading)
7222 (org-move-subtree-down)
7223 (end-of-line 1))
7225 (defun org-insert-heading-respect-content ()
7226 (interactive)
7227 (let ((org-insert-heading-respect-content t))
7228 (org-insert-heading t)))
7230 (defun org-insert-todo-heading-respect-content (&optional force-state)
7231 (interactive "P")
7232 (let ((org-insert-heading-respect-content t))
7233 (org-insert-todo-heading force-state t)))
7235 (defun org-insert-todo-heading (arg &optional force-heading)
7236 "Insert a new heading with the same level and TODO state as current heading.
7237 If the heading has no TODO state, or if the state is DONE, use the first
7238 state (TODO by default). Also with prefix arg, force first state."
7239 (interactive "P")
7240 (when (or force-heading (not (org-insert-item 'checkbox)))
7241 (org-insert-heading force-heading)
7242 (save-excursion
7243 (org-back-to-heading)
7244 (outline-previous-heading)
7245 (looking-at org-todo-line-regexp))
7246 (let*
7247 ((new-mark-x
7248 (if (or arg
7249 (not (match-beginning 2))
7250 (member (match-string 2) org-done-keywords))
7251 (car org-todo-keywords-1)
7252 (match-string 2)))
7253 (new-mark
7254 (or
7255 (run-hook-with-args-until-success
7256 'org-todo-get-default-hook new-mark-x nil)
7257 new-mark-x)))
7258 (beginning-of-line 1)
7259 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7260 (if org-treat-insert-todo-heading-as-state-change
7261 (org-todo new-mark)
7262 (insert new-mark " "))))
7263 (when org-provide-todo-statistics
7264 (org-update-parent-todo-statistics))))
7266 (defun org-insert-subheading (arg)
7267 "Insert a new subheading and demote it.
7268 Works for outline headings and for plain lists alike."
7269 (interactive "P")
7270 (org-insert-heading arg)
7271 (cond
7272 ((org-at-heading-p) (org-do-demote))
7273 ((org-at-item-p) (org-indent-item))))
7275 (defun org-insert-todo-subheading (arg)
7276 "Insert a new subheading with TODO keyword or checkbox and demote it.
7277 Works for outline headings and for plain lists alike."
7278 (interactive "P")
7279 (org-insert-todo-heading arg)
7280 (cond
7281 ((org-at-heading-p) (org-do-demote))
7282 ((org-at-item-p) (org-indent-item))))
7284 ;;; Promotion and Demotion
7286 (defvar org-after-demote-entry-hook nil
7287 "Hook run after an entry has been demoted.
7288 The cursor will be at the beginning of the entry.
7289 When a subtree is being demoted, the hook will be called for each node.")
7291 (defvar org-after-promote-entry-hook nil
7292 "Hook run after an entry has been promoted.
7293 The cursor will be at the beginning of the entry.
7294 When a subtree is being promoted, the hook will be called for each node.")
7296 (defun org-promote-subtree ()
7297 "Promote the entire subtree.
7298 See also `org-promote'."
7299 (interactive)
7300 (save-excursion
7301 (org-with-limited-levels (org-map-tree 'org-promote)))
7302 (org-fix-position-after-promote))
7304 (defun org-demote-subtree ()
7305 "Demote the entire subtree. See `org-demote'.
7306 See also `org-promote'."
7307 (interactive)
7308 (save-excursion
7309 (org-with-limited-levels (org-map-tree 'org-demote)))
7310 (org-fix-position-after-promote))
7313 (defun org-do-promote ()
7314 "Promote the current heading higher up the tree.
7315 If the region is active in `transient-mark-mode', promote all headings
7316 in the region."
7317 (interactive)
7318 (save-excursion
7319 (if (org-region-active-p)
7320 (org-map-region 'org-promote (region-beginning) (region-end))
7321 (org-promote)))
7322 (org-fix-position-after-promote))
7324 (defun org-do-demote ()
7325 "Demote the current heading lower down the tree.
7326 If the region is active in `transient-mark-mode', demote all headings
7327 in the region."
7328 (interactive)
7329 (save-excursion
7330 (if (org-region-active-p)
7331 (org-map-region 'org-demote (region-beginning) (region-end))
7332 (org-demote)))
7333 (org-fix-position-after-promote))
7335 (defun org-fix-position-after-promote ()
7336 "Make sure that after pro/demotion cursor position is right."
7337 (let ((pos (point)))
7338 (when (save-excursion
7339 (beginning-of-line 1)
7340 (looking-at org-todo-line-regexp)
7341 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7342 (cond ((eobp) (insert " "))
7343 ((eolp) (insert " "))
7344 ((equal (char-after) ?\ ) (forward-char 1))))))
7346 (defun org-current-level ()
7347 "Return the level of the current entry, or nil if before the first headline.
7348 The level is the number of stars at the beginning of the headline."
7349 (save-excursion
7350 (org-with-limited-levels
7351 (if (ignore-errors (org-back-to-heading t))
7352 (funcall outline-level)))))
7354 (defun org-get-previous-line-level ()
7355 "Return the outline depth of the last headline before the current line.
7356 Returns 0 for the first headline in the buffer, and nil if before the
7357 first headline."
7358 (let ((current-level (org-current-level))
7359 (prev-level (when (> (line-number-at-pos) 1)
7360 (save-excursion
7361 (beginning-of-line 0)
7362 (org-current-level)))))
7363 (cond ((null current-level) nil) ; Before first headline
7364 ((null prev-level) 0) ; At first headline
7365 (prev-level))))
7367 (defun org-reduced-level (l)
7368 "Compute the effective level of a heading.
7369 This takes into account the setting of `org-odd-levels-only'."
7370 (cond
7371 ((zerop l) 0)
7372 (org-odd-levels-only (1+ (floor (/ l 2))))
7373 (t l)))
7375 (defun org-level-increment ()
7376 "Return the number of stars that will be added or removed at a
7377 time to headlines when structure editing, based on the value of
7378 `org-odd-levels-only'."
7379 (if org-odd-levels-only 2 1))
7381 (defun org-get-valid-level (level &optional change)
7382 "Rectify a level change under the influence of `org-odd-levels-only'
7383 LEVEL is a current level, CHANGE is by how much the level should be
7384 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7385 even level numbers will become the next higher odd number."
7386 (if org-odd-levels-only
7387 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7388 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7389 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7390 (max 1 (+ level (or change 0)))))
7392 (if (boundp 'define-obsolete-function-alias)
7393 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7394 (define-obsolete-function-alias 'org-get-legal-level
7395 'org-get-valid-level)
7396 (define-obsolete-function-alias 'org-get-legal-level
7397 'org-get-valid-level "23.1")))
7399 (defun org-promote ()
7400 "Promote the current heading higher up the tree.
7401 If the region is active in `transient-mark-mode', promote all headings
7402 in the region."
7403 (org-back-to-heading t)
7404 (let* ((level (save-match-data (funcall outline-level)))
7405 (after-change-functions (remove 'flyspell-after-change-function
7406 after-change-functions))
7407 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7408 (diff (abs (- level (length up-head) -1))))
7409 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7410 (replace-match up-head nil t)
7411 ;; Fixup tag positioning
7412 (and org-auto-align-tags (org-set-tags nil t))
7413 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7414 (run-hooks 'org-after-promote-entry-hook)))
7416 (defun org-demote ()
7417 "Demote the current heading lower down the tree.
7418 If the region is active in `transient-mark-mode', demote all headings
7419 in the region."
7420 (org-back-to-heading t)
7421 (let* ((level (save-match-data (funcall outline-level)))
7422 (after-change-functions (remove 'flyspell-after-change-function
7423 after-change-functions))
7424 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7425 (diff (abs (- level (length down-head) -1))))
7426 (replace-match down-head nil t)
7427 ;; Fixup tag positioning
7428 (and org-auto-align-tags (org-set-tags nil t))
7429 (if org-adapt-indentation (org-fixup-indentation diff))
7430 (run-hooks 'org-after-demote-entry-hook)))
7432 (defun org-cycle-level ()
7433 "Cycle the level of an empty headline through possible states.
7434 This goes first to child, then to parent, level, then up the hierarchy.
7435 After top level, it switches back to sibling level."
7436 (interactive)
7437 (let ((org-adapt-indentation nil))
7438 (when (org-point-at-end-of-empty-headline)
7439 (setq this-command 'org-cycle-level) ; Only needed for caching
7440 (let ((cur-level (org-current-level))
7441 (prev-level (org-get-previous-line-level)))
7442 (cond
7443 ;; If first headline in file, promote to top-level.
7444 ((= prev-level 0)
7445 (loop repeat (/ (- cur-level 1) (org-level-increment))
7446 do (org-do-promote)))
7447 ;; If same level as prev, demote one.
7448 ((= prev-level cur-level)
7449 (org-do-demote))
7450 ;; If parent is top-level, promote to top level if not already.
7451 ((= prev-level 1)
7452 (loop repeat (/ (- cur-level 1) (org-level-increment))
7453 do (org-do-promote)))
7454 ;; If top-level, return to prev-level.
7455 ((= cur-level 1)
7456 (loop repeat (/ (- prev-level 1) (org-level-increment))
7457 do (org-do-demote)))
7458 ;; If less than prev-level, promote one.
7459 ((< cur-level prev-level)
7460 (org-do-promote))
7461 ;; If deeper than prev-level, promote until higher than
7462 ;; prev-level.
7463 ((> cur-level prev-level)
7464 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7465 do (org-do-promote))))
7466 t))))
7468 (defun org-map-tree (fun)
7469 "Call FUN for every heading underneath the current one."
7470 (org-back-to-heading)
7471 (let ((level (funcall outline-level)))
7472 (save-excursion
7473 (funcall fun)
7474 (while (and (progn
7475 (outline-next-heading)
7476 (> (funcall outline-level) level))
7477 (not (eobp)))
7478 (funcall fun)))))
7480 (defun org-map-region (fun beg end)
7481 "Call FUN for every heading between BEG and END."
7482 (let ((org-ignore-region t))
7483 (save-excursion
7484 (setq end (copy-marker end))
7485 (goto-char beg)
7486 (if (and (re-search-forward org-outline-regexp-bol nil t)
7487 (< (point) end))
7488 (funcall fun))
7489 (while (and (progn
7490 (outline-next-heading)
7491 (< (point) end))
7492 (not (eobp)))
7493 (funcall fun)))))
7495 (defvar org-property-end-re) ; silence byte-compiler
7496 (defun org-fixup-indentation (diff)
7497 "Change the indentation in the current entry by DIFF.
7498 However, if any line in the current entry has no indentation, or if it
7499 would end up with no indentation after the change, nothing at all is done."
7500 (save-excursion
7501 (let ((end (save-excursion (outline-next-heading)
7502 (point-marker)))
7503 (prohibit (if (> diff 0)
7506 col)
7507 (unless (save-excursion (end-of-line 1)
7508 (re-search-forward prohibit end t))
7509 (while (and (< (point) end)
7511 (goto-char (match-end 0))
7512 (setq col (current-column))
7513 (if (< diff 0) (replace-match ""))
7514 (org-indent-to-column (+ diff col))))
7515 (move-marker end nil))))
7517 (defun org-convert-to-odd-levels ()
7518 "Convert an org-mode file with all levels allowed to one with odd levels.
7519 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7520 level 5 etc."
7521 (interactive)
7522 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7523 (let ((outline-level 'org-outline-level)
7524 (org-odd-levels-only nil) n)
7525 (save-excursion
7526 (goto-char (point-min))
7528 (setq n (- (length (match-string 0)) 2))
7529 (while (>= (setq n (1- n)) 0)
7530 (org-demote))
7531 (end-of-line 1))))))
7533 (defun org-convert-to-oddeven-levels ()
7534 "Convert an org-mode file with only odd levels to one with odd/even levels.
7535 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7536 file contains a section with an even level, conversion would
7537 destroy the structure of the file. An error is signaled in this
7538 case."
7539 (interactive)
7540 (goto-char (point-min))
7541 ;; First check if there are no even levels
7543 (org-show-context t)
7544 (error "Not all levels are odd in this file. Conversion not possible"))
7545 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7546 (let ((outline-regexp org-outline-regexp)
7547 (outline-level 'org-outline-level)
7548 (org-odd-levels-only nil) n)
7549 (save-excursion
7550 (goto-char (point-min))
7552 (setq n (/ (1- (length (match-string 0))) 2))
7553 (while (>= (setq n (1- n)) 0)
7554 (org-promote))
7555 (end-of-line 1))))))
7557 (defun org-tr-level (n)
7558 "Make N odd if required."
7559 (if org-odd-levels-only (1+ (/ n 2)) n))
7561 ;;; Vertical tree motion, cutting and pasting of subtrees
7563 (defun org-move-subtree-up (&optional arg)
7564 "Move the current subtree up past ARG headlines of the same level."
7565 (interactive "p")
7566 (org-move-subtree-down (- (prefix-numeric-value arg))))
7568 (defun org-move-subtree-down (&optional arg)
7569 "Move the current subtree down past ARG headlines of the same level."
7570 (interactive "p")
7571 (setq arg (prefix-numeric-value arg))
7572 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7573 'org-get-last-sibling))
7574 (ins-point (make-marker))
7575 (cnt (abs arg))
7576 (col (current-column))
7577 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7578 ;; Select the tree
7579 (org-back-to-heading)
7580 (setq beg0 (point))
7581 (save-excursion
7582 (setq ne-beg (org-back-over-empty-lines))
7583 (setq beg (point)))
7584 (save-match-data
7585 (save-excursion (outline-end-of-heading)
7586 (setq folded (outline-invisible-p)))
7587 (outline-end-of-subtree))
7588 (outline-next-heading)
7589 (setq ne-end (org-back-over-empty-lines))
7590 (setq end (point))
7591 (goto-char beg0)
7592 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7593 ;; include less whitespace
7594 (save-excursion
7595 (goto-char beg)
7596 (forward-line (- ne-beg ne-end))
7597 (setq beg (point))))
7598 ;; Find insertion point, with error handling
7599 (while (> cnt 0)
7600 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7601 (progn (goto-char beg0)
7602 (error "Cannot move past superior level or buffer limit")))
7603 (setq cnt (1- cnt)))
7604 (if (> arg 0)
7605 ;; Moving forward - still need to move over subtree
7606 (progn (org-end-of-subtree t t)
7607 (save-excursion
7608 (org-back-over-empty-lines)
7609 (or (bolp) (newline)))))
7610 (setq ne-ins (org-back-over-empty-lines))
7611 (move-marker ins-point (point))
7612 (setq txt (buffer-substring beg end))
7613 (org-save-markers-in-region beg end)
7614 (delete-region beg end)
7615 (org-remove-empty-overlays-at beg)
7616 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7617 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7619 (let ((bbb (point)))
7620 (insert-before-markers txt)
7621 (org-reinstall-markers-in-region bbb)
7622 (move-marker ins-point bbb))
7624 (setq ins-end (point))
7625 (goto-char ins-point)
7626 (org-skip-whitespace)
7627 (when (and (< arg 0)
7628 (org-first-sibling-p)
7629 (> ne-ins ne-beg))
7630 ;; Move whitespace back to beginning
7631 (save-excursion
7632 (goto-char ins-end)
7633 (let ((kill-whole-line t))
7634 (kill-line (- ne-ins ne-beg)) (point)))
7636 (move-marker ins-point nil)
7637 (if folded
7638 (hide-subtree)
7639 (org-show-entry)
7640 (show-children)
7641 (org-cycle-hide-drawers 'children))
7642 (org-clean-visibility-after-subtree-move)
7643 ;; move back to the initial column we were at
7644 (move-to-column col)))
7646 (defvar org-subtree-clip ""
7647 "Clipboard for cut and paste of subtrees.
7648 This is actually only a copy of the kill, because we use the normal kill
7649 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7651 (defvar org-subtree-clip-folded nil
7652 "Was the last copied subtree folded?
7653 This is used to fold the tree back after pasting.")
7655 (defun org-cut-subtree (&optional n)
7656 "Cut the current subtree into the clipboard.
7657 With prefix arg N, cut this many sequential subtrees.
7658 This is a short-hand for marking the subtree and then cutting it."
7659 (interactive "p")
7660 (org-copy-subtree n 'cut))
7662 (defun org-copy-subtree (&optional n cut force-store-markers)
7663 "Cut the current subtree into the clipboard.
7664 With prefix arg N, cut this many sequential subtrees.
7665 This is a short-hand for marking the subtree and then copying it.
7666 If CUT is non-nil, actually cut the subtree.
7667 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7668 of some markers in the region, even if CUT is non-nil. This is
7669 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7670 (interactive "p")
7671 (let (beg end folded (beg0 (point)))
7672 (if (org-called-interactively-p 'any)
7673 (org-back-to-heading nil) ; take what looks like a subtree
7674 (org-back-to-heading t)) ; take what is really there
7675 (org-back-over-empty-lines)
7676 (setq beg (point))
7678 (save-match-data
7679 (save-excursion (outline-end-of-heading)
7680 (setq folded (outline-invisible-p)))
7681 (condition-case nil
7682 (org-forward-same-level (1- n) t)
7683 (error nil))
7684 (org-end-of-subtree t t))
7685 (org-back-over-empty-lines)
7686 (setq end (point))
7687 (goto-char beg0)
7688 (when (> end beg)
7689 (setq org-subtree-clip-folded folded)
7690 (when (or cut force-store-markers)
7691 (org-save-markers-in-region beg end))
7692 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7693 (setq org-subtree-clip (current-kill 0))
7694 (message "%s: Subtree(s) with %d characters"
7695 (if cut "Cut" "Copied")
7696 (length org-subtree-clip)))))
7698 (defun org-paste-subtree (&optional level tree for-yank)
7699 "Paste the clipboard as a subtree, with modification of headline level.
7700 The entire subtree is promoted or demoted in order to match a new headline
7701 level.
7703 If the cursor is at the beginning of a headline, the same level as
7704 that headline is used to paste the tree
7706 If not, the new level is derived from the *visible* headings
7707 before and after the insertion point, and taken to be the inferior headline
7708 level of the two. So if the previous visible heading is level 3 and the
7709 next is level 4 (or vice versa), level 4 will be used for insertion.
7710 This makes sure that the subtree remains an independent subtree and does
7711 not swallow low level entries.
7713 You can also force a different level, either by using a numeric prefix
7714 argument, or by inserting the heading marker by hand. For example, if the
7717 If optional TREE is given, use this text instead of the kill ring.
7719 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7720 move back over whitespace before inserting, and move point to the end of
7721 the inserted text when done."
7722 (interactive "P")
7723 (setq tree (or tree (and kill-ring (current-kill 0))))
7724 (unless (org-kill-is-subtree-p tree)
7725 (error "%s"
7726 (substitute-command-keys
7728 (org-with-limited-levels
7729 (let* ((visp (not (outline-invisible-p)))
7730 (txt tree)
7732 (old-level (if (string-match org-outline-regexp-bol txt)
7733 (- (match-end 0) (match-beginning 0) 1)
7734 -1))
7735 (force-level (cond (level (prefix-numeric-value level))
7737 (string-match
7739 (point-at-bol) (point))))
7740 (- (match-end 1) (match-beginning 1)))
7741 ((and (bolp)
7742 (looking-at org-outline-regexp))
7743 (- (match-end 0) (point) 1))
7744 (t nil)))
7745 (previous-level (save-excursion
7746 (condition-case nil
7747 (progn
7748 (outline-previous-visible-heading 1)
7749 (if (looking-at ^re_)
7750 (- (match-end 0) (match-beginning 0) 1)
7751 1))
7752 (error 1))))
7753 (next-level (save-excursion
7754 (condition-case nil
7755 (progn
7756 (or (looking-at org-outline-regexp)
7757 (outline-next-visible-heading 1))
7758 (if (looking-at ^re_)
7759 (- (match-end 0) (match-beginning 0) 1)
7760 1))
7761 (error 1))))
7762 (new-level (or force-level (max previous-level next-level)))
7763 (shift (if (or (= old-level -1)
7764 (= new-level -1)
7765 (= old-level new-level))
7766 0
7767 (- new-level old-level)))
7768 (delta (if (> shift 0) -1 1))
7769 (func (if (> shift 0) 'org-demote 'org-promote))
7770 (org-odd-levels-only nil)
7771 beg end newend)
7772 ;; Remove the forced level indicator
7773 (if force-level
7774 (delete-region (point-at-bol) (point)))
7775 ;; Paste
7776 (beginning-of-line (if (bolp) 1 2))
7777 (unless for-yank (org-back-over-empty-lines))
7778 (setq beg (point))
7779 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7780 (insert-before-markers txt)
7782 (setq newend (point))
7783 (org-reinstall-markers-in-region beg)
7784 (setq end (point))
7785 (goto-char beg)
7787 (setq beg (point))
7788 (if (and (outline-invisible-p) visp)
7789 (save-excursion (outline-show-heading)))
7790 ;; Shift if necessary
7791 (unless (= shift 0)
7792 (save-restriction
7793 (narrow-to-region beg end)
7794 (while (not (= shift 0))
7795 (org-map-region func (point-min) (point-max))
7796 (setq shift (+ delta shift)))
7797 (goto-char (point-min))
7798 (setq newend (point-max))))
7799 (when (or (org-called-interactively-p 'interactive) for-yank)
7800 (message "Clipboard pasted as level %d subtree" new-level))
7801 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7802 kill-ring
7803 (eq org-subtree-clip (current-kill 0))
7804 org-subtree-clip-folded)
7805 ;; The tree was folded before it was killed/copied
7806 (hide-subtree))
7807 (and for-yank (goto-char newend)))))
7809 (defun org-kill-is-subtree-p (&optional txt)
7810 "Check if the current kill is an outline subtree, or a set of trees.
7811 Returns nil if kill does not start with a headline, or if the first
7812 headline level is not the largest headline level in the tree.
7813 So this will actually accept several entries of equal levels as well,
7814 which is OK for `org-paste-subtree'.
7815 If optional TXT is given, check this string instead of the current kill."
7816 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7817 (re (org-get-limited-outline-regexp))
7818 (^re (concat "^" re))
7819 (start-level (and kill
7820 (string-match
7822 kill)
7823 (- (match-end 2) (match-beginning 2) 1)))
7824 (start (1+ (or (match-beginning 2) -1))))
7825 (if (not start-level)
7826 (progn
7827 nil) ;; does not even start with a heading
7828 (catch 'exit
7829 (while (setq start (string-match ^re kill (1+ start)))
7830 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7831 (throw 'exit nil)))
7832 t))))
7834 (defvar org-markers-to-move nil
7835 "Markers that should be moved with a cut-and-paste operation.
7836 Those markers are stored together with their positions relative to
7837 the start of the region.")
7839 (defun org-save-markers-in-region (beg end)
7840 "Check markers in region.
7841 If these markers are between BEG and END, record their position relative
7842 to BEG, so that after moving the block of text, we can put the markers back
7843 into place.
7844 This function gets called just before an entry or tree gets cut from the
7845 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7846 called immediately, to move the markers with the entries."
7847 (setq org-markers-to-move nil)
7848 (when (featurep 'org-clock)
7849 (org-clock-save-markers-for-cut-and-paste beg end))
7850 (when (featurep 'org-agenda)
7851 (org-agenda-save-markers-for-cut-and-paste beg end)))
7853 (defun org-check-and-save-marker (marker beg end)
7854 "Check if MARKER is between BEG and END.
7855 If yes, remember the marker and the distance to BEG."
7856 (when (and (marker-buffer marker)
7857 (equal (marker-buffer marker) (current-buffer)))
7858 (if (and (>= marker beg) (< marker end))
7859 (push (cons marker (- marker beg)) org-markers-to-move))))
7861 (defun org-reinstall-markers-in-region (beg)
7862 "Move all remembered markers to their position relative to BEG."
7863 (mapc (lambda (x)
7864 (move-marker (car x) (+ beg (cdr x))))
7865 org-markers-to-move)
7866 (setq org-markers-to-move nil))
7868 (defun org-narrow-to-subtree ()
7869 "Narrow buffer to the current subtree."
7870 (interactive)
7871 (save-excursion
7872 (save-match-data
7873 (org-with-limited-levels
7874 (narrow-to-region
7875 (progn (org-back-to-heading t) (point))
7876 (progn (org-end-of-subtree t t)
7877 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7878 (point)))))))
7880 (defun org-narrow-to-block ()
7881 "Narrow buffer to the current block."
7882 (interactive)
7883 (let* ((case-fold-search t)
7886 (if blockp
7887 (narrow-to-region (car blockp) (cdr blockp))
7888 (error "Not in a block"))))
7890 (eval-when-compile
7891 (defvar org-property-drawer-re))
7893 (defvar org-property-start-re) ;; defined below
7894 (defun org-clone-subtree-with-time-shift (n &optional shift)
7895 "Clone the task (subtree) at point N times.
7896 The clones will be inserted as siblings.
7898 In interactive use, the user will be prompted for the number of
7899 clones to be produced, and for a time SHIFT, which may be a
7900 repeater as used in time stamps, for example `+3d'.
7902 When a valid repeater is given and the entry contains any time
7903 stamps, the clones will become a sequence in time, with time
7904 stamps in the subtree shifted for each clone produced. If SHIFT
7905 is nil or the empty string, time stamps will be left alone. The
7906 ID property of the original subtree is removed.
7908 If the original subtree did contain time stamps with a repeater,
7909 the following will happen:
7910 - the repeater will be removed in each clone
7911 - an additional clone will be produced, with the current, unshifted
7912 date(s) in the entry.
7913 - the original entry will be placed *after* all the clones, with
7914 repeater intact.
7915 - the start days in the repeater in the original entry will be shifted
7916 to past the last clone.
7917 In this way you can spell out a number of instances of a repeating task,
7918 and still retain the repeater to cover future instances of the task."
7919 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7920 (let (beg end template task idprop
7921 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7922 (drawer-re org-drawer-regexp))
7923 (if (not (and (integerp n) (> n 0)))
7924 (error "Invalid number of replications %s" n))
7927 shift)))
7928 (error "Invalid shift specification %s" shift))
7929 (when doshift
7930 (setq shift-n (string-to-number (match-string 1 shift))
7931 shift-what (cdr (assoc (match-string 2 shift)
7932 '(("d" . day) ("w" . week)
7933 ("m" . month) ("y" . year))))))
7934 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7935 (setq nmin 1 nmax n)
7936 (org-back-to-heading t)
7937 (setq beg (point))
7938 (setq idprop (org-entry-get nil "ID"))
7939 (org-end-of-subtree t t)
7941 (setq end (point))
7942 (setq template (buffer-substring beg end))
7943 (when (and doshift
7945 (delete-region beg end)
7946 (setq end beg)
7947 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7948 (goto-char end)
7949 (loop for n from nmin to nmax do
7950 ;; prepare clone
7951 (with-temp-buffer
7952 (insert template)
7953 (org-mode)
7954 (goto-char (point-min))
7955 (org-show-subtree)
7956 (and idprop (if org-clone-delete-id
7957 (org-entry-delete nil "ID")
7958 (org-id-get-create t)))
7959 (unless (= n 0)
7961 (kill-whole-line))
7962 (goto-char (point-min))
7963 (while (re-search-forward drawer-re nil t)
7964 (mapc (lambda (d)
7965 (org-remove-empty-drawer-at d (point))) org-drawers)))
7966 (goto-char (point-min))
7967 (when doshift
7968 (while (re-search-forward org-ts-regexp-both nil t)
7969 (org-timestamp-change (* n shift-n) shift-what))
7970 (unless (= n n-no-remove)
7971 (goto-char (point-min))
7972 (while (re-search-forward org-ts-regexp nil t)
7973 (save-excursion
7974 (goto-char (match-beginning 0))
7976 (delete-region (match-beginning 1) (match-end 1)))))))
7977 (setq task (buffer-string)))
7978 (insert task))
7979 (goto-char beg)))
7981 ;;; Outline Sorting
7983 (defun org-sort (with-case)
7984 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7985 Optional argument WITH-CASE means sort case-sensitively."
7986 (interactive "P")
7987 (cond
7988 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7989 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7990 (t
7991 (org-call-with-arg 'org-sort-entries with-case))))
7993 (defun org-sort-remove-invisible (s)
7994 (remove-text-properties 0 (length s) org-rm-props s)
7995 (while (string-match org-bracket-link-regexp s)
7996 (setq s (replace-match (if (match-end 2)
7997 (match-string 3 s)
7998 (match-string 1 s)) t t s)))
7999 s)
8001 (defvar org-priority-regexp) ; defined later in the file
8003 (defvar org-after-sorting-entries-or-items-hook nil
8004 "Hook that is run after a bunch of entries or items have been sorted.
8005 When children are sorted, the cursor is in the parent line when this
8006 hook gets called. When a region or a plain list is sorted, the cursor
8007 will be in the first entry of the sorted region/list.")
8009 (defun org-sort-entries
8010 (&optional with-case sorting-type getkey-func compare-func property)
8011 "Sort entries on a certain level of an outline tree.
8012 If there is an active region, the entries in the region are sorted.
8013 Else, if the cursor is before the first entry, sort the top-level items.
8014 Else, the children of the entry at point are sorted.
8016 Sorting can be alphabetically, numerically, by date/time as given by
8017 a time stamp, by a property or by priority.
8019 The command prompts for the sorting type unless it has been given to the
8020 function through the SORTING-TYPE argument, which needs to be a character,
8021 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8022 precise meaning of each character:
8024 n Numerically, by converting the beginning of the entry/item to a number.
8025 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8026 t By date/time, either the first active time stamp in the entry, or, if
8027 none exist, by the first inactive one.
8028 s By the scheduled date/time.
8029 d By deadline date/time.
8030 c By creation time, which is assumed to be the first inactive time stamp
8031 at the beginning of a line.
8032 p By priority according to the cookie.
8033 r By the value of a property.
8035 Capital letters will reverse the sort order.
8037 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8038 called with point at the beginning of the record. It must return either
8039 a string or a number that should serve as the sorting key for that record.
8041 Comparing entries ignores case by default. However, with an optional argument
8042 WITH-CASE, the sorting considers case as well."
8043 (interactive "P")
8044 (let ((case-func (if with-case 'identity 'downcase))
8045 start beg end stars re re2
8046 txt what tmp)
8047 ;; Find beginning and end of region to sort
8048 (cond
8049 ((org-region-active-p)
8050 ;; we will sort the region
8051 (setq end (region-end)
8052 what "region")
8053 (goto-char (region-beginning))
8054 (if (not (org-at-heading-p)) (outline-next-heading))
8055 (setq start (point)))
8056 ((or (org-at-heading-p)
8057 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8058 ;; we will sort the children of the current headline
8059 (org-back-to-heading)
8060 (setq start (point)
8061 end (progn (org-end-of-subtree t t)
8063 (org-back-over-empty-lines)
8064 (point))
8065 what "children")
8066 (goto-char start)
8067 (show-subtree)
8068 (outline-next-heading))
8069 (t
8070 ;; we will sort the top-level entries in this file
8071 (goto-char (point-min))
8072 (or (org-at-heading-p) (outline-next-heading))
8073 (setq start (point))
8074 (goto-char (point-max))
8075 (beginning-of-line 1)
8077 ;; File ends in a non-white line
8078 (end-of-line 1)
8080 (setq end (point-max))
8081 (setq what "top-level")
8082 (goto-char start)
8083 (show-all)))
8085 (setq beg (point))
8086 (if (>= beg end) (error "Nothing to sort"))
8089 (setq stars (match-string 1)
8090 re (concat "^" (regexp-quote stars) " +")
8092 txt (buffer-substring beg end))
8094 (if (and (not (equal stars "*")) (string-match re2 txt))
8095 (error "Region to sort contains a level above the first entry"))
8097 (unless sorting-type
8098 (message
8099 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8101 A/N/T/S/D/C/P/O/F means reversed:"
8102 what)
8103 (setq sorting-type (read-char-exclusive))
8105 (and (= (downcase sorting-type) ?f)
8106 (setq getkey-func
8107 (org-icompleting-read "Sort using function: "
8108 obarray 'fboundp t nil nil))
8109 (setq getkey-func (intern getkey-func)))
8111 (and (= (downcase sorting-type) ?r)
8112 (setq property
8113 (org-icompleting-read "Property: "
8114 (mapcar 'list (org-buffer-property-keys t))
8115 nil t))))
8117 (message "Sorting entries...")
8119 (save-restriction
8120 (narrow-to-region start end)
8121 (let ((dcst (downcase sorting-type))
8122 (case-fold-search nil)
8123 (now (current-time)))
8124 (sort-subr
8125 (/= dcst sorting-type)
8126 ;; This function moves to the beginning character of the "record" to
8127 ;; be sorted.
8128 (lambda nil
8129 (if (re-search-forward re nil t)
8130 (goto-char (match-beginning 0))
8131 (goto-char (point-max))))
8132 ;; This function moves to the last character of the "record" being
8133 ;; sorted.
8134 (lambda nil
8135 (save-match-data
8136 (condition-case nil
8137 (outline-forward-same-level 1)
8138 (error
8139 (goto-char (point-max))))))
8140 ;; This function returns the value that gets sorted against.
8141 (lambda nil
8142 (cond
8143 ((= dcst ?n)
8144 (if (looking-at org-complex-heading-regexp)
8145 (string-to-number (match-string 4))
8146 nil))
8147 ((= dcst ?a)
8148 (if (looking-at org-complex-heading-regexp)
8149 (funcall case-func (match-string 4))
8150 nil))
8151 ((= dcst ?t)
8152 (let ((end (save-excursion (outline-next-heading) (point))))
8153 (if (or (re-search-forward org-ts-regexp end t)
8154 (re-search-forward org-ts-regexp-both end t))
8155 (org-time-string-to-seconds (match-string 0))
8156 (org-float-time now))))
8157 ((= dcst ?c)
8158 (let ((end (save-excursion (outline-next-heading) (point))))
8159 (if (re-search-forward
8161 end t)
8162 (org-time-string-to-seconds (match-string 0))
8163 (org-float-time now))))
8164 ((= dcst ?s)
8165 (let ((end (save-excursion (outline-next-heading) (point))))
8166 (if (re-search-forward org-scheduled-time-regexp end t)
8167 (org-time-string-to-seconds (match-string 1))
8168 (org-float-time now))))
8169 ((= dcst ?d)
8170 (let ((end (save-excursion (outline-next-heading) (point))))
8171 (if (re-search-forward org-deadline-time-regexp end t)
8172 (org-time-string-to-seconds (match-string 1))
8173 (org-float-time now))))
8174 ((= dcst ?p)
8175 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8176 (string-to-char (match-string 2))
8177 org-default-priority))
8178 ((= dcst ?r)
8179 (or (org-entry-get nil property) ""))
8180 ((= dcst ?o)
8181 (if (looking-at org-complex-heading-regexp)
8182 (- 9999 (length (member (match-string 2)
8183 org-todo-keywords-1)))))
8184 ((= dcst ?f)
8185 (if getkey-func
8186 (progn
8187 (setq tmp (funcall getkey-func))
8188 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8189 tmp)
8190 (error "Invalid key function `%s'" getkey-func)))
8191 (t (error "Invalid sorting type `%c'" sorting-type))))
8192 nil
8193 (cond
8194 ((= dcst ?a) 'string<)
8195 ((= dcst ?f) compare-func)
8196 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8197 (t nil)))))
8198 (run-hooks 'org-after-sorting-entries-or-items-hook)
8199 (message "Sorting entries...done")))
8201 (defun org-do-sort (table what &optional with-case sorting-type)
8202 "Sort TABLE of WHAT according to SORTING-TYPE.
8203 The user will be prompted for the SORTING-TYPE if the call to this
8204 function does not specify it. WHAT is only for the prompt, to indicate
8205 what is being sorted. The sorting key will be extracted from
8206 the car of the elements of the table.
8207 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8208 (unless sorting-type
8209 (message
8210 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8211 what)
8212 (setq sorting-type (read-char-exclusive)))
8213 (let ((dcst (downcase sorting-type))
8214 extractfun comparefun)
8215 ;; Define the appropriate functions
8216 (cond
8217 ((= dcst ?n)
8218 (setq extractfun 'string-to-number
8219 comparefun (if (= dcst sorting-type) '< '>)))
8220 ((= dcst ?a)
8221 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8222 (lambda(x) (downcase (org-sort-remove-invisible x))))
8223 comparefun (if (= dcst sorting-type)
8224 'string<
8225 (lambda (a b) (and (not (string< a b))
8226 (not (string= a b)))))))
8227 ((= dcst ?t)
8228 (setq extractfun
8229 (lambda (x)
8230 (if (or (string-match org-ts-regexp x)
8231 (string-match org-ts-regexp-both x))
8232 (org-float-time
8233 (org-time-string-to-time (match-string 0 x)))
8234 0))
8235 comparefun (if (= dcst sorting-type) '< '>)))
8236 (t (error "Invalid sorting type `%c'" sorting-type)))
8238 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8239 table)
8240 (lambda (a b) (funcall comparefun (car a) (car b))))))
8243 ;;; The orgstruct minor mode
8245 ;; Define a minor mode which can be used in other modes in order to
8246 ;; integrate the org-mode structure editing commands.
8248 ;; This is really a hack, because the org-mode structure commands use
8249 ;; keys which normally belong to the major mode. Here is how it
8250 ;; works: The minor mode defines all the keys necessary to operate the
8251 ;; structure commands, but wraps the commands into a function which
8252 ;; tests if the cursor is currently at a headline or a plain list
8253 ;; item. If that is the case, the structure command is used,
8254 ;; temporarily setting many Org-mode variables like regular
8255 ;; expressions for filling etc. However, when any of those keys is
8256 ;; used at a different location, function uses `key-binding' to look
8257 ;; up if the key has an associated command in another currently active
8258 ;; keymap (minor modes, major mode, global), and executes that
8259 ;; command. There might be problems if any of the keys is otherwise
8260 ;; used as a prefix key.
8262 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8263 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8264 ;; addresses this by checking explicitly for both bindings.
8266 (defvar orgstruct-mode-map (make-sparse-keymap)
8267 "Keymap for the minor `orgstruct-mode'.")
8269 (defvar org-local-vars nil
8270 "List of local variables, for use by `orgstruct-mode'.")
8272 ;;;###autoload
8273 (define-minor-mode orgstruct-mode
8274 "Toggle the minor mode `orgstruct-mode'.
8275 This mode is for using Org-mode structure commands in other
8276 modes. The following keys behave as if Org-mode were active, if
8277 the cursor is on a headline, or on a plain list item (both as
8278 defined by Org-mode).
8280 M-up Move entry/item up
8281 M-down Move entry/item down
8282 M-left Promote
8283 M-right Demote
8284 M-S-up Move entry/item up
8285 M-S-down Move entry/item down
8286 M-S-left Promote subtree
8287 M-S-right Demote subtree
8288 M-q Fill paragraph and items like in Org-mode
8289 C-c ^ Sort entries
8290 C-c - Cycle list bullet
8291 TAB Cycle item visibility
8292 M-RET Insert new heading/item
8293 S-M-RET Insert new TODO heading / Checkbox item
8294 C-c C-c Set tags / toggle checkbox"
8295 nil " OrgStruct" nil
8296 (org-load-modules-maybe)
8297 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8299 ;;;###autoload
8300 (defun turn-on-orgstruct ()
8301 "Unconditionally turn on `orgstruct-mode'."
8302 (orgstruct-mode 1))
8304 (defun orgstruct++-mode (&optional arg)
8305 "Toggle `orgstruct-mode', the enhanced version of it.
8306 In addition to setting orgstruct-mode, this also exports all indentation
8307 and autofilling variables from org-mode into the buffer. It will also
8308 recognize item context in multiline items.
8309 Note that turning off orgstruct-mode will *not* remove the
8310 indentation/paragraph settings. This can only be done by refreshing the
8312 (interactive "P")
8313 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8314 (if (< arg 1)
8315 (orgstruct-mode -1)
8316 (orgstruct-mode 1)
8317 (let (var val)
8318 (mapc
8319 (lambda (x)
8320 (when (string-match
8322 (symbol-name (car x)))
8323 (setq var (car x) val (nth 1 x))
8324 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8325 org-local-vars)
8326 (org-set-local 'orgstruct-is-++ t))))
8328 (defvar orgstruct-is-++ nil
8329 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8330 (make-variable-buffer-local 'orgstruct-is-++)
8332 ;;;###autoload
8333 (defun turn-on-orgstruct++ ()
8334 "Unconditionally turn on `orgstruct++-mode'."
8335 (orgstruct++-mode 1))
8337 (defun orgstruct-error ()
8338 "Error when there is no default binding for a structure key."
8339 (interactive)
8340 (error "This key has no function outside structure elements"))
8342 (defun orgstruct-setup ()
8343 "Setup orgstruct keymaps."
8344 (let ((nfunc 0)
8345 (bindings
8346 (list
8347 '([(meta up)] org-metaup)
8348 '([(meta down)] org-metadown)
8349 '([(meta left)] org-metaleft)
8350 '([(meta right)] org-metaright)
8351 '([(meta shift up)] org-shiftmetaup)
8352 '([(meta shift down)] org-shiftmetadown)
8353 '([(meta shift left)] org-shiftmetaleft)
8354 '([(meta shift right)] org-shiftmetaright)
8355 '([?\e (up)] org-metaup)
8356 '([?\e (down)] org-metadown)
8357 '([?\e (left)] org-metaleft)
8358 '([?\e (right)] org-metaright)
8359 '([?\e (shift up)] org-shiftmetaup)
8360 '([?\e (shift down)] org-shiftmetadown)
8361 '([?\e (shift left)] org-shiftmetaleft)
8362 '([?\e (shift right)] org-shiftmetaright)
8363 '([(shift up)] org-shiftup)
8364 '([(shift down)] org-shiftdown)
8365 '([(shift left)] org-shiftleft)
8366 '([(shift right)] org-shiftright)
8367 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8368 '("\M-q" fill-paragraph)
8369 '("\C-c^" org-sort)
8370 '("\C-c-" org-cycle-list-bullet)))
8371 elt key fun cmd)
8372 (while (setq elt (pop bindings))
8373 (setq nfunc (1+ nfunc))
8374 (setq key (org-key (car elt))
8375 fun (nth 1 elt)
8376 cmd (orgstruct-make-binding fun nfunc key))
8377 (org-defkey orgstruct-mode-map key cmd))
8379 ;; Special treatment needed for TAB and RET
8380 (org-defkey orgstruct-mode-map [(tab)]
8381 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8382 (org-defkey orgstruct-mode-map "\C-i"
8383 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8385 (org-defkey orgstruct-mode-map "\M-\C-m"
8386 (orgstruct-make-binding 'org-insert-heading 105
8387 "\M-\C-m" [(meta return)]))
8388 (org-defkey orgstruct-mode-map [(meta return)]
8389 (orgstruct-make-binding 'org-insert-heading 106
8390 [(meta return)] "\M-\C-m"))
8392 (org-defkey orgstruct-mode-map [(shift meta return)]
8393 (orgstruct-make-binding 'org-insert-todo-heading 107
8394 [(meta return)] "\M-\C-m"))
8396 (org-defkey orgstruct-mode-map "\e\C-m"
8397 (orgstruct-make-binding 'org-insert-heading 108
8398 "\e\C-m" [?\e (return)]))
8399 (org-defkey orgstruct-mode-map [?\e (return)]
8400 (orgstruct-make-binding 'org-insert-heading 109
8401 [?\e (return)] "\e\C-m"))
8402 (org-defkey orgstruct-mode-map [?\e (shift return)]
8403 (orgstruct-make-binding 'org-insert-todo-heading 110
8404 [?\e (return)] "\e\C-m"))
8406 (unless org-local-vars
8407 (setq org-local-vars (org-get-local-variables)))
8409 t))
8411 (defun orgstruct-make-binding (fun n &rest keys)
8412 "Create a function for binding in the structure minor mode.
8413 FUN is the command to call inside a table. N is used to create a unique
8414 command name. KEYS are keys that should be checked in for a command
8415 to execute outside of tables."
8416 (eval
8417 (list 'defun
8418 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8419 '(arg)
8421 "Outside of structure, run the binding of `"
8422 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8423 "'.")
8424 '(interactive "p")
8425 (list 'if
8426 `(org-context-p 'headline 'item
8427 (and orgstruct-is-++
8428 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8429 'item-body))
8430 (list 'org-run-like-in-org-mode (list 'quote fun))
8431 (list 'let '(orgstruct-mode)
8432 (list 'call-interactively
8433 (append '(or)
8434 (mapcar (lambda (k)
8435 (list 'key-binding k))
8436 keys)
8437 '('orgstruct-error))))))))
8439 (defun org-context-p (&rest contexts)
8440 "Check if local context is any of CONTEXTS.
8441 Possible values in the list of contexts are `table', `headline', and `item'."
8442 (let ((pos (point)))
8443 (goto-char (point-at-bol))
8444 (prog1 (or (and (memq 'table contexts)
8446 (and (memq 'headline contexts)
8447 (looking-at org-outline-regexp))
8448 (and (memq 'item contexts)
8450 (and (memq 'item-body contexts)
8451 (org-in-item-p)))
8452 (goto-char pos))))
8454 (defun org-get-local-variables ()
8455 "Return a list of all local variables in an org-mode buffer."
8456 (let (varlist)
8457 (with-current-buffer (get-buffer-create "*Org tmp*")
8458 (erase-buffer)
8459 (org-mode)
8460 (setq varlist (buffer-local-variables)))
8461 (kill-buffer "*Org tmp*")
8462 (delq nil
8463 (mapcar
8464 (lambda (x)
8465 (setq x
8466 (if (symbolp x)
8467 (list x)
8468 (list (car x) (list 'quote (cdr x)))))
8469 (if (string-match
8470 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8471 (symbol-name (car x)))
8472 x nil))
8473 varlist))))
8475 (defun org-clone-local-variables (from-buffer &optional regexp)
8476 "Clone local variables from FROM-BUFFER.
8477 Optional argument REGEXP selects variables to clone."
8478 (mapc
8479 (lambda (pair)
8480 (and (symbolp (car pair))
8481 (or (null regexp)
8482 (string-match regexp (symbol-name (car pair))))
8483 (set (make-local-variable (car pair))
8484 (cdr pair))))
8485 (buffer-local-variables from-buffer)))
8487 ;;;###autoload
8488 (defun org-run-like-in-org-mode (cmd)
8489 "Run a command, pretending that the current buffer is in Org-mode.
8490 This will temporarily bind local variables that are typically bound in
8491 Org-mode to the values they have in Org-mode, and then interactively
8492 call CMD."
8493 (org-load-modules-maybe)
8494 (unless org-local-vars
8495 (setq org-local-vars (org-get-local-variables)))
8496 (eval (list 'let org-local-vars
8497 (list 'call-interactively (list 'quote cmd)))))
8499 ;;;; Archiving
8501 (defun org-get-category (&optional pos force-refresh)
8502 "Get the category applying to position POS."
8503 (save-match-data
8504 (if force-refresh (org-refresh-category-properties))
8505 (let ((pos (or pos (point))))
8506 (or (get-text-property pos 'org-category)
8507 (progn (org-refresh-category-properties)
8508 (get-text-property pos 'org-category))))))
8510 (defun org-refresh-category-properties ()
8511 "Refresh category text properties in the buffer."
8512 (let ((def-cat (cond
8513 ((null org-category)
8514 (if buffer-file-name
8515 (file-name-sans-extension
8516 (file-name-nondirectory buffer-file-name))
8517 "???"))
8518 ((symbolp org-category) (symbol-name org-category))
8519 (t org-category)))
8520 beg end cat pos optionp)
8521 (org-unmodified
8522 (save-excursion
8523 (save-restriction
8524 (widen)
8525 (goto-char (point-min))
8526 (put-text-property (point) (point-max) 'org-category def-cat)
8527 (while (re-search-forward
8529 (setq pos (match-end 0)
8530 optionp (equal (char-after (match-beginning 0)) ?#)
8531 cat (org-trim (match-string 2)))
8532 (if optionp
8533 (setq beg (point-at-bol) end (point-max))
8534 (org-back-to-heading t)
8535 (setq beg (point) end (org-end-of-subtree t t)))
8536 (put-text-property beg end 'org-category cat)
8537 (put-text-property beg end 'org-category-position beg)
8538 (goto-char pos)))))))
8541 ;;;; Link Stuff
8543 ;;; Link abbreviations
8545 (defun org-link-expand-abbrev (link)
8546 "Apply replacements as defined in `org-link-abbrev-alist."
8548 (let* ((key (match-string 1 link))
8549 (as (or (assoc key org-link-abbrev-alist-local)
8550 (assoc key org-link-abbrev-alist)))
8551 (tag (and (match-end 2) (match-string 3 link)))
8552 rpl)
8553 (if (not as)
8554 link
8555 (setq rpl (cdr as))
8556 (cond
8557 ((symbolp rpl) (funcall rpl tag))
8558 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8559 ((string-match "%h" rpl)
8560 (replace-match (url-hexify-string (or tag "")) t t rpl))
8561 (t (concat rpl tag)))))
8562 link))
8564 ;;; Storing and inserting links
8566 (defvar org-insert-link-history nil
8567 "Minibuffer history for links inserted with `org-insert-link'.")
8569 (defvar org-stored-links nil
8570 "Contains the links stored with `org-store-link'.")
8572 (defvar org-store-link-plist nil
8573 "Plist with info about the most recently link created with `org-store-link'.")
8575 (defvar org-link-protocols nil
8576 "Link protocols added to Org-mode using `org-add-link-type'.")
8578 (defvar org-store-link-functions nil
8579 "List of functions that are called to create and store a link.
8580 Each function will be called in turn until one returns a non-nil
8581 value. Each function should check if it is responsible for creating
8582 this link (for example by looking at the major mode).
8583 If not, it must exit and return nil.
8584 If yes, it should return a non-nil value after a calling
8585 `org-store-link-props' with a list of properties and values.
8586 Special properties are:
8590 This is obligatory as well.
8591 :description Optional default description for the second pair
8592 of brackets in an Org-mode link. The user can still change
8593 this when inserting this link into an Org-mode buffer.
8595 In addition to these, any additional properties can be specified
8596 and then used in remember templates.")
8598 (defun org-add-link-type (type &optional follow export)
8599 "Add TYPE to the list of `org-link-types'.
8600 Re-compute all regular expressions depending on `org-link-types'
8602 FOLLOW and EXPORT are two functions.
8604 FOLLOW should take the link path as the single argument and do whatever
8605 is necessary to follow the link, for example find a file or display
8606 a mail message.
8608 EXPORT should format the link path for export to one of the export formats.
8609 It should be a function accepting three arguments:
8612 desc the description of the link, if any, or a description added by
8613 org-export-normalize-links if there is none
8614 format the export format, a symbol like `html' or `latex' or `ascii'..
8616 The function may use the FORMAT information to return different values
8617 depending on the format. The return value will be put literally into
8618 the exported file. If the return value is nil, this means Org should
8619 do what it normally does with links which do not have EXPORT defined.
8621 Org-mode has a built-in default for exporting links. If you are happy with
8622 this default, there is no need to define an export function for the link
8623 type. For a simple example of an export function, see `org-bbdb.el'."
8624 (add-to-list 'org-link-types type t)
8625 (org-make-link-regexps)
8626 (if (assoc type org-link-protocols)
8627 (setcdr (assoc type org-link-protocols) (list follow export))
8628 (push (list type follow export) org-link-protocols)))
8630 (defvar org-agenda-buffer-name)
8632 ;;;###autoload
8633 (defun org-store-link (arg)
8635 This link is added to `org-stored-links' and can later be inserted
8638 For some link types, a prefix arg is interpreted:
8639 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8640 For file links, arg negates `org-context-in-file-links'."
8641 (interactive "P")
8642 (org-load-modules-maybe)
8643 (setq org-store-link-plist nil) ; reset
8644 (org-with-limited-levels
8645 (let (link cpltxt desc description search txt custom-id agenda-link)
8646 (cond
8648 ((run-hook-with-args-until-success 'org-store-link-functions)
8649 (setq link (plist-get org-store-link-plist :link)
8650 desc (or (plist-get org-store-link-plist :description) link)))
8652 ((org-src-edit-buffer-p)
8653 (let (label gc)
8654 (while (or (not label)
8655 (save-excursion
8656 (save-restriction
8657 (widen)
8658 (goto-char (point-min))
8659 (re-search-forward
8660 (regexp-quote (format org-coderef-label-format label))
8661 nil t))))
8662 (when label (message "Label exists already") (sit-for 2))
8663 (setq label (read-string "Code line label: " label)))
8664 (end-of-line 1)
8665 (setq link (format org-coderef-label-format label))
8666 (setq gc (- 79 (length link)))
8667 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8668 (insert link)
8669 (setq link (concat "(" label ")") desc nil)))
8671 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8672 ;; We are in the agenda, link to referenced location
8673 (let ((m (or (get-text-property (point) 'org-hd-marker)
8674 (get-text-property (point) 'org-marker))))
8675 (when m
8676 (org-with-point-at m
8677 (setq agenda-link
8678 (if (org-called-interactively-p 'any)
8679 (call-interactively 'org-store-link)
8680 (org-store-link nil)))))))
8682 ((eq major-mode 'calendar-mode)
8683 (let ((cd (calendar-cursor-to-date)))
8684 (setq link
8685 (format-time-string
8686 (car org-time-stamp-formats)
8687 (apply 'encode-time
8688 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8689 nil nil nil))))
8690 (org-store-link-props :type "calendar" :date cd)))
8692 ((eq major-mode 'w3-mode)
8693 (setq cpltxt (if (and (buffer-name)
8694 (not (string-match "Untitled" (buffer-name))))
8695 (buffer-name)
8696 (url-view-url t))
8697 link (org-make-link (url-view-url t)))
8698 (org-store-link-props :type "w3" :url (url-view-url t)))
8700 ((eq major-mode 'w3m-mode)
8701 (setq cpltxt (or w3m-current-title w3m-current-url)
8702 link (org-make-link w3m-current-url))
8703 (org-store-link-props :type "w3m" :url (url-view-url t)))
8705 ((setq search (run-hook-with-args-until-success
8706 'org-create-file-search-functions))
8707 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8708 "::" search))
8709 (setq cpltxt (or description link)))
8711 ((eq major-mode 'image-mode)
8712 (setq cpltxt (concat "file:"
8713 (abbreviate-file-name buffer-file-name))
8714 link (org-make-link cpltxt))
8715 (org-store-link-props :type "image" :file buffer-file-name))
8717 ((eq major-mode 'dired-mode)
8718 ;; link to the file in the current line
8719 (let ((file (dired-get-filename nil t)))
8720 (setq file (if file
8721 (abbreviate-file-name
8722 (expand-file-name (dired-get-filename nil t)))
8723 ;; otherwise, no file so use current directory.
8724 default-directory))
8725 (setq cpltxt (concat "file:" file)
8726 link (org-make-link cpltxt))))
8728 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8729 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8730 (cond
8732 (setq cpltxt
8733 (concat "file:"
8734 (abbreviate-file-name
8735 (buffer-file-name (buffer-base-buffer)))
8736 "::" (match-string 1))
8737 link (org-make-link cpltxt)))
8738 ((and (featurep 'org-id)
8739 (or (eq org-link-to-org-use-id t)
8740 (and (eq org-link-to-org-use-id 'create-if-interactive)
8741 (org-called-interactively-p 'any))
8742 (and (eq org-link-to-org-use-id
8743 'create-if-interactive-and-no-custom-id)
8744 (org-called-interactively-p 'any)
8745 (not custom-id))
8746 (and org-link-to-org-use-id
8747 (org-entry-get nil "ID"))))
8748 ;; We can make a link using the ID.
8749 (setq link (condition-case nil
8750 (prog1 (org-id-store-link)
8751 (setq desc (plist-get org-store-link-plist
8752 :description)))
8753 (error
8754 ;; probably before first headline, link to file only
8755 (concat "file:"
8756 (abbreviate-file-name
8757 (buffer-file-name (buffer-base-buffer))))))))
8758 (t
8759 ;; Just link to current headline
8760 (setq cpltxt (concat "file:"
8761 (abbreviate-file-name
8762 (buffer-file-name (buffer-base-buffer)))))
8763 ;; Add a context search string
8764 (when (org-xor org-context-in-file-links arg)
8765 (setq txt (cond
8766 ((org-at-heading-p) nil)
8767 ((org-region-active-p)
8768 (buffer-substring (region-beginning) (region-end)))
8769 (t nil)))
8771 (setq cpltxt
8772 (concat cpltxt "::"
8773 (condition-case nil
8774 (org-make-org-heading-search-string txt)
8775 (error "")))
8776 desc (or (nth 4 (ignore-errors
8777 (org-heading-components))) "NONE"))))
8779 (setq cpltxt (substring cpltxt 0 -2)))
8780 (setq link (org-make-link cpltxt)))))
8782 ((buffer-file-name (buffer-base-buffer))
8783 ;; Just link to this file here.
8784 (setq cpltxt (concat "file:"
8785 (abbreviate-file-name
8786 (buffer-file-name (buffer-base-buffer)))))
8787 ;; Add a context string
8788 (when (org-xor org-context-in-file-links arg)
8789 (setq txt (if (org-region-active-p)
8790 (buffer-substring (region-beginning) (region-end))
8791 (buffer-substring (point-at-bol) (point-at-eol))))
8792 ;; Only use search option if there is some text.
8794 (setq cpltxt
8795 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8796 desc "NONE")))
8797 (setq link (org-make-link cpltxt)))
8799 ((org-called-interactively-p 'interactive)
8800 (error "Cannot link to a buffer which is not visiting a file"))
8802 (t (setq link nil)))
8804 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8805 (setq link (or link cpltxt)
8806 desc (or desc cpltxt))
8807 (if (equal desc "NONE") (setq desc nil))
8809 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8810 (progn
8811 (setq org-stored-links
8812 (cons (list link desc) org-stored-links))
8813 (message "Stored: %s" (or desc link))
8814 (when custom-id
8815 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8816 "::#" custom-id))
8817 (setq org-stored-links
8818 (cons (list link desc) org-stored-links))))
8819 (or agenda-link (and link (org-make-link-string link desc)))))))
8821 (defun org-store-link-props (&rest plist)
8822 "Store link properties, extract names and addresses."
8823 (let (x adr)
8824 (when (setq x (plist-get plist :from))
8825 (setq adr (mail-extract-address-components x))
8826 (setq plist (plist-put plist :fromname (car adr)))
8827 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8828 (when (setq x (plist-get plist :to))
8829 (setq adr (mail-extract-address-components x))
8830 (setq plist (plist-put plist :toname (car adr)))
8831 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8832 (let ((from (plist-get plist :from))
8833 (to (plist-get plist :to)))
8834 (when (and from to org-from-is-user-regexp)
8835 (setq plist
8836 (plist-put plist :fromto
8837 (if (string-match org-from-is-user-regexp from)
8838 (concat "to %t")
8839 (concat "from %f"))))))
8840 (setq org-store-link-plist plist))
8842 (defun org-add-link-props (&rest plist)
8843 "Add these properties to the link property list."
8844 (let (key value)
8845 (while plist
8846 (setq key (pop plist) value (pop plist))
8847 (setq org-store-link-plist
8848 (plist-put org-store-link-plist key value)))))
8850 (defun org-email-link-description (&optional fmt)
8851 "Return the description part of an email link.
8852 This takes information from `org-store-link-plist' and formats it
8853 according to FMT (default from `org-email-link-description-format')."
8854 (setq fmt (or fmt org-email-link-description-format))
8855 (let* ((p org-store-link-plist)
8856 (to (plist-get p :toaddress))
8857 (from (plist-get p :fromaddress))
8858 (table
8859 (list
8860 (cons "%c" (plist-get p :fromto))
8861 (cons "%F" (plist-get p :from))
8862 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8863 (cons "%T" (plist-get p :to))
8864 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8865 (cons "%s" (plist-get p :subject))
8866 (cons "%d" (plist-get p :date))
8867 (cons "%m" (plist-get p :message-id)))))
8868 (when (string-match "%c" fmt)
8869 ;; Check if the user wrote this message
8870 (if (and org-from-is-user-regexp from to
8871 (save-match-data (string-match org-from-is-user-regexp from)))
8872 (setq fmt (replace-match "to %t" t t fmt))
8873 (setq fmt (replace-match "from %f" t t fmt))))
8874 (org-replace-escapes fmt table)))
8876 (defun org-make-org-heading-search-string (&optional string heading)
8877 "Make search string for STRING or current headline."
8878 (interactive)
8879 (let ((s (or string (org-get-heading)))
8880 (lines org-context-in-file-links))
8881 (unless (and string (not heading))
8882 ;; We are using a headline, clean up garbage in there.
8883 (if (string-match org-todo-regexp s)
8884 (setq s (replace-match "" t t s)))
8886 (setq s (replace-match "" t t s)))
8887 (setq s (org-trim s))
8890 (setq s (replace-match "" t t s)))
8891 (while (string-match org-ts-regexp s)
8892 (setq s (replace-match "" t t s))))
8893 (or string (setq s (concat "*" s))) ; Add * for headlines
8894 (when (and string (integerp lines) (> lines 0))
8896 (when (< lines (length slines))
8897 (setq s (mapconcat
8898 'identity
8899 (reverse (nthcdr (- (length slines) lines)
8903 (defun org-make-link (&rest strings)
8904 "Concatenate STRINGS."
8905 (apply 'concat strings))
8907 (defun org-make-link-string (link &optional description)
8908 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8910 (error "Empty link"))
8911 (when (and description
8912 (stringp description)
8914 (setq description nil))
8915 (when (stringp description)
8916 ;; Remove brackets from the description, they are fatal.
8918 (setq description (replace-match "{" t t description)))
8920 (setq description (replace-match "}" t t description))))
8921 (when (equal link description)
8922 ;; No description needed, it is identical
8923 (setq description nil))
8924 (when (and (not description)
8925 (not (string-match (org-image-file-name-regexp) link))
8926 (not (equal link (org-link-escape link))))
8927 (setq description (org-extract-attributes link)))
8928 (setq link
8929 (cond ((string-match (org-image-file-name-regexp) link) link)
8930 ((string-match org-link-types-re link)
8931 (concat (match-string 1 link)
8932 (org-link-escape (substring link (match-end 1)))))
8933 (t (org-link-escape link))))
8934 (concat "[[" link "]"
8935 (if description (concat "[" description "]") "")
8936 "]"))
8938 (defconst org-link-escape-chars
8939 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8940 "List of characters that should be escaped in link.
8941 This is the list that is used for internal purposes.")
8943 (defvar org-url-encoding-use-url-hexify nil)
8945 (defconst org-link-escape-chars-browser
8946 '(?\ )
8947 "List of escapes for characters that are problematic in links.
8948 This is the list that is used before handing over to the browser.")
8950 (defun org-link-escape (text &optional table merge)
8951 "Return percent escaped representation of TEXT.
8952 TEXT is a string with the text to escape.
8953 Optional argument TABLE is a list with characters that should be
8954 escaped. When nil, `org-link-escape-chars' is used.
8955 If optional argument MERGE is set, merge TABLE into
8956 `org-link-escape-chars'."
8957 (if (and org-url-encoding-use-url-hexify (not table))
8958 (url-hexify-string text)
8959 (cond
8960 ((and table merge)
8961 (mapc (lambda (defchr)
8962 (unless (member defchr table)
8963 (setq table (cons defchr table)))) org-link-escape-chars))
8964 ((null table)
8965 (setq table org-link-escape-chars)))
8966 (mapconcat
8967 (lambda (char)
8968 (if (or (member char table)
8969 (< char 32) (= char 37) (> char 126))
8970 (mapconcat (lambda (sequence-element)
8971 (format "%%%.2X" sequence-element))
8972 (or (encode-coding-char char 'utf-8)
8973 (error "Unable to percent escape character: %s"
8974 (char-to-string char))) "")
8975 (char-to-string char))) text "")))
8977 (defun org-link-unescape (str)
8978 "Unhex hexified Unicode strings as returned from the JavaScript function
8979 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8980 (unless (and (null str) (string= "" str))
8981 (let ((pos 0) (case-fold-search t) unhexed)
8983 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8984 (setq str (replace-match unhexed t t str))
8985 (setq pos (+ pos (length unhexed))))))
8986 str)
8988 (defun org-link-unescape-compound (hex)
8989 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8990 Note: this function also decodes single byte encodings like
8992 (save-match-data
8993 (let* ((bytes (cdr (split-string hex "%")))
8994 (ret "")
8995 (eat 0)
8996 (sum 0))
8997 (while bytes
8998 (let* ((val (string-to-number (pop bytes) 16))
8999 (shift-xor
9000 (if (= 0 eat)
9001 (cond
9002 ((>= val 252) (cons 6 252))
9003 ((>= val 248) (cons 5 248))
9004 ((>= val 240) (cons 4 240))
9005 ((>= val 224) (cons 3 224))
9006 ((>= val 192) (cons 2 192))
9007 (t (cons 0 0)))
9008 (cons 6 128))))
9009 (if (>= val 192) (setq eat (car shift-xor)))
9010 (setq val (logxor val (cdr shift-xor)))
9011 (setq sum (+ (lsh sum (car shift-xor)) val))
9012 (if (> eat 0) (setq eat (- eat 1)))
9013 (cond
9014 ((= 0 eat) ;multi byte
9015 (setq ret (concat ret (org-char-to-string sum)))
9016 (setq sum 0))
9017 ((not bytes) ; single byte(s)
9018 (setq ret (org-link-unescape-single-byte-sequence hex))))
9019 )) ;; end (while bytes
9020 ret )))
9022 (defun org-link-unescape-single-byte-sequence (hex)
9023 "Unhexify hex-encoded single byte character sequences."
9024 (mapconcat (lambda (byte)
9025 (char-to-string (string-to-number byte 16)))
9026 (cdr (split-string hex "%")) ""))
9028 (defun org-xor (a b)
9029 "Exclusive or."
9030 (if a (not b) b))
9032 (defun org-fixup-message-id-for-http (s)
9033 "Replace special characters in a message id, so it can be used in an http query."
9034 (when (string-match "%" s)
9035 (setq s (mapconcat (lambda (c)
9036 (if (eq c ?%)
9037 "%25"
9038 (char-to-string c)))
9039 s "")))
9040 (while (string-match "<" s)
9041 (setq s (replace-match "%3C" t t s)))
9042 (while (string-match ">" s)
9043 (setq s (replace-match "%3E" t t s)))
9044 (while (string-match "@" s)
9045 (setq s (replace-match "%40" t t s)))
9046 s)
9048 ;;;###autoload
9049 (defun org-insert-link-global ()
9050 "Insert a link like Org-mode does.
9051 This command can be called in any mode to insert a link in Org-mode syntax."
9052 (interactive)
9053 (org-load-modules-maybe)
9054 (org-run-like-in-org-mode 'org-insert-link))
9056 (defun org-insert-link (&optional complete-file link-location default-description)
9057 "Insert a link. At the prompt, enter the link.
9059 Completion can be used to insert any of the link protocol prefixes like
9060 http or ftp in use.
9062 The history can be used to select a link previously stored with
9063 `org-store-link'. When the empty string is entered (i.e. if you just
9064 press RET at the prompt), the link defaults to the most recently
9065 stored link. As SPC triggers completion in the minibuffer, you need to
9066 use M-SPC or C-q SPC to force the insertion of a space character.
9068 You will also be prompted for a description, and if one is given, it will
9069 be displayed in the buffer instead of the link.
9071 If there is already a link at point, this command will allow you to edit link
9072 and description parts.
9075 be selected using completion. The path to the file will be relative to the
9076 current directory if the file is in the current directory or a subdirectory.
9077 Otherwise, the link will be the absolute path as completed in the minibuffer
9078 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9079 option `org-link-file-path-type'.
9082 the current directory or below.
9085 `org-keep-stored-link-after-insertion'.
9087 If `org-make-link-description-function' is non-nil, this function will be
9088 called with the link target, and the result will be the default
9089 link description.
9091 If the LINK-LOCATION parameter is non-nil, this value will be
9092 used as the link location instead of reading one interactively.
9094 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9095 be used as the default description."
9096 (interactive "P")
9097 (let* ((wcf (current-window-configuration))
9098 (region (if (org-region-active-p)
9099 (buffer-substring (region-beginning) (region-end))))
9100 (remove (and region (list (region-beginning) (region-end))))
9101 (desc region)
9102 tmphist ; byte-compile incorrectly complains about this
9103 (link link-location)
9104 entry file all-prefixes)
9105 (cond
9106 (link-location) ; specified by arg, just use it.
9107 ((org-in-regexp org-bracket-link-regexp 1)
9108 ;; We do have a link at point, and we are going to edit it.
9109 (setq remove (list (match-beginning 0) (match-end 0)))
9110 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9111 (setq link (read-string "Link: "
9112 (org-link-unescape
9113 (org-match-string-no-properties 1)))))
9114 ((or (org-in-regexp org-angle-link-re)
9115 (org-in-regexp org-plain-link-re))
9116 ;; Convert to bracket link
9117 (setq remove (list (match-beginning 0) (match-end 0))
9118 link (read-string "Link: "
9119 (org-remove-angle-brackets (match-string 0)))))
9120 ((member complete-file '((4) (16)))
9121 ;; Completing read for file names.
9122 (setq link (org-file-complete-link complete-file)))
9123 (t
9124 ;; Read link, with completion for stored links.
9125 (with-output-to-temp-buffer "*Org Links*"
9126 (princ "Insert a link.
9128 (when org-stored-links
9130 (princ (mapconcat
9131 (lambda (x)
9132 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9134 (let ((cw (selected-window)))
9135 (select-window (get-buffer-window "*Org Links*" 'visible))
9136 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9137 (unless (pos-visible-in-window-p (point-max))
9138 (org-fit-window-to-buffer))
9139 (and (window-live-p cw) (select-window cw)))
9140 ;; Fake a link history, containing the stored links.
9141 (setq tmphist (append (mapcar 'car org-stored-links)
9142 org-insert-link-history))
9143 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9144 (mapcar 'car org-link-abbrev-alist)
9145 org-link-types))
9146 (unwind-protect
9147 (progn
9148 (setq link
9149 (let ((org-completion-use-ido nil)
9150 (org-completion-use-iswitchb nil))
9151 (org-completing-read
9152 "Link: "
9153 (append
9154 (mapcar (lambda (x) (list (concat x ":")))
9155 all-prefixes)
9156 (mapcar 'car org-stored-links))
9157 nil nil nil
9158 'tmphist
9159 (car (car org-stored-links)))))
9161 (error "No link selected"))
9162 (if (or (member link all-prefixes)
9163 (and (equal ":" (substring link -1))
9164 (member (substring link 0 -1) all-prefixes)
9165 (setq link (substring link 0 -1))))
9166 (setq link (org-link-try-special-completion link))))
9167 (set-window-configuration wcf)
9168 (kill-buffer "*Org Links*"))
9169 (setq entry (assoc link org-stored-links))
9170 (or entry (push link org-insert-link-history))
9171 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9172 (not org-keep-stored-link-after-insertion))
9173 (setq org-stored-links (delq (assoc link org-stored-links)
9174 org-stored-links)))
9175 (setq desc (or desc (nth 1 entry)))))
9177 (if (string-match org-plain-link-re link)
9178 ;; URL-like link, normalize the use of angular brackets.
9179 (setq link (org-make-link (org-remove-angle-brackets link))))
9181 ;; Check if we are linking to the current file with a search option
9182 ;; If yes, simplify the link by using only the search option.
9183 (when (and buffer-file-name
9185 (let* ((path (match-string 1 link))
9186 (case-fold-search nil)
9187 (search (match-string 2 link)))
9188 (save-match-data
9189 (if (equal (file-truename buffer-file-name) (file-truename path))
9190 ;; We are linking to this same file, with a search option
9191 (setq link search)))))
9193 ;; Check if we can/should use a relative path. If yes, simplify the link
9195 (let* ((type (match-string 1 link))
9196 (path (match-string 2 link))
9197 (origpath path)
9198 (case-fold-search nil))
9199 (cond
9200 ((or (eq org-link-file-path-type 'absolute)
9201 (equal complete-file '(16)))
9202 (setq path (abbreviate-file-name (expand-file-name path))))
9203 ((eq org-link-file-path-type 'noabbrev)
9204 (setq path (expand-file-name path)))
9205 ((eq org-link-file-path-type 'relative)
9206 (setq path (file-relative-name path)))
9207 (t
9208 (save-match-data
9209 (if (string-match (concat "^" (regexp-quote
9210 (expand-file-name
9211 (file-name-as-directory
9212 default-directory))))
9213 (expand-file-name path))
9214 ;; We are linking a file with relative path name.
9215 (setq path (substring (expand-file-name path)
9216 (match-end 0)))
9217 (setq path (abbreviate-file-name (expand-file-name path)))))))
9218 (setq link (concat type path))
9219 (if (equal desc origpath)
9220 (setq desc path))))
9222 (if org-make-link-description-function
9223 (setq desc (funcall org-make-link-description-function link desc))
9224 (if default-description (setq desc default-description)))
9226 (setq desc (read-string "Description: " desc))
9228 (if remove (apply 'delete-region remove))
9229 (insert (org-make-link-string link desc))))
9231 (defun org-link-try-special-completion (type)
9232 "If there is completion support for link type TYPE, offer it."
9233 (let ((fun (intern (concat "org-" type "-complete-link"))))
9234 (if (functionp fun)
9235 (funcall fun)
9236 (read-string "Link (no completion support): " (concat type ":")))))
9238 (defun org-file-complete-link (&optional arg)
9239 "Create a file link using completion."
9240 (let (file link)
9241 (setq file (read-file-name "File: "))
9242 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9243 (pwd1 (file-name-as-directory (abbreviate-file-name
9244 (expand-file-name ".")))))
9245 (cond
9246 ((equal arg '(16))
9247 (setq link (org-make-link
9248 "file:"
9249 (abbreviate-file-name (expand-file-name file)))))
9251 (setq link (org-make-link "file:" (match-string 1 file))))
9253 (expand-file-name file))
9254 (setq link (org-make-link
9255 "file:" (match-string 1 (expand-file-name file)))))
9256 (t (setq link (org-make-link "file:" file)))))
9257 link))
9259 (defun org-completing-read (&rest args)
9260 "Completing-read with SPACE being a normal character."
9261 (let ((enable-recursive-minibuffers t)
9262 (minibuffer-local-completion-map
9263 (copy-keymap minibuffer-local-completion-map)))
9264 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9265 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9266 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9267 (apply 'org-icompleting-read args)))
9269 (defun org-completing-read-no-i (&rest args)
9270 (let (org-completion-use-ido org-completion-use-iswitchb)
9271 (apply 'org-completing-read args)))
9273 (defun org-iswitchb-completing-read (prompt choices &rest args)
9274 "Use iswitch as a completing-read replacement to choose from choices.
9275 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9276 from."
9277 (let* ((iswitchb-use-virtual-buffers nil)
9278 (iswitchb-make-buflist-hook
9279 (lambda ()
9280 (setq iswitchb-temp-buflist choices))))
9281 (iswitchb-read-buffer prompt)))
9283 (defun org-icompleting-read (&rest args)
9284 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9285 (org-without-partial-completion
9286 (if (and org-completion-use-ido
9287 (fboundp 'ido-completing-read)
9288 (boundp 'ido-mode) ido-mode
9289 (listp (second args)))
9290 (let ((ido-enter-matching-directory nil))
9291 (apply 'ido-completing-read (concat (car args))
9292 (if (consp (car (nth 1 args)))
9293 (mapcar 'car (nth 1 args))
9294 (nth 1 args))
9295 (cddr args)))
9296 (if (and org-completion-use-iswitchb
9297 (boundp 'iswitchb-mode) iswitchb-mode
9298 (listp (second args)))
9299 (apply 'org-iswitchb-completing-read (concat (car args))
9300 (if (consp (car (nth 1 args)))
9301 (mapcar 'car (nth 1 args))
9302 (nth 1 args))
9303 (cddr args))
9304 (apply 'completing-read args)))))
9306 (defun org-extract-attributes (s)
9307 "Extract the attributes cookie from a string and set as text property."
9308 (let (a attr (start 0) key value)
9309 (save-match-data
9311 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9313 (setq key (match-string 1 a) value (match-string 2 a)
9314 start (match-end 0)
9315 attr (plist-put attr (intern key) value))))
9316 (org-add-props s nil 'org-attr attr))
9317 s))
9319 (defun org-extract-attributes-from-string (tag)
9320 (let (key value attr)
9322 (setq key (match-string 1 tag) value (match-string 2 tag)
9323 tag (replace-match "" t t tag)
9324 attr (plist-put attr (intern key) value)))
9325 (cons tag attr)))
9327 (defun org-attributes-to-string (plist)
9328 "Format a property list into an HTML attribute list."
9329 (let ((s "") key value)
9330 (while plist
9331 (setq key (pop plist) value (pop plist))
9332 (and value
9334 s))
9336 ;;; Opening/following a link
9338 (defvar org-link-search-failed nil)
9340 (defvar org-open-link-functions nil
9341 "Hook for functions finding a plain text link.
9342 These functions must take a single argument, the link content.
9343 They will be called for links that look like [[link text][description]]
9347 These functions will be called *before* Org attempts to resolve the
9348 link by doing text searches in the current buffer - so if you want a
9350 handle this as a special case.
9352 When the function does handle the link, it must return a non-nil value.
9353 If it decides that it is not responsible for this link, it must return
9354 nil to indicate that that Org-mode can continue with other options
9355 like exact and fuzzy text search.")
9357 (defun org-next-link ()
9358 "Move forward to the next link.
9359 If the link is in hidden text, expose it."
9360 (interactive)
9361 (when (and org-link-search-failed (eq this-command last-command))
9362 (goto-char (point-min))
9363 (message "Link search wrapped back to beginning of buffer"))
9364 (setq org-link-search-failed nil)
9365 (let* ((pos (point))
9366 (ct (org-context))
9367 (a (assoc :link ct)))
9368 (if a (goto-char (nth 2 a)))
9369 (if (re-search-forward org-any-link-re nil t)
9370 (progn
9371 (goto-char (match-beginning 0))
9372 (if (outline-invisible-p) (org-show-context)))
9373 (goto-char pos)
9374 (setq org-link-search-failed t)
9375 (error "No further link found"))))
9377 (defun org-previous-link ()
9378 "Move backward to the previous link.
9379 If the link is in hidden text, expose it."
9380 (interactive)
9381 (when (and org-link-search-failed (eq this-command last-command))
9382 (goto-char (point-max))
9383 (message "Link search wrapped back to end of buffer"))
9384 (setq org-link-search-failed nil)
9385 (let* ((pos (point))
9386 (ct (org-context))
9387 (a (assoc :link ct)))
9388 (if a (goto-char (nth 1 a)))
9389 (if (re-search-backward org-any-link-re nil t)
9390 (progn
9391 (goto-char (match-beginning 0))
9392 (if (outline-invisible-p) (org-show-context)))
9393 (goto-char pos)
9394 (setq org-link-search-failed t)
9395 (error "No further link found"))))
9397 (defun org-translate-link (s)
9398 "Translate a link string if a translation function has been defined."
9399 (if (and org-link-translation-function
9400 (fboundp org-link-translation-function)
9402 (progn
9403 (setq s (funcall org-link-translation-function
9404 (match-string 1) (match-string 2)))
9405 (concat (car s) ":" (cdr s)))
9406 s))
9408 (defun org-translate-link-from-planner (type path)
9409 "Translate a link from Emacs Planner syntax so that Org can follow it.
9410 This is still an experimental function, your mileage may vary."
9411 (cond
9412 ((member type '("http" "https" "news" "ftp"))
9413 ;; standard Internet links are the same.
9414 nil)
9415 ((and (equal type "irc") (string-match "^//" path))
9416 ;; Planner has two / at the beginning of an irc link, we have 1.
9417 ;; We should have zero, actually....
9418 (setq path (substring path 1)))
9419 ((and (equal type "lisp") (string-match "^/" path))
9420 ;; Planner has a slash, we do not.
9421 (setq type "elisp" path (substring path 1)))
9423 ;; A typical message link. Planner has the id after the final slash,
9424 ;; we separate it with a hash mark
9425 (setq path (concat (match-string 1 path) "#"
9426 (org-remove-angle-brackets (match-string 2 path)))))
9427 )
9428 (cons type path))
9430 (defun org-find-file-at-mouse (ev)
9431 "Open file link or URL at mouse."
9432 (interactive "e")
9433 (mouse-set-point ev)
9434 (org-open-at-point 'in-emacs))
9436 (defun org-open-at-mouse (ev)
9437 "Open file link or URL at mouse.
9438 See the docstring of `org-open-file' for details."
9439 (interactive "e")
9440 (mouse-set-point ev)
9441 (if (eq major-mode 'org-agenda-mode)
9442 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9443 (org-open-at-point))
9445 (defvar org-window-config-before-follow-link nil
9446 "The window configuration before following a link.
9447 This is saved in case the need arises to restore it.")
9449 (defvar org-open-link-marker (make-marker)
9450 "Marker pointing to the location where `org-open-at-point; was called.")
9452 ;;;###autoload
9453 (defun org-open-at-point-global ()
9454 "Follow a link like Org-mode does.
9455 This command can be called in any mode to follow a link that has
9456 Org-mode syntax."
9457 (interactive)
9458 (org-run-like-in-org-mode 'org-open-at-point))
9460 ;;;###autoload
9461 (defun org-open-link-from-string (s &optional arg reference-buffer)
9462 "Open a link in the string S, as if it was in Org-mode."
9464 (let ((reference-buffer (or reference-buffer (current-buffer))))
9465 (with-temp-buffer
9466 (let ((org-inhibit-startup (not reference-buffer)))
9467 (org-mode)
9468 (insert s)
9469 (goto-char (point-min))
9470 (when reference-buffer
9471 (setq org-link-abbrev-alist-local
9472 (with-current-buffer reference-buffer
9473 org-link-abbrev-alist-local)))
9474 (org-open-at-point arg reference-buffer)))))
9476 (defvar org-open-at-point-functions nil
9477 "Hook that is run when following a link at point.
9479 Functions in this hook must return t if they identify and follow
9480 a link at point. If they don't find anything interesting at point,
9481 they must return nil.")
9483 (defun org-open-at-point (&optional arg reference-buffer)
9484 "Open link at or after point.
9485 If there is no link at point, this function will search forward up to
9486 the end of the current line.
9487 Normally, files will be opened by an appropriate application. If the
9488 optional prefix argument ARG is non-nil, Emacs will visit the file.
9489 With a double prefix argument, try to open outside of Emacs, in the
9490 application the system uses for this file type."
9491 (interactive "P")
9492 ;; if in a code block, then open the block's results
9493 (unless (call-interactively #'org-babel-open-src-block-result)
9494 (org-load-modules-maybe)
9495 (move-marker org-open-link-marker (point))
9496 (setq org-window-config-before-follow-link (current-window-configuration))
9497 (org-remove-occur-highlights nil nil t)
9498 (cond
9499 ((and (org-at-heading-p)
9500 (not (org-in-regexp
9505 (not (get-text-property (point) 'org-linked-text)))
9506 (or (org-offer-links-in-entry arg)
9507 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9508 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9509 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9510 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9511 (not (org-in-regexp org-bracket-link-regexp)))
9512 (org-footnote-action))
9513 (t
9514 (let (type path link line search (pos (point)))
9515 (catch 'match
9516 (save-excursion
9518 (when (org-in-regexp org-bracket-link-regexp 1)
9519 (setq link (org-extract-attributes
9520 (org-link-unescape (org-match-string-no-properties 1))))
9522 (setq link (replace-match " " t t link)))
9523 (setq link (org-link-expand-abbrev link))
9524 (cond
9525 ((or (file-name-absolute-p link)
9527 (setq type "file" path link))
9528 ((string-match org-link-re-with-space3 link)
9529 (setq type (match-string 1 link) path (match-string 2 link)))
9530 (t (setq type "thisfile" path link)))
9531 (throw 'match t)))
9533 (when (get-text-property (point) 'org-linked-text)
9534 (setq type "thisfile"
9535 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9536 (1+ (point)) (point))
9537 path (buffer-substring
9538 (or (previous-single-property-change pos 'org-linked-text)
9539 (point-min))
9540 (or (next-single-property-change pos 'org-linked-text)
9541 (point-max))))
9542 (throw 'match t))
9544 (save-excursion
9545 (when (or (org-in-regexp org-angle-link-re)
9546 (org-in-regexp org-plain-link-re))
9547 (setq type (match-string 1)
9548 path (org-link-unescape (match-string 2)))
9549 (throw 'match t)))
9550 (save-excursion
9552 (setq type "tags"
9553 path (match-string 1))
9554 (while (string-match ":" path)
9555 (setq path (replace-match "+" t t path)))
9556 (throw 'match t)))
9558 (setq type "tree-match"
9559 path (match-string 1))
9560 (throw 'match t)))
9561 (unless path
9562 (error "No link found"))
9564 ;; switch back to reference buffer
9565 ;; needed when if called in a temporary buffer through
9566 ;; org-open-link-from-string
9567 (with-current-buffer (or reference-buffer (current-buffer))
9569 ;; Remove any trailing spaces in path
9571 (setq path (replace-match "" t t path)))
9572 (if (and org-link-translation-function
9573 (fboundp org-link-translation-function))
9574 ;; Check if we need to translate the link
9575 (let ((tmp (funcall org-link-translation-function type path)))
9576 (setq type (car tmp) path (cdr tmp))))
9578 (cond
9580 ((assoc type org-link-protocols)
9581 (funcall (nth 1 (assoc type org-link-protocols)) path))
9583 ((equal type "mailto")
9584 (let ((cmd (car org-link-mailto-program))
9585 (args (cdr org-link-mailto-program)) args1
9586 (address path) (subject "") a)
9588 (setq address (match-string 1 path)
9589 subject (org-link-escape (match-string 2 path))))
9590 (while args
9591 (cond
9592 ((not (stringp (car args))) (push (pop args) args1))
9593 (t (setq a (pop args))
9594 (if (string-match "%a" a)
9595 (setq a (replace-match address t t a)))
9596 (if (string-match "%s" a)
9597 (setq a (replace-match subject t t a)))
9598 (push a args1))))
9599 (apply cmd (nreverse args1))))
9601 ((member type '("http" "https" "ftp" "news"))
9602 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9603 (org-link-escape
9604 path org-link-escape-chars-browser)
9605 path))))
9607 ((string= type "doi")
9608 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9609 (org-link-escape
9610 path org-link-escape-chars-browser)
9611 path))))
9613 ((member type '("message"))
9614 (browse-url (concat type ":" path)))
9616 ((string= type "tags")
9617 (org-tags-view arg path))
9619 ((string= type "tree-match")
9622 ((string= type "file")
9624 (setq line (string-to-number (match-string 1 path))
9625 path (substring path 0 (match-beginning 0)))
9627 (setq search (match-string 1 path)
9628 path (substring path 0 (match-beginning 0)))))
9629 (if (string-match "[*?{]" (file-name-nondirectory path))
9630 (dired path)
9631 (org-open-file path arg line search)))
9633 ((string= type "shell")
9634 (let ((cmd path))
9635 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9636 (string-match org-confirm-shell-link-not-regexp cmd))
9637 (not org-confirm-shell-link-function)
9638 (funcall org-confirm-shell-link-function
9640 (org-add-props cmd nil
9641 'face 'org-warning))))
9642 (progn
9643 (message "Executing %s" cmd)
9644 (shell-command cmd))
9645 (error "Abort"))))
9647 ((string= type "elisp")
9648 (let ((cmd path))
9649 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9650 (string-match org-confirm-elisp-link-not-regexp cmd))
9651 (not org-confirm-elisp-link-function)
9652 (funcall org-confirm-elisp-link-function
9654 (org-add-props cmd nil
9655 'face 'org-warning))))
9656 (message "%s => %s" cmd
9657 (if (equal (string-to-char cmd) ?\()
9658 (eval (read cmd))
9659 (call-interactively (read cmd))))
9660 (error "Abort"))))
9662 ((and (string= type "thisfile")
9663 (run-hook-with-args-until-success
9664 'org-open-link-functions path)))
9666 ((string= type "thisfile")
9667 (if arg
9668 (switch-to-buffer-other-window
9669 (org-get-buffer-for-internal-link (current-buffer)))
9670 (org-mark-ring-push))
9671 (let ((cmd `(org-link-search
9672 ,path
9673 ,(cond ((equal arg '(4)) ''occur)
9674 ((equal arg '(16)) ''org-occur)
9675 (t nil))
9676 ,pos)))
9677 (condition-case nil (let ((org-link-search-inhibit-query t))
9678 (eval cmd))
9679 (error (progn (widen) (eval cmd))))))
9681 (t
9682 (browse-url-at-point)))))))
9683 (move-marker org-open-link-marker nil)
9684 (run-hook-with-args 'org-follow-link-hook)))
9686 (defun org-offer-links-in-entry (&optional nth zero)
9687 "Offer links in the current entry and follow the selected link.
9688 If there is only one link, follow it immediately as well.
9689 If NTH is an integer, immediately pick the NTH link found.
9690 If ZERO is a string, check also this string for a link, and if
9691 there is one, offer it as link number zero."
9695 (cnt ?0)
9696 (in-emacs (if (integerp nth) nil nth))
9697 have-zero end links link c)
9698 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9699 (push (match-string 0 zero) links)
9700 (setq cnt (1- cnt) have-zero t))
9701 (save-excursion
9702 (org-back-to-heading t)
9703 (setq end (save-excursion (outline-next-heading) (point)))
9704 (while (re-search-forward re end t)
9705 (push (match-string 0) links))
9706 (setq links (org-uniquify (reverse links))))
9708 (cond
9709 ((null links)
9710 (message "No links"))
9711 ((equal (length links) 1)
9712 (setq link (list (car links))))
9713 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9714 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9715 (t ; we have to select a link
9716 (save-excursion
9717 (save-window-excursion
9718 (delete-other-windows)
9719 (with-output-to-temp-buffer "*Select Link*"
9720 (mapc (lambda (l)
9721 (if (not (string-match org-bracket-link-regexp l))
9723 (org-remove-angle-brackets l)))
9724 (if (match-end 3)
9726 (match-string 3 l) (match-string 1 l)))
9728 (match-string 1 l))))))
9729 links))
9730 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9731 (message "Select link to open, RET to open all:")
9732 (setq c (read-char-exclusive))
9733 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9734 (when (equal c ?q) (error "Abort"))
9735 (if (equal c ?\C-m)
9736 (setq link links)
9737 (setq nth (- c ?0))
9738 (if have-zero (setq nth (1+ nth)))
9739 (unless (and (integerp nth) (>= (length links) nth))
9740 (error "Invalid link selection"))
9741 (setq link (list (nth (1- nth) links))))))
9742 (if link
9743 (let ((buf (current-buffer)))
9744 (dolist (l link)
9745 (org-open-link-from-string l in-emacs buf))
9746 t)
9747 nil)))
9749 ;; Add special file links that specify the way of opening
9751 (org-add-link-type "file+sys" 'org-open-file-with-system)
9752 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9753 (defun org-open-file-with-system (path)
9754 "Open file at PATH using the system way of opening it."
9755 (org-open-file path 'system))
9756 (defun org-open-file-with-emacs (path)
9757 "Open file at PATH in Emacs."
9758 (org-open-file path 'emacs))
9759 (defun org-remove-file-link-modifiers ()
9760 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9761 (goto-char (point-min))
9763 (org-if-unprotected
9764 (replace-match "file:" t t))))
9765 (eval-after-load "org-exp"
9766 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9767 'org-remove-file-link-modifiers))
9769 ;;;; Time estimates
9771 (defun org-get-effort (&optional pom)
9772 "Get the effort estimate for the current entry."
9773 (org-entry-get pom org-effort-property))
9775 ;;; File search
9777 (defvar org-create-file-search-functions nil
9778 "List of functions to construct the right search string for a file link.
9779 These functions are called in turn with point at the location to
9780 which the link should point.
9782 A function in the hook should first test if it would like to
9783 handle this file type, for example by checking the `major-mode'
9784 or the file extension. If it decides not to handle this file, it
9785 should just return nil to give other functions a chance. If it
9786 does handle the file, it must return the search string to be used
9787 when following the link. The search string will be part of the
9788 file link, given after a double colon, and `org-open-at-point'
9789 will automatically search for it. If special measures must be
9790 taken to make the search successful, another function should be
9791 added to the companion hook `org-execute-file-search-functions',
9792 which see.
9794 A function in this hook may also use `setq' to set the variable
9795 `description' to provide a suggestion for the descriptive text to
9796 be used for this link when it gets inserted into an Org-mode
9799 (defvar org-execute-file-search-functions nil
9800 "List of functions to execute a file search triggered by a link.
9802 Functions added to this hook must accept a single argument, the
9803 search string that was part of the file link, the part after the
9804 double colon. The function must first check if it would like to
9805 handle this search, for example by checking the `major-mode' or
9806 the file extension. If it decides not to handle this search, it
9807 should just return nil to give other functions a chance. If it
9808 does handle the search, it must return a non-nil value to keep
9809 other functions from trying.
9811 Each function can access the current prefix argument through the
9812 variable `current-prefix-argument'. Note that a single prefix is
9813 used to force opening a link in Emacs, so it may be good to only
9814 use a numeric or double prefix to guide the search function.
9816 In case this is needed, a function in this hook can also restore
9817 the window configuration before `org-open-at-point' was called using:
9819 (set-window-configuration org-window-config-before-follow-link)")
9821 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9822 (defun org-link-search (s &optional type avoid-pos stealth)
9823 "Search for a link search option.
9824 If S is surrounded by forward slashes, it is interpreted as a
9825 regular expression. In org-mode files, this will create an `org-occur'
9826 sparse tree. In ordinary files, `occur' will be used to list matches.
9827 If the current buffer is in `dired-mode', grep will be used to search
9828 in all files. If AVOID-POS is given, ignore matches near that position.
9830 When optional argument STEALTH is non-nil, do not modify
9831 visibility around point, thus ignoring
9832 `org-show-hierarchy-above', `org-show-following-heading' and
9833 `org-show-siblings' variables."
9834 (let ((case-fold-search t)
9838 org-emphasis-alist)
9840 (pos (point))
9841 (pre nil) (post nil)
9842 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9843 (cond
9844 ;; First check if there are any special search functions
9845 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9846 ;; Now try the builtin stuff
9847 ((and (equal (string-to-char s0) ?#)
9848 (> (length s0) 1)
9849 (save-excursion
9850 (goto-char (point-min))
9851 (and
9852 (re-search-forward
9854 (setq type 'dedicated
9855 pos (match-beginning 0))))
9856 ;; There is an exact target for this
9857 (goto-char pos)
9858 (org-back-to-heading t)))
9859 ((save-excursion
9860 (goto-char (point-min))
9861 (and
9862 (re-search-forward
9863 (concat "<<" (regexp-quote s0) ">>") nil t)
9864 (setq type 'dedicated
9865 pos (match-beginning 0))))
9866 ;; There is an exact target for this
9867 (goto-char pos))
9869 (save-excursion
9870 (goto-char (point-min))
9871 (and
9872 (re-search-forward
9873 (concat "[^[]" (regexp-quote
9874 (format org-coderef-label-format
9875 (match-string 1 s0))))
9876 nil t)
9877 (setq type 'dedicated
9878 pos (1+ (match-beginning 0))))))
9879 ;; There is a coderef target for this
9880 (goto-char pos))
9882 ;; A regular expression
9883 (cond
9884 ((eq major-mode 'org-mode)
9885 (org-occur (match-string 1 s)))
9886 ;;((eq major-mode 'dired-mode)
9887 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9888 (t (org-do-occur (match-string 1 s)))))
9889 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9890 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9891 (goto-char (point-min))
9892 (cond
9893 ((let (case-fold-search)
9894 (re-search-forward (format org-complex-heading-regexp-format
9895 (regexp-quote s))
9896 nil t))
9897 ;; OK, found a match
9898 (setq type 'dedicated)
9899 (goto-char (match-beginning 0)))
9900 ((and (not org-link-search-inhibit-query)
9901 (eq org-link-search-must-match-exact-headline 'query-to-create)
9902 (y-or-n-p "No match - create this as a new heading? "))
9903 (goto-char (point-max))
9904 (or (bolp) (newline))
9906 (beginning-of-line 0))
9907 (t
9908 (goto-char pos)
9909 (error "No match"))))
9910 (t
9911 ;; A normal search string
9912 (when (equal (string-to-char s) ?*)
9913 ;; Anchor on headlines, post may include tags.
9916 s (substring s 1)))
9917 (remove-text-properties
9918 0 (length s)
9919 '(face nil mouse-face nil keymap nil fontified nil) s)
9920 ;; Make a series of regular expressions to find a match
9929 re4 (concat "[^a-zA-Z_]" re4_)
9931 re1 (concat pre re2 post)
9932 re3 (concat pre (if pre re4_ re4) post)
9933 re5 (concat pre ".*" re4)
9934 re2 (concat pre re2)
9935 re2a (concat pre (if pre re2a_ re2a))
9936 re4 (concat pre (if pre re4_ re4))
9940 ))
9941 (cond
9942 ((eq type 'org-occur) (org-occur reall))
9943 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9944 (t (goto-char (point-min))
9945 (setq type 'fuzzy)
9946 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9947 (org-search-not-self 1 re1 nil t)
9948 (org-search-not-self 1 re2 nil t)
9949 (org-search-not-self 1 re2a nil t)
9950 (org-search-not-self 1 re3 nil t)
9951 (org-search-not-self 1 re4 nil t)
9952 (org-search-not-self 1 re5 nil t)
9953 )
9954 (goto-char (match-beginning 1))
9955 (goto-char pos)
9956 (error "No match"))))))
9957 (and (eq major-mode 'org-mode)
9958 (not stealth)
9959 (org-show-context 'link-search))
9960 type))
9962 (defun org-search-not-self (group &rest args)
9963 "Execute `re-search-forward', but only accept matches that do not
9964 enclose the position of `org-open-link-marker'."
9965 (let ((m org-open-link-marker))
9966 (catch 'exit
9967 (while (apply 're-search-forward args)
9968 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9969 (goto-char (match-end group))
9970 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9971 (> (match-beginning 0) (marker-position m))
9972 (< (match-end 0) (marker-position m)))
9973 (save-match-data
9974 (or (not (org-in-regexp
9975 org-bracket-link-analytic-regexp 1))
9976 (not (match-end 4)) ; no description
9977 (and (<= (match-beginning 4) (point))
9978 (>= (match-end 4) (point))))))
9979 (throw 'exit (point))))))))
9981 (defun org-get-buffer-for-internal-link (buffer)
9982 "Return a buffer to be used for displaying the link target of internal links."
9983 (cond
9984 ((not org-display-internal-link-with-indirect-buffer)
9985 buffer)
9986 ((string-match "(Clone)$" (buffer-name buffer))
9987 (message "Buffer is already a clone, not making another one")
9988 ;; we also do not modify visibility in this case
9989 buffer)
9990 (t ; make a new indirect buffer for displaying the link
9991 (let* ((bn (buffer-name buffer))
9992 (ibn (concat bn "(Clone)"))
9993 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9994 (with-current-buffer ib (org-overview))
9995 ib))))
9997 (defun org-do-occur (regexp &optional cleanup)
9998 "Call the Emacs command `occur'.
9999 If CLEANUP is non-nil, remove the printout of the regular expression
10000 in the *Occur* buffer. This is useful if the regex is long and not useful
10001 to read."
10002 (occur regexp)
10003 (when cleanup
10004 (let ((cwin (selected-window)) win beg end)
10005 (when (setq win (get-buffer-window "*Occur*"))
10006 (select-window win))
10007 (goto-char (point-min))
10008 (when (re-search-forward "match[a-z]+" nil t)
10009 (setq beg (match-end 0))
10011 (setq end (1- (match-beginning 0)))))
10012 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10013 (goto-char (point-min))
10014 (select-window cwin))))
10016 ;;; The mark ring for links jumps
10018 (defvar org-mark-ring nil
10019 "Mark ring for positions before jumps in Org-mode.")
10020 (defvar org-mark-ring-last-goto nil
10021 "Last position in the mark ring used to go back.")
10022 ;; Fill and close the ring
10023 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10024 (loop for i from 1 to org-mark-ring-length do
10025 (push (make-marker) org-mark-ring))
10026 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10027 org-mark-ring)
10029 (defun org-mark-ring-push (&optional pos buffer)
10030 "Put the current position or POS into the mark ring and rotate it."
10031 (interactive)
10032 (setq pos (or pos (point)))
10033 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10034 (move-marker (car org-mark-ring)
10035 (or pos (point))
10036 (or buffer (current-buffer)))
10037 (message "%s"
10038 (substitute-command-keys
10041 (defun org-mark-ring-goto (&optional n)
10042 "Jump to the previous position in the mark ring.
10043 With prefix arg N, jump back that many stored positions. When
10044 called several times in succession, walk through the entire ring.
10045 Org-mode commands jumping to a different position in the current file,
10046 or to another Org-mode file, automatically push the old position
10047 onto the ring."
10048 (interactive "p")
10049 (let (p m)
10050 (if (eq last-command this-command)
10051 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10052 (setq p org-mark-ring))
10053 (setq org-mark-ring-last-goto p)
10054 (setq m (car p))
10055 (org-pop-to-buffer-same-window (marker-buffer m))
10056 (goto-char m)
10057 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10059 (defun org-remove-angle-brackets (s)
10060 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10061 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10062 s)
10063 (defun org-add-angle-brackets (s)
10064 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10065 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10066 s)
10067 (defun org-remove-double-quotes (s)
10070 s)
10072 ;;; Following specific links
10074 (defun org-follow-timestamp-link ()
10075 (cond
10076 ((org-at-date-range-p t)
10077 (let ((org-agenda-start-on-weekday)
10078 (t1 (match-string 1))
10079 (t2 (match-string 2)))
10080 (setq t1 (time-to-days (org-time-string-to-time t1))
10081 t2 (time-to-days (org-time-string-to-time t2)))
10082 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10083 ((org-at-timestamp-p t)
10084 (org-agenda-list nil (time-to-days (org-time-string-to-time
10085 (substring (match-string 1) 0 10)))
10086 1))
10087 (t (error "This should not happen"))))
10090 ;;; Following file links
10091 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10092 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10093 (declare-function mailcap-mime-info
10094 "mailcap" (string &optional request no-decode))
10095 (defvar org-wait nil)
10096 (defun org-open-file (path &optional in-emacs line search)
10097 "Open the file at PATH.
10098 First, this expands any special file name abbreviations. Then the
10099 configuration variable `org-file-apps' is checked if it contains an
10100 entry for this file type, and if yes, the corresponding command is launched.
10102 If no application is found, Emacs simply visits the file.
10104 With optional prefix argument IN-EMACS, Emacs will visit the file.
10106 prefix arg, Org tries to avoid opening in Emacs
10107 and to use an external application to visit the file.
10109 Optional LINE specifies a line to go to, optional SEARCH a string
10110 to search for. If LINE or SEARCH is given, the file will be
10111 opened in Emacs, unless an entry from org-file-apps that makes
10112 use of groups in a regexp matches.
10114 If you want to change the way frames are used when following a
10115 link, please customize `org-link-frame-setup'.
10117 If the file does not exist, an error is thrown."
10118 (let* ((file (if (equal path "")
10119 buffer-file-name
10120 (substitute-in-file-name (expand-file-name path))))
10121 (file-apps (append org-file-apps (org-default-apps)))
10122 (apps (org-remove-if
10123 'org-file-apps-entry-match-against-dlink-p file-apps))
10124 (apps-dlink (org-remove-if-not
10125 'org-file-apps-entry-match-against-dlink-p file-apps))
10126 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10127 (dirp (if remp nil (file-directory-p file)))
10128 (file (if (and dirp org-open-directory-means-index-dot-org)
10129 (concat (file-name-as-directory file) "index.org")
10130 file))
10131 (a-m-a-p (assq 'auto-mode apps))
10132 (dfile (downcase file))
10133 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10134 (link (cond ((and (eq line nil)
10135 (eq search nil))
10136 file)
10137 (line
10138 (concat file "::" (number-to-string line)))
10139 (search
10140 (concat file "::" search))))
10141 (dlink (downcase link))
10142 (old-buffer (current-buffer))
10143 (old-pos (point))
10144 (old-mode major-mode)
10145 ext cmd link-match-data)
10147 (setq ext (match-string 1 dfile))
10149 (setq ext (match-string 1 dfile))))
10150 (cond
10151 ((member in-emacs '((16) system))
10152 (setq cmd (cdr (assoc 'system apps))))
10153 (in-emacs (setq cmd 'emacs))
10154 (t
10155 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10156 (and dirp (cdr (assoc 'directory apps)))
10157 ; first, try matching against apps-dlink
10158 ; if we get a match here, store the match data for later
10159 (let ((match (assoc-default dlink apps-dlink
10160 'string-match)))
10161 (if match
10162 (progn (setq link-match-data (match-data))
10163 match)
10164 (progn (setq in-emacs (or in-emacs line search))
10165 nil))) ; if we have no match in apps-dlink,
10166 ; always open the file in emacs if line or search
10167 ; is given (for backwards compatibility)
10168 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10169 'string-match)
10170 (cdr (assoc ext apps))
10171 (cdr (assoc t apps))))))
10172 (when (eq cmd 'system)
10173 (setq cmd (cdr (assoc 'system apps))))
10174 (when (eq cmd 'default)
10175 (setq cmd (cdr (assoc t apps))))
10176 (when (eq cmd 'mailcap)
10177 (require 'mailcap)
10178 (mailcap-parse-mailcaps)
10179 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10180 (command (mailcap-mime-info mime-type)))
10181 (if (stringp command)
10182 (setq cmd command)
10183 (setq cmd 'emacs))))
10184 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10185 (not (file-exists-p file))
10186 (not org-open-non-existing-files))
10187 (error "No such file: %s" file))
10188 (cond
10190 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10192 (setq cmd (replace-match "%s" t t cmd)))
10193 (while (string-match "%s" cmd)
10194 (setq cmd (replace-match
10195 (save-match-data
10196 (shell-quote-argument
10197 (convert-standard-filename file)))
10198 t t cmd)))
10200 ;; Replace "%1", "%2" etc. in command with group matches from regex
10201 (save-match-data
10202 (let ((match-index 1)
10203 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10204 (set-match-data link-match-data)
10205 (while (<= match-index number-of-groups)
10206 (let ((regex (concat "%" (number-to-string match-index)))
10207 (replace-with (match-string match-index dlink)))
10208 (while (string-match regex cmd)
10209 (setq cmd (replace-match replace-with t t cmd))))
10210 (setq match-index (+ match-index 1)))))
10212 (save-window-excursion
10213 (start-process-shell-command cmd nil cmd)
10214 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10215 ))
10216 ((or (stringp cmd)
10217 (eq cmd 'emacs))
10218 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10219 (widen)
10220 (if line (org-goto-line line)
10221 (if search (org-link-search search))))
10222 ((consp cmd)
10223 (let ((file (convert-standard-filename file)))
10224 (save-match-data
10225 (set-match-data link-match-data)
10226 (eval cmd))))
10227 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10228 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10229 (or (not (equal old-buffer (current-buffer)))
10230 (not (equal old-pos (point))))
10231 (org-mark-ring-push old-pos old-buffer))))
10233 (defun org-file-apps-entry-match-against-dlink-p (entry)
10234 "This function returns non-nil if `entry' uses a regular
10235 expression which should be matched against the whole link by
10236 org-open-file.
10238 It assumes that is the case when the entry uses a regular
10239 expression which has at least one grouping construct and the
10240 action is either a lisp form or a command string containing
10241 '%1', i.e. using at least one subexpression match as a
10242 parameter."
10243 (let ((selector (car entry))
10244 (action (cdr entry)))
10245 (if (stringp selector)
10246 (and (> (regexp-opt-depth selector) 0)
10247 (or (and (stringp action)
10248 (string-match "%[0-9]" action))
10249 (consp action)))
10250 nil)))
10252 (defun org-default-apps ()
10253 "Return the default applications for this operating system."
10254 (cond
10255 ((eq system-type 'darwin)
10256 org-file-apps-defaults-macosx)
10257 ((eq system-type 'windows-nt)
10258 org-file-apps-defaults-windowsnt)
10259 (t org-file-apps-defaults-gnu)))
10261 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10262 "Convert extensions to regular expressions in the cars of LIST.
10263 Also, weed out any non-string entries, because the return value is used
10264 only for regexp matching.
10265 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10266 point to the symbol `emacs', indicating that the file should
10267 be opened in Emacs."
10268 (append
10269 (delq nil
10270 (mapcar (lambda (x)
10271 (if (not (stringp (car x)))
10272 nil
10274 x
10276 list))
10277 (if add-auto-mode
10278 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10280 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10281 (defun org-file-remote-p (file)
10282 "Test whether FILE specifies a location on a remote system.
10283 Return non-nil if the location is indeed remote.
10287 (cond ((fboundp 'file-remote-p)
10288 (file-remote-p file))
10289 ((fboundp 'tramp-handle-file-remote-p)
10290 (tramp-handle-file-remote-p file))
10291 ((and (boundp 'ange-ftp-name-format)
10292 (string-match (car ange-ftp-name-format) file))
10293 t)
10294 (t nil)))
10297 ;;;; Refiling
10299 (defun org-get-org-file ()
10300 "Read a filename, with default directory `org-directory'."
10301 (let ((default (or org-default-notes-file remember-data-file)))
10302 (read-file-name (format "File name [%s]: " default)
10303 (file-name-as-directory org-directory)
10304 default)))
10306 (defun org-notes-order-reversed-p ()
10307 "Check if the current file should receive notes in reversed order."
10308 (cond
10309 ((not org-reverse-note-order) nil)
10310 ((eq t org-reverse-note-order) t)
10311 ((not (listp org-reverse-note-order)) nil)
10312 (t (catch 'exit
10313 (let ((all org-reverse-note-order)
10314 entry)
10315 (while (setq entry (pop all))
10316 (if (string-match (car entry) buffer-file-name)
10317 (throw 'exit (cdr entry))))
10318 nil)))))
10320 (defvar org-refile-target-table nil
10321 "The list of refile targets, created by `org-refile'.")
10323 (defvar org-agenda-new-buffers nil
10324 "Buffers created to visit agenda files.")
10326 (defvar org-refile-cache nil
10327 "Cache for refile targets.")
10329 (defvar org-refile-markers nil
10330 "All the markers used for caching refile locations.")
10332 (defun org-refile-marker (pos)
10333 "Get a new refile marker, but only if caching is in use."
10334 (if (not org-refile-use-cache)
10335 pos
10336 (let ((m (make-marker)))
10337 (move-marker m pos)
10338 (push m org-refile-markers)
10339 m)))
10341 (defun org-refile-cache-clear ()
10342 "Clear the refile cache and disable all the markers."
10343 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10344 (setq org-refile-markers nil)
10345 (setq org-refile-cache nil)
10346 (message "Refile cache has been cleared"))
10348 (defun org-refile-cache-check-set (set)
10349 "Check if all the markers in the cache still have live buffers."
10350 (let (marker)
10351 (catch 'exit
10352 (while (and set (setq marker (nth 3 (pop set))))
10353 ;; if org-refile-use-outline-path is 'file, marker may be nil
10354 (when (and marker (null (marker-buffer marker)))
10355 (message "not found") (sit-for 3)
10356 (throw 'exit nil)))
10357 t)))
10359 (defun org-refile-cache-put (set &rest identifiers)
10360 "Push the refile targets SET into the cache, under IDENTIFIERS."
10361 (let* ((key (sha1 (prin1-to-string identifiers)))
10362 (entry (assoc key org-refile-cache)))
10363 (if entry
10364 (setcdr entry set)
10365 (push (cons key set) org-refile-cache))))
10367 (defun org-refile-cache-get (&rest identifiers)
10368 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10369 (cond
10370 ((not org-refile-cache) nil)
10371 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10372 (t
10373 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10374 org-refile-cache))))
10375 (and set (org-refile-cache-check-set set) set)))))
10377 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10378 "Produce a table with refile targets."
10379 (let ((case-fold-search nil)
10380 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10381 (entries (or org-refile-targets '((nil . (:level . 1)))))
10382 targets tgs txt re files f desc descre fast-path-p level pos0)
10383 (message "Getting targets...")
10384 (with-current-buffer (or default-buffer (current-buffer))
10385 (while (setq org-entry (pop entries))
10386 (setq files (car org-entry) desc (cdr org-entry))
10387 (setq fast-path-p nil)
10388 (cond
10389 ((null files) (setq files (list (current-buffer))))
10390 ((eq files 'org-agenda-files)
10391 (setq files (org-agenda-files 'unrestricted)))
10392 ((and (symbolp files) (fboundp files))
10393 (setq files (funcall files)))
10394 ((and (symbolp files) (boundp files))
10395 (setq files (symbol-value files))))
10396 (if (stringp files) (setq files (list files)))
10397 (cond
10398 ((eq (car desc) :tag)
10400 ((eq (car desc) :todo)
10402 ((eq (car desc) :regexp)
10403 (setq descre (cdr desc)))
10404 ((eq (car desc) :level)
10406 (if org-odd-levels-only
10407 (1- (* 2 (cdr desc)))
10408 (cdr desc)))
10410 ((eq (car desc) :maxlevel)
10411 (setq fast-path-p t)
10413 (if org-odd-levels-only
10414 (1- (* 2 (cdr desc)))
10415 (cdr desc)))
10417 (t (error "Bad refiling target description %s" desc)))
10418 (while (setq f (pop files))
10419 (with-current-buffer
10420 (if (bufferp f) f (org-get-agenda-file-buffer f))
10421 (or
10422 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10423 (progn
10424 (if (bufferp f) (setq f (buffer-file-name
10425 (buffer-base-buffer f))))
10426 (setq f (and f (expand-file-name f)))
10427 (if (eq org-refile-use-outline-path 'file)
10428 (push (list (file-name-nondirectory f) f nil nil) tgs))
10429 (save-excursion
10430 (save-restriction
10431 (widen)
10432 (goto-char (point-min))
10433 (while (re-search-forward descre nil t)
10434 (goto-char (setq pos0 (point-at-bol)))
10435 (catch 'next
10436 (when org-refile-target-verify-function
10437 (save-match-data
10438 (or (funcall org-refile-target-verify-function)
10439 (throw 'next t))))
10440 (when (and (looking-at org-complex-heading-regexp)
10441 (not (member (match-string 4) excluded-entries))
10442 (match-string 4))
10443 (setq level (org-reduced-level
10444 (- (match-end 1) (match-beginning 1)))
10445 txt (org-link-display-format (match-string 4))
10447 re (format org-complex-heading-regexp-format
10448 (regexp-quote (match-string 4))))
10449 (when org-refile-use-outline-path
10450 (setq txt (mapconcat
10451 'org-protect-slash
10452 (append
10453 (if (eq org-refile-use-outline-path
10454 'file)
10455 (list (file-name-nondirectory
10456 (buffer-file-name
10457 (buffer-base-buffer))))
10458 (if (eq org-refile-use-outline-path
10459 'full-file-path)
10460 (list (buffer-file-name
10461 (buffer-base-buffer)))))
10462 (org-get-outline-path fast-path-p
10463 level txt)
10464 (list txt))
10465 "/")))
10466 (push (list txt f re (org-refile-marker (point)))
10467 tgs)))
10468 (when (= (point) pos0)
10469 ;; verification function has not moved point
10470 (goto-char (point-at-eol))))))))
10471 (when org-refile-use-cache
10472 (org-refile-cache-put tgs (buffer-file-name) descre))
10473 (setq targets (append tgs targets))
10474 ))))
10475 (message "Getting targets...done")
10476 (nreverse targets)))
10478 (defun org-protect-slash (s)
10479 (while (string-match "/" s)
10481 s)
10483 (defvar org-olpa (make-vector 20 nil))
10485 (defun org-get-outline-path (&optional fastp level heading)
10486 "Return the outline path to the current entry, as a list.
10488 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10489 routine which makes outline path derivations for an entire file,
10490 avoiding backtracing. Refile target collection makes use of that."
10491 (if fastp
10492 (progn
10493 (if (> level 19)
10494 (error "Outline path failure, more than 19 levels"))
10495 (loop for i from level upto 19 do
10496 (aset org-olpa i nil))
10497 (prog1
10498 (delq nil (append org-olpa nil))
10499 (aset org-olpa level heading)))
10500 (let (rtn case-fold-search)
10501 (save-excursion
10502 (save-restriction
10503 (widen)
10504 (while (org-up-heading-safe)
10505 (when (looking-at org-complex-heading-regexp)
10506 (push (org-match-string-no-properties 4) rtn)))
10507 rtn)))))
10509 (defun org-format-outline-path (path &optional width prefix)
10510 "Format the outline path PATH for display.
10511 Width is the maximum number of characters that is available.
10512 Prefix is a prefix to be included in the returned string,
10513 such as the file name."
10514 (setq width (or width 79))
10515 (if prefix (setq width (- width (length prefix))))
10516 (if (not path)
10517 (or prefix "")
10518 (let* ((nsteps (length path))
10519 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10520 (maxwidth (if (<= total-width width)
10521 10000 ;; everything fits
10522 ;; we need to shorten the level headings
10523 (/ (- width nsteps) nsteps)))
10524 (org-odd-levels-only nil)
10525 (n 0)
10526 (total (1+ (length prefix))))
10527 (setq maxwidth (max maxwidth 10))
10528 (concat prefix
10529 (mapconcat
10530 (lambda (h)
10531 (setq n (1+ n))
10532 (if (and (= n nsteps) (< maxwidth 10000))
10533 (setq maxwidth (- total-width total)))
10534 (if (< (length h) maxwidth)
10535 (progn (setq total (+ total (length h) 1)) h)
10536 (setq h (substring h 0 (- maxwidth 2))
10537 total (+ total maxwidth 1))
10539 (setq h (substring h 0 (match-beginning 0))))
10540 (setq h (concat h "..")))
10541 (org-add-props h nil 'face
10542 (nth (% (1- n) org-n-level-faces)
10543 org-level-faces))
10544 h)
10545 path "/")))))
10547 (defun org-display-outline-path (&optional file current)
10548 "Display the current outline path in the echo area."
10549 (interactive "P")
10550 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10551 (case-fold-search nil)
10552 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10553 (if current (setq path (append path
10554 (save-excursion
10555 (org-back-to-heading t)
10556 (if (looking-at org-complex-heading-regexp)
10557 (list (match-string 4)))))))
10558 (message "%s"
10559 (org-format-outline-path
10560 path
10561 (1- (frame-width))
10562 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10564 (defvar org-refile-history nil
10565 "History for refiling operations.")
10567 (defvar org-after-refile-insert-hook nil
10568 "Hook run after `org-refile' has inserted its stuff at the new location.
10569 Note that this is still *before* the stuff will be removed from
10570 the *old* location.")
10572 (defvar org-capture-last-stored-marker)
10573 (defun org-refile (&optional goto default-buffer rfloc)
10574 "Move the entry or entries at point to another heading.
10575 The list of target headings is compiled using the information in
10576 `org-refile-targets', which see.
10578 At the target location, the entry is filed as a subitem of the target
10579 heading. Depending on `org-reverse-note-order', the new subitem will
10580 either be the first or the last subitem.
10582 If there is an active region, all entries in that region will be moved.
10583 However, the region must fulfill the requirement that the first heading
10584 is the first one sets the top-level of the moved text - at most siblings
10585 below it are allowed.
10587 With prefix arg GOTO, the command will only visit the target location
10588 and not actually move anything.
10591 go to the location where the last refiling operation has put the subtree.
10592 With a prefix argument of `2', refile to the running clock.
10594 RFLOC can be a refile location obtained in a different way.
10596 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10598 If you are using target caching (see `org-refile-use-cache'),
10599 You have to clear the target cache in order to find new targets.
10600 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10601 prefix argument (`C-u C-u C-u C-c C-w')."
10603 (interactive "P")
10604 (if (member goto '(0 (64)))
10605 (org-refile-cache-clear)
10606 (let* ((cbuf (current-buffer))
10607 (regionp (org-region-active-p))
10608 (region-start (and regionp (region-beginning)))
10609 (region-end (and regionp (region-end)))
10610 (region-length (and regionp (- region-end region-start)))
10611 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10612 pos it nbuf file re level reversed)
10613 (setq last-command nil)
10614 (when regionp
10615 (goto-char region-start)
10616 (or (bolp) (goto-char (point-at-bol)))
10617 (setq region-start (point))
10618 (unless (or (org-kill-is-subtree-p
10619 (buffer-substring region-start region-end))
10620 (prog1 org-refile-active-region-within-subtree
10621 (org-toggle-heading)))
10622 (error "The region is not a (sequence of) subtree(s)")))
10623 (if (equal goto '(16))
10624 (org-refile-goto-last-stored)
10625 (when (or
10626 (and (equal goto 2)
10627 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10628 (prog1
10629 (setq it (list (or org-clock-heading "running clock")
10630 (buffer-file-name
10631 (marker-buffer org-clock-hd-marker))
10632 ""
10633 (marker-position org-clock-hd-marker)))
10634 (setq goto nil)))
10635 (setq it (or rfloc
10636 (let (heading-text)
10637 (save-excursion
10638 (unless goto
10639 (org-back-to-heading t)
10640 (setq heading-text
10641 (nth 4 (org-heading-components))))
10642 (org-refile-get-location
10643 (cond (goto "Goto")
10644 (regionp "Refile region to")
10647 default-buffer
10648 (and (not (equal '(4) goto))
10649 org-refile-allow-creating-parent-nodes)
10650 goto))))))
10651 (setq file (nth 1 it)
10652 re (nth 2 it)
10653 pos (nth 3 it))
10654 (if (and (not goto)
10655 pos
10656 (equal (buffer-file-name) file)
10657 (if regionp
10658 (and (>= pos region-start)
10659 (<= pos region-end))
10660 (and (>= pos (point))
10661 (< pos (save-excursion
10662 (org-end-of-subtree t t))))))
10663 (error "Cannot refile to position inside the tree or region"))
10665 (setq nbuf (or (find-buffer-visiting file)
10666 (find-file-noselect file)))
10667 (if goto
10668 (progn
10669 (org-pop-to-buffer-same-window nbuf)
10670 (goto-char pos)
10671 (org-show-context 'org-goto))
10672 (if regionp
10673 (progn
10674 (org-kill-new (buffer-substring region-start region-end))
10675 (org-save-markers-in-region region-start region-end))
10676 (org-copy-subtree 1 nil t))
10677 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10678 (find-file-noselect file)))
10679 (setq reversed (org-notes-order-reversed-p))
10680 (save-excursion
10681 (save-restriction
10682 (widen)
10683 (if pos
10684 (progn
10685 (goto-char pos)
10686 (looking-at org-outline-regexp)
10687 (setq level (org-get-valid-level (funcall outline-level) 1))
10688 (goto-char
10689 (if reversed
10690 (or (outline-next-heading) (point-max))
10691 (or (save-excursion (org-get-next-sibling))
10692 (org-end-of-subtree t t)
10693 (point-max)))))
10694 (setq level 1)
10695 (if (not reversed)
10696 (goto-char (point-max))
10697 (goto-char (point-min))
10698 (or (outline-next-heading) (goto-char (point-max)))))
10699 (if (not (bolp)) (newline))
10700 (org-paste-subtree level)
10701 (when org-log-refile
10702 (org-add-log-setup 'refile nil nil 'findpos
10703 org-log-refile)
10704 (unless (eq org-log-refile 'note)
10705 (save-excursion (org-add-log-note))))
10706 (and org-auto-align-tags (org-set-tags nil t))
10707 (bookmark-set "org-refile-last-stored")
10708 ;; If we are refiling for capture, make sure that the
10709 ;; last-capture pointers point here
10710 (when (org-bound-and-true-p org-refile-for-capture)
10711 (bookmark-set "org-capture-last-stored-marker")
10712 (move-marker org-capture-last-stored-marker (point)))
10713 (if (fboundp 'deactivate-mark) (deactivate-mark))
10714 (run-hooks 'org-after-refile-insert-hook))))
10715 (if regionp
10716 (delete-region (point) (+ (point) region-length))
10717 (org-cut-subtree))
10718 (when (featurep 'org-inlinetask)
10719 (org-inlinetask-remove-END-maybe))
10720 (setq org-markers-to-move nil)
10723 (defun org-refile-goto-last-stored ()
10724 "Go to the location where the last refile was stored."
10725 (interactive)
10726 (bookmark-jump "org-refile-last-stored")
10727 (message "This is the location of the last refile"))
10729 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10730 no-exclude)
10731 "Prompt the user for a refile location, using PROMPT.
10732 PROMPT should not be suffixed with a colon and a space, because
10733 this function appends the default value from
10734 `org-refile-history' automatically, if that is not empty.
10735 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10736 this is used for the GOTO interface."
10737 (let ((org-refile-targets org-refile-targets)
10738 (org-refile-use-outline-path org-refile-use-outline-path)
10739 excluded-entries)
10740 (when (and (eq major-mode 'org-mode)
10741 (not org-refile-use-cache)
10742 (not no-exclude))
10743 (org-map-tree
10744 (lambda()
10745 (setq excluded-entries
10746 (append excluded-entries (list (org-get-heading t t)))))))
10747 (setq org-refile-target-table
10748 (org-refile-get-targets default-buffer excluded-entries)))
10749 (unless org-refile-target-table
10750 (error "No refile targets"))
10751 (let* ((prompt (concat prompt
10752 (and (car org-refile-history)
10753 (concat " (default " (car org-refile-history) ")"))
10754 ": "))
10755 (cbuf (current-buffer))
10756 (partial-completion-mode nil)
10757 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10758 (cfunc (if (and org-refile-use-outline-path
10759 org-outline-path-complete-in-steps)
10760 'org-olpath-completing-read
10761 'org-icompleting-read))
10762 (extra (if org-refile-use-outline-path "/" ""))
10763 (filename (and cfn (expand-file-name cfn)))
10764 (tbl (mapcar
10765 (lambda (x)
10766 (if (and (not (member org-refile-use-outline-path
10767 '(file full-file-path)))
10768 (not (equal filename (nth 1 x))))
10769 (cons (concat (car x) extra " ("
10770 (file-name-nondirectory (nth 1 x)) ")")
10771 (cdr x))
10772 (cons (concat (car x) extra) (cdr x))))
10773 org-refile-target-table))
10774 (completion-ignore-case t)
10775 pa answ parent-target child parent old-hist)
10776 (setq old-hist org-refile-history)
10777 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10778 nil 'org-refile-history (car org-refile-history)))
10779 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10780 (org-refile-check-position pa)
10781 (if pa
10782 (progn
10783 (when (or (not org-refile-history)
10784 (not (eq old-hist org-refile-history))
10785 (not (equal (car pa) (car org-refile-history))))
10786 (setq org-refile-history
10787 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10788 org-refile-history
10789 (cdr org-refile-history))))
10790 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10791 (pop org-refile-history)))
10792 pa)
10794 (progn
10795 (setq parent (match-string 1 answ)
10796 child (match-string 2 answ))
10797 (setq parent-target (or (assoc parent tbl)
10798 (assoc (concat parent "/") tbl)))
10799 (when (and parent-target
10800 (or (eq new-nodes t)
10801 (and (eq new-nodes 'confirm)
10803 child)))))
10804 (org-refile-new-child parent-target child)))
10805 (error "Invalid target location")))))
10807 (defun org-refile-check-position (refile-pointer)
10808 "Check if the refile pointer matches the readline to which it points."
10809 (let* ((file (nth 1 refile-pointer))
10810 (re (nth 2 refile-pointer))
10811 (pos (nth 3 refile-pointer))
10812 buffer)
10813 (when (org-string-nw-p re)
10814 (setq buffer (if (markerp pos)
10815 (marker-buffer pos)
10816 (or (find-buffer-visiting file)
10817 (find-file-noselect file))))
10818 (with-current-buffer buffer
10819 (save-excursion
10820 (save-restriction
10821 (widen)
10822 (goto-char pos)
10823 (beginning-of-line 1)
10824 (unless (org-looking-at-p re)
10825 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10827 (defun org-refile-new-child (parent-target child)
10828 "Use refile target PARENT-TARGET to add new CHILD below it."
10829 (unless parent-target
10830 (error "Cannot find parent for new node"))
10831 (let ((file (nth 1 parent-target))
10832 (pos (nth 3 parent-target))
10833 level)
10834 (with-current-buffer (or (find-buffer-visiting file)
10835 (find-file-noselect file))
10836 (save-excursion
10837 (save-restriction
10838 (widen)
10839 (if pos
10840 (goto-char pos)
10841 (goto-char (point-max))
10842 (if (not (bolp)) (newline)))
10843 (when (looking-at org-outline-regexp)
10844 (setq level (funcall outline-level))
10845 (org-end-of-subtree t t))
10846 (org-back-over-empty-lines)
10848 (if pos (org-get-valid-level level 1) 1) ?*)
10850 (beginning-of-line 0)
10851 (list (concat (car parent-target) "/" child) file "" (point)))))))
10853 (defun org-olpath-completing-read (prompt collection &rest args)
10854 "Read an outline path like a file name."
10855 (let ((thetable collection)
10856 (org-completion-use-ido nil) ; does not work with ido.
10857 (org-completion-use-iswitchb nil)) ; or iswitchb
10858 (apply
10859 'org-icompleting-read prompt
10860 (lambda (string predicate &optional flag)
10861 (let (rtn r f (l (length string)))
10862 (cond
10863 ((eq flag nil)
10864 ;; try completion
10865 (try-completion string thetable))
10866 ((eq flag t)
10867 ;; all-completions
10868 (setq rtn (all-completions string thetable predicate))
10869 (mapcar
10870 (lambda (x)
10871 (setq r (substring x l))
10872 (if (string-match " ([^)]*)$" x)
10873 (setq f (match-string 0 x))
10874 (setq f ""))
10875 (if (string-match "/" r)
10876 (concat string (substring r 0 (match-end 0)) f)
10877 x))
10878 rtn))
10879 ((eq flag 'lambda)
10880 ;; exact match?
10881 (assoc string thetable)))
10882 ))
10883 args)))
10885 ;;;; Dynamic blocks
10887 (defun org-find-dblock (name)
10888 "Find the first dynamic block with name NAME in the buffer.
10889 If not found, stay at current position and return nil."
10890 (let (pos)
10891 (save-excursion
10892 (goto-char (point-min))
10894 nil t)
10895 (match-beginning 0))))
10896 (if pos (goto-char pos))
10897 pos))
10899 (defconst org-dblock-start-re
10901 "Matches the start line of a dynamic block, with parameters.")
10904 "Matches the end of a dynamic block.")
10906 (defun org-create-dblock (plist)
10907 "Create a dynamic block section, with parameters taken from PLIST.
10908 PLIST must contain a :name entry which is used as name of the block."
10910 (end-of-line 1)
10911 (newline))
10912 (let ((col (current-column))
10913 (name (plist-get plist :name)))
10914 (insert "#+BEGIN: " name)
10915 (while plist
10916 (if (eq (car plist) :name)
10917 (setq plist (cddr plist))
10918 (insert " " (prin1-to-string (pop plist)))))
10920 (beginning-of-line -2)))
10922 (defun org-prepare-dblock ()
10923 "Prepare dynamic block for refresh.
10924 This empties the block, puts the cursor at the insert position and returns
10925 the property list including an extra property :name with the block name."
10926 (unless (looking-at org-dblock-start-re)
10927 (error "Not at a dynamic block"))
10928 (let* ((begdel (1+ (match-end 0)))
10929 (name (org-no-properties (match-string 1)))
10930 (params (append (list :name name)
10931 (read (concat "(" (match-string 3) ")")))))
10932 (save-excursion
10933 (beginning-of-line 1)
10935 (setq params (plist-put params :indentation-column (current-column))))
10936 (unless (re-search-forward org-dblock-end-re nil t)
10937 (error "Dynamic block not terminated"))
10938 (setq params
10939 (append params
10940 (list :content (buffer-substring
10941 begdel (match-beginning 0)))))
10942 (delete-region begdel (match-beginning 0))
10943 (goto-char begdel)
10944 (open-line 1)
10945 params))
10947 (defun org-map-dblocks (&optional command)
10948 "Apply COMMAND to all dynamic blocks in the current buffer.
10949 If COMMAND is not given, use `org-update-dblock'."
10950 (let ((cmd (or command 'org-update-dblock)))
10951 (save-excursion
10952 (goto-char (point-min))
10953 (while (re-search-forward org-dblock-start-re nil t)
10954 (goto-char (match-beginning 0))
10955 (save-excursion
10956 (condition-case nil
10957 (funcall cmd)
10958 (error (message "Error during update of dynamic block"))))
10959 (unless (re-search-forward org-dblock-end-re nil t)
10960 (error "Dynamic block not terminated"))))))
10962 (defun org-dblock-update (&optional arg)
10963 "User command for updating dynamic blocks.
10964 Update the dynamic block at point. With prefix ARG, update all dynamic
10965 blocks in the buffer."
10966 (interactive "P")
10967 (if arg
10968 (org-update-all-dblocks)
10969 (or (looking-at org-dblock-start-re)
10970 (org-beginning-of-dblock))
10971 (org-update-dblock)))
10973 (defun org-update-dblock ()
10974 "Update the dynamic block at point.
10975 This means to empty the block, parse for parameters and then call
10976 the correct writing function."
10977 (interactive)
10978 (save-window-excursion
10979 (let* ((pos (point))
10980 (line (org-current-line))
10981 (params (org-prepare-dblock))
10982 (name (plist-get params :name))
10983 (indent (plist-get params :indentation-column))
10984 (cmd (intern (concat "org-dblock-write:" name))))
10985 (message "Updating dynamic block `%s' at line %d..." name line)
10986 (funcall cmd params)
10987 (message "Updating dynamic block `%s' at line %d...done" name line)
10988 (goto-char pos)
10989 (when (and indent (> indent 0))
10990 (setq indent (make-string indent ?\ ))
10991 (save-excursion
10992 (org-beginning-of-dblock)
10993 (forward-line 1)
10994 (while (not (looking-at org-dblock-end-re))
10995 (insert indent)
10996 (beginning-of-line 2))
10997 (when (looking-at org-dblock-end-re)
10999 (replace-match ""))
11000 (insert indent)))))))
11002 (defun org-beginning-of-dblock ()
11003 "Find the beginning of the dynamic block at point.
11004 Error if there is no such block at point."
11005 (let ((pos (point))
11006 beg)
11007 (end-of-line 1)
11008 (if (and (re-search-backward org-dblock-start-re nil t)
11009 (setq beg (match-beginning 0))
11010 (re-search-forward org-dblock-end-re nil t)
11011 (> (match-end 0) pos))
11012 (goto-char beg)
11013 (goto-char pos)
11014 (error "Not in a dynamic block"))))
11016 (defun org-update-all-dblocks ()
11017 "Update all dynamic blocks in the buffer.
11018 This function can be used in a hook."
11019 (interactive)
11020 (when (eq major-mode 'org-mode)
11021 (org-map-dblocks 'org-update-dblock)))
11024 ;;;; Completion
11026 (defconst org-additional-option-like-keywords
11027 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11028 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11029 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11030 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11031 "BEGIN:" "END:"
11032 "ORGTBL" "TBLFM:" "TBLNAME:"
11033 "BEGIN_EXAMPLE" "END_EXAMPLE"
11034 "BEGIN_QUOTE" "END_QUOTE"
11035 "BEGIN_VERSE" "END_VERSE"
11036 "BEGIN_CENTER" "END_CENTER"
11037 "BEGIN_SRC" "END_SRC"
11038 "BEGIN_RESULT" "END_RESULT"
11039 "NAME:" "RESULTS:"
11040 "HEADER:" "HEADERS:"
11041 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11042 "CAPTION:" "LABEL:"
11043 "SETUPFILE:"
11044 "INCLUDE:"
11045 "BIND:"
11046 "MACRO:"))
11048 (defcustom org-structure-template-alist
11049 '(
11062 ("L" "#+latex: "
11066 ("H" "#+html: "
11069 ("A" "#+ascii: ")
11070 ("i" "#+index: ?"
11071 "#+index: ?")
11072 ("I" "#+include %file ?"
11074 )
11075 "Structure completion elements.
11076 This is a list of abbreviation keys and values. The value gets inserted
11077 if you type `<' followed by the key and then press the completion key,
11078 usually `M-TAB'. %file will be replaced by a file name after prompting
11079 for the file using completion. The cursor will be placed at the position
11080 of the `?` in the template.
11081 There are two templates for each key, the first uses the original Org syntax,
11082 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11083 the default when the /org-mtags.el/ module has been loaded. See also the
11084 variable `org-mtags-prefer-muse-templates'.
11085 This is an experimental feature, it is undecided if it is going to stay in."
11086 :group 'org-completion
11087 :type '(repeat
11088 (string :tag "Key")
11089 (string :tag "Template")
11090 (string :tag "Muse Template")))
11092 (defun org-try-structure-completion ()
11093 "Try to complete a structure template before point.
11095 expands them."
11096 (let ((l (buffer-substring (point-at-bol) (point)))
11097 a)
11100 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11101 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11102 (match-beginning 1)) a)
11103 t)))
11105 (defun org-complete-expand-structure-template (start cell)
11106 "Expand a structure template."
11107 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11108 (rpl (nth (if musep 2 1) cell))
11109 (ind ""))
11110 (delete-region start (point))
11112 (cond
11113 ((bolp))
11115 (setq ind (buffer-substring (point-at-bol) (point))))
11116 (t (newline))))
11117 (setq start (point))
11118 (if (string-match "%file" rpl)
11119 (setq rpl (replace-match
11120 (concat
11122 (save-match-data
11123 (abbreviate-file-name (read-file-name "Include file: ")))
11125 t t rpl)))
11128 (insert rpl)
11131 ;;;; TODO, DEADLINE, Comments
11133 (defun org-toggle-comment ()
11134 "Change the COMMENT state of an entry."
11135 (interactive)
11136 (save-excursion
11137 (org-back-to-heading)
11138 (let (case-fold-search)
11139 (cond
11140 ((looking-at (format org-heading-keyword-regexp-format
11141 org-comment-string))
11142 (goto-char (match-end 1))
11143 (looking-at (concat " +" org-comment-string))
11144 (replace-match "" t t)
11145 (when (eolp) (insert " ")))
11146 ((looking-at org-outline-regexp)
11147 (goto-char (match-end 0))
11148 (insert org-comment-string " "))))))
11150 (defvar org-last-todo-state-is-todo nil
11151 "This is non-nil when the last TODO state change led to a TODO state.
11152 If the last change removed the TODO tag or switched to DONE, then
11153 this is nil.")
11155 (defvar org-setting-tags nil) ; dynamically skipped
11157 (defvar org-todo-setup-filter-hook nil
11158 "Hook for functions that pre-filter todo specs.
11159 Each function takes a todo spec and returns either nil or the spec
11160 transformed into canonical form." )
11162 (defvar org-todo-get-default-hook nil
11163 "Hook for functions that get a default item for todo.
11164 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11165 nil or a string to be used for the todo mark." )
11167 (defvar org-agenda-headline-snapshot-before-repeat)
11169 (defun org-current-effective-time ()
11170 "Return current time adjusted for `org-extend-today-until' variable"
11171 (let* ((ct (org-current-time))
11172 (dct (decode-time ct))
11173 (ct1
11174 (if (and org-use-effective-time
11175 (< (nth 2 dct) org-extend-today-until))
11176 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11177 ct)))
11178 ct1))
11180 (defun org-todo-yesterday (&optional arg)
11181 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11182 (interactive "P")
11183 (if (eq major-mode 'org-agenda-mode)
11184 (apply 'org-agenda-todo-yesterday arg)
11185 (let* ((hour (third (decode-time
11186 (org-current-time))))
11187 (org-extend-today-until (1+ hour)))
11188 (org-todo arg))))
11190 (defun org-todo (&optional arg)
11191 "Change the TODO state of an item.
11192 The state of an item is given by a keyword at the start of the heading,
11193 like
11194 *** TODO Write paper
11195 *** DONE Call mom
11197 The different keywords are specified in the variable `org-todo-keywords'.
11199 So for this example: when the item starts with TODO, it is changed to DONE.
11200 When it starts with DONE, the DONE is removed. And when neither TODO nor
11201 DONE are present, add TODO at the beginning of the heading.
11204 state.
11205 With numeric prefix arg, switch to that state.
11207 keywords (nextset).
11209 With a numeric prefix arg of 0, inhibit note taking for the change.
11211 For calling through lisp, arg is also interpreted in the following way:
11212 'none -> empty state
11214 'done -> switch to DONE
11215 'nextset -> switch to the next set of keywords
11216 'previousset -> switch to the previous set of keywords
11218 really is a member of `org-todo-keywords'."
11219 (interactive "P")
11220 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11221 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11222 'region-start-level 'region))
11223 org-loop-over-headlines-in-active-region)
11224 (org-map-entries
11225 `(org-todo ,arg)
11226 org-loop-over-headlines-in-active-region
11227 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11228 (if (equal arg '(16)) (setq arg 'nextset))
11229 (let ((org-blocker-hook org-blocker-hook)
11230 (case-fold-search nil))
11231 (when (equal arg '(64))
11232 (setq arg nil org-blocker-hook nil))
11233 (when (and org-blocker-hook
11234 (or org-inhibit-blocking
11235 (org-entry-get nil "NOBLOCKING")))
11236 (setq org-blocker-hook nil))
11237 (save-excursion
11238 (catch 'exit
11239 (org-back-to-heading t)
11240 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11243 (let* ((match-data (match-data))
11244 (startpos (point-at-bol))
11245 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11246 (org-log-done org-log-done)
11247 (org-log-repeat org-log-repeat)
11248 (org-todo-log-states org-todo-log-states)
11249 (org-inhibit-logging
11250 (if (equal arg 0)
11251 (progn (setq arg nil) 'note) org-inhibit-logging))
11252 (this (match-string 1))
11253 (hl-pos (match-beginning 0))
11254 (head (org-get-todo-sequence-head this))
11255 (ass (assoc head org-todo-kwd-alist))
11256 (interpret (nth 1 ass))
11257 (done-word (nth 3 ass))
11258 (final-done-word (nth 4 ass))
11259 (org-last-state (or this ""))
11260 (completion-ignore-case t)
11261 (member (member this org-todo-keywords-1))
11262 (tail (cdr member))
11263 (org-state (cond
11264 ((and org-todo-key-trigger
11265 (or (and (equal arg '(4))
11266 (eq org-use-fast-todo-selection 'prefix))
11267 (and (not arg) org-use-fast-todo-selection
11268 (not (eq org-use-fast-todo-selection
11269 'prefix)))))
11270 ;; Use fast selection
11271 (org-fast-todo-selection))
11272 ((and (equal arg '(4))
11273 (or (not org-use-fast-todo-selection)
11274 (not org-todo-key-trigger)))
11275 ;; Read a state with completion
11276 (org-icompleting-read
11277 "State: " (mapcar (lambda(x) (list x))
11278 org-todo-keywords-1)
11279 nil t))
11280 ((eq arg 'right)
11281 (if this
11282 (if tail (car tail) nil)
11283 (car org-todo-keywords-1)))
11284 ((eq arg 'left)
11285 (if (equal member org-todo-keywords-1)
11286 nil
11287 (if this
11288 (nth (- (length org-todo-keywords-1)
11289 (length tail) 2)
11290 org-todo-keywords-1)
11291 (org-last org-todo-keywords-1))))
11292 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11293 (setq arg nil))) ; hack to fall back to cycling
11294 (arg
11295 ;; user or caller requests a specific state
11296 (cond
11297 ((equal arg "") nil)
11298 ((eq arg 'none) nil)
11299 ((eq arg 'done) (or done-word (car org-done-keywords)))
11300 ((eq arg 'nextset)
11301 (or (car (cdr (member head org-todo-heads)))
11302 (car org-todo-heads)))
11303 ((eq arg 'previousset)
11304 (let ((org-todo-heads (reverse org-todo-heads)))
11305 (or (car (cdr (member head org-todo-heads)))
11306 (car org-todo-heads))))
11307 ((car (member arg org-todo-keywords-1)))
11308 ((stringp arg)
11309 (error "State `%s' not valid in this file" arg))
11310 ((nth (1- (prefix-numeric-value arg))
11311 org-todo-keywords-1))))
11312 ((null member) (or head (car org-todo-keywords-1)))
11313 ((equal this final-done-word) nil) ;; -> make empty
11314 ((null tail) nil) ;; -> first entry
11315 ((memq interpret '(type priority))
11316 (if (eq this-command last-command)
11317 (car tail)
11318 (if (> (length tail) 0)
11319 (or done-word (car org-done-keywords))
11320 nil)))
11321 (t
11322 (car tail))))
11323 (org-state (or
11324 (run-hook-with-args-until-success
11325 'org-todo-get-default-hook org-state org-last-state)
11326 org-state))
11327 (next (if org-state (concat " " org-state " ") " "))
11328 (change-plist (list :type 'todo-state-change :from this :to org-state
11329 :position startpos))
11330 dolog now-done-p)
11331 (when org-blocker-hook
11332 (setq org-last-todo-state-is-todo
11333 (not (member this org-done-keywords)))
11334 (unless (save-excursion
11335 (save-match-data
11336 (org-with-wide-buffer
11337 (run-hook-with-args-until-failure
11338 'org-blocker-hook change-plist))))
11339 (if (org-called-interactively-p 'interactive)
11340 (error "TODO state change from %s to %s blocked" this org-state)
11341 ;; fail silently
11342 (message "TODO state change from %s to %s blocked" this org-state)
11343 (throw 'exit nil))))
11344 (store-match-data match-data)
11345 (replace-match next t t)
11346 (unless (pos-visible-in-window-p hl-pos)
11347 (message "TODO state changed to %s" (org-trim next)))
11348 (unless head
11349 (setq head (org-get-todo-sequence-head org-state)
11350 ass (assoc head org-todo-kwd-alist)
11351 interpret (nth 1 ass)
11352 done-word (nth 3 ass)
11353 final-done-word (nth 4 ass)))
11354 (when (memq arg '(nextset previousset))
11355 (message "Keyword-Set %d/%d: %s"
11356 (- (length org-todo-sets) -1
11357 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11358 (length org-todo-sets)
11359 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11360 (setq org-last-todo-state-is-todo
11361 (not (member org-state org-done-keywords)))
11362 (setq now-done-p (and (member org-state org-done-keywords)
11363 (not (member this org-done-keywords))))
11364 (and logging (org-local-logging logging))
11365 (when (and (or org-todo-log-states org-log-done)
11366 (not (eq org-inhibit-logging t))
11367 (not (memq arg '(nextset previousset))))
11368 ;; we need to look at recording a time and note
11369 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11370 (nth 2 (assoc this org-todo-log-states))))
11371 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11372 (setq dolog 'time))
11373 (when (and org-state
11374 (member org-state org-not-done-keywords)
11375 (not (member this org-not-done-keywords)))
11376 ;; This is now a todo state and was not one before
11377 ;; If there was a CLOSED time stamp, get rid of it.
11378 (org-add-planning-info nil nil 'closed))
11379 (when (and now-done-p org-log-done)
11380 ;; It is now done, and it was not done before
11381 (org-add-planning-info 'closed (org-current-effective-time))
11382 (if (and (not dolog) (eq 'note org-log-done))
11383 (org-add-log-setup 'done state this 'findpos 'note)))
11384 (when (and org-state dolog)
11385 ;; This is a non-nil state, and we need to log it
11386 (org-add-log-setup 'state org-state this 'findpos dolog)))
11387 ;; Fixup tag positioning
11388 (org-todo-trigger-tag-changes org-state)
11389 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11390 (when org-provide-todo-statistics
11391 (org-update-parent-todo-statistics))
11392 (run-hooks 'org-after-todo-state-change-hook)
11393 (if (and arg (not (member org-state org-done-keywords)))
11394 (setq head (org-get-todo-sequence-head org-state)))
11395 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11396 ;; Do we need to trigger a repeat?
11397 (when now-done-p
11398 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11399 ;; This is for the agenda, take a snapshot of the headline.
11400 (save-match-data
11401 (setq org-agenda-headline-snapshot-before-repeat
11402 (org-get-heading))))
11403 (org-auto-repeat-maybe org-state))
11404 ;; Fixup cursor location if close to the keyword
11405 (if (and (outline-on-heading-p)
11406 (not (bolp))
11407 (save-excursion (beginning-of-line 1)
11408 (looking-at org-todo-line-regexp))
11409 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11410 (progn
11411 (goto-char (or (match-end 2) (match-end 1)))
11412 (and (looking-at " ") (just-one-space))))
11413 (when org-trigger-hook
11414 (save-excursion
11415 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11417 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11418 "Block turning an entry into a TODO, using the hierarchy.
11419 This checks whether the current task should be blocked from state
11420 changes. Such blocking occurs when:
11422 1. The task has children which are not all in a completed state.
11424 2. A task has a parent with the property :ORDERED:, and there
11425 are siblings prior to the current task with incomplete
11426 status.
11428 3. The parent of the task is blocked because it has siblings that should
11429 be done first, or is child of a block grandparent TODO entry."
11431 (if (not org-enforce-todo-dependencies)
11432 t ; if locally turned off don't block
11433 (catch 'dont-block
11434 ;; If this is not a todo state change, or if this entry is already DONE,
11435 ;; do not block
11436 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11437 (member (plist-get change-plist :from)
11438 (cons 'done org-done-keywords))
11439 (member (plist-get change-plist :to)
11440 (cons 'todo org-not-done-keywords))
11441 (not (plist-get change-plist :to)))
11442 (throw 'dont-block t))
11443 ;; If this task has children, and any are undone, it's blocked
11444 (save-excursion
11445 (org-back-to-heading t)
11446 (let ((this-level (funcall outline-level)))
11447 (outline-next-heading)
11448 (let ((child-level (funcall outline-level)))
11449 (while (and (not (eobp))
11450 (> child-level this-level))
11451 ;; this todo has children, check whether they are all
11452 ;; completed
11453 (if (and (not (org-entry-is-done-p))
11454 (org-entry-is-todo-p))
11455 (throw 'dont-block nil))
11456 (outline-next-heading)
11457 (setq child-level (funcall outline-level))))))
11458 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11459 ;; any previous siblings are undone, it's blocked
11460 (save-excursion
11461 (org-back-to-heading t)
11462 (let* ((pos (point))
11463 (parent-pos (and (org-up-heading-safe) (point))))
11464 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11465 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11466 (forward-line 1)
11467 (re-search-forward org-not-done-heading-regexp pos t))
11468 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11469 ;; Search further up the hierarchy, to see if an ancestor is blocked
11470 (while t
11471 (goto-char parent-pos)
11472 (if (not (looking-at org-not-done-heading-regexp))
11473 (throw 'dont-block t)) ; do not block, parent is not a TODO
11474 (setq pos (point))
11475 (setq parent-pos (and (org-up-heading-safe) (point)))
11476 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11477 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11478 (forward-line 1)
11479 (re-search-forward org-not-done-heading-regexp pos t))
11480 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11482 (defcustom org-track-ordered-property-with-tag nil
11483 "Should the ORDERED property also be shown as a tag?
11484 The ORDERED property decides if an entry should require subtasks to be
11485 completed in sequence. Since a property is not very visible, setting
11486 this option means that toggling the ORDERED property with the command
11487 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11488 not relevant for the behavior, but it makes things more visible.
11490 Note that toggling the tag with tags commands will not change the property
11491 and therefore not influence behavior!
11493 This can be t, meaning the tag ORDERED should be used, It can also be a
11494 string to select a different tag for this task."
11495 :group 'org-todo
11496 :type '(choice
11497 (const :tag "No tracking" nil)
11498 (const :tag "Track with ORDERED tag" t)
11499 (string :tag "Use other tag")))
11501 (defun org-toggle-ordered-property ()
11502 "Toggle the ORDERED property of the current entry.
11503 For better visibility, you can track the value of this property with a tag.
11504 See variable `org-track-ordered-property-with-tag'."
11505 (interactive)
11506 (let* ((t1 org-track-ordered-property-with-tag)
11507 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11508 (save-excursion
11509 (org-back-to-heading)
11510 (if (org-entry-get nil "ORDERED")
11511 (progn
11512 (org-delete-property "ORDERED")
11513 (and tag (org-toggle-tag tag 'off))
11514 (message "Subtasks can be completed in arbitrary order"))
11515 (org-entry-put nil "ORDERED" "t")
11516 (and tag (org-toggle-tag tag 'on))
11517 (message "Subtasks must be completed in sequence")))))
11519 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11520 (defun org-block-todo-from-checkboxes (change-plist)
11521 "Block turning an entry into a TODO, using checkboxes.
11522 This checks whether the current task should be blocked from state
11523 changes because there are unchecked boxes in this entry."
11524 (if (not org-enforce-todo-checkbox-dependencies)
11525 t ; if locally turned off don't block
11526 (catch 'dont-block
11527 ;; If this is not a todo state change, or if this entry is already DONE,
11528 ;; do not block
11529 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11530 (member (plist-get change-plist :from)
11531 (cons 'done org-done-keywords))
11532 (member (plist-get change-plist :to)
11533 (cons 'todo org-not-done-keywords))
11534 (not (plist-get change-plist :to)))
11535 (throw 'dont-block t))
11536 ;; If this task has checkboxes that are not checked, it's blocked
11537 (save-excursion
11538 (org-back-to-heading t)
11539 (let ((beg (point)) end)
11540 (outline-next-heading)
11541 (setq end (point))
11542 (goto-char beg)
11543 (if (org-list-search-forward
11544 (concat (org-item-beginning-re)
11547 end t)
11548 (progn
11549 (if (boundp 'org-blocked-by-checkboxes)
11550 (setq org-blocked-by-checkboxes t))
11551 (throw 'dont-block nil)))))
11552 t))) ; do not block
11554 (defun org-entry-blocked-p ()
11555 "Is the current entry blocked?"
11556 (if (org-entry-get nil "NOBLOCKING")
11557 nil ;; Never block this entry
11558 (not
11559 (run-hook-with-args-until-failure
11560 'org-blocker-hook
11561 (list :type 'todo-state-change
11562 :position (point)
11563 :from 'todo
11564 :to 'done)))))
11566 (defun org-update-statistics-cookies (all)
11567 "Update the statistics cookie, either from TODO or from checkboxes.
11568 This should be called with the cursor in a line with a statistics cookie."
11569 (interactive "P")
11570 (if all
11571 (progn
11572 (org-update-checkbox-count 'all)
11573 (org-map-entries 'org-update-parent-todo-statistics))
11574 (if (not (org-at-heading-p))
11575 (org-update-checkbox-count)
11576 (let ((pos (move-marker (make-marker) (point)))
11577 end l1 l2)
11578 (ignore-errors (org-back-to-heading t))
11579 (if (not (org-at-heading-p))
11580 (org-update-checkbox-count)
11581 (setq l1 (org-outline-level))
11582 (setq end (save-excursion
11583 (outline-next-heading)
11584 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11585 (point)))
11586 (if (and (save-excursion
11587 (re-search-forward
11589 (not (save-excursion (re-search-forward
11591 (org-update-checkbox-count)
11592 (if (and l2 (> l2 l1))
11593 (progn
11594 (goto-char end)
11595 (org-update-parent-todo-statistics))
11596 (goto-char pos)
11597 (beginning-of-line 1)
11598 (while (re-search-forward
11600 (point-at-eol) t)
11601 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11602 (goto-char pos)
11603 (move-marker pos nil)))))
11605 (defvar org-entry-property-inherited-from) ;; defined below
11606 (defun org-update-parent-todo-statistics ()
11607 "Update any statistics cookie in the parent of the current headline.
11608 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11609 the entire subtree and this will travel up the hierarchy and update
11610 statistics everywhere."
11611 (let* ((prop (save-excursion (org-up-heading-safe)
11612 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11613 (recursive (or (not org-hierarchical-todo-statistics)
11615 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11616 0))
11617 (first t)
11619 level ltoggle l1 new ndel
11620 (cnt-all 0) (cnt-done 0) is-percent kwd
11621 checkbox-beg ov ovs ove cookie-present)
11622 (catch 'exit
11623 (save-excursion
11624 (beginning-of-line 1)
11625 (setq ltoggle (funcall outline-level))
11626 ;; Three situations are to consider:
11628 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11629 ;; to the top-level ancestor on the headline;
11631 ;; 2. If parent has "recursive" property, repeat up to the
11632 ;; headline setting that property, taking inheritance into
11633 ;; account;
11635 ;; 3. Else, move up to direct parent and proceed only once.
11636 (while (and (setq level (org-up-heading-safe))
11637 (or recursive first)
11638 (>= (point) lim))
11639 (setq first nil cookie-present nil)
11640 (unless (and level
11641 (not (string-match
11643 (downcase (or (org-entry-get nil "COOKIE_DATA")
11644 "")))))
11645 (throw 'exit nil))
11646 (while (re-search-forward box-re (point-at-eol) t)
11647 (setq cnt-all 0 cnt-done 0 cookie-present t)
11648 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11649 (save-match-data
11650 (unless (outline-next-heading) (throw 'exit nil))
11651 (while (and (looking-at org-complex-heading-regexp)
11652 (> (setq l1 (length (match-string 1))) level))
11653 (setq kwd (and (or recursive (= l1 ltoggle))
11654 (match-string 2)))
11655 (if (or (eq org-provide-todo-statistics 'all-headlines)
11656 (and (listp org-provide-todo-statistics)
11657 (or (member kwd org-provide-todo-statistics)
11658 (member kwd org-done-keywords))))
11659 (setq cnt-all (1+ cnt-all))
11660 (if (eq org-provide-todo-statistics t)
11661 (and kwd (setq cnt-all (1+ cnt-all)))))
11662 (and (member kwd org-done-keywords)
11663 (setq cnt-done (1+ cnt-done)))
11664 (outline-next-heading)))
11665 (setq new
11666 (if is-percent
11667 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11668 (format "[%d/%d]" cnt-done cnt-all))
11669 ndel (- (match-end 0) checkbox-beg))
11670 ;; handle overlays when updating cookie from column view
11671 (when (setq ov (car (overlays-at checkbox-beg)))
11672 (setq ovs (overlay-start ov) ove (overlay-end ov))
11673 (delete-overlay ov))
11674 (goto-char checkbox-beg)
11675 (insert new)
11676 (delete-region (point) (+ (point) ndel))
11677 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11678 (when ov (move-overlay ov ovs ove)))
11679 (when cookie-present
11680 (run-hook-with-args 'org-after-todo-statistics-hook
11681 cnt-done (- cnt-all cnt-done))))))
11682 (run-hooks 'org-todo-statistics-hook)))
11684 (defvar org-after-todo-statistics-hook nil
11685 "Hook that is called after a TODO statistics cookie has been updated.
11686 Each function is called with two arguments: the number of not-done entries
11687 and the number of done entries.
11689 For example, the following function, when added to this hook, will switch
11690 an entry to DONE when all children are done, and back to TODO when new
11691 entries are set to a TODO status. Note that this hook is only called
11692 when there is a statistics cookie in the headline!
11694 (defun org-summary-todo (n-done n-not-done)
11696 (let (org-log-done org-log-states) ; turn off logging
11698 ")
11700 (defvar org-todo-statistics-hook nil
11701 "Hook that is run whenever Org thinks TODO statistics should be updated.
11702 This hook runs even if there is no statistics cookie present, in which case
11703 `org-after-todo-statistics-hook' would not run.")
11705 (defun org-todo-trigger-tag-changes (state)
11706 "Apply the changes defined in `org-todo-state-tags-triggers'."
11707 (let ((l org-todo-state-tags-triggers)
11708 changes)
11709 (when (or (not state) (equal state ""))
11710 (setq changes (append changes (cdr (assoc "" l)))))
11711 (when (and (stringp state) (> (length state) 0))
11712 (setq changes (append changes (cdr (assoc state l)))))
11713 (when (member state org-not-done-keywords)
11714 (setq changes (append changes (cdr (assoc 'todo l)))))
11715 (when (member state org-done-keywords)
11716 (setq changes (append changes (cdr (assoc 'done l)))))
11717 (dolist (c changes)
11718 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11720 (defun org-local-logging (value)
11721 "Get logging settings from a property VALUE."
11722 (let* (words w a)
11723 ;; directly set the variables, they are already local.
11724 (setq org-log-done nil
11725 org-log-repeat nil
11726 org-todo-log-states nil)
11727 (setq words (org-split-string value))
11728 (while (setq w (pop words))
11729 (cond
11730 ((setq a (assoc w org-startup-options))
11731 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11732 (set (nth 1 a) (nth 2 a))))
11733 ((setq a (org-extract-log-state-settings w))
11734 (and (member (car a) org-todo-keywords-1)
11735 (push a org-todo-log-states)))))))
11737 (defun org-get-todo-sequence-head (kwd)
11738 "Return the head of the TODO sequence to which KWD belongs.
11739 If KWD is not set, check if there is a text property remembering the
11740 right sequence."
11741 (let (p)
11742 (cond
11743 ((not kwd)
11744 (or (get-text-property (point-at-bol) 'org-todo-head)
11745 (progn
11746 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11747 nil (point-at-eol)))
11748 (get-text-property p 'org-todo-head))))
11749 ((not (member kwd org-todo-keywords-1))
11750 (car org-todo-keywords-1))
11751 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11753 (defun org-fast-todo-selection ()
11754 "Fast TODO keyword selection with single keys.
11755 Returns the new TODO keyword, or nil if no state change should occur."
11756 (let* ((fulltable org-todo-key-alist)
11757 (done-keywords org-done-keywords) ;; needed for the faces.
11758 (maxlen (apply 'max (mapcar
11759 (lambda (x)
11760 (if (stringp (car x)) (string-width (car x)) 0))
11761 fulltable)))
11762 (expert nil)
11763 (fwidth (+ maxlen 3 1 3))
11764 (ncol (/ (- (window-width) 4) fwidth))
11765 tg cnt e c tbl
11766 groups ingroup)
11767 (save-excursion
11768 (save-window-excursion
11769 (if expert
11770 (set-buffer (get-buffer-create " *Org todo*"))
11771 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11772 (erase-buffer)
11773 (org-set-local 'org-done-keywords done-keywords)
11774 (setq tbl fulltable cnt 0)
11775 (while (setq e (pop tbl))
11776 (cond
11777 ((equal e '(:startgroup))
11778 (push '() groups) (setq ingroup t)
11779 (when (not (= cnt 0))
11780 (setq cnt 0)
11782 (insert "{ "))
11783 ((equal e '(:endgroup))
11784 (setq ingroup nil cnt 0)
11786 ((equal e '(:newline))
11787 (when (not (= cnt 0))
11788 (setq cnt 0)
11790 (setq e (car tbl))
11791 (while (equal (car tbl) '(:newline))
11793 (setq tbl (cdr tbl)))))
11794 (t
11795 (setq tg (car e) c (cdr e))
11796 (if ingroup (push tg (car groups)))
11797 (setq tg (org-add-props tg nil 'face
11798 (org-get-todo-face tg)))
11799 (if (and (= cnt 0) (not ingroup)) (insert " "))
11800 (insert "[" c "] " tg (make-string
11801 (- fwidth 4 (length tg)) ?\ ))
11802 (when (= (setq cnt (1+ cnt)) ncol)
11804 (if ingroup (insert " "))
11805 (setq cnt 0)))))
11807 (goto-char (point-min))
11808 (if (not expert) (org-fit-window-to-buffer))
11809 (message "[a-z..]:Set [SPC]:clear")
11810 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11811 (cond
11812 ((or (= c ?\C-g)
11813 (and (= c ?q) (not (rassoc c fulltable))))
11814 (setq quit-flag t))
11815 ((= c ?\ ) nil)
11816 ((setq e (rassoc c fulltable) tg (car e))
11817 tg)
11818 (t (setq quit-flag t)))))))
11820 (defun org-entry-is-todo-p ()
11821 (member (org-get-todo-state) org-not-done-keywords))
11823 (defun org-entry-is-done-p ()
11824 (member (org-get-todo-state) org-done-keywords))
11826 (defun org-get-todo-state ()
11827 (save-excursion
11828 (org-back-to-heading t)
11829 (and (looking-at org-todo-line-regexp)
11830 (match-end 2)
11831 (match-string 2))))
11833 (defun org-at-date-range-p (&optional inactive-ok)
11834 "Is the cursor inside a date range?"
11835 (interactive)
11836 (save-excursion
11837 (catch 'exit
11838 (let ((pos (point)))
11840 (skip-chars-backward "<[")
11841 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11842 (>= (match-end 0) pos)
11843 (throw 'exit t))
11845 (skip-chars-backward "<[")
11846 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11847 (>= (match-end 0) pos)
11848 (throw 'exit t)))
11849 nil)))
11851 (defun org-get-repeat (&optional tagline)
11852 "Check if there is a deadline/schedule with repeater in this entry."
11853 (save-match-data
11854 (save-excursion
11855 (org-back-to-heading t)
11856 (and (re-search-forward (if tagline
11858 org-repeat-re)
11859 (org-entry-end-position) t)
11860 (match-string-no-properties 1)))))
11862 (defvar org-last-changed-timestamp)
11863 (defvar org-last-inserted-timestamp)
11864 (defvar org-log-post-message)
11865 (defvar org-log-note-purpose)
11866 (defvar org-log-note-how)
11867 (defvar org-log-note-extra)
11868 (defun org-auto-repeat-maybe (done-word)
11869 "Check if the current headline contains a repeated deadline/schedule.
11870 If yes, set TODO state back to what it was and change the base date
11871 of repeating deadline/scheduled time stamps to new date.
11872 This function is run automatically after each state change to a DONE state."
11873 ;; last-state is dynamically scoped into this function
11874 (let* ((repeat (org-get-repeat))
11875 (aa (assoc org-last-state org-todo-kwd-alist))
11876 (interpret (nth 1 aa))
11877 (head (nth 2 aa))
11878 (whata '(("d" . day) ("m" . month) ("y" . year)))
11879 (msg "Entry repeats: ")
11880 (org-log-done nil)
11881 (org-todo-log-states nil)
11882 re type n what ts time to-state)
11883 (when repeat
11884 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11885 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11886 org-todo-repeat-to-state))
11887 (unless (and to-state (member to-state org-todo-keywords-1))
11888 (setq to-state (if (eq interpret 'type) org-last-state head)))
11889 (org-todo to-state)
11890 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11891 (org-entry-put nil "LAST_REPEAT" (format-time-string
11892 (org-time-stamp-format t t))))
11893 (when org-log-repeat
11894 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11895 (memq 'org-add-log-note post-command-hook))
11896 ;; OK, we are already setup for some record
11897 (if (eq org-log-repeat 'note)
11898 ;; make sure we take a note, not only a time stamp
11899 (setq org-log-note-how 'note))
11900 ;; Set up for taking a record
11901 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11902 org-last-state
11903 'findpos org-log-repeat)))
11904 (org-back-to-heading t)
11905 (org-add-planning-info nil nil 'closed)
11909 (while (re-search-forward
11910 re (save-excursion (outline-next-heading) (point)) t)
11911 (setq type (if (match-end 1) org-scheduled-string
11912 (if (match-end 3) org-deadline-string "Plain:"))
11913 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11915 (setq n (string-to-number (match-string 2 ts))
11916 what (match-string 3 ts))
11917 (if (equal what "w") (setq n (* n 7) what "d"))
11918 ;; Preparation, see if we need to modify the start date for the change
11919 (when (match-end 1)
11920 (setq time (save-match-data (org-time-string-to-time ts)))
11921 (cond
11922 ((equal (match-string 1 ts) ".")
11923 ;; Shift starting date to today
11924 (org-timestamp-change
11925 (- (org-today) (time-to-days time))
11926 'day))
11927 ((equal (match-string 1 ts) "+")
11928 (let ((nshiftmax 10) (nshift 0))
11929 (while (or (= nshift 0)
11930 (<= (time-to-days time)
11931 (time-to-days (current-time))))
11932 (when (= (incf nshift) nshiftmax)
11933 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11934 (error "Abort")))
11935 (org-timestamp-change n (cdr (assoc what whata)))
11936 (org-at-timestamp-p t)
11937 (setq ts (match-string 1))
11938 (setq time (save-match-data (org-time-string-to-time ts)))))
11939 (org-timestamp-change (- n) (cdr (assoc what whata)))
11940 ;; rematch, so that we have everything in place for the real shift
11941 (org-at-timestamp-p t)
11942 (setq ts (match-string 1))
11944 (org-timestamp-change n (cdr (assoc what whata)))
11945 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11946 (setq org-log-post-message msg)
11947 (message "%s" msg))))
11949 (defun org-show-todo-tree (arg)
11950 "Make a compact tree which shows all headlines marked with TODO.
11951 The tree will show the lines where the regexp matches, and all higher
11952 headlines above the match.
11954 With a numeric prefix N, construct a sparse tree for the Nth element
11955 of `org-todo-keywords-1'."
11956 (interactive "P")
11957 (let ((case-fold-search nil)
11958 (kwd-re
11959 (cond ((null arg) org-not-done-regexp)
11960 ((equal arg '(4))
11961 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11962 (mapcar 'list org-todo-keywords-1))))
11966 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11967 (regexp-quote (nth (1- (prefix-numeric-value arg))
11968 org-todo-keywords-1)))
11969 (t (error "Invalid prefix argument: %s" arg)))))
11970 (message "%d TODO entries found"
11971 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11973 (defun org-deadline (&optional remove time)
11975 With argument REMOVE, remove any deadline from the item.
11976 With argument TIME, set the deadline at the corresponding date. TIME
11978 (interactive "P")
11979 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11980 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11981 'region-start-level 'region))
11982 org-loop-over-headlines-in-active-region)
11983 (org-map-entries
11984 `(org-deadline ',remove ,time)
11985 org-loop-over-headlines-in-active-region
11986 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11987 (let* ((old-date (org-entry-get nil "DEADLINE"))
11988 (repeater (and old-date
11989 (string-match
11991 old-date)
11992 (match-string 1 old-date))))
11993 (if remove
11994 (progn
11995 (when (and old-date org-log-redeadline)
11996 (org-add-log-setup 'deldeadline nil old-date 'findpos
11997 org-log-redeadline))
11998 (org-remove-timestamp-with-keyword org-deadline-string)
11999 (message "Item no longer has a deadline."))
12000 (org-add-planning-info 'deadline time 'closed)
12001 (when (and old-date org-log-redeadline
12002 (not (equal old-date
12003 (substring org-last-inserted-timestamp 1 -1))))
12004 (org-add-log-setup 'redeadline nil old-date 'findpos
12005 org-log-redeadline))
12006 (when repeater
12007 (save-excursion
12008 (org-back-to-heading t)
12009 (when (re-search-forward (concat org-deadline-string " "
12010 org-last-inserted-timestamp)
12011 (save-excursion
12012 (outline-next-heading) (point)) t)
12013 (goto-char (1- (match-end 0)))
12014 (insert " " repeater)
12015 (setq org-last-inserted-timestamp
12016 (concat (substring org-last-inserted-timestamp 0 -1)
12017 " " repeater
12018 (substring org-last-inserted-timestamp -1))))))
12019 (message "Deadline on %s" org-last-inserted-timestamp)))))
12021 (defun org-schedule (&optional remove time)
12022 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12023 With argument REMOVE, remove any scheduling date from the item.
12024 With argument TIME, scheduled at the corresponding date. TIME can
12026 (interactive "P")
12027 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12028 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12029 'region-start-level 'region))
12030 org-loop-over-headlines-in-active-region)
12031 (org-map-entries
12032 `(org-schedule ',remove ,time)
12033 org-loop-over-headlines-in-active-region
12034 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12035 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12036 (repeater (and old-date
12037 (string-match
12039 old-date)
12040 (match-string 1 old-date))))
12041 (if remove
12042 (progn
12043 (when (and old-date org-log-reschedule)
12044 (org-add-log-setup 'delschedule nil old-date 'findpos
12045 org-log-reschedule))
12046 (org-remove-timestamp-with-keyword org-scheduled-string)
12047 (message "Item is no longer scheduled."))
12048 (org-add-planning-info 'scheduled time 'closed)
12049 (when (and old-date org-log-reschedule
12050 (not (equal old-date
12051 (substring org-last-inserted-timestamp 1 -1))))
12052 (org-add-log-setup 'reschedule nil old-date 'findpos
12053 org-log-reschedule))
12054 (when repeater
12055 (save-excursion
12056 (org-back-to-heading t)
12057 (when (re-search-forward (concat org-scheduled-string " "
12058 org-last-inserted-timestamp)
12059 (save-excursion
12060 (outline-next-heading) (point)) t)
12061 (goto-char (1- (match-end 0)))
12062 (insert " " repeater)
12063 (setq org-last-inserted-timestamp
12064 (concat (substring org-last-inserted-timestamp 0 -1)
12065 " " repeater
12066 (substring org-last-inserted-timestamp -1))))))
12067 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12069 (defun org-get-scheduled-time (pom &optional inherit)
12070 "Get the scheduled time as a time tuple, of a format suitable
12071 for calling org-schedule with, or if there is no scheduling,
12072 returns nil."
12073 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12074 (when time
12075 (apply 'encode-time (org-parse-time-string time)))))
12077 (defun org-get-deadline-time (pom &optional inherit)
12078 "Get the deadline as a time tuple, of a format suitable for
12079 calling org-deadline with, or if there is no scheduling, returns
12080 nil."
12081 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12082 (when time
12083 (apply 'encode-time (org-parse-time-string time)))))
12085 (defun org-remove-timestamp-with-keyword (keyword)
12086 "Remove all time stamps with KEYWORD in the current entry."
12088 beg)
12089 (save-excursion
12090 (org-back-to-heading t)
12091 (setq beg (point))
12092 (outline-next-heading)
12093 (while (re-search-backward re beg t)
12094 (replace-match "")
12096 (equal (char-before) ?\ ))
12097 (backward-delete-char 1)
12099 (point-at-bol) (point-at-eol)))
12100 (delete-region (point-at-bol)
12101 (min (point-max) (1+ (point-at-eol))))))))))
12103 (defun org-add-planning-info (what &optional time &rest remove)
12104 "Insert new timestamp with keyword in the line directly after the headline.
12105 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12106 If non is given, the user is prompted for a date.
12107 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12108 be removed."
12109 (interactive)
12110 (let (org-time-was-given org-end-time-was-given ts
12111 end default-time default-input)
12113 (catch 'exit
12114 (when (and (memq what '(scheduled deadline))
12115 (or (not time)
12116 (and (stringp time)
12117 (string-match "^[-+]+[0-9]" time))))
12118 ;; Try to get a default date/time from existing timestamp
12119 (save-excursion
12120 (org-back-to-heading t)
12121 (setq end (save-excursion (outline-next-heading) (point)))
12122 (when (re-search-forward (if (eq what 'scheduled)
12123 org-scheduled-time-regexp
12124 org-deadline-time-regexp)
12125 end t)
12126 (setq ts (match-string 1)
12127 default-time
12128 (apply 'encode-time (org-parse-time-string ts))
12129 default-input (and ts (org-get-compact-tod ts))))))
12130 (when what
12131 (setq time
12132 (if (stringp time)
12133 ;; This is a string (relative or absolute), set proper date
12134 (apply 'encode-time
12135 (org-read-date-analyze
12136 time default-time (decode-time default-time)))
12137 ;; If necessary, get the time from the user
12138 (or time (org-read-date nil 'to-time nil nil
12139 default-time default-input)))))
12141 (when (and org-insert-labeled-timestamps-at-point
12142 (member what '(scheduled deadline)))
12143 (insert
12144 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12145 (org-insert-time-stamp time org-time-was-given
12146 nil nil nil (list org-end-time-was-given))
12147 (setq what nil))
12148 (save-excursion
12149 (save-restriction
12150 (let (col list elt ts buffer-invisibility-spec)
12151 (org-back-to-heading t)
12153 (goto-char (match-end 1))
12154 (setq col (current-column))
12155 (goto-char (match-end 0))
12157 (when (and (not what)
12158 (not (looking-at
12160 org-keyword-time-not-clock-regexp))))
12161 ;; Nothing to add, nothing to remove...... :-)
12162 (throw 'exit nil))
12163 (if (and (not (looking-at org-outline-regexp))
12166 (not (equal (match-string 1) org-clock-string)))
12167 (narrow-to-region (match-beginning 0) (match-end 0))
12169 (backward-char 1)
12170 (narrow-to-region (point) (point))
12171 (and org-adapt-indentation (org-indent-to-column col)))
12172 ;; Check if we have to remove something.
12173 (setq list (cons what remove))
12174 (while list
12175 (setq elt (pop list))
12176 (when (or (and (eq elt 'scheduled)
12177 (re-search-forward org-scheduled-time-regexp nil t))
12178 (and (eq elt 'deadline)
12179 (re-search-forward org-deadline-time-regexp nil t))
12180 (and (eq elt 'closed)
12181 (re-search-forward org-closed-time-regexp nil t)))
12182 (replace-match "")
12183 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12185 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12186 (when what
12187 (insert
12188 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12189 (cond ((eq what 'scheduled) org-scheduled-string)
12190 ((eq what 'deadline) org-deadline-string)
12191 ((eq what 'closed) org-closed-string))
12192 " ")
12193 (setq ts (org-insert-time-stamp
12194 time
12195 (or org-time-was-given
12196 (and (eq what 'closed) org-log-done-with-time))
12197 (eq what 'closed)
12198 nil nil (list org-end-time-was-given)))
12199 (insert
12200 (if (not (or (bolp) (eq (char-before) ?\ )
12201 (memq (char-after) '(32 10))
12202 (eobp))) " " ""))
12203 (end-of-line 1))
12204 (goto-char (point-min))
12205 (widen)
12208 (delete-region (1- (point)) (point-at-eol)))
12209 ts))))))
12211 (defvar org-log-note-marker (make-marker))
12212 (defvar org-log-note-purpose nil)
12213 (defvar org-log-note-state nil)
12214 (defvar org-log-note-previous-state nil)
12215 (defvar org-log-note-how nil)
12216 (defvar org-log-note-extra nil)
12217 (defvar org-log-note-window-configuration nil)
12218 (defvar org-log-note-return-to (make-marker))
12219 (defvar org-log-note-effective-time nil
12220 "Remembered current time so that dynamically scoped
12221 `org-extend-today-until' affects tha timestamps in state change
12222 log")
12224 (defvar org-log-post-message nil
12225 "Message to be displayed after a log note has been stored.
12226 The auto-repeater uses this.")
12228 (defun org-add-note ()
12229 "Add a note to the current entry.
12230 This is done in the same way as adding a state change note."
12231 (interactive)
12232 (org-add-log-setup 'note nil nil 'findpos nil))
12234 (defvar org-property-end-re)
12235 (defun org-add-log-setup (&optional purpose state prev-state
12236 findpos how extra)
12237 "Set up the post command hook to take a note.
12238 If this is about to TODO state change, the new state is expected in STATE.
12239 When FINDPOS is non-nil, find the correct position for the note in
12240 the current entry. If not, assume that it can be inserted at point.
12241 HOW is an indicator what kind of note should be created.
12242 EXTRA is additional text that will be inserted into the notes buffer."
12243 (let* ((org-log-into-drawer (org-log-into-drawer))
12244 (drawer (cond ((stringp org-log-into-drawer)
12245 org-log-into-drawer)
12246 (org-log-into-drawer "LOGBOOK")
12247 (t nil))))
12248 (save-restriction
12249 (save-excursion
12250 (when findpos
12251 (org-back-to-heading t)
12252 (narrow-to-region (point) (save-excursion
12253 (outline-next-heading) (point)))
12257 (goto-char (match-end 0))
12258 (cond
12259 (drawer
12261 nil t)
12262 (progn
12263 (goto-char (match-end 0))
12264 (or org-log-states-order-reversed
12265 (and (re-search-forward org-property-end-re nil t)
12266 (goto-char (1- (match-beginning 0))))))
12268 (beginning-of-line 0)
12269 (org-indent-line-function)
12270 (beginning-of-line 2)
12271 (org-indent-line-function)
12272 (end-of-line 0)))
12273 ((and org-log-state-notes-insert-after-drawers
12274 (save-excursion
12275 (forward-line) (looking-at org-drawer-regexp)))
12276 (forward-line)
12277 (while (looking-at org-drawer-regexp)
12278 (goto-char (match-end 0))
12279 (re-search-forward org-property-end-re (point-max) t)
12280 (forward-line))
12281 (forward-line -1)))
12282 (unless org-log-states-order-reversed
12284 (org-skip-over-state-notes)
12286 (move-marker org-log-note-marker (point))
12287 (setq org-log-note-purpose purpose
12288 org-log-note-state state
12289 org-log-note-previous-state prev-state
12290 org-log-note-how how
12291 org-log-note-extra extra
12292 org-log-note-effective-time (org-current-effective-time))
12293 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12295 (defun org-skip-over-state-notes ()
12296 "Skip past the list of State notes in an entry."
12298 (when (ignore-errors (goto-char (org-in-item-p)))
12299 (let* ((struct (org-list-struct))
12300 (prevs (org-list-prevs-alist struct)))
12302 (goto-char (or (org-list-get-next-item (point) struct prevs)
12303 (org-list-get-item-end (point) struct)))))))
12305 (defun org-add-log-note (&optional purpose)
12306 "Pop up a window for taking a note, and add this note later at point."
12307 (remove-hook 'post-command-hook 'org-add-log-note)
12308 (setq org-log-note-window-configuration (current-window-configuration))
12309 (delete-other-windows)
12310 (move-marker org-log-note-return-to (point))
12311 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12312 (goto-char org-log-note-marker)
12313 (org-switch-to-buffer-other-window "*Org Note*")
12314 (erase-buffer)
12315 (if (memq org-log-note-how '(time state))
12316 (let (current-prefix-arg) (org-store-log-note))
12317 (let ((org-inhibit-startup t)) (org-mode))
12318 (insert (format "# Insert note for %s.
12320 (cond
12321 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12322 ((eq org-log-note-purpose 'done) "closed todo item")
12323 ((eq org-log-note-purpose 'state)
12325 (or org-log-note-previous-state "")
12326 (or org-log-note-state "")))
12327 ((eq org-log-note-purpose 'reschedule)
12328 "rescheduling")
12329 ((eq org-log-note-purpose 'delschedule)
12330 "no longer scheduled")
12331 ((eq org-log-note-purpose 'redeadline)
12332 "changing deadline")
12333 ((eq org-log-note-purpose 'deldeadline)
12334 "removing deadline")
12335 ((eq org-log-note-purpose 'refile)
12336 "refiling")
12337 ((eq org-log-note-purpose 'note)
12338 "this entry")
12339 (t (error "This should not happen")))))
12340 (if org-log-note-extra (insert org-log-note-extra))
12341 (org-set-local 'org-finish-function 'org-store-log-note)
12342 (run-hooks 'org-log-buffer-setup-hook)))
12344 (defvar org-note-abort nil) ; dynamically scoped
12345 (defun org-store-log-note ()
12346 "Finish taking a log note, and insert it to where it belongs."
12347 (let ((txt (buffer-string))
12348 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12349 lines ind bul)
12350 (kill-buffer (current-buffer))
12352 (setq txt (replace-match "" t t txt)))
12354 (setq txt (replace-match "" t t txt)))
12357 (setq note
12358 (org-replace-escapes
12359 note
12360 (list (cons "%u" (user-login-name))
12361 (cons "%U" user-full-name)
12362 (cons "%t" (format-time-string
12363 (org-time-stamp-format 'long 'inactive)
12364 org-log-note-effective-time))
12365 (cons "%T" (format-time-string
12366 (org-time-stamp-format 'long nil)
12367 org-log-note-effective-time))
12368 (cons "%d" (format-time-string
12369 (org-time-stamp-format nil 'inactive)
12370 org-log-note-effective-time))
12371 (cons "%D" (format-time-string
12372 (org-time-stamp-format nil nil)
12373 org-log-note-effective-time))
12374 (cons "%s" (if org-log-note-state
12376 ""))
12377 (cons "%S" (if org-log-note-previous-state
12381 (push note lines))
12382 (when (or current-prefix-arg org-note-abort)
12383 (when org-log-into-drawer
12384 (org-remove-empty-drawer-at
12385 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12386 org-log-note-marker))
12387 (setq lines nil))
12388 (when lines
12389 (with-current-buffer (marker-buffer org-log-note-marker)
12390 (save-excursion
12391 (goto-char org-log-note-marker)
12392 (move-marker org-log-note-marker nil)
12393 (end-of-line 1)
12395 (setq ind (save-excursion
12396 (if (ignore-errors (goto-char (org-in-item-p)))
12397 (let ((struct (org-list-struct)))
12398 (org-list-get-ind
12399 (org-list-get-top-point struct) struct))
12401 (cond
12402 ((and (org-at-heading-p)
12403 org-adapt-indentation)
12404 (1+ (org-current-level)))
12405 ((org-at-heading-p) 0)
12406 (t (org-get-indentation))))))
12407 (setq bul (org-list-bullet-string "-"))
12408 (org-indent-line-to ind)
12409 (insert bul (pop lines))
12410 (let ((ind-body (+ (length bul) ind)))
12411 (while lines
12413 (org-indent-line-to ind-body)
12414 (insert (pop lines))))
12415 (message "Note stored")
12416 (org-back-to-heading t)
12417 (org-cycle-hide-drawers 'children)))))
12418 (set-window-configuration org-log-note-window-configuration)
12419 (with-current-buffer (marker-buffer org-log-note-return-to)
12420 (goto-char org-log-note-return-to))
12421 (move-marker org-log-note-return-to nil)
12422 (and org-log-post-message (message "%s" org-log-post-message)))
12424 (defun org-remove-empty-drawer-at (drawer pos)
12425 "Remove an empty drawer DRAWER at position POS.
12426 POS may also be a marker."
12427 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12428 (save-excursion
12429 (save-restriction
12430 (widen)
12431 (goto-char pos)
12432 (if (org-in-regexp
12434 (replace-match ""))))))
12436 (defun org-sparse-tree (&optional arg)
12437 "Create a sparse tree, prompt for the details.
12438 This command can create sparse trees. You first need to select the type
12439 of match used to create the tree:
12441 t Show all TODO entries.
12442 T Show entries with a specific TODO keyword.
12443 m Show entries selected by a tags/property match.
12444 p Enter a property name and its value (both with completion on existing
12445 names/values) and show entries with that property.
12446 r Show entries matching a regular expression (`/' can be used as well)
12447 d Show deadlines due within `org-deadline-warning-days'.
12448 b Show deadlines and scheduled items before a date.
12449 a Show deadlines and scheduled items after a date."
12450 (interactive "P")
12451 (let (ans kwd value)
12452 (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")
12453 (setq ans (read-char-exclusive))
12454 (cond
12455 ((equal ans ?d)
12456 (call-interactively 'org-check-deadlines))
12457 ((equal ans ?b)
12458 (call-interactively 'org-check-before-date))
12459 ((equal ans ?a)
12460 (call-interactively 'org-check-after-date))
12461 ((equal ans ?D)
12462 (call-interactively 'org-check-dates-range))
12463 ((equal ans ?t)
12464 (org-show-todo-tree nil))
12465 ((equal ans ?T)
12466 (org-show-todo-tree '(4)))
12467 ((member ans '(?T ?m))
12468 (call-interactively 'org-match-sparse-tree))
12469 ((member ans '(?p ?P))
12470 (setq kwd (org-icompleting-read "Property: "
12471 (mapcar 'list (org-buffer-property-keys))))
12472 (setq value (org-icompleting-read "Value: "
12473 (mapcar 'list (org-property-values kwd))))
12476 (org-match-sparse-tree arg (concat kwd "=" value)))
12477 ((member ans '(?r ?R ?/))
12478 (call-interactively 'org-occur))
12481 (defvar org-occur-highlights nil
12482 "List of overlays used for occur matches.")
12483 (make-variable-buffer-local 'org-occur-highlights)
12484 (defvar org-occur-parameters nil
12485 "Parameters of the active org-occur calls.
12486 This is a list, each call to org-occur pushes as cons cell,
12487 containing the regular expression and the callback, onto the list.
12488 The list can contain several entries if `org-occur' has been called
12489 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12490 will only contain one set of parameters. When the highlights are
12491 removed (for example with `C-c C-c', or with the next edit (depending
12492 on `org-remove-highlights-with-change'), this variable is emptied
12493 as well.")
12494 (make-variable-buffer-local 'org-occur-parameters)
12496 (defun org-occur (regexp &optional keep-previous callback)
12497 "Make a compact tree which shows all matches of REGEXP.
12498 The tree will show the lines where the regexp matches, and all higher
12499 headlines above the match. It will also show the heading after the match,
12500 to make sure editing the matching entry is easy.
12501 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12502 call to `org-occur' will be kept, to allow stacking of calls to this
12503 command.
12504 If CALLBACK is non-nil, it is a function which is called to confirm
12505 that the match should indeed be shown."
12507 (when (equal regexp "")
12508 (error "Regexp cannot be empty"))
12509 (unless keep-previous
12510 (org-remove-occur-highlights nil nil t))
12511 (push (cons regexp callback) org-occur-parameters)
12512 (let ((cnt 0))
12513 (save-excursion
12514 (goto-char (point-min))
12515 (if (or (not keep-previous) ; do not want to keep
12516 (not org-occur-highlights)) ; no previous matches
12517 ;; hide everything
12518 (org-overview))
12519 (while (re-search-forward regexp nil t)
12520 (when (or (not callback)
12521 (save-match-data (funcall callback)))
12522 (setq cnt (1+ cnt))
12523 (when org-highlight-sparse-tree-matches
12524 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12525 (org-show-context 'occur-tree))))
12526 (when org-remove-highlights-with-change
12527 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12528 nil 'local))
12529 (unless org-sparse-tree-open-archived-trees
12530 (org-hide-archived-subtrees (point-min) (point-max)))
12531 (run-hooks 'org-occur-hook)
12532 (if (org-called-interactively-p 'interactive)
12533 (message "%d match(es) for regexp %s" cnt regexp))
12534 cnt))
12536 (defun org-occur-next-match (&optional n reset)
12537 "Function for `next-error-function' to find sparse tree matches.
12538 N is the number of matches to move, when negative move backwards.
12539 RESET is entirely ignored - this function always goes back to the
12540 starting point when no match is found."
12541 (let* ((limit (if (< n 0) (point-min) (point-max)))
12542 (search-func (if (< n 0)
12543 'previous-single-char-property-change
12544 'next-single-char-property-change))
12545 (n (abs n))
12546 (pos (point))
12547 p1)
12548 (catch 'exit
12549 (while (setq p1 (funcall search-func (point) 'org-type))
12550 (when (equal p1 limit)
12551 (goto-char pos)
12552 (error "No more matches"))
12553 (when (equal (get-char-property p1 'org-type) 'org-occur)
12554 (setq n (1- n))
12555 (when (= n 0)
12556 (goto-char p1)
12557 (throw 'exit (point))))
12558 (goto-char p1))
12559 (goto-char p1)
12560 (error "No more matches"))))
12562 (defun org-show-context (&optional key)
12563 "Make sure point and context are visible.
12564 How much context is shown depends upon the variables
12565 `org-show-hierarchy-above', `org-show-following-heading',
12566 `org-show-entry-below' and `org-show-siblings'."
12567 (let ((heading-p (org-at-heading-p t))
12568 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12569 (following-p (org-get-alist-option org-show-following-heading key))
12570 (entry-p (org-get-alist-option org-show-entry-below key))
12571 (siblings-p (org-get-alist-option org-show-siblings key)))
12572 (catch 'exit
12573 ;; Show heading or entry text
12574 (if (and heading-p (not entry-p))
12575 (org-flag-heading nil) ; only show the heading
12576 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12577 (org-show-hidden-entry))) ; show entire entry
12578 (when following-p
12579 ;; Show next sibling, or heading below text
12580 (save-excursion
12581 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12582 (org-flag-heading nil))))
12583 (when siblings-p (org-show-siblings))
12584 (when hierarchy-p
12585 ;; show all higher headings, possibly with siblings
12586 (save-excursion
12587 (while (and (condition-case nil
12588 (progn (org-up-heading-all 1) t)
12589 (error nil))
12590 (not (bobp)))
12591 (org-flag-heading nil)
12592 (when siblings-p (org-show-siblings))))))))
12594 (defvar org-reveal-start-hook nil
12595 "Hook run before revealing a location.")
12597 (defun org-reveal (&optional siblings)
12598 "Show current entry, hierarchy above it, and the following headline.
12599 This can be used to show a consistent set of context around locations
12600 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12601 not t for the search context.
12603 With optional argument SIBLINGS, on each level of the hierarchy all
12604 siblings are shown. This repairs the tree structure to what it would
12605 look like when opened with hierarchical calls to `org-cycle'.
12607 go to the parent and show the
12608 entire tree."
12609 (interactive "P")
12610 (run-hooks 'org-reveal-start-hook)
12611 (let ((org-show-hierarchy-above t)
12612 (org-show-following-heading t)
12613 (org-show-siblings (if siblings t org-show-siblings)))
12614 (org-show-context nil))
12615 (when (equal siblings '(16))
12616 (save-excursion
12617 (when (org-up-heading-safe)
12618 (org-show-subtree)
12619 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12621 (defun org-highlight-new-match (beg end)
12622 "Highlight from BEG to END and mark the highlight is an occur headline."
12623 (let ((ov (make-overlay beg end)))
12624 (overlay-put ov 'face 'secondary-selection)
12625 (overlay-put ov 'org-type 'org-occur)
12626 (push ov org-occur-highlights)))
12628 (defun org-remove-occur-highlights (&optional beg end noremove)
12629 "Remove the occur highlights from the buffer.
12630 BEG and END are ignored. If NOREMOVE is nil, remove this function
12631 from the `before-change-functions' in the current buffer."
12632 (interactive)
12633 (unless org-inhibit-highlight-removal
12634 (mapc 'delete-overlay org-occur-highlights)
12635 (setq org-occur-highlights nil)
12636 (setq org-occur-parameters nil)
12637 (unless noremove
12638 (remove-hook 'before-change-functions
12639 'org-remove-occur-highlights 'local))))
12641 ;;;; Priorities
12644 "Regular expression matching the priority indicator.")
12646 (defvar org-remove-priority-next-time nil)
12648 (defun org-priority-up ()
12649 "Increase the priority of the current item."
12650 (interactive)
12651 (org-priority 'up))
12653 (defun org-priority-down ()
12654 "Decrease the priority of the current item."
12655 (interactive)
12656 (org-priority 'down))
12658 (defun org-priority (&optional action)
12659 "Change the priority of an item by ARG.
12660 ACTION can be `set', `up', `down', or a character."
12661 (interactive)
12662 (unless org-enable-priority-commands
12663 (error "Priority commands are disabled"))
12664 (setq action (or action 'set))
12665 (let (current new news have remove)
12666 (save-excursion
12667 (org-back-to-heading t)
12668 (if (looking-at org-priority-regexp)
12669 (setq current (string-to-char (match-string 2))
12670 have t))
12671 (cond
12672 ((eq action 'remove)
12673 (setq remove t new ?\ ))
12674 ((or (eq action 'set)
12675 (if (featurep 'xemacs) (characterp action) (integerp action)))
12676 (if (not (eq action 'set))
12677 (setq new action)
12678 (message "Priority %c-%c, SPC to remove: "
12679 org-highest-priority org-lowest-priority)
12680 (save-match-data
12681 (setq new (read-char-exclusive))))
12682 (if (and (= (upcase org-highest-priority) org-highest-priority)
12683 (= (upcase org-lowest-priority) org-lowest-priority))
12684 (setq new (upcase new)))
12685 (cond ((equal new ?\ ) (setq remove t))
12686 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12687 (error "Priority must be between `%c' and `%c'"
12688 org-highest-priority org-lowest-priority))))
12689 ((eq action 'up)
12690 (setq new (if have
12691 (1- current) ; normal cycling
12692 ;; last priority was empty
12693 (if (eq last-command this-command)
12694 org-lowest-priority ; wrap around empty to lowest
12695 ;; default
12696 (if org-priority-start-cycle-with-default
12697 org-default-priority
12698 (1- org-default-priority))))))
12699 ((eq action 'down)
12700 (setq new (if have
12701 (1+ current) ; normal cycling
12702 ;; last priority was empty
12703 (if (eq last-command this-command)
12704 org-highest-priority ; wrap around empty to highest
12705 ;; default
12706 (if org-priority-start-cycle-with-default
12707 org-default-priority
12708 (1+ org-default-priority))))))
12709 (t (error "Invalid action")))
12710 (if (or (< (upcase new) org-highest-priority)
12711 (> (upcase new) org-lowest-priority))
12712 (if (and (memq action '(up down))
12713 (not have) (not (eq last-command this-command)))
12714 ;; `new' is from default priority
12715 (error
12716 "The default can not be set, see `org-default-priority' why")
12717 ;; normal cycling: `new' is beyond highest/lowest priority
12718 ;; and is wrapped around to the empty priority
12719 (setq remove t)))
12720 (setq news (format "%c" new))
12721 (if have
12722 (if remove
12723 (replace-match "" t t nil 1)
12724 (replace-match news t t nil 2))
12725 (if remove
12726 (error "No priority cookie found in line")
12727 (let ((case-fold-search nil))
12728 (looking-at org-todo-line-regexp))
12729 (if (match-end 2)
12730 (progn
12731 (goto-char (match-end 2))
12732 (insert " [#" news "]"))
12733 (goto-char (match-beginning 3))
12734 (insert "[#" news "] "))))
12735 (org-preserve-lc (org-set-tags nil 'align)))
12736 (if remove
12737 (message "Priority removed")
12738 (message "Priority of current item set to %s" news))))
12740 (defun org-get-priority (s)
12741 "Find priority cookie and return priority."
12742 (if (functionp org-get-priority-function)
12743 (funcall org-get-priority-function)
12744 (save-match-data
12745 (if (not (string-match org-priority-regexp s))
12746 (* 1000 (- org-lowest-priority org-default-priority))
12747 (* 1000 (- org-lowest-priority
12748 (string-to-char (match-string 2 s))))))))
12750 ;;;; Tags
12752 (defvar org-agenda-archives-mode)
12753 (defvar org-map-continue-from nil
12754 "Position from where mapping should continue.
12755 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12757 (defvar org-scanner-tags nil
12758 "The current tag list while the tags scanner is running.")
12759 (defvar org-trust-scanner-tags nil
12760 "Should `org-get-tags-at' use the tags for the scanner.
12761 This is for internal dynamical scoping only.
12762 When this is non-nil, the function `org-get-tags-at' will return the value
12763 of `org-scanner-tags' instead of building the list by itself. This
12764 can lead to large speed-ups when the tags scanner is used in a file with
12765 many entries, and when the list of tags is retrieved, for example to
12766 obtain a list of properties. Building the tags list for each entry in such
12767 a file becomes an N^2 operation - but with this variable set, it scales
12768 as N.")
12770 (defun org-scan-tags (action matcher todo-only &optional start-level)
12771 "Scan headline tags with inheritance and produce output ACTION.
12773 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12774 or `agenda' to produce an entry list for an agenda view. It can also be
12775 a Lisp form or a function that should be called at each matched headline, in
12776 this case the return value is a list of all return values from these calls.
12778 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12779 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12780 only lines with a not-done TODO keyword are included in the output.
12781 This should be the same variable that was scoped into
12782 and set by `org-make-tags-matcher' when it constructed MATCHER.
12784 START-LEVEL can be a string with asterisks, reducing the scope to
12785 headlines matching this string."
12786 (require 'org-agenda)
12787 (let* ((re (concat "^"
12788 (if start-level
12789 ;; Get the correct level to match
12791 org-outline-regexp)
12794 (org-re
12796 (props (list 'face 'default
12797 'done-face 'org-agenda-done
12798 'undone-face 'default
12799 'mouse-face 'highlight
12800 'org-not-done-regexp org-not-done-regexp
12801 'org-todo-regexp org-todo-regexp
12802 'org-complex-heading-regexp org-complex-heading-regexp
12803 'help-echo
12804 (format "mouse-2 or RET jump to org file %s"
12805 (abbreviate-file-name
12806 (or (buffer-file-name (buffer-base-buffer))
12807 (buffer-name (buffer-base-buffer)))))))
12808 (case-fold-search nil)
12809 (org-map-continue-from nil)
12810 lspos tags tags-list
12811 (tags-alist (list (cons 0 org-file-tags)))
12812 (llast 0) rtn rtn1 level category i txt
12813 todo marker entry priority)
12814 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12815 (setq action (list 'lambda nil action)))
12816 (save-excursion
12817 (goto-char (point-min))
12818 (when (eq action 'sparse-tree)
12819 (org-overview)
12820 (org-remove-occur-highlights))
12821 (while (re-search-forward re nil t)
12822 (setq org-map-continue-from nil)
12823 (catch :skip
12824 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12825 tags (if (match-end 4) (org-match-string-no-properties 4)))
12826 (goto-char (setq lspos (match-beginning 0)))
12827 (setq level (org-reduced-level (funcall outline-level))
12828 category (org-get-category))
12829 (setq i llast llast level)
12830 ;; remove tag lists from same and sublevels
12831 (while (>= i level)
12832 (when (setq entry (assoc i tags-alist))
12833 (setq tags-alist (delete entry tags-alist)))
12834 (setq i (1- i)))
12835 ;; add the next tags
12836 (when tags
12837 (setq tags (org-split-string tags ":")
12838 tags-alist
12839 (cons (cons level tags) tags-alist)))
12840 ;; compile tags for current headline
12841 (setq tags-list
12842 (if org-use-tag-inheritance
12843 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12844 tags)
12845 org-scanner-tags tags-list)
12846 (when org-use-tag-inheritance
12847 (setcdr (car tags-alist)
12848 (mapcar (lambda (x)
12849 (setq x (copy-sequence x))
12850 (org-add-prop-inherited x))
12851 (cdar tags-alist))))
12852 (when (and tags org-use-tag-inheritance
12853 (or (not (eq t org-use-tag-inheritance))
12854 org-tags-exclude-from-inheritance))
12855 ;; selective inheritance, remove uninherited ones
12856 (setcdr (car tags-alist)
12857 (org-remove-uninherited-tags (cdar tags-alist))))
12858 (when (and
12860 ;; eval matcher only when the todo condition is OK
12861 (and (or (not todo-only) (member todo org-not-done-keywords))
12862 (let ((case-fold-search t)) (eval matcher)))
12864 ;; Call the skipper, but return t if it does not skip,
12865 ;; so that the `and' form continues evaluating
12866 (progn
12867 (unless (eq action 'sparse-tree) (org-agenda-skip))
12868 t)
12870 ;; Check if timestamps are deselecting this entry
12871 (or (not todo-only)
12872 (and (member todo org-not-done-keywords)
12873 (or (not org-agenda-tags-todo-honor-ignore-options)
12874 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12876 ;; Extra check for the archive tag
12877 ;; FIXME: Does the skipper already do this????
12878 (or
12879 (not (member org-archive-tag tags-list))
12880 ;; we have an archive tag, should we use this anyway?
12881 (or (not org-agenda-skip-archived-trees)
12882 (and (eq action 'agenda) org-agenda-archives-mode))))
12884 ;; select this headline
12886 (cond
12887 ((eq action 'sparse-tree)
12888 (and org-highlight-sparse-tree-matches
12889 (org-get-heading) (match-end 0)
12890 (org-highlight-new-match
12891 (match-beginning 1) (match-end 1)))
12892 (org-show-context 'tags-tree))
12893 ((eq action 'agenda)
12894 (setq txt (org-agenda-format-item
12895 ""
12896 (concat
12897 (if (eq org-tags-match-list-sublevels 'indented)
12898 (make-string (1- level) ?.) "")
12899 (org-get-heading))
12900 category
12901 tags-list
12902 )
12903 priority (org-get-priority txt))
12904 (goto-char lspos)
12905 (setq marker (org-agenda-new-marker))
12906 (org-add-props txt props
12907 'org-marker marker 'org-hd-marker marker 'org-category category
12908 'todo-state todo
12909 'priority priority 'type "tagsmatch")
12910 (push txt rtn))
12911 ((functionp action)
12912 (setq org-map-continue-from nil)
12913 (save-excursion
12914 (setq rtn1 (funcall action))
12915 (push rtn1 rtn)))
12916 (t (error "Invalid action")))
12918 ;; if we are to skip sublevels, jump to end of subtree
12919 (unless org-tags-match-list-sublevels
12920 (org-end-of-subtree t)
12921 (backward-char 1))))
12922 ;; Get the correct position from where to continue
12923 (if org-map-continue-from
12924 (goto-char org-map-continue-from)
12925 (and (= (point) lspos) (end-of-line 1)))))
12926 (when (and (eq action 'sparse-tree)
12927 (not org-sparse-tree-open-archived-trees))
12928 (org-hide-archived-subtrees (point-min) (point-max)))
12929 (nreverse rtn)))
12931 (defun org-remove-uninherited-tags (tags)
12932 "Remove all tags that are not inherited from the list TAGS."
12933 (cond
12934 ((eq org-use-tag-inheritance t)
12935 (if org-tags-exclude-from-inheritance
12936 (org-delete-all org-tags-exclude-from-inheritance tags)
12937 tags))
12938 ((not org-use-tag-inheritance) nil)
12939 ((stringp org-use-tag-inheritance)
12940 (delq nil (mapcar
12941 (lambda (x)
12942 (if (and (string-match org-use-tag-inheritance x)
12943 (not (member x org-tags-exclude-from-inheritance)))
12944 x nil))
12945 tags)))
12946 ((listp org-use-tag-inheritance)
12947 (delq nil (mapcar
12948 (lambda (x)
12949 (if (member x org-use-tag-inheritance) x nil))
12950 tags)))))
12952 (defun org-match-sparse-tree (&optional todo-only match)
12953 "Create a sparse tree according to tags string MATCH.
12954 MATCH can contain positive and negative selection of tags, like
12956 If optional argument TODO-ONLY is non-nil, only select lines that are
12957 also TODO lines."
12958 (interactive "P")
12959 (org-prepare-agenda-buffers (list (current-buffer)))
12960 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12962 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12964 (defvar org-cached-props nil)
12965 (defun org-cached-entry-get (pom property)
12966 (if (or (eq t org-use-property-inheritance)
12967 (and (stringp org-use-property-inheritance)
12968 (string-match org-use-property-inheritance property))
12969 (and (listp org-use-property-inheritance)
12970 (member property org-use-property-inheritance)))
12971 ;; Caching is not possible, check it directly
12972 (org-entry-get pom property 'inherit)
12973 ;; Get all properties, so that we can do complicated checks easily
12974 (cdr (assoc property (or org-cached-props
12975 (setq org-cached-props
12976 (org-entry-properties pom)))))))
12978 (defun org-global-tags-completion-table (&optional files)
12979 "Return the list of all tags in all agenda buffer/files.
12980 Optional FILES argument is a list of files to which can be used
12981 instead of the agenda files."
12982 (save-excursion
12983 (org-uniquify
12984 (delq nil
12985 (apply 'append
12986 (mapcar
12987 (lambda (file)
12988 (set-buffer (find-file-noselect file))
12989 (append (org-get-buffer-tags)
12990 (mapcar (lambda (x) (if (stringp (car-safe x))
12991 (list (car-safe x)) nil))
12992 org-tag-alist)))
12993 (if (and files (car files))
12994 files
12995 (org-agenda-files))))))))
12997 (defun org-make-tags-matcher (match)
12998 "Create the TAGS/TODO matcher form for the selection string MATCH.
13000 The variable `todo-only' is scoped dynamically into this function; it will be
13001 set to t if the matcher restricts matching to TODO entries,
13002 otherwise will not be touched.
13004 Returns a cons of the selection string MATCH and the constructed
13005 lisp form implementing the matcher. The matcher is to be
13006 evaluated at an Org entry, with point on the headline,
13007 and returns t if the entry matches the
13008 selection string MATCH. The returned lisp form references
13009 two variables with information about the entry, which must be
13010 bound around the form's evaluation: todo, the TODO keyword at the
13011 entry (or nil of none); and tags-list, the list of all tags at the
13012 entry including inherited ones. Additionally, the category
13013 of the entry (if any) must be specified as the text property
13014 'org-category on the headline.
13016 See also `org-scan-tags'.
13017 "
13018 (declare (special todo-only))
13019 (unless (boundp 'todo-only)
13020 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13021 (unless match
13022 ;; Get a new match request, with completion
13023 (let ((org-last-tags-completion-table
13024 (org-global-tags-completion-table)))
13025 (setq match (org-completing-read-no-i
13026 "Match: " 'org-tags-completion-function nil nil nil
13027 'org-tags-history))))
13029 ;; Parse the string and create a lisp form
13030 (let ((match0 match)
13031 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13032 minus tag mm
13033 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13034 orterms term orlist re-p str-p level-p level-op time-p
13035 prop-p pn pv po gv rest)
13036 (if (string-match "/+" match)
13037 ;; match contains also a todo-matching request
13038 (progn
13039 (setq tagsmatch (substring match 0 (match-beginning 0))
13040 todomatch (substring match (match-end 0)))
13041 (if (string-match "^!" todomatch)
13042 (setq todo-only t todomatch (substring todomatch 1)))
13044 (setq todomatch nil)))
13045 ;; only matching tags
13046 (setq tagsmatch match todomatch nil))
13048 ;; Make the tags matcher
13050 (setq tagsmatcher t)
13051 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13052 (while (setq term (pop orterms))
13054 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13055 (while (string-match re term)
13056 (setq rest (substring term (match-end 0))
13057 minus (and (match-end 1)
13058 (equal (match-string 1 term) "-"))
13059 tag (save-match-data (replace-regexp-in-string
13061 (match-string 2 term)))
13062 re-p (equal (string-to-char tag) ?{)
13063 level-p (match-end 4)
13064 prop-p (match-end 5)
13065 mm (cond
13066 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13067 (level-p
13068 (setq level-op (org-op-to-function (match-string 3 term)))
13069 `(,level-op level ,(string-to-number
13070 (match-string 4 term))))
13071 (prop-p
13072 (setq pn (match-string 5 term)
13073 po (match-string 6 term)
13074 pv (match-string 7 term)
13075 re-p (equal (string-to-char pv) ?{)
13077 time-p (save-match-data
13079 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13080 (if time-p (setq pv (org-matcher-time pv)))
13081 (setq po (org-op-to-function po (if time-p 'time str-p)))
13082 (cond
13083 ((equal pn "CATEGORY")
13084 (setq gv '(get-text-property (point) 'org-category)))
13085 ((equal pn "TODO")
13086 (setq gv 'todo))
13087 (t
13088 (setq gv `(org-cached-entry-get nil ,pn))))
13089 (if re-p
13090 (if (eq po 'org<>)
13091 `(not (string-match ,pv (or ,gv "")))
13092 `(string-match ,pv (or ,gv "")))
13093 (if str-p
13094 `(,po (or ,gv "") ,pv)
13095 `(,po (string-to-number (or ,gv ""))
13096 ,(string-to-number pv) ))))
13097 (t `(member ,tag tags-list)))
13098 mm (if minus (list 'not mm) mm)
13099 term rest)
13100 (push mm tagsmatcher))
13101 (push (if (> (length tagsmatcher) 1)
13102 (cons 'and tagsmatcher)
13103 (car tagsmatcher))
13104 orlist)
13105 (setq tagsmatcher nil))
13106 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13107 (setq tagsmatcher
13108 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13109 ;; Make the todo matcher
13111 (setq todomatcher t)
13112 (setq orterms (org-split-string todomatch "|") orlist nil)
13113 (while (setq term (pop orterms))
13114 (while (string-match re term)
13115 (setq minus (and (match-end 1)
13116 (equal (match-string 1 term) "-"))
13117 kwd (match-string 2 term)
13118 re-p (equal (string-to-char kwd) ?{)
13119 term (substring term (match-end 0))
13120 mm (if re-p
13121 `(string-match ,(substring kwd 1 -1) todo)
13122 (list 'equal 'todo kwd))
13123 mm (if minus (list 'not mm) mm))
13124 (push mm todomatcher))
13125 (push (if (> (length todomatcher) 1)
13126 (cons 'and todomatcher)
13127 (car todomatcher))
13128 orlist)
13129 (setq todomatcher nil))
13130 (setq todomatcher (if (> (length orlist) 1)
13131 (cons 'or orlist) (car orlist))))
13133 ;; Return the string and lisp forms of the matcher
13134 (setq matcher (if todomatcher
13135 (list 'and tagsmatcher todomatcher)
13136 tagsmatcher))
13137 (when todo-only
13138 (setq matcher (list 'and '(member todo org-not-done-keywords)
13139 matcher)))
13140 (cons match0 matcher)))
13142 (defun org-op-to-function (op &optional stringp)
13143 "Turn an operator into the appropriate function."
13144 (setq op
13145 (cond
13146 ((equal op "<" ) '(< string< org-time<))
13147 ((equal op ">" ) '(> org-string> org-time>))
13148 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13149 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13150 ((member op '("=" "==")) '(= string= org-time=))
13151 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13152 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13154 (defun org<> (a b) (not (= a b)))
13155 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13156 (defun org-string>= (a b) (not (string< a b)))
13157 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13158 (defun org-string<> (a b) (not (string= 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) (> a b)))
13163 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13164 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13165 (defun org-2ft (s)
13166 "Convert S to a floating point time.
13167 If S is already a number, just return it. If it is a string, parse
13168 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13169 (cond
13170 ((numberp s) s)
13171 ((stringp s)
13172 (condition-case nil
13173 (float-time (apply 'encode-time (org-parse-time-string s)))
13174 (error 0.)))
13175 (t 0.)))
13177 (defun org-time-today ()
13178 "Time in seconds today at 0:00.
13179 Returns the float number of seconds since the beginning of the
13180 epoch to the beginning of today (00:00)."
13181 (float-time (apply 'encode-time
13182 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13184 (defun org-matcher-time (s)
13185 "Interpret a time comparison value."
13186 (save-match-data
13187 (cond
13188 ((string= s "<now>") (float-time))
13189 ((string= s "<today>") (org-time-today))
13190 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13191 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13193 (+ (org-time-today)
13194 (* (string-to-number (match-string 1 s))
13195 (cdr (assoc (match-string 2 s)
13196 '(("d" . 86400.0) ("w" . 604800.0)
13197 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13198 (t (org-2ft s)))))
13200 (defun org-match-any-p (re list)
13201 "Does re match any element of list?"
13202 (setq list (mapcar (lambda (x) (string-match re x)) list))
13203 (delq nil list))
13205 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13206 (defvar org-tags-overlay (make-overlay 1 1))
13207 (org-detach-overlay org-tags-overlay)
13209 (defun org-get-local-tags-at (&optional pos)
13210 "Get a list of tags defined in the current headline."
13211 (org-get-tags-at pos 'local))
13213 (defun org-get-local-tags ()
13214 "Get a list of tags defined in the current headline."
13215 (org-get-tags-at nil 'local))
13217 (defun org-get-tags-at (&optional pos local)
13218 "Get a list of all headline tags applicable at POS.
13219 POS defaults to point. If tags are inherited, the list contains
13220 the targets in the same sequence as the headlines appear, i.e.
13221 the tags of the current headline come last.
13222 When LOCAL is non-nil, only return tags from the current headline,
13223 ignore inherited ones."
13224 (interactive)
13225 (if (and org-trust-scanner-tags
13226 (or (not pos) (equal pos (point)))
13227 (not local))
13228 org-scanner-tags
13229 (let (tags ltags lastpos parent)
13230 (save-excursion
13231 (save-restriction
13232 (widen)
13233 (goto-char (or pos (point)))
13234 (save-match-data
13235 (catch 'done
13236 (condition-case nil
13237 (progn
13238 (org-back-to-heading t)
13239 (while (not (equal lastpos (point)))
13240 (setq lastpos (point))
13241 (when (looking-at
13243 (setq ltags (org-split-string
13244 (org-match-string-no-properties 1) ":"))
13245 (when parent
13246 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13247 (setq tags (append
13248 (if parent
13249 (org-remove-uninherited-tags ltags)
13250 ltags)
13251 tags)))
13252 (or org-use-tag-inheritance (throw 'done t))
13253 (if local (throw 'done t))
13254 (or (org-up-heading-safe) (error nil))
13255 (setq parent t)))
13256 (error nil)))))
13257 (if local
13258 tags
13259 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13261 (defun org-add-prop-inherited (s)
13262 (add-text-properties 0 (length s) '(inherited t) s)
13263 s)
13265 (defun org-toggle-tag (tag &optional onoff)
13266 "Toggle the tag TAG for the current line.
13267 If ONOFF is `on' or `off', don't toggle but set to this state."
13268 (let (res current)
13269 (save-excursion
13270 (org-back-to-heading t)
13272 (point-at-eol) t)
13273 (progn
13274 (setq current (match-string 1))
13275 (replace-match ""))
13276 (setq current ""))
13277 (setq current (nreverse (org-split-string current ":")))
13278 (cond
13279 ((eq onoff 'on)
13280 (setq res t)
13281 (or (member tag current) (push tag current)))
13282 ((eq onoff 'off)
13283 (or (not (member tag current)) (setq current (delete tag current))))
13284 (t (if (member tag current)
13285 (setq current (delete tag current))
13286 (setq res t)
13287 (push tag current))))
13288 (end-of-line 1)
13289 (if current
13290 (progn
13291 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13292 (org-set-tags nil t))
13293 (delete-horizontal-space))
13294 (run-hooks 'org-after-tags-change-hook))
13295 res))
13297 (defun org-align-tags-here (to-col)
13298 ;; Assumes that this is a headline
13299 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13300 (beginning-of-line 1)
13302 (< pos (match-beginning 2)))
13303 (progn
13304 (setq tags-l (- (match-end 2) (match-beginning 2)))
13305 (goto-char (match-beginning 1))
13306 (insert " ")
13307 (delete-region (point) (1+ (match-beginning 2)))
13308 (setq ncol (max (current-column)
13309 (1+ col)
13310 (if (> to-col 0)
13311 to-col
13312 (- (abs to-col) tags-l))))
13313 (setq p (point))
13314 (insert (make-string (- ncol (current-column)) ?\ ))
13315 (setq ncol (current-column))
13316 (when indent-tabs-mode (tabify p (point-at-eol)))
13317 (org-move-to-column (min ncol col) t))
13318 (goto-char pos))))
13320 (defun org-set-tags-command (&optional arg just-align)
13321 "Call the set-tags command for the current entry."
13322 (interactive "P")
13323 (if (org-at-heading-p)
13324 (org-set-tags arg just-align)
13325 (save-excursion
13326 (org-back-to-heading t)
13327 (org-set-tags arg just-align))))
13329 (defun org-set-tags-to (data)
13330 "Set the tags of the current entry to DATA, replacing the current tags.
13331 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13332 If DATA is nil or the empty string, any tags will be removed."
13333 (interactive "sTags: ")
13334 (setq data
13335 (cond
13336 ((eq data nil) "")
13337 ((equal data "") "")
13338 ((stringp data)
13339 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13340 ":"))
13341 ((listp data)
13342 (concat ":" (mapconcat 'identity data ":") ":"))
13343 (t nil)))
13344 (when data
13345 (save-excursion
13346 (org-back-to-heading t)
13347 (when (looking-at org-complex-heading-regexp)
13348 (if (match-end 5)
13349 (progn
13350 (goto-char (match-beginning 5))
13351 (insert data)
13352 (delete-region (point) (point-at-eol))
13353 (org-set-tags nil 'align))
13354 (goto-char (point-at-eol))
13355 (insert " " data)
13356 (org-set-tags nil 'align)))
13357 (beginning-of-line 1)
13359 (delete-region (match-beginning 1) (match-end 1))))))
13361 (defun org-align-all-tags ()
13362 "Align the tags i all headings."
13363 (interactive)
13364 (save-excursion
13365 (or (ignore-errors (org-back-to-heading t))
13366 (outline-next-heading))
13367 (if (org-at-heading-p)
13368 (org-set-tags t)
13369 (message "No headings"))))
13371 (defvar org-indent-indentation-per-level)
13372 (defun org-set-tags (&optional arg just-align)
13373 "Set the tags for the current headline.
13374 With prefix ARG, realign all tags in headings in the current buffer."
13375 (interactive "P")
13376 (let* ((re org-outline-regexp-bol)
13377 (current (org-get-tags-string))
13378 (col (current-column))
13379 (org-setting-tags t)
13380 table current-tags inherited-tags ; computed below when needed
13381 tags p0 c0 c1 rpl di tc level)
13382 (if arg
13383 (save-excursion
13384 (goto-char (point-min))
13385 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13386 (while (re-search-forward re nil t)
13387 (org-set-tags nil t)
13388 (end-of-line 1)))
13389 (message "All tags realigned to column %d" org-tags-column))
13390 (if just-align
13391 (setq tags current)
13392 ;; Get a new set of tags from the user
13393 (save-excursion
13394 (setq table (append org-tag-persistent-alist
13395 org-tag-alist
13396 (org-get-buffer-tags)
13397 (and
13398 org-complete-tags-always-offer-all-agenda-tags
13399 (org-global-tags-completion-table
13400 (org-agenda-files))))
13401 org-last-tags-completion-table table
13402 current-tags (org-split-string current ":")
13403 inherited-tags (nreverse
13404 (nthcdr (length current-tags)
13405 (nreverse (org-get-tags-at))))
13406 tags
13407 (if (or (eq t org-use-fast-tag-selection)
13408 (and org-use-fast-tag-selection
13409 (delq nil (mapcar 'cdr table))))
13410 (org-fast-tag-selection
13411 current-tags inherited-tags table
13412 (if org-fast-tag-selection-include-todo
13413 org-todo-key-alist))
13414 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13415 (org-trim
13416 (org-icompleting-read "Tags: "
13417 'org-tags-completion-function
13418 nil nil current 'org-tags-history))))))
13419 (while (string-match "[-+&]+" tags)
13420 ;; No boolean logic, just a list
13421 (setq tags (replace-match ":" t t tags))))
13423 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13425 (if org-tags-sort-function
13426 (setq tags (mapconcat 'identity
13427 (sort (org-split-string
13428 tags (org-re "[^[:alnum:]_@#%]+"))
13429 org-tags-sort-function) ":")))
13432 (setq tags "")
13433 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13434 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13436 ;; Insert new tags at the correct column
13437 (beginning-of-line 1)
13438 (setq level (or (and (looking-at org-outline-regexp)
13439 (- (match-end 0) (point) 1))
13440 1))
13441 (cond
13442 ((and (equal current "") (equal tags "")))
13443 ((re-search-forward
13445 (point-at-eol) t)
13446 (if (equal tags "")
13447 (setq rpl "")
13448 (goto-char (match-beginning 0))
13449 (setq c0 (current-column)
13450 ;; compute offset for the case of org-indent-mode active
13451 di (if org-indent-mode
13452 (* (1- org-indent-indentation-per-level) (1- level))
13453 0)
13454 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13455 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13456 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13457 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13458 (replace-match rpl t t)
13459 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13460 tags)
13461 (t (error "Tags alignment failed")))
13462 (org-move-to-column col)
13463 (unless just-align
13464 (run-hooks 'org-after-tags-change-hook)))))
13466 (defun org-change-tag-in-region (beg end tag off)
13467 "Add or remove TAG for each entry in the region.
13468 This works in the agenda, and also in an org-mode buffer."
13469 (interactive
13470 (list (region-beginning) (region-end)
13471 (let ((org-last-tags-completion-table
13472 (if (eq major-mode 'org-mode)
13473 (org-get-buffer-tags)
13474 (org-global-tags-completion-table))))
13475 (org-icompleting-read
13476 "Tag: " 'org-tags-completion-function nil nil nil
13477 'org-tags-history))
13478 (progn
13480 (equal (read-char-exclusive) ?r))))
13481 (if (fboundp 'deactivate-mark) (deactivate-mark))
13482 (let ((agendap (equal major-mode 'org-agenda-mode))
13483 l1 l2 m buf pos newhead (cnt 0))
13484 (goto-char end)
13485 (setq l2 (1- (org-current-line)))
13486 (goto-char beg)
13487 (setq l1 (org-current-line))
13488 (loop for l from l1 to l2 do
13489 (org-goto-line l)
13490 (setq m (get-text-property (point) 'org-hd-marker))
13491 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13492 (and agendap m))
13493 (setq buf (if agendap (marker-buffer m) (current-buffer))
13494 pos (if agendap m (point)))
13495 (with-current-buffer buf
13496 (save-excursion
13497 (save-restriction
13498 (goto-char pos)
13499 (setq cnt (1+ cnt))
13500 (org-toggle-tag tag (if off 'off 'on))
13501 (setq newhead (org-get-heading)))))
13502 (and agendap (org-agenda-change-all-lines newhead m))))
13503 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13505 (defun org-tags-completion-function (string predicate &optional flag)
13506 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13507 (confirm (lambda (x) (stringp (car x)))))
13509 (setq s1 (match-string 1 string)
13510 s2 (match-string 2 string))
13511 (setq s1 "" s2 string))
13512 (cond
13513 ((eq flag nil)
13514 ;; try completion
13515 (setq rtn (try-completion s2 ctable confirm))
13516 (if (stringp rtn)
13517 (setq rtn
13518 (concat s1 s2 (substring rtn (length s2))
13519 (if (and org-add-colon-after-tag-completion
13520 (assoc rtn ctable))
13521 ":" ""))))
13522 rtn)
13523 ((eq flag t)
13524 ;; all-completions
13525 (all-completions s2 ctable confirm)
13526 )
13527 ((eq flag 'lambda)
13528 ;; exact match?
13529 (assoc s2 ctable)))
13530 ))
13532 (defun org-fast-tag-insert (kwd tags face &optional end)
13533 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13534 (insert (format "%-12s" (concat kwd ":"))
13535 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13536 (or end "")))
13538 (defun org-fast-tag-show-exit (flag)
13539 (save-excursion
13540 (org-goto-line 3)
13542 (replace-match ""))
13543 (when flag
13544 (end-of-line 1)
13545 (org-move-to-column (- (window-width) 19) t)
13546 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13548 (defun org-set-current-tags-overlay (current prefix)
13549 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13550 (if (featurep 'xemacs)
13551 (org-overlay-display org-tags-overlay (concat prefix s)
13552 'secondary-selection)
13553 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13554 (org-overlay-display org-tags-overlay (concat prefix s)))))
13556 (defvar org-last-tag-selection-key nil)
13557 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13558 "Fast tag selection with single keys.
13559 CURRENT is the current list of tags in the headline, INHERITED is the
13560 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13561 possibly with grouping information. TODO-TABLE is a similar table with
13562 TODO keywords, should these have keys assigned to them.
13563 If the keys are nil, a-z are automatically assigned.
13564 Returns the new tags string, or nil to not change the current settings."
13565 (let* ((fulltable (append table todo-table))
13566 (maxlen (apply 'max (mapcar
13567 (lambda (x)
13568 (if (stringp (car x)) (string-width (car x)) 0))
13569 fulltable)))
13570 (buf (current-buffer))
13571 (expert (eq org-fast-tag-selection-single-key 'expert))
13572 (buffer-tags nil)
13573 (fwidth (+ maxlen 3 1 3))
13574 (ncol (/ (- (window-width) 4) fwidth))
13575 (i-face 'org-done)
13576 (c-face 'org-todo)
13577 tg cnt e c char c1 c2 ntable tbl rtn
13578 ov-start ov-end ov-prefix
13579 (exit-after-next org-fast-tag-selection-single-key)
13580 (done-keywords org-done-keywords)
13581 groups ingroup)
13582 (save-excursion
13583 (beginning-of-line 1)
13584 (if (looking-at
13586 (setq ov-start (match-beginning 1)
13587 ov-end (match-end 1)
13588 ov-prefix "")
13589 (setq ov-start (1- (point-at-eol))
13590 ov-end (1+ ov-start))
13592 (setq ov-prefix
13593 (concat
13594 (buffer-substring (1- (point)) (point))
13595 (if (> (current-column) org-tags-column)
13596 " "
13597 (make-string (- org-tags-column (current-column)) ?\ ))))))
13598 (move-overlay org-tags-overlay ov-start ov-end)
13599 (save-window-excursion
13600 (if expert
13601 (set-buffer (get-buffer-create " *Org tags*"))
13602 (delete-other-windows)
13603 (split-window-vertically)
13604 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13605 (erase-buffer)
13606 (org-set-local 'org-done-keywords done-keywords)
13609 (org-fast-tag-show-exit exit-after-next)
13610 (org-set-current-tags-overlay current ov-prefix)
13611 (setq tbl fulltable char ?a cnt 0)
13612 (while (setq e (pop tbl))
13613 (cond
13614 ((equal (car e) :startgroup)
13615 (push '() groups) (setq ingroup t)
13616 (when (not (= cnt 0))
13617 (setq cnt 0)
13619 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13620 ((equal (car e) :endgroup)
13621 (setq ingroup nil cnt 0)
13623 ((equal e '(:newline))
13624 (when (not (= cnt 0))
13625 (setq cnt 0)
13627 (setq e (car tbl))
13628 (while (equal (car tbl) '(:newline))
13630 (setq tbl (cdr tbl)))))
13631 (t
13632 (setq tg (copy-sequence (car e)) c2 nil)
13633 (if (cdr e)
13634 (setq c (cdr e))
13635 ;; automatically assign a character.
13636 (setq c1 (string-to-char
13637 (downcase (substring
13638 tg (if (= (string-to-char tg) ?@) 1 0)))))
13639 (if (or (rassoc c1 ntable) (rassoc c1 table))
13640 (while (or (rassoc char ntable) (rassoc char table))
13641 (setq char (1+ char)))
13642 (setq c2 c1))
13643 (setq c (or c2 char)))
13644 (if ingroup (push tg (car groups)))
13645 (setq tg (org-add-props tg nil 'face
13646 (cond
13647 ((not (assoc tg table))
13648 (org-get-todo-face tg))
13649 ((member tg current) c-face)
13650 ((member tg inherited) i-face)
13651 (t nil))))
13652 (if (and (= cnt 0) (not ingroup)) (insert " "))
13653 (insert "[" c "] " tg (make-string
13654 (- fwidth 4 (length tg)) ?\ ))
13655 (push (cons tg c) ntable)
13656 (when (= (setq cnt (1+ cnt)) ncol)
13658 (if ingroup (insert " "))
13659 (setq cnt 0)))))
13660 (setq ntable (nreverse ntable))
13662 (goto-char (point-min))
13663 (if (not expert) (org-fit-window-to-buffer))
13664 (setq rtn
13665 (catch 'exit
13666 (while t
13667 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13668 (if (not groups) "no " "")
13669 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13670 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13671 (setq org-last-tag-selection-key c)
13672 (cond
13674 ((= c ?!)
13675 (setq groups (not groups))
13676 (goto-char (point-min))
13677 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13678 ((= c ?\C-c)
13679 (if (not expert)
13680 (org-fast-tag-show-exit
13681 (setq exit-after-next (not exit-after-next)))
13682 (setq expert nil)
13683 (delete-other-windows)
13684 (set-window-buffer (split-window-vertically) " *Org tags*")
13685 (org-switch-to-buffer-other-window " *Org tags*")
13686 (org-fit-window-to-buffer)))
13687 ((or (= c ?\C-g)
13688 (and (= c ?q) (not (rassoc c ntable))))
13689 (org-detach-overlay org-tags-overlay)
13690 (setq quit-flag t))
13691 ((= c ?\ )
13692 (setq current nil)
13693 (if exit-after-next (setq exit-after-next 'now)))
13695 (condition-case nil
13696 (setq tg (org-icompleting-read
13697 "Tag: "
13698 (delete-dups
13699 (append (or buffer-tags
13700 (with-current-buffer buf
13701 (mapcar 'car (org-get-buffer-tags))))
13702 (mapcar 'car table)))))
13703 (quit (setq tg "")))
13705 (add-to-list 'buffer-tags (list tg))
13706 (if (member tg current)
13707 (setq current (delete tg current))
13708 (push tg current)))
13709 (if exit-after-next (setq exit-after-next 'now)))
13710 ((setq e (rassoc c todo-table) tg (car e))
13711 (with-current-buffer buf
13712 (save-excursion (org-todo tg)))
13713 (if exit-after-next (setq exit-after-next 'now)))
13714 ((setq e (rassoc c ntable) tg (car e))
13715 (if (member tg current)
13716 (setq current (delete tg current))
13717 (loop for g in groups do
13718 (if (member tg g)
13719 (mapc (lambda (x)
13720 (setq current (delete x current)))
13721 g)))
13722 (push tg current))
13723 (if exit-after-next (setq exit-after-next 'now))))
13725 ;; Create a sorted list
13726 (setq current
13727 (sort current
13728 (lambda (a b)
13729 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13730 (if (eq exit-after-next 'now) (throw 'exit t))
13731 (goto-char (point-min))
13732 (beginning-of-line 2)
13733 (delete-region (point) (point-at-eol))
13734 (org-fast-tag-insert "Current" current c-face)
13735 (org-set-current-tags-overlay current ov-prefix)
13736 (while (re-search-forward
13738 (setq tg (match-string 1))
13739 (add-text-properties
13740 (match-beginning 1) (match-end 1)
13741 (list 'face
13742 (cond
13743 ((member tg current) c-face)
13744 ((member tg inherited) i-face)
13745 (t (get-text-property (match-beginning 1) 'face))))))
13746 (goto-char (point-min)))))
13747 (org-detach-overlay org-tags-overlay)
13748 (if rtn
13749 (mapconcat 'identity current ":")
13750 nil))))
13752 (defun org-get-tags-string ()
13753 "Get the TAGS string in the current headline."
13754 (unless (org-at-heading-p t)
13755 (error "Not on a heading"))
13756 (save-excursion
13757 (beginning-of-line 1)
13759 (org-match-string-no-properties 1)
13760 "")))
13762 (defun org-get-tags ()
13763 "Get the list of tags specified in the current headline."
13764 (org-split-string (org-get-tags-string) ":"))
13766 (defun org-get-buffer-tags ()
13767 "Get a table of all tags used in the buffer, for completion."
13768 (let (tags)
13769 (save-excursion
13770 (goto-char (point-min))
13771 (while (re-search-forward
13773 (when (equal (char-after (point-at-bol 0)) ?*)
13774 (mapc (lambda (x) (add-to-list 'tags x))
13775 (org-split-string (org-match-string-no-properties 1) ":")))))
13776 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13777 (mapcar 'list tags)))
13779 ;;;; The mapping API
13781 ;;;###autoload
13782 (defun org-map-entries (func &optional match scope &rest skip)
13783 "Call FUNC at each headline selected by MATCH in SCOPE.
13785 FUNC is a function or a lisp form. The function will be called without
13786 arguments, with the cursor positioned at the beginning of the headline.
13787 The return values of all calls to the function will be collected and
13788 returned as a list.
13790 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13791 does not need to preserve point. After evaluation, the cursor will be
13792 moved to the end of the line (presumably of the headline of the
13793 processed entry) and search continues from there. Under some
13794 circumstances, this may not produce the wanted results. For example,
13795 if you have removed (e.g. archived) the current (sub)tree it could
13796 mean that the next entry will be skipped entirely. In such cases, you
13797 can specify the position from where search should continue by making
13798 FUNC set the variable `org-map-continue-from' to the desired buffer
13799 position.
13801 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13802 Only headlines that are matched by this query will be considered during
13803 the iteration. When MATCH is nil or t, all headlines will be
13804 visited by the iteration.
13806 SCOPE determines the scope of this command. It can be any of:
13808 nil The current buffer, respecting the restriction if any
13809 tree The subtree started with the entry at point
13810 region The entries within the active region, if any
13811 region-start-level
13812 The entries within the active region, but only those at
13813 the same level than the first one.
13814 file The current buffer, without restriction
13815 file-with-archives
13816 The current buffer, and any archives associated with it
13817 agenda All agenda files
13818 agenda-with-archives
13819 All agenda files with any archive files associated with them
13820 \(file1 file2 ...)
13821 If this is a list, all files in the list will be scanned
13823 The remaining args are treated as settings for the skipping facilities of
13824 the scanner. The following items can be given here:
13826 archive skip trees with the archive tag.
13827 comment skip trees with the COMMENT keyword
13828 function or Emacs Lisp form:
13829 will be used as value for `org-agenda-skip-function', so whenever
13830 the function returns t, FUNC will not be called for that
13831 entry and search will continue from the point where the
13832 function leaves it.
13834 If your function needs to retrieve the tags including inherited tags
13835 at the *current* entry, you can use the value of the variable
13836 `org-scanner-tags' which will be much faster than getting the value
13837 with `org-get-tags-at'. If your function gets properties with
13838 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13839 to t around the call to `org-entry-properties' to get the same speedup.
13840 Note that if your function moves around to retrieve tags and properties at
13841 a *different* entry, you cannot use these techniques."
13842 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13843 (not (org-region-active-p)))
13844 (let* ((org-agenda-archives-mode nil) ; just to make sure
13845 (org-agenda-skip-archived-trees (memq 'archive skip))
13846 (org-agenda-skip-comment-trees (memq 'comment skip))
13847 (org-agenda-skip-function
13848 (car (org-delete-all '(comment archive) skip)))
13849 (org-tags-match-list-sublevels t)
13850 (start-level (eq scope 'region-start-level))
13851 matcher file res
13852 org-todo-keywords-for-agenda
13853 org-done-keywords-for-agenda
13854 org-todo-keyword-alist-for-agenda
13855 org-drawers-for-agenda
13856 org-tag-alist-for-agenda
13857 todo-only)
13859 (cond
13860 ((eq match t) (setq matcher t))
13861 ((eq match nil) (setq matcher t))
13862 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13864 (save-excursion
13865 (save-restriction
13866 (cond ((eq scope 'tree)
13867 (org-back-to-heading t)
13868 (org-narrow-to-subtree)
13869 (setq scope nil))
13870 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13871 (org-region-active-p))
13872 ;; If needed, set start-level to a string like "2"
13873 (when start-level
13874 (save-excursion
13875 (goto-char (region-beginning))
13876 (unless (org-at-heading-p) (outline-next-heading))
13877 (setq start-level (org-current-level))))
13878 (narrow-to-region (region-beginning)
13879 (save-excursion
13880 (goto-char (region-end))
13881 (unless (and (bolp) (org-at-heading-p))
13882 (outline-next-heading))
13883 (point)))
13884 (setq scope nil)))
13886 (if (not scope)
13887 (progn
13888 (org-prepare-agenda-buffers
13889 (list (buffer-file-name (current-buffer))))
13890 (setq res (org-scan-tags func matcher todo-only start-level)))
13891 ;; Get the right scope
13892 (cond
13893 ((and scope (listp scope) (symbolp (car scope)))
13894 (setq scope (eval scope)))
13895 ((eq scope 'agenda)
13896 (setq scope (org-agenda-files t)))
13897 ((eq scope 'agenda-with-archives)
13898 (setq scope (org-agenda-files t))
13899 (setq scope (org-add-archive-files scope)))
13900 ((eq scope 'file)
13901 (setq scope (list (buffer-file-name))))
13902 ((eq scope 'file-with-archives)
13903 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13904 (org-prepare-agenda-buffers scope)
13905 (while (setq file (pop scope))
13906 (with-current-buffer (org-find-base-buffer-visiting file)
13907 (save-excursion
13908 (save-restriction
13909 (widen)
13910 (goto-char (point-min))
13911 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
13912 res)))
13914 ;;;; Properties
13916 ;;; Setting and retrieving properties
13918 (defconst org-special-properties
13919 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13920 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13921 "The special properties valid in Org-mode.
13923 These are properties that are not defined in the property drawer,
13924 but in some other way.")
13926 (defconst org-default-properties
13927 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13928 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13929 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13930 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13931 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13932 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13933 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13934 "Some properties that are used by Org-mode for various purposes.
13935 Being in this list makes sure that they are offered for completion.")
13938 "Regular expression matching the first line of a property drawer.")
13941 "Regular expression matching the last line of a property drawer.")
13944 "Regular expression matching the first line of a property drawer.")
13947 "Regular expression matching the first line of a property drawer.")
13949 (defconst org-property-drawer-re
13952 "Matches an entire property drawer.")
13954 (defconst org-clock-drawer-re
13957 "Matches an entire clock drawer.")
13959 (defsubst org-re-property (property)
13960 "Return a regexp matching PROPERTY.
13961 Match group 1 will be set to the value "
13964 (defun org-property-action ()
13965 "Do an action on properties."
13966 (interactive)
13967 (let (c)
13968 (org-at-property-p)
13969 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13970 (setq c (read-char-exclusive))
13971 (cond
13972 ((equal c ?s)
13973 (call-interactively 'org-set-property))
13974 ((equal c ?d)
13975 (call-interactively 'org-delete-property))
13976 ((equal c ?D)
13977 (call-interactively 'org-delete-property-globally))
13978 ((equal c ?c)
13979 (call-interactively 'org-compute-property-at-point))
13980 (t (error "No such property action %c" c)))))
13982 (defun org-set-effort (&optional value)
13983 "Set the effort property of the current entry.
13984 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13985 allowed value."
13986 (interactive "P")
13987 (if (equal value 0) (setq value 10))
13988 (let* ((completion-ignore-case t)
13989 (prop org-effort-property)
13990 (cur (org-entry-get nil prop))
13991 (allowed (org-property-get-allowed-values nil prop 'table))
13992 (existing (mapcar 'list (org-property-values prop)))
13993 rpl
13994 (val (cond
13995 ((stringp value) value)
13996 ((and allowed (integerp value))
13997 (or (car (nth (1- value) allowed))
13998 (car (org-last allowed))))
13999 (allowed
14000 (message "Select 1-9,0, [RET%s]: %s"
14001 (if cur (concat "=" cur) "")
14002 (mapconcat 'car allowed " "))
14003 (setq rpl (read-char-exclusive))
14005 cur
14006 (setq rpl (- rpl ?0))
14007 (if (equal rpl 0) (setq rpl 10))
14008 (if (and (> rpl 0) (<= rpl (length allowed)))
14009 (car (nth (1- rpl) allowed))
14010 (org-completing-read "Effort: " allowed nil))))
14011 (t
14012 (let (org-completion-use-ido org-completion-use-iswitchb)
14013 (org-completing-read
14015 (concat "[" cur "]") "")
14016 ": ")
14017 existing nil nil "" nil cur))))))
14018 (unless (equal (org-entry-get nil prop) val)
14019 (org-entry-put nil prop val))
14020 (message "%s is now %s" prop val)))
14022 (defun org-at-property-p ()
14023 "Is cursor inside a property drawer?"
14024 (save-excursion
14025 (beginning-of-line 1)
14027 (save-match-data ;; Used by calling procedures
14028 (let ((p (point))
14029 (range (unless (org-before-first-heading-p)
14030 (org-get-property-block))))
14031 (and range (<= (car range) p) (< p (cdr range))))))))
14033 (defun org-get-property-block (&optional beg end force)
14034 "Return the (beg . end) range of the body of the property drawer.
14035 BEG and END can be beginning and end of subtree, if not given
14036 they will be found.
14037 If the drawer does not exist and FORCE is non-nil, create the drawer."
14038 (catch 'exit
14039 (save-excursion
14040 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14041 (end (or end (progn (outline-next-heading) (point)))))
14042 (goto-char beg)
14043 (if (re-search-forward org-property-start-re end t)
14044 (setq beg (1+ (match-end 0)))
14045 (if force
14046 (save-excursion
14047 (org-insert-property-drawer)
14048 (setq end (progn (outline-next-heading) (point))))
14049 (throw 'exit nil))
14050 (goto-char beg)
14051 (if (re-search-forward org-property-start-re end t)
14052 (setq beg (1+ (match-end 0)))))
14053 (if (re-search-forward org-property-end-re end t)
14054 (setq end (match-beginning 0))
14055 (or force (throw 'exit nil))
14056 (goto-char beg)
14057 (setq end beg)
14058 (org-indent-line-function)
14060 (cons beg end)))))
14062 (defun org-entry-properties (&optional pom which specific)
14063 "Get all properties of the entry at point-or-marker POM.
14064 This includes the TODO keyword, the tags, time strings for deadline,
14065 scheduled, and clocking, and any additional properties defined in the
14066 entry. The return value is an alist, keys may occur multiple times
14067 if the property key was used several times.
14068 POM may also be nil, in which case the current entry is used.
14069 If WHICH is nil or `all', get all properties. If WHICH is
14070 `special' or `standard', only get that subclass. If WHICH
14071 is a string only get exactly this property. SPECIFIC can be a string, the
14072 specific property we are interested in. Specifying it can speed
14073 things up because then unnecessary parsing is avoided."
14074 (setq which (or which 'all))
14075 (org-with-point-at pom
14076 (let ((clockstr (substring org-clock-string 0 -1))
14077 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14078 (case-fold-search nil)
14079 beg end range props sum-props key key1 value string clocksum)
14080 (save-excursion
14081 (when (condition-case nil
14082 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14083 (error nil))
14084 (setq beg (point))
14085 (setq sum-props (get-text-property (point) 'org-summaries))
14086 (setq clocksum (get-text-property (point) :org-clock-minutes))
14087 (outline-next-heading)
14088 (setq end (point))
14089 (when (memq which '(all special))
14090 ;; Get the special properties, like TODO and tags
14091 (goto-char beg)
14092 (when (and (or (not specific) (string= specific "TODO"))
14093 (looking-at org-todo-line-regexp) (match-end 2))
14094 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14095 (when (and (or (not specific) (string= specific "PRIORITY"))
14096 (looking-at org-priority-regexp))
14097 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14098 (when (or (not specific) (string= specific "FILE"))
14099 (push (cons "FILE" buffer-file-name) props))
14100 (when (and (or (not specific) (string= specific "TAGS"))
14101 (setq value (org-get-tags-string))
14103 (push (cons "TAGS" value) props))
14104 (when (and (or (not specific) (string= specific "ALLTAGS"))
14105 (setq value (org-get-tags-at)))
14106 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14107 ":"))
14108 props))
14109 (when (or (not specific) (string= specific "BLOCKED"))
14110 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14111 (when (or (not specific)
14112 (member specific
14113 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14114 "TIMESTAMP" "TIMESTAMP_IA")))
14115 (catch 'match
14116 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14117 (setq key (if (match-end 1)
14118 (substring (org-match-string-no-properties 1)
14119 0 -1))
14120 string (if (equal key clockstr)
14121 (org-no-properties
14122 (org-trim
14123 (buffer-substring
14124 (match-beginning 3) (goto-char
14125 (point-at-eol)))))
14126 (substring (org-match-string-no-properties 3)
14127 1 -1)))
14128 ;; Get the correct property name from the key. This is
14129 ;; necessary if the user has configured time keywords.
14130 (setq key1 (concat key ":"))
14131 (cond
14132 ((not key)
14133 (setq key
14134 (if (= (char-after (match-beginning 3)) ?\[)
14135 "TIMESTAMP_IA" "TIMESTAMP")))
14136 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14137 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14138 ((equal key1 org-closed-string) (setq key "CLOSED"))
14139 ((equal key1 org-clock-string) (setq key "CLOCK")))
14140 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14141 (progn
14142 (push (cons key string) props)
14143 ;; no need to search further if match is found
14144 (throw 'match t))
14145 (when (or (equal key "CLOCK") (not (assoc key props)))
14146 (push (cons key string) props))))))
14147 )
14149 (when (memq which '(all standard))
14150 ;; Get the standard properties, like :PROP: ...
14151 (setq range (org-get-property-block beg end))
14152 (when range
14153 (goto-char (car range))
14154 (while (re-search-forward
14156 (cdr range) t)
14157 (setq key (org-match-string-no-properties 1)
14158 value (org-trim (or (org-match-string-no-properties 2) "")))
14159 (unless (member key excluded)
14160 (push (cons key (or value "")) props)))))
14161 (if clocksum
14162 (push (cons "CLOCKSUM"
14163 (org-columns-number-to-string (/ (float clocksum) 60.)
14164 'add_times))
14165 props))
14166 (unless (assoc "CATEGORY" props)
14167 (push (cons "CATEGORY" (org-get-category)) props))
14168 (append sum-props (nreverse props)))))))
14170 (defun org-entry-get (pom property &optional inherit literal-nil)
14171 "Get value of PROPERTY for entry at point-or-marker POM.
14172 If INHERIT is non-nil and the entry does not have the property,
14173 then also check higher levels of the hierarchy.
14174 If INHERIT is the symbol `selective', use inheritance only if the setting
14175 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14176 If the property is present but empty, the return value is the empty string.
14177 If the property is not present at all, nil is returned.
14180 do not interpret it as the list atom nil. This is used for inheritance
14182 (org-with-point-at pom
14183 (if (and inherit (if (eq inherit 'selective)
14184 (org-property-inherit-p property)
14185 t))
14186 (org-entry-get-with-inheritance property literal-nil)
14187 (if (member property org-special-properties)
14188 ;; We need a special property. Use `org-entry-properties' to
14189 ;; retrieve it, but specify the wanted property
14190 (cdr (assoc property (org-entry-properties nil 'special property)))
14191 (let ((range (unless (org-before-first-heading-p)
14192 (org-get-property-block)))
14193 (props (list (or (assoc property org-file-properties)
14194 (assoc property org-global-properties)
14195 (assoc property org-global-properties-fixed))))
14196 val)
14197 (flet ((ap (key)
14198 (when (re-search-forward
14199 (org-re-property key) (cdr range) t)
14200 (setq props
14201 (org-update-property-plist
14202 key
14203 (if (match-end 1)
14204 (org-match-string-no-properties 1) "")
14205 props)))))
14206 (when (and range (goto-char (car range)))
14207 (ap property)
14208 (goto-char (car range))
14209 (while (ap (concat property "+")))
14210 (setq val (cdr (assoc property props)))
14211 (when val (if literal-nil val (org-not-nil val))))))))))
14213 (defun org-property-or-variable-value (var &optional inherit)
14214 "Check if there is a property fixing the value of VAR.
14215 If yes, return this value. If not, return the current value of the variable."
14216 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14218 (read prop)
14219 (symbol-value var))))
14221 (defun org-entry-delete (pom property)
14222 "Delete the property PROPERTY from entry at point-or-marker POM."
14223 (org-with-point-at pom
14224 (if (member property org-special-properties)
14225 nil ; cannot delete these properties.
14226 (let ((range (org-get-property-block)))
14227 (if (and range
14228 (goto-char (car range))
14229 (re-search-forward
14230 (org-re-property property)
14231 (cdr range) t))
14232 (progn
14233 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14234 t)
14235 nil)))))
14237 ;; Multi-values properties are properties that contain multiple values
14238 ;; These values are assumed to be single words, separated by whitespace.
14239 (defun org-entry-add-to-multivalued-property (pom property value)
14240 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14241 (let* ((old (org-entry-get pom property))
14243 (setq value (org-entry-protect-space value))
14244 (unless (member value values)
14245 (setq values (cons value values))
14246 (org-entry-put pom property
14247 (mapconcat 'identity values " ")))))
14249 (defun org-entry-remove-from-multivalued-property (pom property value)
14250 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14251 (let* ((old (org-entry-get pom property))
14253 (setq value (org-entry-protect-space value))
14254 (when (member value values)
14255 (setq values (delete value values))
14256 (org-entry-put pom property
14257 (mapconcat 'identity values " ")))))
14259 (defun org-entry-member-in-multivalued-property (pom property value)
14260 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14261 (let* ((old (org-entry-get pom property))
14263 (setq value (org-entry-protect-space value))
14264 (member value values)))
14266 (defun org-entry-get-multivalued-property (pom property)
14267 "Return a list of values in a multivalued property."
14268 (let* ((value (org-entry-get pom property))
14270 (mapcar 'org-entry-restore-space values)))
14272 (defun org-entry-put-multivalued-property (pom property &rest values)
14273 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14274 VALUES should be a list of strings. Spaces will be protected."
14275 (org-entry-put pom property
14276 (mapconcat 'org-entry-protect-space values " "))
14277 (let* ((value (org-entry-get pom property))
14279 (mapcar 'org-entry-restore-space values)))
14281 (defun org-entry-protect-space (s)
14282 "Protect spaces and newline in string S."
14283 (while (string-match " " s)
14284 (setq s (replace-match "%20" t t s)))
14286 (setq s (replace-match "%0A" t t s)))
14287 s)
14289 (defun org-entry-restore-space (s)
14290 "Restore spaces and newline in string S."
14291 (while (string-match "%20" s)
14292 (setq s (replace-match " " t t s)))
14293 (while (string-match "%0A" s)
14295 s)
14297 (defvar org-entry-property-inherited-from (make-marker)
14298 "Marker pointing to the entry from where a property was inherited.
14299 Each call to `org-entry-get-with-inheritance' will set this marker to the
14300 location of the entry where the inheritance search matched. If there was
14301 no match, the marker will point nowhere.
14302 Note that also `org-entry-get' calls this function, if the INHERIT flag
14303 is set.")
14305 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14306 "Get entry property, and search higher levels if not present.
14307 The search will stop at the first ancestor which has the property defined.
14309 should be considered as undefined (this is the meaning of nil here).
14311 (move-marker org-entry-property-inherited-from nil)
14312 (let (tmp)
14313 (unless (org-before-first-heading-p)
14314 (save-excursion
14315 (save-restriction
14316 (widen)
14317 (catch 'ex
14318 (while t
14319 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14320 (org-back-to-heading t)
14321 (move-marker org-entry-property-inherited-from (point))
14322 (throw 'ex tmp))
14323 (or (org-up-heading-safe) (throw 'ex nil)))))))
14324 (setq tmp (or tmp
14325 (cdr (assoc property org-file-properties))
14326 (cdr (assoc property org-global-properties))
14327 (cdr (assoc property org-global-properties-fixed))))
14328 (if literal-nil tmp (org-not-nil tmp))))
14330 (defvar org-property-changed-functions nil
14331 "Hook called when the value of a property has changed.
14332 Each hook function should accept two arguments, the name of the property
14333 and the new value.")
14335 (defun org-entry-put (pom property value)
14336 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14337 (org-with-point-at pom
14338 (org-back-to-heading t)
14339 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14340 range)
14341 (cond
14342 ((equal property "TODO")
14344 (not (member value org-todo-keywords-1)))
14346 (if (or (not value)
14348 (setq value 'none))
14349 (org-todo value)
14350 (org-set-tags nil 'align))
14351 ((equal property "PRIORITY")
14353 (string-to-char value) ?\ ))
14354 (org-set-tags nil 'align))
14355 ((equal property "SCHEDULED")
14356 (if (re-search-forward org-scheduled-time-regexp end t)
14357 (cond
14358 ((eq value 'earlier) (org-timestamp-change -1 'day))
14359 ((eq value 'later) (org-timestamp-change 1 'day))
14360 (t (call-interactively 'org-schedule)))
14361 (call-interactively 'org-schedule)))
14362 ((equal property "DEADLINE")
14363 (if (re-search-forward org-deadline-time-regexp end t)
14364 (cond
14365 ((eq value 'earlier) (org-timestamp-change -1 'day))
14366 ((eq value 'later) (org-timestamp-change 1 'day))
14367 (t (call-interactively 'org-deadline)))
14368 (call-interactively 'org-deadline)))
14369 ((member property org-special-properties)
14370 (error "The %s property can not yet be set with `org-entry-put'"
14371 property))
14372 (t ; a non-special property
14373 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14374 (setq range (org-get-property-block beg end 'force))
14375 (goto-char (car range))
14376 (if (re-search-forward
14377 (org-re-property property) (cdr range) t)
14378 (progn
14379 (delete-region (match-beginning 0) (match-end 0))
14380 (goto-char (match-beginning 0)))
14381 (goto-char (cdr range))
14383 (backward-char 1)
14384 (org-indent-line-function))
14385 (insert ":" property ":")
14386 (and value (insert " " value))
14387 (org-indent-line-function)))))
14388 (run-hook-with-args 'org-property-changed-functions property value)))
14390 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14391 "Get all property keys in the current buffer.
14392 With INCLUDE-SPECIALS, also list the special properties that reflect things
14393 like tags and TODO state.
14394 With INCLUDE-DEFAULTS, also include properties that has special meaning
14395 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14396 and others.
14397 With INCLUDE-COLUMNS, also include property names given in COLUMN
14398 formats in the current buffer."
14399 (let (rtn range cfmt s p)
14400 (save-excursion
14401 (save-restriction
14402 (widen)
14403 (goto-char (point-min))
14404 (while (re-search-forward org-property-start-re nil t)
14405 (setq range (org-get-property-block))
14406 (goto-char (car range))
14407 (while (re-search-forward
14409 (cdr range) t)
14410 (add-to-list 'rtn (org-match-string-no-properties 1)))
14411 (outline-next-heading))))
14413 (when include-specials
14414 (setq rtn (append org-special-properties rtn)))
14416 (when include-defaults
14417 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14418 (add-to-list 'rtn org-effort-property))
14420 (when include-columns
14421 (save-excursion
14422 (save-restriction
14423 (widen)
14424 (goto-char (point-min))
14425 (while (re-search-forward
14427 nil t)
14428 (setq cfmt (match-string 2) s 0)
14430 cfmt s)
14431 (setq s (match-end 0)
14432 p (match-string 1 cfmt))
14433 (unless (or (equal p "ITEM")
14434 (member p org-special-properties))
14435 (add-to-list 'rtn (match-string 1 cfmt))))))))
14437 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14439 (defun org-property-values (key)
14440 "Return a list of all values of property KEY in the current buffer."
14441 (save-excursion
14442 (save-restriction
14443 (widen)
14444 (goto-char (point-min))
14445 (let ((re (org-re-property key))
14446 values)
14447 (while (re-search-forward re nil t)
14448 (add-to-list 'values (org-trim (match-string 1))))
14449 (delete "" values)))))
14451 (defun org-insert-property-drawer ()
14452 "Insert a property drawer into the current entry."
14453 (interactive)
14454 (org-back-to-heading t)
14455 (looking-at org-outline-regexp)
14456 (let ((indent (if org-adapt-indentation
14457 (- (match-end 0)(match-beginning 0))
14458 0))
14459 (beg (point))
14461 end hiddenp)
14462 (outline-next-heading)
14463 (setq end (point))
14464 (goto-char beg)
14465 (while (re-search-forward re end t))
14466 (setq hiddenp (outline-invisible-p))
14467 (end-of-line 1)
14470 (if (member (match-string 1) '("CLOCK:" ":END:"))
14471 ;; just skip this line
14472 (beginning-of-line 2)
14473 ;; Drawer start, find the end
14475 (beginning-of-line 1)))
14476 (org-skip-over-state-notes)
14478 (if (eq (char-before) ?*) (forward-char 1))
14480 (beginning-of-line 0)
14481 (org-indent-to-column indent)
14482 (beginning-of-line 2)
14483 (org-indent-to-column indent)
14484 (beginning-of-line 0)
14485 (if hiddenp
14486 (save-excursion
14487 (org-back-to-heading t)
14488 (hide-entry))
14489 (org-flag-drawer t))))
14491 (defvar org-property-set-functions-alist nil
14492 "Property set function alist.
14493 Each entry should have the following format:
14495 (PROPERTY . READ-FUNCTION)
14497 The read function will be called with the same argument as
14498 `org-completing-read'.")
14500 (defun org-set-property-function (property)
14501 "Get the function that should be used to set PROPERTY.
14502 This is computed according to `org-property-set-functions-alist'."
14503 (or (cdr (assoc property org-property-set-functions-alist))
14504 'org-completing-read))
14506 (defun org-read-property-value (property)
14507 "Read PROPERTY value from user."
14508 (let* ((completion-ignore-case t)
14509 (allowed (org-property-get-allowed-values nil property 'table))
14510 (cur (org-entry-get nil property))
14511 (prompt (concat property " value"
14513 (concat " [" cur "]") "") ": "))
14514 (set-function (org-set-property-function property))
14515 (val (if allowed
14516 (funcall set-function prompt allowed nil
14517 (not (get-text-property 0 'org-unrestricted
14518 (caar allowed))))
14519 (let (org-completion-use-ido org-completion-use-iswitchb)
14520 (funcall set-function prompt
14521 (mapcar 'list (org-property-values property))
14522 nil nil "" nil cur)))))
14523 (if (equal val "")
14524 cur
14525 val)))
14527 (defvar org-last-set-property nil)
14528 (defun org-read-property-name ()
14529 "Read a property name."
14530 (let* ((completion-ignore-case t)
14531 (keys (org-buffer-property-keys nil t t))
14532 (default-prop (or (save-excursion
14533 (save-match-data
14534 (beginning-of-line)
14536 (null (string= (match-string 1) "END"))
14537 (match-string 1))))
14538 org-last-set-property))
14539 (property (org-icompleting-read
14540 (concat "Property"
14541 (if default-prop (concat " [" default-prop "]") "")
14542 ": ")
14543 (mapcar 'list keys)
14544 nil nil nil nil
14545 default-prop
14546 )))
14547 (if (member property keys)
14548 property
14549 (or (cdr (assoc (downcase property)
14550 (mapcar (lambda (x) (cons (downcase x) x))
14551 keys)))
14552 property))))
14554 (defun org-set-property (property value)
14555 "In the current entry, set PROPERTY to VALUE.
14556 When called interactively, this will prompt for a property name, offering
14557 completion on existing and default properties. And then it will prompt
14558 for a value, offering completion either on allowed values (via an inherited
14559 xxx_ALL property) or on existing values in other instances of this property
14560 in the current file."
14561 (interactive (list nil nil))
14562 (let* ((property (or property (org-read-property-name)))
14563 (value (or value (org-read-property-value property)))
14564 (fn (assoc property org-properties-postprocess-alist)))
14565 (setq org-last-set-property property)
14566 ;; Possibly postprocess the inserted value:
14567 (when fn (setq value (funcall (cadr fn) value)))
14568 (unless (equal (org-entry-get nil property) value)
14569 (org-entry-put nil property value))))
14571 (defun org-delete-property (property)
14572 "In the current entry, delete PROPERTY."
14573 (interactive
14574 (let* ((completion-ignore-case t)
14575 (prop (org-icompleting-read "Property: "
14576 (org-entry-properties nil 'standard))))
14577 (list prop)))
14578 (message "Property %s %s" property
14579 (if (org-entry-delete nil property)
14580 "deleted"
14581 "was not present in the entry")))
14583 (defun org-delete-property-globally (property)
14584 "Remove PROPERTY globally, from all entries."
14585 (interactive
14586 (let* ((completion-ignore-case t)
14587 (prop (org-icompleting-read
14588 "Globally remove property: "
14589 (mapcar 'list (org-buffer-property-keys)))))
14590 (list prop)))
14591 (save-excursion
14592 (save-restriction
14593 (widen)
14594 (goto-char (point-min))
14595 (let ((cnt 0))
14596 (while (re-search-forward
14597 (org-re-property property)
14598 nil t)
14599 (setq cnt (1+ cnt))
14600 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14603 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14605 (defun org-compute-property-at-point ()
14606 "Compute the property at point.
14607 This looks for an enclosing column format, extracts the operator and
14608 then applies it to the property in the column format's scope."
14609 (interactive)
14610 (unless (org-at-property-p)
14611 (error "Not at a property"))
14612 (let ((prop (org-match-string-no-properties 2)))
14613 (org-columns-get-format-and-top-level)
14614 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14615 (error "No operator defined for property %s" prop))
14616 (org-columns-compute prop)))
14618 (defvar org-property-allowed-value-functions nil
14619 "Hook for functions supplying allowed values for a specific property.
14620 The functions must take a single argument, the name of the property, and
14622 the values, this means that these values are intended as defaults for
14623 completion, but that other values should be allowed too.
14624 The functions must return nil if they are not responsible for this
14625 property.")
14627 (defun org-property-get-allowed-values (pom property &optional table)
14628 "Get allowed values for the property PROPERTY.
14629 When TABLE is non-nil, return an alist that can directly be used for
14630 completion."
14631 (let (vals)
14632 (cond
14633 ((equal property "TODO")
14634 (setq vals (org-with-point-at pom
14635 (append org-todo-keywords-1 '("")))))
14636 ((equal property "PRIORITY")
14637 (let ((n org-lowest-priority))
14638 (while (>= n org-highest-priority)
14639 (push (char-to-string n) vals)
14640 (setq n (1- n)))))
14641 ((member property org-special-properties))
14642 ((setq vals (run-hook-with-args-until-success
14643 'org-property-allowed-value-functions property)))
14644 (t
14645 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14647 (setq vals (car (read-from-string (concat "(" vals ")"))))
14648 (setq vals (mapcar (lambda (x)
14649 (cond ((stringp x) x)
14650 ((numberp x) (number-to-string x))
14651 ((symbolp x) (symbol-name x))
14652 (t "???")))
14653 vals)))))
14654 (when (member ":ETC" vals)
14655 (setq vals (remove ":ETC" vals))
14656 (org-add-props (car vals) '(org-unrestricted t)))
14657 (if table (mapcar 'list vals) vals)))
14659 (defun org-property-previous-allowed-value (&optional previous)
14660 "Switch to the next allowed value for this property."
14661 (interactive)
14662 (org-property-next-allowed-value t))
14664 (defun org-property-next-allowed-value (&optional previous)
14665 "Switch to the next allowed value for this property."
14666 (interactive)
14667 (unless (org-at-property-p)
14668 (error "Not at a property"))
14669 (let* ((key (match-string 2))
14670 (value (match-string 3))
14671 (allowed (or (org-property-get-allowed-values (point) key)
14672 (and (member value '("[ ]" "[-]" "[X]"))
14673 '("[ ]" "[X]"))))
14674 nval)
14675 (unless allowed
14676 (error "Allowed values for this property have not been defined"))
14677 (if previous (setq allowed (reverse allowed)))
14678 (if (member value allowed)
14679 (setq nval (car (cdr (member value allowed)))))
14680 (setq nval (or nval (car allowed)))
14681 (if (equal nval value)
14682 (error "Only one allowed value for this property"))
14683 (org-at-property-p)
14684 (replace-match (concat " :" key ": " nval) t t)
14685 (org-indent-line-function)
14686 (beginning-of-line 1)
14688 (run-hook-with-args 'org-property-changed-functions key nval)))
14690 (defun org-find-olp (path &optional this-buffer)
14691 "Return a marker pointing to the entry at outline path OLP.
14692 If anything goes wrong, throw an error.
14693 You can wrap this call to catch the error like this:
14695 (condition-case msg
14696 (org-mobile-locate-entry (match-string 4))
14697 (error (nth 1 msg)))
14699 The return value will then be either a string with the error message,
14700 or a marker if everything is OK.
14702 If THIS-BUFFER is set, the outline path does not contain a file,
14703 only headings."
14704 (let* ((file (if this-buffer buffer-file-name (pop path)))
14705 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14706 (level 1)
14707 (lmin 1)
14708 (lmax 1)
14709 limit re end found pos heading cnt flevel)
14710 (unless buffer (error "File not found :%s" file))
14711 (with-current-buffer buffer
14712 (save-excursion
14713 (save-restriction
14714 (widen)
14715 (setq limit (point-max))
14716 (goto-char (point-min))
14717 (while (setq heading (pop path))
14718 (setq re (format org-complex-heading-regexp-format
14719 (regexp-quote heading)))
14720 (setq cnt 0 pos (point))
14721 (while (re-search-forward re end t)
14722 (setq level (- (match-end 1) (match-beginning 1)))
14723 (if (and (>= level lmin) (<= level lmax))
14724 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14725 (when (= cnt 0) (error "Heading not found on level %d: %s"
14726 lmax heading))
14727 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14728 lmax heading))
14729 (goto-char found)
14730 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14731 (setq end (save-excursion (org-end-of-subtree t t))))
14732 (when (org-at-heading-p)
14733 (move-marker (make-marker) (point))))))))
14735 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14736 "Find node HEADING in BUFFER.
14737 Return a marker to the heading if it was found, or nil if not.
14738 If POS-ONLY is set, return just the position instead of a marker.
14740 The heading text must match exact, but it may have a TODO keyword,
14741 a priority cookie and tags in the standard locations."
14742 (with-current-buffer (or buffer (current-buffer))
14743 (save-excursion
14744 (save-restriction
14745 (widen)
14746 (goto-char (point-min))
14747 (let (case-fold-search)
14748 (if (re-search-forward
14749 (format org-complex-heading-regexp-format
14750 (regexp-quote heading)) nil t)
14751 (if pos-only
14752 (match-beginning 0)
14753 (move-marker (make-marker) (match-beginning 0)))))))))
14755 (defun org-find-exact-heading-in-directory (heading &optional dir)
14756 "Find Org node headline HEADING in all .org files in directory DIR.
14757 When the target headline is found, return a marker to this location."
14758 (let ((files (directory-files (or dir default-directory)
14760 file visiting m buffer)
14761 (catch 'found
14762 (while (setq file (pop files))
14763 (message "trying %s" file)
14764 (setq visiting (org-find-base-buffer-visiting file))
14765 (setq buffer (or visiting (find-file-noselect file)))
14766 (setq m (org-find-exact-headline-in-buffer
14767 heading buffer))
14768 (when (and (not m) (not visiting)) (kill-buffer buffer))
14769 (and m (throw 'found m))))))
14771 (defun org-find-entry-with-id (ident)
14772 "Locate the entry that contains the ID property with exact value IDENT.
14773 IDENT can be a string, a symbol or a number, this function will search for
14774 the string representation of it.
14775 Return the position where this entry starts, or nil if there is no such entry."
14776 (interactive "sID: ")
14777 (let ((id (cond
14778 ((stringp ident) ident)
14779 ((symbol-name ident) (symbol-name ident))
14780 ((numberp ident) (number-to-string ident))
14781 (t (error "IDENT %s must be a string, symbol or number" ident))))
14782 (case-fold-search nil))
14783 (save-excursion
14784 (save-restriction
14785 (widen)
14786 (goto-char (point-min))
14787 (when (re-search-forward
14789 nil t)
14790 (org-back-to-heading t)
14791 (point))))))
14793 ;;;; Timestamps
14795 (defvar org-last-changed-timestamp nil)
14796 (defvar org-last-inserted-timestamp nil
14797 "The last time stamp inserted with `org-insert-time-stamp'.")
14798 (defvar org-time-was-given) ; dynamically scoped parameter
14799 (defvar org-end-time-was-given) ; dynamically scoped parameter
14800 (defvar org-ts-what) ; dynamically scoped parameter
14802 (defun org-time-stamp (arg &optional inactive)
14803 "Prompt for a date/time and insert a time stamp.
14804 If the user specifies a time like HH:MM, or if this command is called
14805 with a prefix argument, the time stamp will contain date and time.
14806 Otherwise, only the date will be included. All parts of a date not
14807 specified by the user will be filled in from the current date/time.
14808 So if you press just return without typing anything, the time stamp
14809 will represent the current date/time. If there is already a timestamp
14810 at the cursor, it will be modified."
14811 (interactive "P")
14812 (let* ((ts nil)
14813 (default-time
14814 ;; Default time is either today, or, when entering a range,
14815 ;; the range start.
14816 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14817 (save-excursion
14818 (re-search-backward
14820 (- (point) 20) t)))
14821 (apply 'encode-time (org-parse-time-string (match-string 1)))
14822 (current-time)))
14823 (default-input (and ts (org-get-compact-tod ts)))
14824 (repeater (save-excursion
14825 (save-match-data
14826 (beginning-of-line)
14827 (when (re-search-forward
14829 (save-excursion (progn (end-of-line) (point))) t)
14830 (match-string 0)))))
14831 org-time-was-given org-end-time-was-given time)
14832 (cond
14833 ((and (org-at-timestamp-p t)
14834 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14835 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14836 (insert "--")
14837 (setq time (let ((this-command this-command))
14838 (org-read-date arg 'totime nil nil
14839 default-time default-input)))
14840 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14841 ((org-at-timestamp-p t)
14842 (setq time (let ((this-command this-command))
14843 (org-read-date arg 'totime nil nil default-time default-input)))
14844 (when (org-at-timestamp-p t) ; just to get the match data
14845 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14846 (replace-match "")
14847 (setq org-last-changed-timestamp
14848 (org-insert-time-stamp
14849 time (or org-time-was-given arg)
14850 inactive nil nil (list org-end-time-was-given)))
14851 (when repeater (goto-char (1- (point))) (insert " " repeater)
14852 (setq org-last-changed-timestamp
14853 (concat (substring org-last-inserted-timestamp 0 -1)
14854 " " repeater ">"))))
14855 (message "Timestamp updated"))
14856 (t
14857 (setq time (let ((this-command this-command))
14858 (org-read-date arg 'totime nil nil default-time default-input)))
14859 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14860 nil nil (list org-end-time-was-given))))))
14862 ;; FIXME: can we use this for something else, like computing time differences?
14863 (defun org-get-compact-tod (s)
14864 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14865 (let* ((t1 (match-string 1 s))
14866 (h1 (string-to-number (match-string 2 s)))
14867 (m1 (string-to-number (match-string 3 s)))
14868 (t2 (and (match-end 4) (match-string 5 s)))
14869 (h2 (and t2 (string-to-number (match-string 6 s))))
14870 (m2 (and t2 (string-to-number (match-string 7 s))))
14871 dh dm)
14872 (if (not t2)
14873 t1
14874 (setq dh (- h2 h1) dm (- m2 m1))
14875 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14876 (concat t1 "+" (number-to-string dh)
14877 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14879 (defun org-time-stamp-inactive (&optional arg)
14880 "Insert an inactive time stamp.
14881 An inactive time stamp is enclosed in square brackets instead of angle
14882 brackets. It is inactive in the sense that it does not trigger agenda entries,
14883 does not link to the calendar and cannot be changed with the S-cursor keys.
14884 So these are more for recording a certain time/date."
14885 (interactive "P")
14886 (org-time-stamp arg 'inactive))
14888 (defvar org-date-ovl (make-overlay 1 1))
14889 (overlay-put org-date-ovl 'face 'org-warning)
14890 (org-detach-overlay org-date-ovl)
14892 (defvar org-ans1) ; dynamically scoped parameter
14893 (defvar org-ans2) ; dynamically scoped parameter
14895 (defvar org-plain-time-of-day-regexp) ; defined below
14897 (defvar org-overriding-default-time nil) ; dynamically scoped
14898 (defvar org-read-date-overlay nil)
14899 (defvar org-dcst nil) ; dynamically scoped
14900 (defvar org-read-date-history nil)
14901 (defvar org-read-date-final-answer nil)
14902 (defvar org-read-date-analyze-futurep nil)
14903 (defvar org-read-date-analyze-forced-year nil)
14905 (defun org-read-date (&optional org-with-time to-time from-string prompt
14906 default-time default-input)
14907 "Read a date, possibly a time, and make things smooth for the user.
14908 The prompt will suggest to enter an ISO date, but you can also enter anything
14909 which will at least partially be understood by `parse-time-string'.
14910 Unrecognized parts of the date will default to the current day, month, year,
14911 hour and minute. If this command is called to replace a timestamp at point,
14912 or to enter the second timestamp of a range, the default time is taken
14913 from the existing stamp. Furthermore, the command prefers the future,
14914 so if you are giving a date where the year is not given, and the day-month
14915 combination is already past in the current year, it will assume you
14916 mean next year. For details, see the manual. A few examples:
14918 3-2-5 --> 2003-02-05
14919 feb 15 --> currentyear-02-15
14920 2/15 --> currentyear-02-15
14921 sep 12 9 --> 2009-09-12
14922 12:45 --> today 12:45
14923 22 sept 0:34 --> currentyear-09-22 0:34
14924 12 --> currentyear-currentmonth-12
14925 Fri --> nearest Friday (today or later)
14926 etc.
14928 Furthermore you can specify a relative date by giving, as the *first* thing
14929 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14930 change in days weeks, months, years.
14931 With a single plus or minus, the date is relative to today. With a double
14932 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14933 +4d --> four days from today
14934 +4 --> same as above
14935 +2w --> two weeks from today
14936 ++5 --> five days from default date
14938 The function understands only English month and weekday abbreviations.
14940 While prompting, a calendar is popped up - you can also select the
14941 date with the mouse (button 1). The calendar shows a period of three
14942 months. To scroll it to other months, use the keys `>' and `<'.
14943 If you don't like the calendar, turn it off with
14944 \(setq org-read-date-popup-calendar nil)
14946 With optional argument TO-TIME, the date will immediately be converted
14947 to an internal time.
14948 With an optional argument WITH-TIME, the prompt will suggest to also
14949 insert a time. Note that when WITH-TIME is not set, you can still
14950 enter a time, and this function will inform the calling routine about
14951 this change. The calling routine may then choose to change the format
14952 used to insert the time stamp into the buffer to include the time.
14953 With optional argument FROM-STRING, read from this string instead from
14954 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14955 the time/date that is used for everything that is not specified by the
14956 user."
14957 (require 'parse-time)
14958 (let* ((org-time-stamp-rounding-minutes
14959 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14960 (org-dcst org-display-custom-times)
14961 (ct (org-current-time))
14962 (org-def (or org-overriding-default-time default-time ct))
14963 (org-defdecode (decode-time org-def))
14964 (dummy (progn
14965 (when (< (nth 2 org-defdecode) org-extend-today-until)
14966 (setcar (nthcdr 2 org-defdecode) -1)
14967 (setcar (nthcdr 1 org-defdecode) 59)
14968 (setq org-def (apply 'encode-time org-defdecode)
14969 org-defdecode (decode-time org-def)))))
14970 (calendar-frame-setup nil)
14971 (calendar-setup nil)
14972 (calendar-move-hook nil)
14973 (calendar-view-diary-initially-flag nil)
14974 (calendar-view-holidays-initially-flag nil)
14975 (timestr (format-time-string
14976 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
14977 (prompt (concat (if prompt (concat prompt " ") "")
14978 (format "Date+time [%s]: " timestr)))
14979 ans (org-ans0 "") org-ans1 org-ans2 final)
14981 (cond
14982 (from-string (setq ans from-string))
14983 (org-read-date-popup-calendar
14984 (save-excursion
14985 (save-window-excursion
14986 (calendar)
14987 (unwind-protect
14988 (progn
14989 (calendar-forward-day (- (time-to-days org-def)
14990 (calendar-absolute-from-gregorian
14991 (calendar-current-date))))
14992 (org-eval-in-calendar nil t)
14993 (let* ((old-map (current-local-map))
14994 (map (copy-keymap calendar-mode-map))
14995 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14996 (org-defkey map (kbd "RET") 'org-calendar-select)
14997 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14998 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14999 (org-defkey minibuffer-local-map [(meta shift left)]
15000 (lambda () (interactive)
15001 (org-eval-in-calendar '(calendar-backward-month 1))))
15002 (org-defkey minibuffer-local-map [(meta shift right)]
15003 (lambda () (interactive)
15004 (org-eval-in-calendar '(calendar-forward-month 1))))
15005 (org-defkey minibuffer-local-map [(meta shift up)]
15006 (lambda () (interactive)
15007 (org-eval-in-calendar '(calendar-backward-year 1))))
15008 (org-defkey minibuffer-local-map [(meta shift down)]
15009 (lambda () (interactive)
15010 (org-eval-in-calendar '(calendar-forward-year 1))))
15011 (org-defkey minibuffer-local-map [?\e (shift left)]
15012 (lambda () (interactive)
15013 (org-eval-in-calendar '(calendar-backward-month 1))))
15014 (org-defkey minibuffer-local-map [?\e (shift right)]
15015 (lambda () (interactive)
15016 (org-eval-in-calendar '(calendar-forward-month 1))))
15017 (org-defkey minibuffer-local-map [?\e (shift up)]
15018 (lambda () (interactive)
15019 (org-eval-in-calendar '(calendar-backward-year 1))))
15020 (org-defkey minibuffer-local-map [?\e (shift down)]
15021 (lambda () (interactive)
15022 (org-eval-in-calendar '(calendar-forward-year 1))))
15023 (org-defkey minibuffer-local-map [(shift up)]
15024 (lambda () (interactive)
15025 (org-eval-in-calendar '(calendar-backward-week 1))))
15026 (org-defkey minibuffer-local-map [(shift down)]
15027 (lambda () (interactive)
15028 (org-eval-in-calendar '(calendar-forward-week 1))))
15029 (org-defkey minibuffer-local-map [(shift left)]
15030 (lambda () (interactive)
15031 (org-eval-in-calendar '(calendar-backward-day 1))))
15032 (org-defkey minibuffer-local-map [(shift right)]
15033 (lambda () (interactive)
15034 (org-eval-in-calendar '(calendar-forward-day 1))))
15035 (org-defkey minibuffer-local-map ">"
15036 (lambda () (interactive)
15037 (org-eval-in-calendar '(scroll-calendar-left 1))))
15038 (org-defkey minibuffer-local-map "<"
15039 (lambda () (interactive)
15040 (org-eval-in-calendar '(scroll-calendar-right 1))))
15041 (org-defkey minibuffer-local-map "\C-v"
15042 (lambda () (interactive)
15043 (org-eval-in-calendar
15044 '(calendar-scroll-left-three-months 1))))
15045 (org-defkey minibuffer-local-map "\M-v"
15046 (lambda () (interactive)
15047 (org-eval-in-calendar
15048 '(calendar-scroll-right-three-months 1))))
15049 (run-hooks 'org-read-date-minibuffer-setup-hook)
15050 (unwind-protect
15051 (progn
15052 (use-local-map map)
15053 (add-hook 'post-command-hook 'org-read-date-display)
15054 (setq org-ans0 (read-string prompt default-input
15055 'org-read-date-history nil))
15056 ;; org-ans0: from prompt
15057 ;; org-ans1: from mouse click
15058 ;; org-ans2: from calendar motion
15059 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15060 (remove-hook 'post-command-hook 'org-read-date-display)
15061 (use-local-map old-map)
15062 (when org-read-date-overlay
15063 (delete-overlay org-read-date-overlay)
15064 (setq org-read-date-overlay nil)))))
15065 (bury-buffer "*Calendar*")))))
15067 (t ; Naked prompt only
15068 (unwind-protect
15069 (setq ans (read-string prompt default-input
15070 'org-read-date-history timestr))
15071 (when org-read-date-overlay
15072 (delete-overlay org-read-date-overlay)
15073 (setq org-read-date-overlay nil)))))
15075 (setq final (org-read-date-analyze ans org-def org-defdecode))
15077 (when org-read-date-analyze-forced-year
15078 (message "Year was forced into %s"
15079 (if org-read-date-force-compatible-dates
15080 "compatible range (1970-2037)"
15081 "range representable on this machine"))
15082 (ding))
15084 ;; One round trip to get rid of 34th of August and stuff like that....
15085 (setq final (decode-time (apply 'encode-time final)))
15087 (setq org-read-date-final-answer ans)
15089 (if to-time
15090 (apply 'encode-time final)
15091 (if (and (boundp 'org-time-was-given) org-time-was-given)
15092 (format "%04d-%02d-%02d %02d:%02d"
15093 (nth 5 final) (nth 4 final) (nth 3 final)
15094 (nth 2 final) (nth 1 final))
15095 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15097 (defvar org-def)
15098 (defvar org-defdecode)
15099 (defvar org-with-time)
15100 (defun org-read-date-display ()
15101 "Display the current date prompt interpretation in the minibuffer."
15102 (when org-read-date-display-live
15103 (when org-read-date-overlay
15104 (delete-overlay org-read-date-overlay))
15105 (let ((p (point)))
15106 (end-of-line 1)
15107 (while (not (equal (buffer-substring
15108 (max (point-min) (- (point) 4)) (point))
15109 " "))
15110 (insert " "))
15111 (goto-char p))
15112 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15113 " " (or org-ans1 org-ans2)))
15114 (org-end-time-was-given nil)
15115 (f (org-read-date-analyze ans org-def org-defdecode))
15116 (fmts (if org-dcst
15117 org-time-stamp-custom-formats
15118 org-time-stamp-formats))
15119 (fmt (if (or org-with-time
15120 (and (boundp 'org-time-was-given) org-time-was-given))
15121 (cdr fmts)
15122 (car fmts)))
15123 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15124 (when (and org-end-time-was-given
15125 (string-match org-plain-time-of-day-regexp txt))
15126 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15127 org-end-time-was-given
15128 (substring txt (match-end 0)))))
15129 (when org-read-date-analyze-futurep
15130 (setq txt (concat txt " (=>F)")))
15131 (setq org-read-date-overlay
15132 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15133 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15135 (defun org-read-date-analyze (ans org-def org-defdecode)
15136 "Analyze the combined answer of the date prompt."
15137 ;; FIXME: cleanup and comment
15138 (let ((nowdecode (decode-time (current-time)))
15139 delta deltan deltaw deltadef year month day
15140 hour minute second wday pm h2 m2 tl wday1
15141 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15142 (setq org-read-date-analyze-futurep nil
15143 org-read-date-analyze-forced-year nil)
15145 (setq ans "+0"))
15147 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15148 (setq ans (replace-match "" t t ans)
15149 deltan (car delta)
15150 deltaw (nth 1 delta)
15151 deltadef (nth 2 delta)))
15153 ;; Check if there is an iso week date in there
15154 ;; If yes, store the info and postpone interpreting it until the rest
15155 ;; of the parsing is done
15156 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15157 (setq iso-year (if (match-end 1)
15158 (org-small-year-to-year
15159 (string-to-number (match-string 1 ans))))
15160 iso-weekday (if (match-end 3)
15161 (string-to-number (match-string 3 ans)))
15162 iso-week (string-to-number (match-string 2 ans)))
15163 (setq ans (replace-match "" t t ans)))
15165 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15166 (when (string-match
15168 (setq year (if (match-end 2)
15169 (string-to-number (match-string 2 ans))
15170 (progn (setq kill-year t)
15171 (string-to-number (format-time-string "%Y"))))
15172 month (string-to-number (match-string 3 ans))
15173 day (string-to-number (match-string 4 ans)))
15174 (if (< year 100) (setq year (+ 2000 year)))
15176 t nil ans)))
15178 ;; Help matching dotted european dates
15179 (when (string-match
15180 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15181 (setq year (if (match-end 3)
15182 (string-to-number (match-string 3 ans))
15183 (progn (setq kill-year t)
15184 (string-to-number (format-time-string "%Y"))))
15185 day (string-to-number (match-string 1 ans))
15186 month (string-to-number (match-string 2 ans))
15188 t nil ans)))
15190 ;; Help matching american dates, like 5/30 or 5/30/7
15191 (when (string-match
15192 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15193 (setq year (if (match-end 4)
15194 (string-to-number (match-string 4 ans))
15195 (progn (setq kill-year t)
15196 (string-to-number (format-time-string "%Y"))))
15197 month (string-to-number (match-string 1 ans))
15198 day (string-to-number (match-string 2 ans)))
15199 (if (< year 100) (setq year (+ 2000 year)))
15201 t nil ans)))
15202 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15203 ;; If there is a time with am/pm, and *no* time without it, we convert
15204 ;; so that matching will be successful.
15205 (loop for i from 1 to 2 do ; twice, for end time as well
15208 (setq hour (string-to-number (match-string 1 ans))
15209 minute (if (match-end 3)
15210 (string-to-number (match-string 3 ans))
15211 0)
15212 pm (equal ?p
15213 (string-to-char (downcase (match-string 4 ans)))))
15214 (if (and (= hour 12) (not pm))
15215 (setq hour 0)
15216 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15217 (setq ans (replace-match (format "%02d:%02d" hour minute)
15218 t t ans))))
15220 ;; Check if a time range is given as a duration
15221 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15222 (setq hour (string-to-number (match-string 1 ans))
15223 h2 (+ hour (string-to-number (match-string 3 ans)))
15224 minute (string-to-number (match-string 2 ans))
15225 m2 (+ minute (if (match-end 5) (string-to-number
15226 (match-string 5 ans))0)))
15227 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15228 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15229 t t ans)))
15231 ;; Check if there is a time range
15232 (when (boundp 'org-end-time-was-given)
15233 (setq org-time-was-given nil)
15234 (when (and (string-match org-plain-time-of-day-regexp ans)
15235 (match-end 8))
15236 (setq org-end-time-was-given (match-string 8 ans))
15237 (setq ans (concat (substring ans 0 (match-beginning 7))
15238 (substring ans (match-end 7))))))
15240 (setq tl (parse-time-string ans)
15241 day (or (nth 3 tl) (nth 3 org-defdecode))
15242 month (or (nth 4 tl)
15243 (if (and org-read-date-prefer-future
15244 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15245 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15246 (nth 4 org-defdecode)))
15247 year (or (and (not kill-year) (nth 5 tl))
15248 (if (and org-read-date-prefer-future
15249 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15250 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15251 (nth 5 org-defdecode)))
15252 hour (or (nth 2 tl) (nth 2 org-defdecode))
15253 minute (or (nth 1 tl) (nth 1 org-defdecode))
15254 second (or (nth 0 tl) 0)
15255 wday (nth 6 tl))
15257 (when (and (eq org-read-date-prefer-future 'time)
15258 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15259 (equal day (nth 3 nowdecode))
15260 (equal month (nth 4 nowdecode))
15261 (equal year (nth 5 nowdecode))
15262 (nth 2 tl)
15263 (or (< (nth 2 tl) (nth 2 nowdecode))
15264 (and (= (nth 2 tl) (nth 2 nowdecode))
15265 (nth 1 tl)
15266 (< (nth 1 tl) (nth 1 nowdecode)))))
15267 (setq day (1+ day)
15268 futurep t))
15270 ;; Special date definitions below
15271 (cond
15272 (iso-week
15273 ;; There was an iso week
15274 (require 'cal-iso)
15275 (setq futurep nil)
15276 (setq year (or iso-year year)
15277 day (or iso-weekday wday 1)
15278 wday nil ; to make sure that the trigger below does not match
15279 iso-date (calendar-gregorian-from-absolute
15280 (calendar-absolute-from-iso
15281 (list iso-week day year))))
15282 ; FIXME: Should we also push ISO weeks into the future?
15283 ; (when (and org-read-date-prefer-future
15284 ; (not iso-year)
15285 ; (< (calendar-absolute-from-gregorian iso-date)
15286 ; (time-to-days (current-time))))
15287 ; (setq year (1+ year)
15288 ; iso-date (calendar-gregorian-from-absolute
15289 ; (calendar-absolute-from-iso
15290 ; (list iso-week day year)))))
15291 (setq month (car iso-date)
15292 year (nth 2 iso-date)
15293 day (nth 1 iso-date)))
15294 (deltan
15295 (setq futurep nil)
15296 (unless deltadef
15297 (let ((now (decode-time (current-time))))
15298 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15299 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15300 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15301 ((equal deltaw "m") (setq month (+ month deltan)))
15302 ((equal deltaw "y") (setq year (+ year deltan)))))
15303 ((and wday (not (nth 3 tl)))
15304 (setq futurep nil)
15305 ;; Weekday was given, but no day, so pick that day in the week
15306 ;; on or after the derived date.
15307 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15308 (unless (equal wday wday1)
15309 (setq day (+ day (% (- wday wday1 -7) 7))))))
15310 (if (and (boundp 'org-time-was-given)
15311 (nth 2 tl))
15312 (setq org-time-was-given t))
15313 (if (< year 100) (setq year (+ 2000 year)))
15314 ;; Check of the date is representable
15315 (if org-read-date-force-compatible-dates
15316 (progn
15317 (if (< year 1970)
15318 (setq year 1970 org-read-date-analyze-forced-year t))
15319 (if (> year 2037)
15320 (setq year 2037 org-read-date-analyze-forced-year t)))
15321 (condition-case nil
15322 (ignore (encode-time second minute hour day month year))
15323 (error
15324 (setq year (nth 5 org-defdecode))
15325 (setq org-read-date-analyze-forced-year t))))
15326 (setq org-read-date-analyze-futurep futurep)
15327 (list second minute hour day month year)))
15329 (defvar parse-time-weekdays)
15330 (defun org-read-date-get-relative (s today default)
15331 "Check string S for special relative date string.
15332 TODAY and DEFAULT are internal times, for today and for a default.
15333 Return shift list (N what def-flag)
15335 N is the number of WHATs to shift.
15336 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15337 the DEFAULT date rather than TODAY."
15338 (require 'parse-time)
15339 (when (and
15340 (string-match
15341 (concat
15346 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15347 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15348 (string-to-char (substring (match-string 1 s) -1))
15349 ?+))
15350 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15351 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15352 (what (if (match-end 3) (match-string 3 s) "d"))
15353 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15354 (date (if rel default today))
15355 (wday (nth 6 (decode-time date)))
15356 delta)
15357 (if wday1
15358 (progn
15359 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15360 (if (= dir ?-) (setq delta (- delta 7)))
15361 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15362 (list delta "d" rel))
15363 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15365 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15366 "Turn a user-specified date into the internal representation.
15367 The internal representation needed by the calendar is (month day year).
15368 This is a wrapper to handle the brain-dead convention in calendar that
15369 user function argument order change dependent on argument order."
15370 (if (boundp 'calendar-date-style)
15371 (cond
15372 ((eq calendar-date-style 'american)
15373 (list arg1 arg2 arg3))
15374 ((eq calendar-date-style 'european)
15375 (list arg2 arg1 arg3))
15376 ((eq calendar-date-style 'iso)
15377 (list arg2 arg3 arg1)))
15378 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15379 (if (org-bound-and-true-p european-calendar-style)
15380 (list arg2 arg1 arg3)
15381 (list arg1 arg2 arg3)))))
15383 (defun org-eval-in-calendar (form &optional keepdate)
15384 "Eval FORM in the calendar window and return to current window.
15385 Also, store the cursor date in variable org-ans2."
15386 (let ((sf (selected-frame))
15387 (sw (selected-window)))
15388 (select-window (get-buffer-window "*Calendar*" t))
15389 (eval form)
15390 (when (and (not keepdate) (calendar-cursor-to-date))
15391 (let* ((date (calendar-cursor-to-date))
15392 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15393 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15394 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15395 (select-window sw)
15396 (org-select-frame-set-input-focus sf)))
15398 (defun org-calendar-select ()
15399 "Return to `org-read-date' with the date currently selected.
15400 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15401 (interactive)
15402 (when (calendar-cursor-to-date)
15403 (let* ((date (calendar-cursor-to-date))
15404 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15405 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15406 (if (active-minibuffer-window) (exit-minibuffer))))
15408 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15409 "Insert a date stamp for the date given by the internal TIME.
15410 WITH-HM means use the stamp format that includes the time of the day.
15411 INACTIVE means use square brackets instead of angular ones, so that the
15412 stamp will not contribute to the agenda.
15413 PRE and POST are optional strings to be inserted before and after the
15414 stamp.
15415 The command returns the inserted time stamp."
15416 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15417 stamp)
15418 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15419 (insert-before-markers (or pre ""))
15420 (when (listp extra)
15421 (setq extra (car extra))
15422 (if (and (stringp extra)
15424 (setq extra (format "-%02d:%02d"
15425 (string-to-number (match-string 1 extra))
15426 (string-to-number (match-string 2 extra))))
15427 (setq extra nil)))
15428 (when extra
15429 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15430 (insert-before-markers (setq stamp (format-time-string fmt time)))
15431 (insert-before-markers (or post ""))
15432 (setq org-last-inserted-timestamp stamp)))
15434 (defun org-toggle-time-stamp-overlays ()
15435 "Toggle the use of custom time stamp formats."
15436 (interactive)
15437 (setq org-display-custom-times (not org-display-custom-times))
15438 (unless org-display-custom-times
15439 (let ((p (point-min)) (bmp (buffer-modified-p)))
15440 (while (setq p (next-single-property-change p 'display))
15441 (if (and (get-text-property p 'display)
15442 (eq (get-text-property p 'face) 'org-date))
15443 (remove-text-properties
15444 p (setq p (next-single-property-change p 'display))
15445 '(display t))))
15446 (set-buffer-modified-p bmp)))
15447 (if (featurep 'xemacs)
15448 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15449 (org-restart-font-lock)
15450 (setq org-table-may-need-update t)
15451 (if org-display-custom-times
15452 (message "Time stamps are overlaid with custom format")
15453 (message "Time stamp overlays removed")))
15455 (defun org-display-custom-time (beg end)
15456 "Overlay modified time stamp format over timestamp between BEG and END."
15457 (let* ((ts (buffer-substring beg end))
15458 t1 w1 with-hm tf time str w2 (off 0))
15459 (save-match-data
15460 (setq t1 (org-parse-time-string ts t))
15461 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15462 (setq off (- (match-end 0) (match-beginning 0)))))
15463 (setq end (- end off))
15464 (setq w1 (- end beg)
15465 with-hm (and (nth 1 t1) (nth 2 t1))
15466 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15467 time (org-fix-decoded-time t1)
15468 str (org-add-props
15469 (format-time-string
15470 (substring tf 1 -1) (apply 'encode-time time))
15471 nil 'mouse-face 'highlight)
15472 w2 (length str))
15473 (if (not (= w2 w1))
15474 (add-text-properties (1+ beg) (+ 2 beg)
15475 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15476 (if (featurep 'xemacs)
15477 (progn
15478 (put-text-property beg end 'invisible t)
15479 (put-text-property beg end 'end-glyph (make-glyph str)))
15480 (put-text-property beg end 'display str))))
15482 (defun org-translate-time (string)
15483 "Translate all timestamps in STRING to custom format.
15484 But do this only if the variable `org-display-custom-times' is set."
15485 (when org-display-custom-times
15486 (save-match-data
15487 (let* ((start 0)
15488 (re org-ts-regexp-both)
15489 t1 with-hm inactive tf time str beg end)
15490 (while (setq start (string-match re string start))
15491 (setq beg (match-beginning 0)
15492 end (match-end 0)
15493 t1 (save-match-data
15494 (org-parse-time-string (substring string beg end) t))
15495 with-hm (and (nth 1 t1) (nth 2 t1))
15496 inactive (equal (substring string beg (1+ beg)) "[")
15497 tf (funcall (if with-hm 'cdr 'car)
15498 org-time-stamp-custom-formats)
15499 time (org-fix-decoded-time t1)
15500 str (format-time-string
15501 (concat
15502 (if inactive "[" "<") (substring tf 1 -1)
15503 (if inactive "]" ">"))
15504 (apply 'encode-time time))
15505 string (replace-match str t t string)
15506 start (+ start (length str)))))))
15507 string)
15509 (defun org-fix-decoded-time (time)
15510 "Set 0 instead of nil for the first 6 elements of time.
15511 Don't touch the rest."
15512 (let ((n 0))
15513 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15515 (defun org-days-to-time (timestamp-string)
15516 "Difference between TIMESTAMP-STRING and now in days."
15517 (- (time-to-days (org-time-string-to-time timestamp-string))
15518 (time-to-days (current-time))))
15520 (defun org-deadline-close (timestamp-string &optional ndays)
15521 "Is the time in TIMESTAMP-STRING close to the current date?"
15522 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15523 (and (< (org-days-to-time timestamp-string) ndays)
15524 (not (org-entry-is-done-p))))
15526 (defun org-get-wdays (ts)
15527 "Get the deadline lead time appropriate for timestring TS."
15528 (cond
15529 ((<= org-deadline-warning-days 0)
15530 ;; 0 or negative, enforce this value no matter what
15531 (- org-deadline-warning-days))
15533 ;; lead time is specified.
15534 (floor (* (string-to-number (match-string 1 ts))
15535 (cdr (assoc (match-string 2 ts)
15536 '(("d" . 1) ("w" . 7)
15537 ("m" . 30.4) ("y" . 365.25)))))))
15538 ;; go for the default.
15539 (t org-deadline-warning-days)))
15541 (defun org-calendar-select-mouse (ev)
15542 "Return to `org-read-date' with the date currently selected.
15543 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15544 (interactive "e")
15545 (mouse-set-point ev)
15546 (when (calendar-cursor-to-date)
15547 (let* ((date (calendar-cursor-to-date))
15548 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15549 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15550 (if (active-minibuffer-window) (exit-minibuffer))))
15552 (defun org-check-deadlines (ndays)
15553 "Check if there are any deadlines due or past due.
15554 A deadline is considered due if it happens within `org-deadline-warning-days'
15555 days from today's date. If the deadline appears in an entry marked DONE,
15556 it is not shown. The prefix arg NDAYS can be used to test that many
15558 (interactive "P")
15559 (let* ((org-warn-days
15560 (cond
15561 ((equal ndays '(4)) 100000)
15562 (ndays (prefix-numeric-value ndays))
15563 (t (abs org-deadline-warning-days))))
15564 (case-fold-search nil)
15566 (callback
15567 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15569 (message "%d deadlines past-due or due within %d days"
15570 (org-occur regexp nil callback)
15571 org-warn-days)))
15573 (defun org-check-before-date (date)
15574 "Check if there are deadlines or scheduled entries before DATE."
15575 (interactive (list (org-read-date)))
15576 (let ((case-fold-search nil)
15580 (callback
15581 (lambda () (time-less-p
15582 (org-time-string-to-time (match-string 2))
15583 (org-time-string-to-time date)))))
15584 (message "%d entries before %s"
15585 (org-occur regexp nil callback) date)))
15587 (defun org-check-after-date (date)
15588 "Check if there are deadlines or scheduled entries after DATE."
15589 (interactive (list (org-read-date)))
15590 (let ((case-fold-search nil)
15594 (callback
15595 (lambda () (not
15596 (time-less-p
15597 (org-time-string-to-time (match-string 2))
15598 (org-time-string-to-time date))))))
15599 (message "%d entries after %s"
15600 (org-occur regexp nil callback) date)))
15602 (defun org-check-dates-range (start-date end-date)
15603 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15604 (interactive (list (org-read-date nil nil nil "Range starts")
15605 (org-read-date nil nil nil "Range end")))
15606 (let ((case-fold-search nil)
15610 (callback
15611 (lambda ()
15612 (let ((match (match-string 2)))
15613 (and
15614 (not (time-less-p
15615 (org-time-string-to-time match)
15616 (org-time-string-to-time start-date)))
15617 (time-less-p
15618 (org-time-string-to-time match)
15619 (org-time-string-to-time end-date)))))))
15620 (message "%d entries between %s and %s"
15621 (org-occur regexp nil callback) start-date end-date)))
15623 (defun org-evaluate-time-range (&optional to-buffer)
15624 "Evaluate a time range by computing the difference between start and end.
15625 Normally the result is just printed in the echo area, but with prefix arg
15626 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15627 If the time range is actually in a table, the result is inserted into the
15628 next column.
15629 For time difference computation, a year is assumed to be exactly 365
15630 days in order to avoid rounding problems."
15631 (interactive "P")
15632 (or
15633 (org-clock-update-time-maybe)
15634 (save-excursion
15635 (unless (org-at-date-range-p t)
15636 (goto-char (point-at-bol))
15637 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15638 (if (not (org-at-date-range-p t))
15639 (error "Not at a time-stamp range, and none found in current line")))
15640 (let* ((ts1 (match-string 1))
15641 (ts2 (match-string 2))
15642 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15643 (match-end (match-end 0))
15644 (time1 (org-time-string-to-time ts1))
15645 (time2 (org-time-string-to-time ts2))
15646 (t1 (org-float-time time1))
15647 (t2 (org-float-time time2))
15648 (diff (abs (- t2 t1)))
15649 (negative (< (- t2 t1) 0))
15650 ;; (ys (floor (* 365 24 60 60)))
15651 (ds (* 24 60 60))
15652 (hs (* 60 60))
15653 (fy "%dy %dd %02d:%02d")
15654 (fy1 "%dy %dd")
15655 (fd "%dd %02d:%02d")
15656 (fd1 "%dd")
15657 (fh "%02d:%02d")
15658 y d h m align)
15659 (if havetime
15660 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15661 y 0
15662 d (floor (/ diff ds)) diff (mod diff ds)
15663 h (floor (/ diff hs)) diff (mod diff hs)
15664 m (floor (/ diff 60)))
15665 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15666 y 0
15667 d (floor (+ (/ diff ds) 0.5))
15668 h 0 m 0))
15669 (if (not to-buffer)
15670 (message "%s" (org-make-tdiff-string y d h m))
15671 (if (org-at-table-p)
15672 (progn
15673 (goto-char match-end)
15674 (setq align t)
15675 (and (looking-at " *|") (goto-char (match-end 0))))
15676 (goto-char match-end))
15677 (if (looking-at
15679 (replace-match ""))
15680 (if negative (insert " -"))
15681 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15682 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15683 (insert " " (format fh h m))))
15684 (if align (org-table-align))
15685 (message "Time difference inserted")))))
15687 (defun org-make-tdiff-string (y d h m)
15688 (let ((fmt "")
15689 (l nil))
15690 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15691 l (push y l)))
15692 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15693 l (push d l)))
15694 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15695 l (push h l)))
15696 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15697 l (push m l)))
15698 (apply 'format fmt (nreverse l))))
15700 (defun org-time-string-to-time (s &optional buffer pos)
15701 (condition-case errdata
15702 (apply 'encode-time (org-parse-time-string s))
15704 s (if (not (and buffer pos))
15705 ""
15706 (format " at %d in buffer `%s'" pos buffer))
15707 (cdr errdata)))))
15709 (defun org-time-string-to-seconds (s)
15710 (org-float-time (org-time-string-to-time s)))
15712 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15713 "Convert a time stamp to an absolute day number.
15714 If there is a specifier for a cyclic time stamp, get the closest date to
15715 DAYNR.
15716 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15717 The variable date is bound by the calendar when this is called."
15718 (cond
15720 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15721 daynr
15722 (+ daynr 1000)))
15724 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15725 (time-to-days (current-time))) (match-string 0 s)
15726 prefer show-all))
15727 (t (time-to-days
15728 (condition-case errdata
15729 (apply 'encode-time (org-parse-time-string s))
15731 s (if (not (and buffer pos))
15732 ""
15733 (format " at %d in buffer `%s'" pos buffer))
15734 (cdr errdata))))))))
15736 (defun org-days-to-iso-week (days)
15737 "Return the iso week number."
15738 (require 'cal-iso)
15739 (car (calendar-iso-from-absolute days)))
15741 (defun org-small-year-to-year (year)
15742 "Convert 2-digit years into 4-digit years.
15743 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15744 The year 2000 cannot be abbreviated. Any year larger than 99
15745 is returned unchanged."
15746 (if (< year 38)
15747 (setq year (+ 2000 year))
15748 (if (< year 100)
15749 (setq year (+ 1900 year))))
15750 year)
15752 (defun org-time-from-absolute (d)
15753 "Return the time corresponding to date D.
15754 D may be an absolute day number, or a calendar-type list (month day year)."
15755 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15756 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15758 (defun org-calendar-holiday ()
15759 "List of holidays, for Diary display in Org-mode."
15760 (require 'holidays)
15761 (let ((hl (funcall
15762 (if (fboundp 'calendar-check-holidays)
15763 'calendar-check-holidays 'check-calendar-holidays) date)))
15764 (if hl (mapconcat 'identity hl "; "))))
15766 (defun org-diary-sexp-entry (sexp entry date)
15767 "Process a SEXP diary ENTRY for DATE."
15768 (require 'diary-lib)
15769 (let ((result (if calendar-debug-sexp
15770 (let ((stack-trace-on-error t))
15771 (eval (car (read-from-string sexp))))
15772 (condition-case nil
15773 (eval (car (read-from-string sexp)))
15774 (error
15775 (beep)
15776 (message "Bad sexp at line %d in %s: %s"
15777 (org-current-line)
15778 (buffer-file-name) sexp)
15779 (sleep-for 2))))))
15780 (cond ((stringp result) (split-string result "; "))
15781 ((and (consp result)
15782 (not (consp (cdr result)))
15783 (stringp (cdr result))) (cdr result))
15784 ((and (consp result)
15785 (stringp (car result))) result)
15786 (result entry)
15787 (t nil))))
15789 (defun org-diary-to-ical-string (frombuf)
15790 "Get iCalendar entries from diary entries in buffer FROMBUF.
15791 This uses the icalendar.el library."
15792 (let* ((tmpdir (if (featurep 'xemacs)
15793 (temp-directory)
15794 temporary-file-directory))
15795 (tmpfile (make-temp-name
15796 (expand-file-name "orgics" tmpdir)))
15797 buf rtn b e)
15798 (with-current-buffer frombuf
15799 (icalendar-export-region (point-min) (point-max) tmpfile)
15800 (setq buf (find-buffer-visiting tmpfile))
15801 (set-buffer buf)
15802 (goto-char (point-min))
15803 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15804 (setq b (match-beginning 0)))
15805 (goto-char (point-max))
15806 (if (re-search-backward "^END:VEVENT" nil t)
15807 (setq e (match-end 0)))
15809 (kill-buffer buf)
15810 (delete-file tmpfile)
15811 rtn))
15813 (defun org-closest-date (start current change prefer show-all)
15814 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15815 When PREFER is `past', return a date that is either CURRENT or past.
15816 When PREFER is `future', return a date that is either CURRENT or future.
15817 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15818 ;; Make the proper lists from the dates
15819 (catch 'exit
15820 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15821 dn dw sday cday n1 n2 n0
15822 d m y y1 y2 date1 date2 nmonths nm ny m2)
15824 (setq start (org-date-to-gregorian start)
15825 current (org-date-to-gregorian
15826 (if show-all
15827 current
15828 (time-to-days (current-time))))
15829 sday (calendar-absolute-from-gregorian start)
15830 cday (calendar-absolute-from-gregorian current))
15832 (if (<= cday sday) (throw 'exit sday))
15835 (setq dn (string-to-number (match-string 1 change))
15836 dw (cdr (assoc (match-string 2 change) a1)))
15837 (error "Invalid change specifier: %s" change))
15838 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15839 (cond
15840 ((eq dw 'day)
15841 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15842 n2 (+ n1 dn)))
15843 ((eq dw 'year)
15844 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15845 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15846 (setq date1 (list m d y1)
15847 n1 (calendar-absolute-from-gregorian date1)
15848 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15849 n2 (calendar-absolute-from-gregorian date2)))
15850 ((eq dw 'month)
15851 ;; approx number of month between the two dates
15852 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15853 ;; How often does dn fit in there?
15854 (setq d (nth 1 start) m (car start) y (nth 2 start)
15855 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15856 m (+ m nm)
15857 ny (floor (/ m 12))
15858 y (+ y ny)
15859 m (- m (* ny 12)))
15860 (while (> m 12) (setq m (- m 12) y (1+ y)))
15861 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15862 (setq m2 (+ m dn) y2 y)
15863 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15864 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15865 (while (<= n2 cday)
15866 (setq n1 n2 m m2 y y2)
15867 (setq m2 (+ m dn) y2 y)
15868 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15869 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15870 ;; Make sure n1 is the earlier date
15871 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15872 (if show-all
15873 (cond
15874 ((eq prefer 'past) (if (= cday n2) n2 n1))
15875 ((eq prefer 'future) (if (= cday n1) n1 n2))
15876 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15877 (cond
15878 ((eq prefer 'past) (if (= cday n2) n2 n1))
15879 ((eq prefer 'future) (if (= cday n1) n1 n2))
15880 (t (if (= cday n1) n1 n2)))))))
15882 (defun org-date-to-gregorian (date)
15883 "Turn any specification of DATE into a Gregorian date for the calendar."
15884 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15885 ((and (listp date) (= (length date) 3)) date)
15886 ((stringp date)
15887 (setq date (org-parse-time-string date))
15888 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15889 ((listp date)
15890 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15892 (defun org-parse-time-string (s &optional nodefault)
15893 "Parse the standard Org-mode time string.
15894 This should be a lot faster than the normal `parse-time-string'.
15895 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15896 hour and minute fields will be nil if not given."
15897 (if (string-match org-ts-regexp0 s)
15898 (list 0
15899 (if (or (match-beginning 8) (not nodefault))
15900 (string-to-number (or (match-string 8 s) "0")))
15901 (if (or (match-beginning 7) (not nodefault))
15902 (string-to-number (or (match-string 7 s) "0")))
15903 (string-to-number (match-string 4 s))
15904 (string-to-number (match-string 3 s))
15905 (string-to-number (match-string 2 s))
15906 nil nil nil)
15907 (error "Not a standard Org-mode time string: %s" s)))
15909 (defun org-timestamp-up (&optional arg)
15910 "Increase the date item at the cursor by one.
15911 If the cursor is on the year, change the year. If it is on the month,
15912 the day or the time, change that.
15913 With prefix ARG, change by that many units."
15914 (interactive "p")
15915 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15917 (defun org-timestamp-down (&optional arg)
15918 "Decrease the date item at the cursor by one.
15919 If the cursor is on the year, change the year. If it is on the month,
15920 the day or the time, change that.
15921 With prefix ARG, change by that many units."
15922 (interactive "p")
15923 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15925 (defun org-timestamp-up-day (&optional arg)
15926 "Increase the date in the time stamp by one day.
15927 With prefix ARG, change that many days."
15928 (interactive "p")
15929 (if (and (not (org-at-timestamp-p t))
15930 (org-at-heading-p))
15931 (org-todo 'up)
15932 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15934 (defun org-timestamp-down-day (&optional arg)
15935 "Decrease the date in the time stamp by one day.
15936 With prefix ARG, change that many days."
15937 (interactive "p")
15938 (if (and (not (org-at-timestamp-p t))
15939 (org-at-heading-p))
15940 (org-todo 'down)
15941 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15943 (defun org-at-timestamp-p (&optional inactive-ok)
15944 "Determine if the cursor is in or at a timestamp."
15945 (interactive)
15946 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15947 (pos (point))
15948 (ans (or (looking-at tsr)
15949 (save-excursion
15951 (if (> (point) (point-min)) (backward-char 1))
15952 (and (looking-at tsr)
15953 (> (- (match-end 0) pos) -1))))))
15954 (and ans
15955 (boundp 'org-ts-what)
15956 (setq org-ts-what
15957 (cond
15958 ((= pos (match-beginning 0)) 'bracket)
15959 ;; Point is considered to be "on the bracket" whether
15960 ;; it's really on it or right after it.
15961 ((or (= pos (1- (match-end 0)))
15962 (= pos (match-end 0))) 'bracket)
15963 ((org-pos-in-match-range pos 2) 'year)
15964 ((org-pos-in-match-range pos 3) 'month)
15965 ((org-pos-in-match-range pos 7) 'hour)
15966 ((org-pos-in-match-range pos 8) 'minute)
15967 ((or (org-pos-in-match-range pos 4)
15968 (org-pos-in-match-range pos 5)) 'day)
15969 ((and (> pos (or (match-end 8) (match-end 5)))
15970 (< pos (match-end 0)))
15971 (- pos (or (match-end 8) (match-end 5))))
15972 (t 'day))))
15973 ans))
15975 (defun org-toggle-timestamp-type ()
15976 "Toggle the type (<active> or [inactive]) of a time stamp."
15977 (interactive)
15978 (when (org-at-timestamp-p t)
15979 (let ((beg (match-beginning 0)) (end (match-end 0))
15980 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15981 (save-excursion
15982 (goto-char beg)
15983 (while (re-search-forward "[][<>]" end t)
15984 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15985 t t)))
15986 (message "Timestamp is now %sactive"
15987 (if (equal (char-after beg) ?<) "" "in")))))
15989 (defun org-timestamp-change (n &optional what updown)
15990 "Change the date in the time stamp at point.
15991 The date will be changed by N times WHAT. WHAT can be `day', `month',
15992 `year', `minute', `second'. If WHAT is not given, the cursor position
15993 in the timestamp determines what will be changed."
15994 (let ((origin (point)) origin-cat
15995 with-hm inactive
15996 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15997 org-ts-what
15998 extra rem
15999 ts time time0)
16000 (if (not (org-at-timestamp-p t))
16001 (error "Not at a timestamp"))
16002 (if (and (not what) (eq org-ts-what 'bracket))
16003 (org-toggle-timestamp-type)
16004 ;; Point isn't on brackets. Remember the part of the time-stamp
16005 ;; the point was in. Indeed, size of time-stamps may change,
16006 ;; but point must be kept in the same category nonetheless.
16007 (setq origin-cat org-ts-what)
16008 (if (and (not what) (not (eq org-ts-what 'day))
16009 org-display-custom-times
16010 (get-text-property (point) 'display)
16011 (not (get-text-property (1- (point)) 'display)))
16012 (setq org-ts-what 'day))
16013 (setq org-ts-what (or what org-ts-what)
16014 inactive (= (char-after (match-beginning 0)) ?\[)
16015 ts (match-string 0))
16016 (replace-match "")
16017 (if (string-match
16019 ts)
16020 (setq extra (match-string 1 ts)))
16022 (setq with-hm t))
16023 (setq time0 (org-parse-time-string ts))
16024 (when (and updown
16025 (eq org-ts-what 'minute)
16026 (not current-prefix-arg))
16027 ;; This looks like s-up and s-down. Change by one rounding step.
16028 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16029 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16030 (setcar (cdr time0) (+ (nth 1 time0)
16031 (if (> n 0) (- rem) (- dm rem))))))
16032 (setq time
16033 (encode-time (or (car time0) 0)
16034 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16035 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16036 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16037 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16038 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16039 (nthcdr 6 time0)))
16040 (when (and (member org-ts-what '(hour minute))
16041 extra
16043 (setq extra (org-modify-ts-extra
16044 extra
16045 (if (eq org-ts-what 'hour) 2 5)
16046 n dm)))
16047 (when (integerp org-ts-what)
16048 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16049 (if (eq what 'calendar)
16050 (let ((cal-date (org-get-date-from-calendar)))
16051 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16052 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16053 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16054 (setcar time0 (or (car time0) 0))
16055 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16056 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16057 (setq time (apply 'encode-time time0))))
16058 ;; Insert the new time-stamp, and ensure point stays in the same
16059 ;; category as before (i.e. not after the last position in that
16060 ;; category).
16061 (let ((pos (point)))
16062 ;; Stay before inserted string. `save-excursion' is of no use.
16063 (setq org-last-changed-timestamp
16064 (org-insert-time-stamp time with-hm inactive nil nil extra))
16065 (goto-char pos))
16066 (save-match-data
16067 (looking-at org-ts-regexp3)
16068 (goto-char (cond
16069 ;; `day' category ends before `hour' if any, or at
16070 ;; the end of the day name.
16071 ((eq origin-cat 'day)
16072 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16073 ((eq origin-cat 'hour) (min (match-end 7) origin))
16074 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16075 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16076 ;; `year' and `month' have both fixed size: point
16077 ;; couldn't have moved into another part.
16078 (t origin))))
16079 ;; Update clock if on a CLOCK line.
16080 (org-clock-update-time-maybe)
16081 ;; Try to recenter the calendar window, if any.
16082 (if (and org-calendar-follow-timestamp-change
16083 (get-buffer-window "*Calendar*" t)
16084 (memq org-ts-what '(day month year)))
16085 (org-recenter-calendar (time-to-days time))))))
16087 (defun org-modify-ts-extra (s pos n dm)
16088 "Change the different parts of the lead-time and repeat fields in timestamp."
16089 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16090 ng h m new rem)
16091 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16092 (cond
16093 ((or (org-pos-in-match-range pos 2)
16094 (org-pos-in-match-range pos 3))
16095 (setq m (string-to-number (match-string 3 s))
16096 h (string-to-number (match-string 2 s)))
16097 (if (org-pos-in-match-range pos 2)
16098 (setq h (+ h n))
16099 (setq n (* dm (org-no-warnings (signum n))))
16100 (when (not (= 0 (setq rem (% m dm))))
16101 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16102 (setq m (+ m n)))
16103 (if (< m 0) (setq m (+ m 60) h (1- h)))
16104 (if (> m 59) (setq m (- m 60) h (1+ h)))
16105 (setq h (min 24 (max 0 h)))
16106 (setq ng 1 new (format "-%02d:%02d" h m)))
16107 ((org-pos-in-match-range pos 6)
16108 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16109 ((org-pos-in-match-range pos 5)
16110 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16112 ((org-pos-in-match-range pos 9)
16113 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16114 ((org-pos-in-match-range pos 8)
16115 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16117 (when ng
16118 (setq s (concat
16119 (substring s 0 (match-beginning ng))
16120 new
16121 (substring s (match-end ng))))))
16122 s))
16124 (defun org-recenter-calendar (date)
16125 "If the calendar is visible, recenter it to DATE."
16126 (let ((cwin (get-buffer-window "*Calendar*" t)))
16127 (when cwin
16128 (let ((calendar-move-hook nil))
16129 (with-selected-window cwin
16130 (calendar-goto-date (if (listp date) date
16131 (calendar-gregorian-from-absolute date))))))))
16133 (defun org-goto-calendar (&optional arg)
16134 "Go to the Emacs calendar at the current date.
16135 If there is a time stamp in the current line, go to that date.
16136 A prefix ARG can be used to force the current date."
16137 (interactive "P")
16138 (let ((tsr org-ts-regexp) diff
16139 (calendar-move-hook nil)
16140 (calendar-view-holidays-initially-flag nil)
16141 (calendar-view-diary-initially-flag nil))
16142 (if (or (org-at-timestamp-p)
16143 (save-excursion
16144 (beginning-of-line 1)
16145 (looking-at (concat ".*" tsr))))
16146 (let ((d1 (time-to-days (current-time)))
16147 (d2 (time-to-days
16148 (org-time-string-to-time (match-string 1)))))
16149 (setq diff (- d2 d1))))
16150 (calendar)
16151 (calendar-goto-today)
16152 (if (and diff (not arg)) (calendar-forward-day diff))))
16154 (defun org-get-date-from-calendar ()
16155 "Return a list (month day year) of date at point in calendar."
16156 (with-current-buffer "*Calendar*"
16157 (save-match-data
16158 (calendar-cursor-to-date))))
16160 (defun org-date-from-calendar ()
16161 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16162 If there is already a time stamp at the cursor position, update it."
16163 (interactive)
16164 (if (org-at-timestamp-p t)
16165 (org-timestamp-change 0 'calendar)
16166 (let ((cal-date (org-get-date-from-calendar)))
16167 (org-insert-time-stamp
16168 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16170 (defun org-minutes-to-hh:mm-string (m)
16171 "Compute H:MM from a number of minutes."
16172 (let ((h (/ m 60)))
16173 (setq m (- m (* 60 h)))
16174 (format org-time-clocksum-format h m)))
16176 (defun org-hh:mm-string-to-minutes (s)
16177 "Convert a string H:MM to a number of minutes.
16178 If the string is just a number, interpret it as minutes.
16179 In fact, the first hh:mm or number in the string will be taken,
16180 there can be extra stuff in the string.
16181 If no number is found, the return value is 0."
16182 (cond
16183 ((integerp s) s)
16185 (+ (* (string-to-number (match-string 1 s)) 60)
16186 (string-to-number (match-string 2 s))))
16188 (string-to-number (match-string 1 s)))
16189 (t 0)))
16191 (defcustom org-effort-durations
16192 `(("h" . 60)
16193 ("d" . ,(* 60 8))
16194 ("w" . ,(* 60 8 5))
16195 ("m" . ,(* 60 8 5 4))
16196 ("y" . ,(* 60 8 5 40)))
16197 "Conversion factor to minutes for an effort modifier.
16199 Each entry has the form (MODIFIER . MINUTES).
16201 In an effort string, a number followed by MODIFIER is multiplied
16202 by the specified number of MINUTES to obtain an effort in
16203 minutes.
16207 :group 'org-agenda
16208 :type '(alist :key-type (string :tag "Modifier")
16209 :value-type (number :tag "Minutes")))
16211 (defun org-duration-string-to-minutes (s)
16212 "Convert a duration string S to minutes.
16214 A bare number is interpreted as minutes, modifiers can be set by
16215 customizing `org-effort-durations' (which see).
16217 Entries containing a colon are interpreted as H:MM by
16218 `org-hh:mm-string-to-minutes'."
16219 (let ((result 0)
16221 (regexp-opt (mapcar 'car org-effort-durations))
16223 (while (string-match re s)
16224 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16225 (string-to-number (match-string 1 s))))
16226 (setq s (replace-match "" nil t s)))
16227 (incf result (org-hh:mm-string-to-minutes s))
16228 result))
16230 ;;;; Files
16232 (defun org-save-all-org-buffers ()
16233 "Save all Org-mode buffers without user confirmation."
16234 (interactive)
16235 (message "Saving all Org-mode buffers...")
16236 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16237 (when (featurep 'org-id) (org-id-locations-save))
16238 (message "Saving all Org-mode buffers... done"))
16240 (defun org-revert-all-org-buffers ()
16241 "Revert all Org-mode buffers.
16242 Prompt for confirmation when there are unsaved changes.
16243 Be sure you know what you are doing before letting this function
16244 overwrite your changes.
16246 This function is useful in a setup where one tracks org files
16247 with a version control system, to revert on one machine after pulling
16248 changes from another. I believe the procedure must be like this:
16250 1. M-x org-save-all-org-buffers
16251 2. Pull changes from the other machine, resolve conflicts
16252 3. M-x org-revert-all-org-buffers"
16253 (interactive)
16254 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16255 (error "Abort"))
16256 (save-excursion
16257 (save-window-excursion
16258 (mapc
16259 (lambda (b)
16260 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16261 (with-current-buffer b buffer-file-name))
16262 (org-pop-to-buffer-same-window b)
16263 (revert-buffer t 'no-confirm)))
16264 (buffer-list))
16265 (when (and (featurep 'org-id) org-id-track-globally)
16266 (org-id-locations-load)))))
16268 ;;;; Agenda files
16270 ;;;###autoload
16271 (defun org-switchb (&optional arg)
16272 "Switch between Org buffers.
16273 With one prefix argument, restrict available buffers to files.
16274 With two prefix arguments, restrict available buffers to agenda files.
16276 Defaults to `iswitchb' for buffer name completion.
16277 Set `org-completion-use-ido' to make it use ido instead."
16278 (interactive "P")
16279 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16280 ((equal arg '(16)) (org-buffer-list 'agenda))
16281 (t (org-buffer-list))))
16282 (org-completion-use-iswitchb org-completion-use-iswitchb)
16283 (org-completion-use-ido org-completion-use-ido))
16284 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16285 (setq org-completion-use-iswitchb t))
16286 (org-pop-to-buffer-same-window
16287 (org-icompleting-read "Org buffer: "
16288 (mapcar 'list (mapcar 'buffer-name blist))
16289 nil t))))
16291 ;;; Define some older names previously used for this functionality
16292 ;;;###autoload
16293 (defalias 'org-ido-switchb 'org-switchb)
16294 ;;;###autoload
16295 (defalias 'org-iswitchb 'org-switchb)
16297 (defun org-buffer-list (&optional predicate exclude-tmp)
16298 "Return a list of Org buffers.
16299 PREDICATE can be `export', `files' or `agenda'.
16301 export restrict the list to Export buffers.
16302 files restrict the list to buffers visiting Org files.
16303 agenda restrict the list to buffers visiting agenda files.
16305 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16306 (let* ((bfn nil)
16307 (agenda-files (and (eq predicate 'agenda)
16308 (mapcar 'file-truename (org-agenda-files t))))
16309 (filter
16310 (cond
16311 ((eq predicate 'files)
16312 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16313 ((eq predicate 'export)
16314 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16315 ((eq predicate 'agenda)
16316 (lambda (b)
16317 (with-current-buffer b
16318 (and (eq major-mode 'org-mode)
16319 (setq bfn (buffer-file-name b))
16320 (member (file-truename bfn) agenda-files)))))
16321 (t (lambda (b) (with-current-buffer b
16322 (or (eq major-mode 'org-mode)
16323 (string-match "\*Org .*Export"
16324 (buffer-name b)))))))))
16325 (delq nil
16326 (mapcar
16327 (lambda(b)
16328 (if (and (funcall filter b)
16329 (or (not exclude-tmp)
16330 (not (string-match "tmp" (buffer-name b)))))
16331 b
16332 nil))
16333 (buffer-list)))))
16335 (defun org-agenda-files (&optional unrestricted archives)
16336 "Get the list of agenda files.
16337 Optional UNRESTRICTED means return the full list even if a restriction
16338 is currently in place.
16339 When ARCHIVES is t, include all archive files that are really being
16340 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16341 `org-agenda-archives-mode' is t."
16342 (let ((files
16343 (cond
16344 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16345 ((stringp org-agenda-files) (org-read-agenda-file-list))
16346 ((listp org-agenda-files) org-agenda-files)
16347 (t (error "Invalid value of `org-agenda-files'")))))
16348 (setq files (apply 'append
16349 (mapcar (lambda (f)
16350 (if (file-directory-p f)
16351 (directory-files
16352 f t org-agenda-file-regexp)
16353 (list f)))
16354 files)))
16355 (when org-agenda-skip-unavailable-files
16356 (setq files (delq nil
16357 (mapcar (function
16358 (lambda (file)
16359 (and (file-readable-p file) file)))
16360 files))))
16361 (when (or (eq archives t)
16362 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16363 (setq files (org-add-archive-files files)))
16364 files))
16366 (defun org-agenda-file-p (&optional file)
16367 "Return non-nil, if FILE is an agenda file.
16368 If FILE is omitted, use the file associated with the current
16369 buffer."
16370 (member (or file (buffer-file-name))
16371 (org-agenda-files t)))
16373 (defun org-edit-agenda-file-list ()
16374 "Edit the list of agenda files.
16375 Depending on setup, this either uses customize to edit the variable
16376 `org-agenda-files', or it visits the file that is holding the list. In the
16377 latter case, the buffer is set up in a way that saving it automatically kills
16378 the buffer and restores the previous window configuration."
16379 (interactive)
16380 (if (stringp org-agenda-files)
16381 (let ((cw (current-window-configuration)))
16382 (find-file org-agenda-files)
16383 (org-set-local 'org-window-configuration cw)
16384 (org-add-hook 'after-save-hook
16385 (lambda ()
16386 (set-window-configuration
16387 (prog1 org-window-configuration
16388 (kill-buffer (current-buffer))))
16389 (org-install-agenda-files-menu)
16390 (message "New agenda file list installed"))
16391 nil 'local)
16392 (message "%s" (substitute-command-keys
16394 (customize-variable 'org-agenda-files)))
16396 (defun org-store-new-agenda-file-list (list)
16397 "Set new value for the agenda file list and save it correctly."
16398 (if (stringp org-agenda-files)
16399 (let ((fe (org-read-agenda-file-list t)) b u)
16400 (while (setq b (find-buffer-visiting org-agenda-files))
16401 (kill-buffer b))
16402 (with-temp-file org-agenda-files
16403 (insert
16404 (mapconcat
16405 (lambda (f) ;; Keep un-expanded entries.
16406 (if (setq u (assoc f fe))
16407 (cdr u)
16408 f))
16411 (let ((org-mode-hook nil) (org-inhibit-startup t)
16412 (org-insert-mode-line-in-empty-file nil))
16413 (setq org-agenda-files list)
16414 (customize-save-variable 'org-agenda-files org-agenda-files))))
16416 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16417 "Read the list of agenda files from a file.
16418 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16419 filenames, used by `org-store-new-agenda-file-list' to write back
16420 un-expanded file names."
16421 (when (file-directory-p org-agenda-files)
16422 (error "`org-agenda-files' cannot be a single directory"))
16423 (when (stringp org-agenda-files)
16424 (with-temp-buffer
16425 (insert-file-contents org-agenda-files)
16426 (mapcar
16427 (lambda (f)
16428 (let ((e (expand-file-name (substitute-in-file-name f)
16429 org-directory)))
16430 (if pair-with-expansion
16431 (cons e f)
16432 e)))
16435 ;;;###autoload
16436 (defun org-cycle-agenda-files ()
16437 "Cycle through the files in `org-agenda-files'.
16438 If the current buffer visits an agenda file, find the next one in the list.
16439 If the current buffer does not, find the first agenda file."
16440 (interactive)
16441 (let* ((fs (org-agenda-files t))
16442 (files (append fs (list (car fs))))
16443 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16444 file)
16445 (unless files (error "No agenda files"))
16446 (catch 'exit
16447 (while (setq file (pop files))
16448 (if (equal (file-truename file) tcf)
16449 (when (car files)
16450 (find-file (car files))
16451 (throw 'exit t))))
16452 (find-file (car fs)))
16453 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16455 (defun org-agenda-file-to-front (&optional to-end)
16456 "Move/add the current file to the top of the agenda file list.
16457 If the file is not present in the list, it is added to the front. If it is
16458 present, it is moved there. With optional argument TO-END, add/move to the
16459 end of the list."
16460 (interactive "P")
16461 (let ((org-agenda-skip-unavailable-files nil)
16462 (file-alist (mapcar (lambda (x)
16463 (cons (file-truename x) x))
16464 (org-agenda-files t)))
16465 (ctf (file-truename buffer-file-name))
16466 x had)
16467 (setq x (assoc ctf file-alist) had x)
16469 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16470 (if to-end
16471 (setq file-alist (append (delq x file-alist) (list x)))
16472 (setq file-alist (cons x (delq x file-alist))))
16473 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16474 (org-install-agenda-files-menu)
16475 (message "File %s to %s of agenda file list"
16476 (if had "moved" "added") (if to-end "end" "front"))))
16478 (defun org-remove-file (&optional file)
16479 "Remove current file from the list of files in variable `org-agenda-files'.
16480 These are the files which are being checked for agenda entries.
16481 Optional argument FILE means use this file instead of the current."
16482 (interactive)
16483 (let* ((org-agenda-skip-unavailable-files nil)
16484 (file (or file buffer-file-name))
16485 (true-file (file-truename file))
16486 (afile (abbreviate-file-name file))
16487 (files (delq nil (mapcar
16488 (lambda (x)
16489 (if (equal true-file
16490 (file-truename x))
16491 nil x))
16492 (org-agenda-files t)))))
16493 (if (not (= (length files) (length (org-agenda-files t))))
16494 (progn
16495 (org-store-new-agenda-file-list files)
16496 (org-install-agenda-files-menu)
16497 (message "Removed file: %s" afile))
16498 (message "File was not in list: %s (not removed)" afile))))
16500 (defun org-file-menu-entry (file)
16501 (vector file (list 'find-file file) t))
16503 (defun org-check-agenda-file (file)
16504 "Make sure FILE exists. If not, ask user what to do."
16505 (when (not (file-exists-p file))
16506 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16507 (abbreviate-file-name file))
16508 (let ((r (downcase (read-char-exclusive))))
16509 (cond
16510 ((equal r ?r)
16511 (org-remove-file file)
16512 (throw 'nextfile t))
16513 (t (error "Abort"))))))
16515 (defun org-get-agenda-file-buffer (file)
16516 "Get a buffer visiting FILE. If the buffer needs to be created, add
16517 it to the list of buffers which might be released later."
16518 (let ((buf (org-find-base-buffer-visiting file)))
16519 (if buf
16520 buf ; just return it
16521 ;; Make a new buffer and remember it
16522 (setq buf (find-file-noselect file))
16523 (if buf (push buf org-agenda-new-buffers))
16524 buf)))
16526 (defun org-release-buffers (blist)
16527 "Release all buffers in list, asking the user for confirmation when needed.
16528 When a buffer is unmodified, it is just killed. When modified, it is saved
16529 \(if the user agrees) and then killed."
16530 (let (buf file)
16531 (while (setq buf (pop blist))
16532 (setq file (buffer-file-name buf))
16533 (when (and (buffer-modified-p buf)
16534 file
16535 (y-or-n-p (format "Save file %s? " file)))
16536 (with-current-buffer buf (save-buffer)))
16537 (kill-buffer buf))))
16539 (defun org-prepare-agenda-buffers (files)
16540 "Create buffers for all agenda files, protect archived trees and comments."
16541 (interactive)
16542 (let ((pa '(:org-archived t))
16543 (pc '(:org-comment t))
16544 (pall '(:org-archived t :org-comment t))
16545 (inhibit-read-only t)
16546 (rea (concat ":" org-archive-tag ":"))
16547 bmp file re)
16548 (save-excursion
16549 (save-restriction
16550 (while (setq file (pop files))
16551 (catch 'nextfile
16552 (if (bufferp file)
16553 (set-buffer file)
16554 (org-check-agenda-file file)
16555 (set-buffer (org-get-agenda-file-buffer file)))
16556 (widen)
16557 (setq bmp (buffer-modified-p))
16558 (org-refresh-category-properties)
16559 (setq org-todo-keywords-for-agenda
16560 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16561 (setq org-done-keywords-for-agenda
16562 (append org-done-keywords-for-agenda org-done-keywords))
16563 (setq org-todo-keyword-alist-for-agenda
16564 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16565 (setq org-drawers-for-agenda
16566 (append org-drawers-for-agenda org-drawers))
16567 (setq org-tag-alist-for-agenda
16568 (append org-tag-alist-for-agenda org-tag-alist))
16570 (save-excursion
16571 (remove-text-properties (point-min) (point-max) pall)
16572 (when org-agenda-skip-archived-trees
16573 (goto-char (point-min))
16574 (while (re-search-forward rea nil t)
16575 (if (org-at-heading-p t)
16576 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16577 (goto-char (point-min))
16578 (setq re (format org-heading-keyword-regexp-format
16579 org-comment-string))
16580 (while (re-search-forward re nil t)
16581 (add-text-properties
16582 (match-beginning 0) (org-end-of-subtree t) pc)))
16583 (set-buffer-modified-p bmp)))))
16584 (setq org-todo-keywords-for-agenda
16585 (org-uniquify org-todo-keywords-for-agenda))
16586 (setq org-todo-keyword-alist-for-agenda
16587 (org-uniquify org-todo-keyword-alist-for-agenda)
16588 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16590 ;;;; Embedded LaTeX
16592 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16593 "Keymap for the minor `org-cdlatex-mode'.")
16595 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16596 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16597 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16598 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16599 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16601 (defvar org-cdlatex-texmathp-advice-is-done nil
16602 "Flag remembering if we have applied the advice to texmathp already.")
16604 (define-minor-mode org-cdlatex-mode
16605 "Toggle the minor `org-cdlatex-mode'.
16606 This mode supports entering LaTeX environment and math in LaTeX fragments
16607 in Org-mode.
16609 nil " OCDL" nil
16610 (when org-cdlatex-mode
16611 (require 'cdlatex)
16612 (run-hooks 'cdlatex-mode-hook)
16613 (cdlatex-compute-tables))
16614 (unless org-cdlatex-texmathp-advice-is-done
16615 (setq org-cdlatex-texmathp-advice-is-done t)
16616 (defadvice texmathp (around org-math-always-on activate)
16617 "Always return t in org-mode buffers.
16618 This is because we want to insert math symbols without dollars even outside
16619 the LaTeX math segments. If Orgmode thinks that point is actually inside
16620 an embedded LaTeX fragment, let texmathp do its job.
16622 (interactive)
16623 (let (p)
16624 (cond
16625 ((not (eq major-mode 'org-mode)) ad-do-it)
16626 ((eq this-command 'cdlatex-math-symbol)
16627 (setq ad-return-value t
16628 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16629 (t
16630 (let ((p (org-inside-LaTeX-fragment-p)))
16631 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16632 (setq ad-return-value t
16633 texmathp-why '("Org-mode embedded math" . 0))
16634 (if p ad-do-it)))))))))
16636 (defun turn-on-org-cdlatex ()
16637 "Unconditionally turn on `org-cdlatex-mode'."
16638 (org-cdlatex-mode 1))
16640 (defun org-inside-LaTeX-fragment-p ()
16641 "Test if point is inside a LaTeX fragment.
16643 sequence appearing also before point.
16644 Even though the matchers for math are configurable, this function assumes
16646 delimiters are skipped when they have been removed by customization.
16647 The return value is nil, or a cons cell with the delimiter and the
16648 position of this delimiter.
16650 This function does a reasonably good job, but can locally be fooled by
16651 for example currency specifications. For example it will assume being in
16653 fragments that are properly closed, but during editing, we have to live
16654 with the uncertainty caused by missing closing delimiters. This function
16655 looks only before point, not after."
16656 (catch 'exit
16657 (let ((pos (point))
16658 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16659 (lim (progn
16661 (point)))
16662 dd-on str (start 0) m re)
16663 (goto-char pos)
16664 (when dodollar
16666 re (nth 1 (assoc "$" org-latex-regexps)))
16667 (while (string-match re str start)
16668 (cond
16669 ((= (match-end 0) (length str))
16670 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16671 ((= (match-end 0) (- (length str) 5))
16672 (throw 'exit nil))
16673 (t (setq start (match-end 0))))))
16674 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16675 (goto-char pos)
16676 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16677 (and (match-beginning 2) (throw 'exit nil))
16678 ;; count $$
16680 (setq dd-on (not dd-on)))
16681 (goto-char pos)
16682 (if dd-on (cons "$$" m))))))
16684 (defun org-inside-latex-macro-p ()
16685 "Is point inside a LaTeX macro or its arguments?"
16686 (save-match-data
16687 (org-in-regexp
16690 (defun org-try-cdlatex-tab ()
16691 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16692 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16693 - inside a LaTeX fragment, or
16694 - after the first word in a line, where an abbreviation expansion could
16695 insert a LaTeX environment."
16696 (when org-cdlatex-mode
16697 (cond
16698 ;; Before any word on the line: No expansion possible.
16700 ;; Just after first word on the line: Expand it. Make sure it
16701 ;; cannot happen on headlines, though.
16702 ((save-excursion
16703 (skip-chars-backward "a-zA-Z0-9*")
16705 (and (bolp) (not (org-at-heading-p))))
16706 (cdlatex-tab) t)
16707 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16709 (defun org-cdlatex-underscore-caret (&optional arg)
16710 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16711 Revert to the normal definition outside of these fragments."
16712 (interactive "P")
16713 (if (org-inside-LaTeX-fragment-p)
16714 (call-interactively 'cdlatex-sub-superscript)
16715 (let (org-cdlatex-mode)
16716 (call-interactively (key-binding (vector last-input-event))))))
16718 (defun org-cdlatex-math-modify (&optional arg)
16719 "Execute `cdlatex-math-modify' in LaTeX fragments.
16720 Revert to the normal definition outside of these fragments."
16721 (interactive "P")
16722 (if (org-inside-LaTeX-fragment-p)
16723 (call-interactively 'cdlatex-math-modify)
16724 (let (org-cdlatex-mode)
16725 (call-interactively (key-binding (vector last-input-event))))))
16727 (defvar org-latex-fragment-image-overlays nil
16728 "List of overlays carrying the images of latex fragments.")
16729 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16731 (defun org-remove-latex-fragment-image-overlays ()
16732 "Remove all overlays with LaTeX fragment images in current buffer."
16733 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16734 (setq org-latex-fragment-image-overlays nil))
16736 (defun org-preview-latex-fragment (&optional subtree)
16737 "Preview the LaTeX fragment at point, or all locally or globally.
16738 If the cursor is in a LaTeX fragment, create the image and overlay
16739 it over the source code. If there is no fragment at point, display
16740 all fragments in the current text, from one headline to the next. With
16741 prefix SUBTREE, display all fragments in the current subtree. With a
16743 the cursor is before the first headline,
16744 display all fragments in the buffer.
16746 (interactive "P")
16747 (unless buffer-file-name
16748 (error "Can't preview LaTeX fragment in a non-file buffer"))
16749 (org-remove-latex-fragment-image-overlays)
16750 (save-excursion
16751 (save-restriction
16752 (let (beg end at msg)
16753 (cond
16754 ((or (equal subtree '(16))
16755 (not (save-excursion
16756 (re-search-backward org-outline-regexp-bol nil t))))
16757 (setq beg (point-min) end (point-max)
16758 msg "Creating images for buffer...%s"))
16759 ((equal subtree '(4))
16760 (org-back-to-heading)
16761 (setq beg (point) end (org-end-of-subtree t)
16762 msg "Creating images for subtree...%s"))
16763 (t
16764 (if (setq at (org-inside-LaTeX-fragment-p))
16765 (goto-char (max (point-min) (- (cdr at) 2)))
16766 (org-back-to-heading))
16767 (setq beg (point) end (progn (outline-next-heading) (point))
16768 msg (if at "Creating image...%s"
16769 "Creating images for entry...%s"))))
16770 (message msg "")
16771 (narrow-to-region beg end)
16772 (goto-char beg)
16773 (org-format-latex
16774 (concat "ltxpng/" (file-name-sans-extension
16775 (file-name-nondirectory
16776 buffer-file-name)))
16777 default-directory 'overlays msg at 'forbuffer 'dvipng)
16778 (message msg "done. Use `C-c C-c' to remove images.")))))
16780 (defvar org-latex-regexps
16782 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16785 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16789 "Regular expressions for matching embedded LaTeX.")
16791 (defvar org-export-have-math nil) ;; dynamic scoping
16792 (defun org-format-latex (prefix &optional dir overlays msg at
16793 forbuffer processing-type)
16794 "Replace LaTeX fragments with links to an image, and produce images.
16795 Some of the options can be changed using the variable
16796 `org-format-latex-options'."
16797 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16798 (let* ((prefixnodir (file-name-nondirectory prefix))
16799 (absprefix (expand-file-name prefix dir))
16800 (todir (file-name-directory absprefix))
16801 (opt org-format-latex-options)
16802 (matchers (plist-get opt :matchers))
16803 (re-list org-latex-regexps)
16804 (org-format-latex-header-extra
16805 (plist-get (org-infile-export-plist) :latex-header-extra))
16806 (cnt 0) txt hash link beg end re e checkdir
16807 executables-checked string
16808 m n block-type block linkfile movefile ov)
16809 ;; Check the different regular expressions
16810 (while (setq e (pop re-list))
16811 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16813 (when (member m matchers)
16814 (goto-char (point-min))
16815 (while (re-search-forward re nil t)
16816 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16817 (not (get-text-property (match-beginning n)
16818 'org-protected))
16819 (or (not overlays)
16820 (not (eq (get-char-property (match-beginning n)
16821 'org-overlay-type)
16822 'org-latex-overlay))))
16823 (setq org-export-have-math t)
16824 (cond
16825 ((eq processing-type 'verbatim)
16826 ;; Leave the text verbatim, just protect it
16827 (add-text-properties (match-beginning n) (match-end n)
16828 '(org-protected t)))
16829 ((eq processing-type 'mathjax)
16830 ;; Prepare for MathJax processing
16831 (setq string (match-string n))
16832 (if (member m '("$" "$1"))
16833 (save-excursion
16834 (delete-region (match-beginning n) (match-end n))
16835 (goto-char (match-beginning n))
16838 '(org-protected t))))
16839 (add-text-properties (match-beginning n) (match-end n)
16840 '(org-protected t))))
16841 ((eq processing-type 'dvipng)
16842 ;; Process to an image
16843 (setq txt (match-string n)
16844 beg (match-beginning n) end (match-end n)
16845 cnt (1+ cnt))
16846 (let (print-length print-level) ; make sure full list is printed
16847 (setq hash (sha1 (prin1-to-string
16848 (list org-format-latex-header
16849 org-format-latex-header-extra
16850 org-export-latex-default-packages-alist
16851 org-export-latex-packages-alist
16852 org-format-latex-options
16853 forbuffer txt)))
16854 linkfile (format "%s_%s.png" prefix hash)
16855 movefile (format "%s_%s.png" absprefix hash)))
16856 (setq link (concat block "[[file:" linkfile "]]" block))
16857 (if msg (message msg cnt))
16858 (goto-char beg)
16859 (unless checkdir ; make sure the directory exists
16860 (setq checkdir t)
16861 (or (file-directory-p todir) (make-directory todir t)))
16863 (unless executables-checked
16864 (org-check-external-command
16865 "latex" "needed to convert LaTeX fragments to images")
16866 (org-check-external-command
16867 "dvipng" "needed to convert LaTeX fragments to images")
16868 (setq executables-checked t))
16870 (unless (file-exists-p movefile)
16871 (org-create-formula-image
16872 txt movefile opt forbuffer))
16873 (if overlays
16874 (progn
16875 (mapc (lambda (o)
16876 (if (eq (overlay-get o 'org-overlay-type)
16877 'org-latex-overlay)
16878 (delete-overlay o)))
16879 (overlays-in beg end))
16880 (setq ov (make-overlay beg end))
16881 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16882 (if (featurep 'xemacs)
16883 (progn
16884 (overlay-put ov 'invisible t)
16885 (overlay-put
16886 ov 'end-glyph
16887 (make-glyph (vector 'png :file movefile))))
16888 (overlay-put
16889 ov 'display
16890 (list 'image :type 'png :file movefile :ascent 'center)))
16891 (push ov org-latex-fragment-image-overlays)
16892 (goto-char end))
16893 (delete-region beg end)
16894 (insert (org-add-props link
16895 (list 'org-latex-src
16896 (replace-regexp-in-string
16898 'org-latex-src-embed-type
16899 (if block-type 'paragraph 'character))))))
16900 ((eq processing-type 'mathml)
16901 ;; Process to MathML
16902 (unless executables-checked
16903 (unless (save-match-data (org-format-latex-mathml-available-p))
16904 (error "LaTeX to MathML converter not configured"))
16905 (setq executables-checked t))
16906 (setq txt (match-string n)
16907 beg (match-beginning n) end (match-end n)
16908 cnt (1+ cnt))
16909 (if msg (message msg cnt))
16910 (goto-char beg)
16911 (delete-region beg end)
16912 (insert (org-format-latex-as-mathml
16913 txt block-type prefix dir)))
16914 (t
16915 (error "Unknown conversion type %s for latex fragments"
16916 processing-type)))))))))
16918 (defun org-create-math-formula (latex-frag &optional mathml-file)
16919 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16920 Use `org-latex-to-mathml-convert-command'. If the conversion is
16922 elements otherwise return nil. When MATHML-FILE is specified,
16923 write the results in to that file. When invoked as an
16924 interactive command, prompt for LATEX-FRAG, with initial value
16925 set to the current active region and echo the results for user
16926 inspection."
16927 (interactive (list (let ((frag (when (region-active-p)
16928 (buffer-substring-no-properties
16929 (region-beginning) (region-end)))))
16930 (read-string "LaTeX Fragment: " frag nil frag))))
16931 (unless latex-frag (error "Invalid latex-frag"))
16932 (let* ((tmp-in-file (file-relative-name
16933 (make-temp-name (expand-file-name "ltxmathml-in"))))
16934 (ignore (write-region latex-frag nil tmp-in-file))
16935 (tmp-out-file (file-relative-name
16936 (make-temp-name (expand-file-name "ltxmathml-out"))))
16937 (cmd (format-spec
16938 org-latex-to-mathml-convert-command
16939 `((?j . ,(shell-quote-argument
16940 (expand-file-name org-latex-to-mathml-jar-file)))
16941 (?I . ,(shell-quote-argument tmp-in-file))
16942 (?o . ,(shell-quote-argument tmp-out-file)))))
16943 mathml shell-command-output)
16944 (when (org-called-interactively-p 'any)
16945 (unless (org-format-latex-mathml-available-p)
16946 (error "LaTeX to MathML converter not configured")))
16947 (message "Running %s" cmd)
16948 (setq shell-command-output (shell-command-to-string cmd))
16949 (setq mathml
16950 (when (file-readable-p tmp-out-file)
16951 (with-current-buffer (find-file-noselect tmp-out-file t)
16952 (goto-char (point-min))
16953 (when (re-search-forward
16954 (concat
16955 (regexp-quote
16958 (regexp-quote "</math>")) nil t)
16959 (prog1 (match-string 0) (kill-buffer))))))
16960 (cond
16961 (mathml
16962 (setq mathml
16964 (when mathml-file
16965 (write-region mathml nil mathml-file))
16966 (when (org-called-interactively-p 'any)
16967 (message mathml)))
16968 ((message "LaTeX to MathML conversion failed")
16969 (message shell-command-output)))
16970 (delete-file tmp-in-file)
16971 (when (file-exists-p tmp-out-file)
16972 (delete-file tmp-out-file))
16973 mathml))
16975 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16976 prefix &optional dir)
16977 "Use `org-create-math-formula' but check local cache first."
16978 (let* ((absprefix (expand-file-name prefix dir))
16979 (print-length nil) (print-level nil)
16980 (formula-id (concat
16981 "formula-"
16982 (sha1
16983 (prin1-to-string
16984 (list latex-frag
16985 org-latex-to-mathml-convert-command)))))
16986 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16987 (formula-cache-dir (file-name-directory formula-cache)))
16989 (unless (file-directory-p formula-cache-dir)
16990 (make-directory formula-cache-dir t))
16992 (unless (file-exists-p formula-cache)
16993 (org-create-math-formula latex-frag formula-cache))
16995 (if (file-exists-p formula-cache)
16996 ;; Successful conversion. Return the link to MathML file.
16997 (org-add-props
16998 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17000 'org-latex-src-embed-type (if latex-frag-type
17001 'paragraph 'character)))
17002 ;; Failed conversion. Return the LaTeX fragment verbatim
17003 (add-text-properties
17004 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17005 latex-frag)))
17007 ;; This function borrows from Ganesh Swami's latex2png.el
17008 (defun org-create-formula-image (string tofile options buffer)
17009 "This calls dvipng."
17010 (require 'org-latex)
17011 (let* ((tmpdir (if (featurep 'xemacs)
17012 (temp-directory)
17013 temporary-file-directory))
17014 (texfilebase (make-temp-name
17015 (expand-file-name "orgtex" tmpdir)))
17016 (texfile (concat texfilebase ".tex"))
17017 (dvifile (concat texfilebase ".dvi"))
17018 (pngfile (concat texfilebase ".png"))
17019 (fnh (if (featurep 'xemacs)
17020 (font-height (face-font 'default))
17021 (face-attribute 'default :height nil)))
17022 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17023 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17024 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17025 "Black"))
17026 (bg (or (plist-get options (if buffer :background :html-background))
17027 "Transparent")))
17028 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17029 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17030 (with-temp-file texfile
17031 (insert (org-splice-latex-header
17032 org-format-latex-header
17033 org-export-latex-default-packages-alist
17034 org-export-latex-packages-alist t
17035 org-format-latex-header-extra))
17037 (require 'org-latex)
17038 (org-export-latex-fix-inputenc))
17039 (let ((dir default-directory))
17040 (condition-case nil
17041 (progn
17042 (cd tmpdir)
17043 (call-process "latex" nil nil nil texfile))
17044 (error nil))
17045 (cd dir))
17046 (if (not (file-exists-p dvifile))
17047 (progn (message "Failed to create dvi file from %s" texfile) nil)
17048 (condition-case nil
17049 (if (featurep 'xemacs)
17050 (call-process "dvipng" nil nil nil
17051 "-fg" fg "-bg" bg
17052 "-T" "tight"
17053 "-o" pngfile
17054 dvifile)
17055 (call-process "dvipng" nil nil nil
17056 "-fg" fg "-bg" bg
17057 "-D" dpi
17058 ;;"-x" scale "-y" scale
17059 "-T" "tight"
17060 "-o" pngfile
17061 dvifile))
17062 (error nil))
17063 (if (not (file-exists-p pngfile))
17064 (if org-format-latex-signal-error
17065 (error "Failed to create png file from %s" texfile)
17066 (message "Failed to create png file from %s" texfile)
17067 nil)
17068 ;; Use the requested file name and clean up
17069 (copy-file pngfile tofile 'replace)
17070 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17071 (delete-file (concat texfilebase e)))
17072 pngfile))))
17074 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17075 "Fill a LaTeX header template TPL.
17076 In the template, the following place holders will be recognized:
17079 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17081 [NO-PACKAGES] do not include PKG
17082 [EXTRA] the string EXTRA
17083 [NO-EXTRA] do not include EXTRA
17085 For backward compatibility, if both the positive and the negative place
17087 assumed to be present at the end of the template.
17088 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17089 EXTRA is a string.
17090 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17091 (let (rpl (end ""))
17093 (setq rpl (if (or (match-end 1) (not def-pkg))
17094 "" (org-latex-packages-to-string def-pkg snippets-p t))
17095 tpl (replace-match rpl t t tpl))
17096 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17099 (setq rpl (if (or (match-end 1) (not pkg))
17100 "" (org-latex-packages-to-string pkg snippets-p t))
17101 tpl (replace-match rpl t t tpl))
17102 (if pkg (setq end
17104 (org-latex-packages-to-string pkg snippets-p)))))
17107 (setq rpl (if (or (match-end 1) (not extra))
17109 tpl (replace-match rpl t t tpl))
17115 tpl)))
17117 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17119 (setq pkg (mapconcat (lambda(p)
17120 (cond
17121 ((stringp p) p)
17122 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17123 (format "%% Package %s omitted" (cadr p)))
17124 ((equal "" (car p))
17126 (t
17128 (car p) (cadr p)))))
17129 pkg
17133 (defun org-dvipng-color (attr)
17134 "Return an rgb color specification for dvipng."
17135 (apply 'format "rgb %s %s %s"
17136 (mapcar 'org-normalize-color
17137 (if (featurep 'xemacs)
17138 (color-rgb-components
17139 (face-property 'default
17140 (cond ((eq attr :foreground) 'foreground)
17141 ((eq attr :background) 'background))))
17142 (color-values (face-attribute 'default attr nil))))))
17144 (defun org-normalize-color (value)
17145 "Return string to be used as color value for an RGB component."
17146 (format "%g" (/ value 65535.0)))
17148 ;; Image display
17151 (defvar org-inline-image-overlays nil)
17152 (make-variable-buffer-local 'org-inline-image-overlays)
17154 (defun org-toggle-inline-images (&optional include-linked)
17155 "Toggle the display of inline images.
17156 INCLUDE-LINKED is passed to `org-display-inline-images'."
17157 (interactive "P")
17158 (if org-inline-image-overlays
17159 (progn
17160 (org-remove-inline-images)
17161 (message "Inline image display turned off"))
17162 (org-display-inline-images include-linked)
17163 (if org-inline-image-overlays
17164 (message "%d images displayed inline"
17165 (length org-inline-image-overlays))
17166 (message "No images to display inline"))))
17168 (defun org-display-inline-images (&optional include-linked refresh beg end)
17169 "Display inline images.
17170 Normally only links without a description part are inlined, because this
17171 is how it will work for export. When INCLUDE-LINKED is set, also links
17172 with a description part will be inlined. This can be nice for a quick
17173 look at those images, but it does not reflect what exported files will look
17174 like.
17175 When REFRESH is set, refresh existing images between BEG and END.
17176 This will create new image displays only if necessary.
17177 BEG and END default to the buffer boundaries."
17178 (interactive "P")
17179 (unless refresh
17180 (org-remove-inline-images)
17181 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17182 (save-excursion
17183 (save-restriction
17184 (widen)
17185 (setq beg (or beg (point-min)) end (or end (point-max)))
17186 (goto-char beg)
17188 (substring (org-image-file-name-regexp) 0 -2)
17190 old file ov img)
17191 (while (re-search-forward re end t)
17192 (setq old (get-char-property-and-overlay (match-beginning 1)
17193 'org-image-overlay))
17194 (setq file (expand-file-name
17195 (concat (or (match-string 3) "") (match-string 4))))
17196 (when (file-exists-p file)
17197 (if (and (car-safe old) refresh)
17198 (image-refresh (overlay-get (cdr old) 'display))
17199 (setq img (save-match-data (create-image file)))
17200 (when img
17201 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17202 (overlay-put ov 'display img)
17203 (overlay-put ov 'face 'default)
17204 (overlay-put ov 'org-image-overlay t)
17205 (overlay-put ov 'modification-hooks
17206 (list 'org-display-inline-modification-hook))
17207 (push ov org-inline-image-overlays)))))))))
17209 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17210 "Remove inline-display overlay if a corresponding region is modified."
17211 (let ((inhibit-modification-hooks t))
17212 (when (and ov after)
17213 (delete ov org-inline-image-overlays)
17214 (delete-overlay ov))))
17216 (defun org-remove-inline-images ()
17217 "Remove inline display of images."
17218 (interactive)
17219 (mapc 'delete-overlay org-inline-image-overlays)
17220 (setq org-inline-image-overlays nil))
17222 ;;;; Key bindings
17224 ;; Outline functions from `outline-mode-prefix-map'
17225 ;; that can be remapped in Org:
17226 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17227 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17228 (define-key org-mode-map [remap outline-forward-same-level]
17229 'org-forward-same-level)
17230 (define-key org-mode-map [remap outline-backward-same-level]
17231 'org-backward-same-level)
17232 (define-key org-mode-map [remap show-branches]
17233 'org-kill-note-or-show-branches)
17234 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17235 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17236 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17238 ;; Outline functions from `outline-mode-prefix-map'
17239 ;; that can not be remapped in Org:
17240 ;; - the column "key binding" shows whether the Outline function is still
17241 ;; available in Org mode on the same key that it has been bound to in
17242 ;; Outline mode:
17243 ;; - "overridden": key used for a different functionality in Org mode
17244 ;; - else: key still bound to the same Outline function in Org mode
17245 ;; | Outline function | key binding | Org replacement |
17246 ;; |------------------------------------+-------------+-----------------------|
17247 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17248 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17249 ;; | `show-children' | `C-c C-i' | visibility cycling |
17250 ;; | `hide-subtree' | overridden | visibility cycling |
17251 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17252 ;; | `hide-body' | overridden | no replacement |
17253 ;; | `show-all' | overridden | no replacement |
17254 ;; | `hide-entry' | overridden | visibility cycling |
17255 ;; | `show-entry' | overridden | no replacement |
17256 ;; | `hide-leaves' | overridden | no replacement |
17257 ;; | `hide-sublevels' | overridden | no replacement |
17258 ;; | `hide-other' | overridden | no replacement |
17259 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17260 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17262 ;; Make `C-c C-x' a prefix key
17263 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17265 ;; TAB key with modifiers
17266 (org-defkey org-mode-map "\C-i" 'org-cycle)
17267 (org-defkey org-mode-map [(tab)] 'org-cycle)
17268 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17270 ;; The following line is necessary under Suse GNU/Linux
17271 (unless (featurep 'xemacs)
17272 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17273 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17274 (define-key org-mode-map [backtab] 'org-shifttab)
17276 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17277 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17278 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17280 ;; Cursor keys with modifiers
17281 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17282 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17283 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17284 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17286 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17287 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17288 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17289 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17291 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17292 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17293 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17294 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17296 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17297 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17298 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17299 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17301 ;; Babel keys
17302 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17303 (mapc (lambda (pair)
17304 (define-key org-babel-map (car pair) (cdr pair)))
17305 org-babel-key-bindings)
17307 ;;; Extra keys for tty access.
17308 ;; We only set them when really needed because otherwise the
17309 ;; menus don't show the simple keys
17311 (when (or org-use-extra-keys
17312 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17313 (not window-system))
17314 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17315 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17316 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17317 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17318 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17319 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17320 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17321 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17322 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17323 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17324 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17325 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17326 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17327 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17328 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17329 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17330 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17331 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17332 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17333 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17334 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17335 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17336 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17337 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17338 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17339 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17340 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17341 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17343 ;; All the other keys
17345 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17346 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17347 (if (boundp 'narrow-map)
17348 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17349 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17350 (if (boundp 'narrow-map)
17351 (org-defkey narrow-map "b" 'org-narrow-to-block)
17352 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17353 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17354 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17355 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17356 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17357 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17358 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17359 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17360 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17361 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17362 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17363 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17364 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17365 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17366 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17367 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17368 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17370 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17371 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17372 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17373 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17374 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17375 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17376 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17377 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17378 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17379 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17380 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17381 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17382 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17383 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17384 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17385 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17386 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17387 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17388 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17389 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17391 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17392 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17393 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17394 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17395 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17396 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17397 (org-defkey org-mode-map "\C-c^" 'org-sort)
17398 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17399 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17400 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17401 (org-defkey org-mode-map "\C-m" 'org-return)
17402 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17403 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17404 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17405 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17406 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17407 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17408 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17409 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17410 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17411 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17412 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17413 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17414 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17415 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17416 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17417 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17418 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17419 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17420 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17421 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17422 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17423 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17425 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17426 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17427 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17428 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17430 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17431 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17432 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17433 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17434 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17435 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17436 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17437 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17438 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17439 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17441 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17442 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17443 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17444 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17445 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17446 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17447 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17449 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17450 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17451 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17452 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17453 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17455 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17457 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17459 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17460 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17462 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17465 (when (featurep 'xemacs)
17466 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17469 (defconst org-speed-commands-default
17470 '(
17471 ("Outline Navigation")
17472 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17473 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17474 ("f" . (org-speed-move-safe 'org-forward-same-level))
17475 ("b" . (org-speed-move-safe 'org-backward-same-level))
17476 ("u" . (org-speed-move-safe 'outline-up-heading))
17477 ("j" . org-goto)
17478 ("g" . (org-refile t))
17479 ("Outline Visibility")
17480 ("c" . org-cycle)
17481 ("C" . org-shifttab)
17482 (" " . org-display-outline-path)
17483 ("Outline Structure Editing")
17484 ("U" . org-shiftmetaup)
17485 ("D" . org-shiftmetadown)
17486 ("r" . org-metaright)
17487 ("l" . org-metaleft)
17488 ("R" . org-shiftmetaright)
17489 ("L" . org-shiftmetaleft)
17490 ("i" . (progn (forward-char 1) (call-interactively
17491 'org-insert-heading-respect-content)))
17492 ("^" . org-sort)
17493 ("w" . org-refile)
17494 ("a" . org-archive-subtree-default-with-confirmation)
17495 ("." . org-mark-subtree)
17496 ("Clock Commands")
17497 ("I" . org-clock-in)
17498 ("O" . org-clock-out)
17499 ("Meta Data Editing")
17500 ("t" . org-todo)
17501 ("0" . (org-priority ?\ ))
17502 ("1" . (org-priority ?A))
17503 ("2" . (org-priority ?B))
17504 ("3" . (org-priority ?C))
17505 (";" . org-set-tags-command)
17506 ("e" . org-set-effort)
17507 ("Agenda Views etc")
17508 ("v" . org-agenda)
17509 ("/" . org-sparse-tree)
17510 ("Misc")
17511 ("o" . org-open-at-point)
17512 ("?" . org-speed-command-help)
17513 ("<" . (org-agenda-set-restriction-lock 'subtree))
17514 (">" . (org-agenda-remove-restriction-lock))
17515 )
17516 "The default speed commands.")
17518 (defun org-print-speed-command (e)
17519 (if (> (length (car e)) 1)
17520 (progn
17522 (princ (car e))
17524 (princ (make-string (length (car e)) ?-))
17526 (princ (car e))
17527 (princ " ")
17528 (if (symbolp (cdr e))
17529 (princ (symbol-name (cdr e)))
17530 (prin1 (cdr e)))
17533 (defun org-speed-command-help ()
17534 "Show the available speed commands."
17535 (interactive)
17536 (if (not org-use-speed-commands)
17537 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17538 (with-output-to-temp-buffer "*Help*"
17540 (mapc 'org-print-speed-command org-speed-commands-user)
17543 (mapc 'org-print-speed-command org-speed-commands-default))
17544 (with-current-buffer "*Help*"
17545 (setq truncate-lines t))))
17547 (defun org-speed-move-safe (cmd)
17548 "Execute CMD, but make sure that the cursor always ends up in a headline.
17549 If not, return to the original position and throw an error."
17550 (interactive)
17551 (let ((pos (point)))
17552 (call-interactively cmd)
17553 (unless (and (bolp) (org-at-heading-p))
17554 (goto-char pos)
17555 (error "Boundary reached while executing %s" cmd))))
17557 (defvar org-self-insert-command-undo-counter 0)
17559 (defvar org-table-auto-blank-field) ; defined in org-table.el
17560 (defvar org-speed-command nil)
17562 (defun org-speed-command-default-hook (keys)
17563 "Hook for activating single-letter speed commands.
17564 `org-speed-commands-default' specifies a minimal command set.
17565 Use `org-speed-commands-user' for further customization."
17566 (when (or (and (bolp) (looking-at org-outline-regexp))
17567 (and (functionp org-use-speed-commands)
17568 (funcall org-use-speed-commands)))
17569 (cdr (assoc keys (append org-speed-commands-user
17570 org-speed-commands-default)))))
17572 (defun org-babel-speed-command-hook (keys)
17573 "Hook for activating single-letter code block commands."
17574 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17575 (cdr (assoc keys org-babel-key-bindings))))
17577 (defcustom org-speed-command-hook
17578 '(org-speed-command-default-hook org-babel-speed-command-hook)
17579 "Hook for activating speed commands at strategic locations.
17580 Hook functions are called in sequence until a valid handler is
17581 found.
17583 Each hook takes a single argument, a user-pressed command key
17584 which is also a `self-insert-command' from the global map.
17586 Within the hook, examine the cursor position and the command key
17587 and return nil or a valid handler as appropriate. Handler could
17588 be one of an interactive command, a function, or a form.
17590 Set `org-use-speed-commands' to non-nil value to enable this
17591 hook. The default setting is `org-speed-command-default-hook'."
17592 :group 'org-structure
17593 :type 'hook)
17595 (defun org-self-insert-command (N)
17596 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17597 If the cursor is in a table looking at whitespace, the whitespace is
17598 overwritten, and the table is not marked as requiring realignment."
17599 (interactive "p")
17600 (org-check-before-invisible-edit 'insert)
17601 (cond
17602 ((and org-use-speed-commands
17603 (setq org-speed-command
17604 (run-hook-with-args-until-success
17605 'org-speed-command-hook (this-command-keys))))
17606 (cond
17607 ((commandp org-speed-command)
17608 (setq this-command org-speed-command)
17609 (call-interactively org-speed-command))
17610 ((functionp org-speed-command)
17611 (funcall org-speed-command))
17612 ((and org-speed-command (listp org-speed-command))
17613 (eval org-speed-command))
17614 (t (let (org-use-speed-commands)
17615 (call-interactively 'org-self-insert-command)))))
17616 ((and
17617 (org-table-p)
17618 (progn
17619 ;; check if we blank the field, and if that triggers align
17620 (and (featurep 'org-table) org-table-auto-blank-field
17621 (member last-command
17622 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17624 ;; got extra space, this field does not determine column width
17625 (let (org-table-may-need-update) (org-table-blank-field))
17626 ;; no extra space, this field may determine column width
17627 (org-table-blank-field)))
17628 t)
17629 (eq N 1)
17631 (let (org-table-may-need-update)
17632 (goto-char (1- (match-end 0)))
17633 (backward-delete-char 1)
17634 (goto-char (match-beginning 0))
17635 (self-insert-command N)))
17636 (t
17637 (setq org-table-may-need-update t)
17638 (self-insert-command N)
17639 (org-fix-tags-on-the-fly)
17640 (if org-self-insert-cluster-for-undo
17641 (if (not (eq last-command 'org-self-insert-command))
17642 (setq org-self-insert-command-undo-counter 1)
17643 (if (>= org-self-insert-command-undo-counter 20)
17644 (setq org-self-insert-command-undo-counter 1)
17645 (and (> org-self-insert-command-undo-counter 0)
17646 buffer-undo-list (listp buffer-undo-list)
17647 (not (cadr buffer-undo-list)) ; remove nil entry
17648 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17649 (setq org-self-insert-command-undo-counter
17650 (1+ org-self-insert-command-undo-counter))))))))
17652 (defun org-check-before-invisible-edit (kind)
17653 "Check is editing if kind KIND would be dangerous with invisible text around.
17654 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17655 ;; First, try to get out of here as quickly as possible, to reduce overhead
17656 (if (and org-catch-invisible-edits
17657 (or (not (boundp 'visible-mode)) (not visible-mode))
17658 (or (get-char-property (point) 'invisible)
17659 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17660 ;; OK, we need to take a closer look
17661 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17662 (invisible-before-point (if (bobp) nil (get-char-property
17663 (1- (point)) 'invisible)))
17664 (border-and-ok-direction
17665 (or
17666 ;; Check if we are acting predictably before invisible text
17667 (and invisible-at-point (not invisible-before-point)
17668 (memq kind '(insert delete-backward)))
17669 ;; Check if we are acting predictably after invisible text
17670 ;; This works not well, and I have turned it off. It seems
17671 ;; better to always show and stop after invisible text.
17672 ;; (and (not invisible-at-point) invisible-before-point
17673 ;; (memq kind '(insert delete)))
17674 )))
17676 (when (or (memq invisible-at-point '(outline org-hide-block))
17677 (memq invisible-before-point '(outline org-hide-block)))
17678 (if (eq org-catch-invisible-edits 'error)
17679 (error "Editing in invisible areas is prohibited - make visible first"))
17680 ;; Make the area visible
17681 (save-excursion
17682 (if invisible-before-point
17683 (goto-char (previous-single-char-property-change
17684 (point) 'invisible)))
17685 (org-cycle))
17686 (cond
17687 ((eq org-catch-invisible-edits 'show)
17688 ;; That's it, we do the edit after showing
17689 (message
17690 "Unfolding invisible region around point before editing")
17691 (sit-for 1))
17692 ((and (eq org-catch-invisible-edits 'smart)
17693 border-and-ok-direction)
17694 (message "Unfolding invisible region around point before editing"))
17695 (t
17696 ;; Don't do the edit, make the user repeat it in full visibility
17697 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17699 (defun org-fix-tags-on-the-fly ()
17700 (when (and (equal (char-after (point-at-bol)) ?*)
17701 (org-at-heading-p))
17702 (org-align-tags-here org-tags-column)))
17704 (defun org-delete-backward-char (N)
17705 "Like `delete-backward-char', insert whitespace at field end in tables.
17706 When deleting backwards, in tables this function will insert whitespace in
17708 still be marked for re-alignment if the field did fill the entire column,
17709 because, in this case the deletion might narrow the column."
17710 (interactive "p")
17711 (org-check-before-invisible-edit 'delete-backward)
17712 (if (and (org-table-p)
17713 (eq N 1)
17714 (string-match "|" (buffer-substring (point-at-bol) (point)))
17715 (looking-at ".*?|"))
17716 (let ((pos (point))
17718 (c org-table-may-need-update))
17719 (backward-delete-char N)
17720 (if (not overwrite-mode)
17721 (progn
17722 (skip-chars-forward "^|")
17723 (insert " ")
17724 (goto-char (1- pos))))
17725 ;; noalign: if there were two spaces at the end, this field
17726 ;; does not determine the width of the column.
17727 (if noalign (setq org-table-may-need-update c)))
17728 (backward-delete-char N)
17729 (org-fix-tags-on-the-fly)))
17731 (defun org-delete-char (N)
17732 "Like `delete-char', but insert whitespace at field end in tables.
17733 When deleting characters, in tables this function will insert whitespace in
17735 still be marked for re-alignment if the field did fill the entire column,
17736 because, in this case the deletion might narrow the column."
17737 (interactive "p")
17738 (org-check-before-invisible-edit 'delete)
17739 (if (and (org-table-p)
17740 (not (bolp))
17741 (not (= (char-after) ?|))
17742 (eq N 1))
17743 (if (looking-at ".*?|")
17744 (let ((pos (point))
17746 (c org-table-may-need-update))
17747 (replace-match (concat
17748 (substring (match-string 0) 1 -1)
17749 " |"))
17750 (goto-char pos)
17751 ;; noalign: if there were two spaces at the end, this field
17752 ;; does not determine the width of the column.
17753 (if noalign (setq org-table-may-need-update c)))
17754 (delete-char N))
17755 (delete-char N)
17756 (org-fix-tags-on-the-fly)))
17758 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17759 (put 'org-self-insert-command 'delete-selection t)
17760 (put 'orgtbl-self-insert-command 'delete-selection t)
17761 (put 'org-delete-char 'delete-selection 'supersede)
17762 (put 'org-delete-backward-char 'delete-selection 'supersede)
17763 (put 'org-yank 'delete-selection 'yank)
17765 ;; Make `flyspell-mode' delay after some commands
17766 (put 'org-self-insert-command 'flyspell-delayed t)
17767 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17768 (put 'org-delete-char 'flyspell-delayed t)
17769 (put 'org-delete-backward-char 'flyspell-delayed t)
17771 ;; Make pabbrev-mode expand after org-mode commands
17772 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17773 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17775 ;; How to do this: Measure non-white length of current string
17776 ;; If equal to column width, we should realign.
17778 (defun org-remap (map &rest commands)
17779 "In MAP, remap the functions given in COMMANDS.
17780 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17781 (let (new old)
17782 (while commands
17783 (setq old (pop commands) new (pop commands))
17784 (if (fboundp 'command-remapping)
17785 (org-defkey map (vector 'remap old) new)
17786 (substitute-key-definition old new map global-map)))))
17788 (when (eq org-enable-table-editor 'optimized)
17789 ;; If the user wants maximum table support, we need to hijack
17790 ;; some standard editing functions
17791 (org-remap org-mode-map
17792 'self-insert-command 'org-self-insert-command
17793 'delete-char 'org-delete-char
17794 'delete-backward-char 'org-delete-backward-char)
17795 (org-defkey org-mode-map "|" 'org-force-self-insert))
17797 (defvar org-ctrl-c-ctrl-c-hook nil
17798 "Hook for functions attaching themselves to `C-c C-c'.
17800 This can be used to add additional functionality to the C-c C-c
17801 key which executes context-dependent commands. This hook is run
17802 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17803 run after the last test.
17805 Each function will be called with no arguments. The function
17806 must check if the context is appropriate for it to act. If yes,
17807 it should do its thing and then return a non-nil value. If the
17808 context is wrong, just do nothing and return nil.")
17810 (defvar org-ctrl-c-ctrl-c-final-hook nil
17811 "Hook for functions attaching themselves to `C-c C-c'.
17813 This can be used to add additional functionality to the C-c C-c
17814 key which executes context-dependent commands. This hook is run
17815 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17816 before the first test.
17818 Each function will be called with no arguments. The function
17819 must check if the context is appropriate for it to act. If yes,
17820 it should do its thing and then return a non-nil value. If the
17821 context is wrong, just do nothing and return nil.")
17823 (defvar org-tab-first-hook nil
17824 "Hook for functions to attach themselves to TAB.
17825 See `org-ctrl-c-ctrl-c-hook' for more information.
17826 This hook runs as the first action when TAB is pressed, even before
17827 `org-cycle' messes around with the `outline-regexp' to cater for
17828 inline tasks and plain list item folding.
17829 If any function in this hook returns t, any other actions that
17830 would have been caused by TAB (such as table field motion or visibility
17831 cycling) will not occur.")
17833 (defvar org-tab-after-check-for-table-hook nil
17834 "Hook for functions to attach themselves to TAB.
17835 See `org-ctrl-c-ctrl-c-hook' for more information.
17836 This hook runs after it has been established that the cursor is not in a
17837 table, but before checking if the cursor is in a headline or if global cycling
17838 should be done.
17839 If any function in this hook returns t, not other actions like visibility
17840 cycling will be done.")
17842 (defvar org-tab-after-check-for-cycling-hook nil
17843 "Hook for functions to attach themselves to TAB.
17844 See `org-ctrl-c-ctrl-c-hook' for more information.
17845 This hook runs after it has been established that not table field motion and
17846 not visibility should be done because of current context. This is probably
17847 the place where a package like yasnippets can hook in.")
17849 (defvar org-tab-before-tab-emulation-hook nil
17850 "Hook for functions to attach themselves to TAB.
17851 See `org-ctrl-c-ctrl-c-hook' for more information.
17852 This hook runs after every other options for TAB have been exhausted, but
17855 (defvar org-metaleft-hook nil
17856 "Hook for functions attaching themselves to `M-left'.
17857 See `org-ctrl-c-ctrl-c-hook' for more information.")
17858 (defvar org-metaright-hook nil
17859 "Hook for functions attaching themselves to `M-right'.
17860 See `org-ctrl-c-ctrl-c-hook' for more information.")
17861 (defvar org-metaup-hook nil
17862 "Hook for functions attaching themselves to `M-up'.
17863 See `org-ctrl-c-ctrl-c-hook' for more information.")
17864 (defvar org-metadown-hook nil
17865 "Hook for functions attaching themselves to `M-down'.
17866 See `org-ctrl-c-ctrl-c-hook' for more information.")
17867 (defvar org-shiftmetaleft-hook nil
17868 "Hook for functions attaching themselves to `M-S-left'.
17869 See `org-ctrl-c-ctrl-c-hook' for more information.")
17870 (defvar org-shiftmetaright-hook nil
17871 "Hook for functions attaching themselves to `M-S-right'.
17872 See `org-ctrl-c-ctrl-c-hook' for more information.")
17873 (defvar org-shiftmetaup-hook nil
17874 "Hook for functions attaching themselves to `M-S-up'.
17875 See `org-ctrl-c-ctrl-c-hook' for more information.")
17876 (defvar org-shiftmetadown-hook nil
17877 "Hook for functions attaching themselves to `M-S-down'.
17878 See `org-ctrl-c-ctrl-c-hook' for more information.")
17879 (defvar org-metareturn-hook nil
17880 "Hook for functions attaching themselves to `M-RET'.
17881 See `org-ctrl-c-ctrl-c-hook' for more information.")
17882 (defvar org-shiftup-hook nil
17883 "Hook for functions attaching themselves to `S-up'.
17884 See `org-ctrl-c-ctrl-c-hook' for more information.")
17885 (defvar org-shiftup-final-hook nil
17886 "Hook for functions attaching themselves to `S-up'.
17887 This one runs after all other options except shift-select have been excluded.
17888 See `org-ctrl-c-ctrl-c-hook' for more information.")
17889 (defvar org-shiftdown-hook nil
17890 "Hook for functions attaching themselves to `S-down'.
17891 See `org-ctrl-c-ctrl-c-hook' for more information.")
17892 (defvar org-shiftdown-final-hook nil
17893 "Hook for functions attaching themselves to `S-down'.
17894 This one runs after all other options except shift-select have been excluded.
17895 See `org-ctrl-c-ctrl-c-hook' for more information.")
17896 (defvar org-shiftleft-hook nil
17897 "Hook for functions attaching themselves to `S-left'.
17898 See `org-ctrl-c-ctrl-c-hook' for more information.")
17899 (defvar org-shiftleft-final-hook nil
17900 "Hook for functions attaching themselves to `S-left'.
17901 This one runs after all other options except shift-select have been excluded.
17902 See `org-ctrl-c-ctrl-c-hook' for more information.")
17903 (defvar org-shiftright-hook nil
17904 "Hook for functions attaching themselves to `S-right'.
17905 See `org-ctrl-c-ctrl-c-hook' for more information.")
17906 (defvar org-shiftright-final-hook nil
17907 "Hook for functions attaching themselves to `S-right'.
17908 This one runs after all other options except shift-select have been excluded.
17909 See `org-ctrl-c-ctrl-c-hook' for more information.")
17911 (defun org-modifier-cursor-error ()
17912 "Throw an error, a modified cursor command was applied in wrong context."
17913 (error "This command is active in special context like tables, headlines or items"))
17915 (defun org-shiftselect-error ()
17916 "Throw an error because Shift-Cursor command was applied in wrong context."
17917 (if (and (boundp 'shift-select-mode) shift-select-mode)
17918 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17919 (error "This command works only in special context like headlines or timestamps")))
17921 (defun org-call-for-shift-select (cmd)
17922 (let ((this-command-keys-shift-translated t))
17923 (call-interactively cmd)))
17925 (defun org-shifttab (&optional arg)
17926 "Global visibility cycling or move to previous table field.
17927 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17928 on context.
17929 See the individual commands for more information."
17930 (interactive "P")
17931 (cond
17932 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17933 ((integerp arg)
17934 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17935 (message "Content view to level: %d" arg)
17936 (org-content (prefix-numeric-value arg2))
17937 (setq org-cycle-global-status 'overview)))
17938 (t (call-interactively 'org-global-cycle))))
17940 (defun org-shiftmetaleft ()
17941 "Promote subtree or delete table column.
17942 Calls `org-promote-subtree', `org-outdent-item',
17943 or `org-table-delete-column', depending on context.
17944 See the individual commands for more information."
17945 (interactive)
17946 (cond
17947 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17948 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17949 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17950 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17951 (t (org-modifier-cursor-error))))
17953 (defun org-shiftmetaright ()
17954 "Demote subtree or insert table column.
17955 Calls `org-demote-subtree', `org-indent-item',
17956 or `org-table-insert-column', depending on context.
17957 See the individual commands for more information."
17958 (interactive)
17959 (cond
17960 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17961 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17962 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17963 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17964 (t (org-modifier-cursor-error))))
17966 (defun org-shiftmetaup (&optional arg)
17967 "Move subtree up or kill table row.
17968 Calls `org-move-subtree-up' or `org-table-kill-row' or
17969 `org-move-item-up' depending on context. See the individual commands
17970 for more information."
17971 (interactive "P")
17972 (cond
17973 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17974 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17975 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17976 ((org-at-item-p) (call-interactively 'org-move-item-up))
17977 (t (org-modifier-cursor-error))))
17979 (defun org-shiftmetadown (&optional arg)
17980 "Move subtree down or insert table row.
17981 Calls `org-move-subtree-down' or `org-table-insert-row' or
17982 `org-move-item-down', depending on context. See the individual
17983 commands for more information."
17984 (interactive "P")
17985 (cond
17986 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17987 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17988 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17989 ((org-at-item-p) (call-interactively 'org-move-item-down))
17990 (t (org-modifier-cursor-error))))
17992 (defsubst org-hidden-tree-error ()
17993 (error
17994 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17996 (defun org-metaleft (&optional arg)
17997 "Promote heading or move table column to left.
17998 Calls `org-do-promote' or `org-table-move-column', depending on context.
17999 With no specific context, calls the Emacs default `backward-word'.
18000 See the individual commands for more information."
18001 (interactive "P")
18002 (cond
18003 ((run-hook-with-args-until-success 'org-metaleft-hook))
18004 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18005 ((org-with-limited-levels
18006 (or (org-at-heading-p)
18007 (and (org-region-active-p)
18008 (save-excursion
18009 (goto-char (region-beginning))
18010 (org-at-heading-p)))))
18011 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18012 (call-interactively 'org-do-promote))
18013 ;; At an inline task.
18014 ((org-at-heading-p)
18015 (call-interactively 'org-inlinetask-promote))
18016 ((or (org-at-item-p)
18017 (and (org-region-active-p)
18018 (save-excursion
18019 (goto-char (region-beginning))
18020 (org-at-item-p))))
18021 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18022 (call-interactively 'org-outdent-item))
18023 (t (call-interactively 'backward-word))))
18025 (defun org-metaright (&optional arg)
18026 "Demote subtree or move table column to right.
18027 Calls `org-do-demote' or `org-table-move-column', depending on context.
18028 With no specific context, calls the Emacs default `forward-word'.
18029 See the individual commands for more information."
18030 (interactive "P")
18031 (cond
18032 ((run-hook-with-args-until-success 'org-metaright-hook))
18033 ((org-at-table-p) (call-interactively 'org-table-move-column))
18034 ((org-with-limited-levels
18035 (or (org-at-heading-p)
18036 (and (org-region-active-p)
18037 (save-excursion
18038 (goto-char (region-beginning))
18039 (org-at-heading-p)))))
18040 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18041 (call-interactively 'org-do-demote))
18042 ;; At an inline task.
18043 ((org-at-heading-p)
18044 (call-interactively 'org-inlinetask-demote))
18045 ((or (org-at-item-p)
18046 (and (org-region-active-p)
18047 (save-excursion
18048 (goto-char (region-beginning))
18049 (org-at-item-p))))
18050 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18051 (call-interactively 'org-indent-item))
18052 (t (call-interactively 'forward-word))))
18054 (defun org-check-for-hidden (what)
18055 "Check if there are hidden headlines/items in the current visual line.
18056 WHAT can be either `headlines' or `items'. If the current line is
18057 an outline or item heading and it has a folded subtree below it,
18058 this function returns t, nil otherwise."
18059 (let ((re (cond
18060 ((eq what 'headlines) org-outline-regexp-bol)
18061 ((eq what 'items) (org-item-beginning-re))
18062 (t (error "This should not happen"))))
18063 beg end)
18064 (save-excursion
18065 (catch 'exit
18066 (unless (org-region-active-p)
18067 (setq beg (point-at-bol))
18068 (beginning-of-line 2)
18069 (while (and (not (eobp)) ;; this is like `next-line'
18070 (get-char-property (1- (point)) 'invisible))
18071 (beginning-of-line 2))
18072 (setq end (point))
18073 (goto-char beg)
18074 (goto-char (point-at-eol))
18075 (setq end (max end (point)))
18076 (while (re-search-forward re end t)
18077 (if (get-char-property (match-beginning 0) 'invisible)
18078 (throw 'exit t))))
18079 nil))))
18081 (defun org-metaup (&optional arg)
18082 "Move subtree up or move table row up.
18083 Calls `org-move-subtree-up' or `org-table-move-row' or
18084 `org-move-item-up', depending on context. See the individual commands
18085 for more information."
18086 (interactive "P")
18087 (cond
18088 ((run-hook-with-args-until-success 'org-metaup-hook))
18089 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18090 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18091 ((org-at-item-p) (call-interactively 'org-move-item-up))
18092 (t (transpose-lines 1) (beginning-of-line -1))))
18094 (defun org-metadown (&optional arg)
18095 "Move subtree down or move table row down.
18096 Calls `org-move-subtree-down' or `org-table-move-row' or
18097 `org-move-item-down', depending on context. See the individual
18098 commands for more information."
18099 (interactive "P")
18100 (cond
18101 ((run-hook-with-args-until-success 'org-metadown-hook))
18102 ((org-at-table-p) (call-interactively 'org-table-move-row))
18103 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18104 ((org-at-item-p) (call-interactively 'org-move-item-down))
18105 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18107 (defun org-shiftup (&optional arg)
18108 "Increase item in timestamp or increase priority of current headline.
18109 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18110 depending on context. See the individual commands for more information."
18111 (interactive "P")
18112 (cond
18113 ((run-hook-with-args-until-success 'org-shiftup-hook))
18114 ((and org-support-shift-select (org-region-active-p))
18115 (org-call-for-shift-select 'previous-line))
18116 ((org-at-timestamp-p t)
18117 (call-interactively (if org-edit-timestamp-down-means-later
18118 'org-timestamp-down 'org-timestamp-up)))
18119 ((and (not (eq org-support-shift-select 'always))
18120 org-enable-priority-commands
18121 (org-at-heading-p))
18122 (call-interactively 'org-priority-up))
18123 ((and (not org-support-shift-select) (org-at-item-p))
18124 (call-interactively 'org-previous-item))
18125 ((org-clocktable-try-shift 'up arg))
18126 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18127 (org-support-shift-select
18128 (org-call-for-shift-select 'previous-line))
18129 (t (org-shiftselect-error))))
18131 (defun org-shiftdown (&optional arg)
18132 "Decrease item in timestamp or decrease priority of current headline.
18133 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18134 depending on context. See the individual commands for more information."
18135 (interactive "P")
18136 (cond
18137 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18138 ((and org-support-shift-select (org-region-active-p))
18139 (org-call-for-shift-select 'next-line))
18140 ((org-at-timestamp-p t)
18141 (call-interactively (if org-edit-timestamp-down-means-later
18142 'org-timestamp-up 'org-timestamp-down)))
18143 ((and (not (eq org-support-shift-select 'always))
18144 org-enable-priority-commands
18145 (org-at-heading-p))
18146 (call-interactively 'org-priority-down))
18147 ((and (not org-support-shift-select) (org-at-item-p))
18148 (call-interactively 'org-next-item))
18149 ((org-clocktable-try-shift 'down arg))
18150 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18151 (org-support-shift-select
18152 (org-call-for-shift-select 'next-line))
18153 (t (org-shiftselect-error))))
18155 (defun org-shiftright (&optional arg)
18156 "Cycle the thing at point or in the current line, depending on context.
18157 Depending on context, this does one of the following:
18159 - switch a timestamp at point one day into the future
18160 - on a headline, switch to the next TODO keyword.
18161 - on an item, switch entire list to the next bullet type
18162 - on a property line, switch to the next allowed value
18163 - on a clocktable definition line, move time block into the future"
18164 (interactive "P")
18165 (cond
18166 ((run-hook-with-args-until-success 'org-shiftright-hook))
18167 ((and org-support-shift-select (org-region-active-p))
18168 (org-call-for-shift-select 'forward-char))
18169 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18170 ((and (not (eq org-support-shift-select 'always))
18171 (org-at-heading-p))
18172 (let ((org-inhibit-logging
18173 (not org-treat-S-cursor-todo-selection-as-state-change))
18174 (org-inhibit-blocking
18175 (not org-treat-S-cursor-todo-selection-as-state-change)))
18176 (org-call-with-arg 'org-todo 'right)))
18177 ((or (and org-support-shift-select
18178 (not (eq org-support-shift-select 'always))
18179 (org-at-item-bullet-p))
18180 (and (not org-support-shift-select) (org-at-item-p)))
18181 (org-call-with-arg 'org-cycle-list-bullet nil))
18182 ((and (not (eq org-support-shift-select 'always))
18183 (org-at-property-p))
18184 (call-interactively 'org-property-next-allowed-value))
18185 ((org-clocktable-try-shift 'right arg))
18186 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18187 (org-support-shift-select
18188 (org-call-for-shift-select 'forward-char))
18189 (t (org-shiftselect-error))))
18191 (defun org-shiftleft (&optional arg)
18192 "Cycle the thing at point or in the current line, depending on context.
18193 Depending on context, this does one of the following:
18195 - switch a timestamp at point one day into the past
18196 - on a headline, switch to the previous TODO keyword.
18197 - on an item, switch entire list to the previous bullet type
18198 - on a property line, switch to the previous allowed value
18199 - on a clocktable definition line, move time block into the past"
18200 (interactive "P")
18201 (cond
18202 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18203 ((and org-support-shift-select (org-region-active-p))
18204 (org-call-for-shift-select 'backward-char))
18205 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18206 ((and (not (eq org-support-shift-select 'always))
18207 (org-at-heading-p))
18208 (let ((org-inhibit-logging
18209 (not org-treat-S-cursor-todo-selection-as-state-change))
18210 (org-inhibit-blocking
18211 (not org-treat-S-cursor-todo-selection-as-state-change)))
18212 (org-call-with-arg 'org-todo 'left)))
18213 ((or (and org-support-shift-select
18214 (not (eq org-support-shift-select 'always))
18215 (org-at-item-bullet-p))
18216 (and (not org-support-shift-select) (org-at-item-p)))
18217 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18218 ((and (not (eq org-support-shift-select 'always))
18219 (org-at-property-p))
18220 (call-interactively 'org-property-previous-allowed-value))
18221 ((org-clocktable-try-shift 'left arg))
18222 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18223 (org-support-shift-select
18224 (org-call-for-shift-select 'backward-char))
18225 (t (org-shiftselect-error))))
18227 (defun org-shiftcontrolright ()
18228 "Switch to next TODO set."
18229 (interactive)
18230 (cond
18231 ((and org-support-shift-select (org-region-active-p))
18232 (org-call-for-shift-select 'forward-word))
18233 ((and (not (eq org-support-shift-select 'always))
18234 (org-at-heading-p))
18235 (org-call-with-arg 'org-todo 'nextset))
18236 (org-support-shift-select
18237 (org-call-for-shift-select 'forward-word))
18238 (t (org-shiftselect-error))))
18240 (defun org-shiftcontrolleft ()
18241 "Switch to previous TODO set."
18242 (interactive)
18243 (cond
18244 ((and org-support-shift-select (org-region-active-p))
18245 (org-call-for-shift-select 'backward-word))
18246 ((and (not (eq org-support-shift-select 'always))
18247 (org-at-heading-p))
18248 (org-call-with-arg 'org-todo 'previousset))
18249 (org-support-shift-select
18250 (org-call-for-shift-select 'backward-word))
18251 (t (org-shiftselect-error))))
18253 (defun org-shiftcontrolup ()
18254 "Change timestamps synchronously up in CLOCK log lines."
18255 (interactive)
18256 (cond ((and (not org-support-shift-select)
18257 (org-at-clock-log-p)
18258 (org-at-timestamp-p t))
18259 (org-clock-timestamps-up))
18260 (t (org-shiftselect-error))))
18262 (defun org-shiftcontroldown ()
18263 "Change timestamps synchronously down in CLOCK log lines."
18264 (interactive)
18265 (cond ((and (not org-support-shift-select)
18266 (org-at-clock-log-p)
18267 (org-at-timestamp-p t))
18268 (org-clock-timestamps-down))
18269 (t (org-shiftselect-error))))
18271 (defun org-ctrl-c-ret ()
18272 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18273 (interactive)
18274 (cond
18275 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18276 (t (call-interactively 'org-insert-heading))))
18278 (defun org-find-visible ()
18279 (let ((s (point)))
18280 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18281 (get-char-property s 'invisible)))
18282 s))
18283 (defun org-find-invisible ()
18284 (let ((s (point)))
18285 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18286 (not (get-char-property s 'invisible))))
18287 s))
18289 (defun org-copy-visible (beg end)
18290 "Copy the visible parts of the region."
18291 (interactive "r")
18292 (let (snippets s)
18293 (save-excursion
18294 (save-restriction
18295 (narrow-to-region beg end)
18296 (setq s (goto-char (point-min)))
18297 (while (not (= (point) (point-max)))
18298 (goto-char (org-find-invisible))
18299 (push (buffer-substring s (point)) snippets)
18300 (setq s (goto-char (org-find-visible))))))
18301 (kill-new (apply 'concat (nreverse snippets)))))
18303 (defun org-copy-special ()
18304 "Copy region in table or copy current subtree.
18305 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18306 See the individual commands for more information."
18307 (interactive)
18308 (call-interactively
18309 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18311 (defun org-cut-special ()
18312 "Cut region in table or cut current subtree.
18313 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18314 See the individual commands for more information."
18315 (interactive)
18316 (call-interactively
18317 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18319 (defun org-paste-special (arg)
18320 "Paste rectangular region into table, or past subtree relative to level.
18321 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18322 See the individual commands for more information."
18323 (interactive "P")
18324 (if (org-at-table-p)
18325 (org-table-paste-rectangle)
18326 (org-paste-subtree arg)))
18328 (defun org-edit-special (&optional arg)
18329 "Call a special editor for the stuff at point.
18330 When at a table, call the formula editor with `org-table-edit-formulas'.
18331 When at the first line of an src example, call `org-edit-src-code'.
18332 When in an #+include line, visit the include file. Otherwise call
18333 `ffap' to visit the file at point."
18334 (interactive)
18335 ;; possibly prep session before editing source
18336 (when arg
18337 (let* ((info (org-babel-get-src-block-info))
18338 (lang (nth 0 info))
18339 (params (nth 2 info))
18340 (session (cdr (assoc :session params))))
18341 (when (and info session) ;; we are in a source-code block with a session
18342 (funcall
18343 (intern (concat "org-babel-prep-session:" lang)) session params))))
18344 (cond ;; proceed with `org-edit-special'
18345 ((save-excursion
18346 (beginning-of-line 1)
18347 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18348 (find-file (org-trim (match-string 1))))
18349 ((org-edit-src-code))
18350 ((org-edit-fixed-width-region))
18351 ((org-at-table.el-p)
18352 (org-edit-src-code))
18353 ((or (org-at-table-p)
18354 (save-excursion
18355 (beginning-of-line 1)
18357 (call-interactively 'org-table-edit-formulas))
18358 (t (call-interactively 'ffap))))
18360 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18361 (defun org-ctrl-c-ctrl-c (&optional arg)
18362 "Set tags in headline, or update according to changed information at point.
18364 This command does many different things, depending on context:
18366 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18367 this is what we do.
18369 - If the cursor is on a statistics cookie, update it.
18371 - If the cursor is in a headline, prompt for tags and insert them
18372 into the current line, aligned to `org-tags-column'. When called
18373 with prefix arg, realign all tags in the current buffer.
18375 - If the cursor is in one of the special #+KEYWORD lines, this
18376 triggers scanning the buffer for these lines and updating the
18377 information.
18379 - If the cursor is inside a table, realign the table. This command
18380 works even if the automatic table editor has been turned off.
18382 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18383 the entire table.
18385 - If the cursor is at a footnote reference or definition, jump to
18386 the corresponding definition or references, respectively.
18388 - If the cursor is a the beginning of a dynamic block, update it.
18390 - If the current buffer is a capture buffer, close note and file it.
18392 - If the cursor is on a <<<target>>>, update radio targets and
18393 corresponding links in this buffer.
18395 - If the cursor is on a numbered item in a plain list, renumber the
18396 ordered list.
18398 - If the cursor is on a checkbox, toggle it.
18400 - If the cursor is on a code block, evaluate it. The variable
18401 `org-confirm-babel-evaluate' can be used to control prompting
18402 before code block evaluation, by default every code block
18403 evaluation requires confirmation. Code block evaluation can be
18404 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18405 (interactive "P")
18406 (let ((org-enable-table-editor t))
18407 (cond
18408 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18409 org-occur-highlights
18410 org-latex-fragment-image-overlays)
18411 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18412 (org-remove-occur-highlights)
18413 (org-remove-latex-fragment-image-overlays)
18414 (message "Temporary highlights/overlays removed from current buffer"))
18415 ((and (local-variable-p 'org-finish-function (current-buffer))
18416 (fboundp org-finish-function))
18417 (funcall org-finish-function))
18418 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18419 ((org-in-regexp org-ts-regexp-both)
18420 (org-timestamp-change 0 'day))
18421 ((or (looking-at org-property-start-re)
18422 (org-at-property-p))
18423 (call-interactively 'org-property-action))
18424 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18426 (or (org-at-heading-p) (org-at-item-p)))
18427 (call-interactively 'org-update-statistics-cookies))
18428 ((org-at-heading-p) (call-interactively 'org-set-tags))
18429 ((org-at-table.el-p)
18430 (message "Use C-c ' to edit table.el tables"))
18431 ((org-at-table-p)
18432 (org-table-maybe-eval-formula)
18433 (if arg
18434 (call-interactively 'org-table-recalculate)
18435 (org-table-maybe-recalculate-line))
18436 (call-interactively 'org-table-align)
18437 (orgtbl-send-table 'maybe))
18438 ((or (org-footnote-at-reference-p)
18439 (org-footnote-at-definition-p))
18440 (call-interactively 'org-footnote-action))
18441 ((org-at-item-checkbox-p)
18442 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18443 ;; list only if at top item.
18444 (let* ((cbox (match-string 1))
18445 (struct (org-list-struct))
18446 (old-struct (copy-tree struct))
18447 (parents (org-list-parents-alist struct))
18448 (orderedp (org-entry-get nil "ORDERED"))
18449 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18450 block-item)
18451 ;; Use a light version of `org-toggle-checkbox' to avoid
18452 ;; computing list structure twice.
18453 (let ((new-box (cond
18454 ((equal arg '(16)) "[-]")
18455 ((equal arg '(4)) nil)
18456 ((equal "[X]" cbox) "[ ]")
18457 (t "[X]"))))
18458 (if (and firstp arg)
18459 ;; If at first item of sub-list, remove check-box from
18460 ;; every item at the same level.
18461 (mapc
18462 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18463 (org-list-get-all-items
18464 (point-at-bol) struct (org-list-prevs-alist struct)))
18465 (org-list-set-checkbox (point-at-bol) struct new-box)))
18466 ;; Replicate `org-list-write-struct', while grabbing a return
18467 ;; value from `org-list-struct-fix-box'.
18468 (org-list-struct-fix-ind struct parents 2)
18469 (org-list-struct-fix-item-end struct)
18470 (let ((prevs (org-list-prevs-alist struct)))
18471 (org-list-struct-fix-bul struct prevs)
18472 (org-list-struct-fix-ind struct parents)
18473 (setq block-item
18474 (org-list-struct-fix-box struct parents prevs orderedp)))
18475 (org-list-struct-apply-struct struct old-struct)
18476 (org-update-checkbox-count-maybe)
18477 (when block-item
18478 (message
18479 "Checkboxes were removed due to unchecked box at line %d"
18480 (org-current-line block-item)))
18481 (when firstp (org-list-send-list 'maybe))))
18482 ((org-at-item-p)
18483 ;; Cursor at an item: repair list. Do checkbox related actions
18484 ;; only if function was called with an argument. Send list only
18485 ;; if at top item.
18486 (let* ((struct (org-list-struct))
18487 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18488 old-struct)
18489 (when arg
18490 (setq old-struct (copy-tree struct))
18491 (if firstp
18492 ;; If at first item of sub-list, add check-box to every
18493 ;; item at the same level.
18494 (mapc
18495 (lambda (pos)
18496 (unless (org-list-get-checkbox pos struct)
18497 (org-list-set-checkbox pos struct "[ ]")))
18498 (org-list-get-all-items
18499 (point-at-bol) struct (org-list-prevs-alist struct)))
18500 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18501 (org-list-write-struct
18502 struct (org-list-parents-alist struct) old-struct)
18503 (when arg (org-update-checkbox-count-maybe))
18504 (when firstp (org-list-send-list 'maybe))))
18505 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18506 ;; Dynamic block
18507 (beginning-of-line 1)
18508 (save-excursion (org-update-dblock)))
18509 ((save-excursion
18510 (beginning-of-line 1)
18512 (cond
18513 ((equal (match-string 1) "TBLFM")
18514 ;; Recalculate the table before this line
18515 (save-excursion
18516 (beginning-of-line 1)
18518 (if (org-at-table-p)
18519 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18520 (t
18521 (let ((org-inhibit-startup-visibility-stuff t)
18522 (org-startup-align-all-tables nil))
18523 (when (boundp 'org-table-coordinate-overlays)
18524 (mapc 'delete-overlay org-table-coordinate-overlays)
18525 (setq org-table-coordinate-overlays nil))
18526 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18527 (message "Local setup has been refreshed"))))
18528 ((org-clock-update-time-maybe))
18529 (t
18530 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18531 (error "C-c C-c can do nothing useful at this location"))))))
18533 (defun org-mode-restart ()
18534 "Restart Org-mode, to scan again for special lines.
18535 Also updates the keyword regular expressions."
18536 (interactive)
18537 (org-mode)
18538 (message "Org-mode restarted"))
18540 (defun org-kill-note-or-show-branches ()
18541 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18542 (interactive)
18543 (if (not org-finish-function)
18544 (progn
18545 (hide-subtree)
18546 (call-interactively 'show-branches))
18547 (let ((org-note-abort t))
18548 (funcall org-finish-function))))
18550 (defun org-return (&optional indent)
18551 "Goto next table row or insert a newline.
18552 Calls `org-table-next-row' or `newline', depending on context.
18553 See the individual commands for more information."
18554 (interactive)
18555 (cond
18556 ((bobp) (if indent (newline-and-indent) (newline)))
18557 ((org-at-table-p)
18558 (org-table-justify-field-maybe)
18559 (call-interactively 'org-table-next-row))
18560 ;; when `newline-and-indent' is called within a list, make sure
18561 ;; text moved stays inside the item.
18562 ((and (org-in-item-p) indent)
18563 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18564 (progn
18565 (save-match-data (newline))
18566 (org-indent-line-to (length (match-string 0))))
18567 (let ((ind (org-get-indentation)))
18568 (newline)
18569 (if (org-looking-back org-list-end-re)
18570 (org-indent-line-function)
18571 (org-indent-line-to ind)))))
18572 ((and org-return-follows-link
18573 (let ((tprop (get-text-property (point) 'face)))
18574 (or (eq tprop 'org-link)
18575 (and (listp tprop) (memq 'org-link tprop)))))
18576 (call-interactively 'org-open-at-point))
18577 ((and (org-at-heading-p)
18578 (looking-at
18580 (org-show-entry)
18581 (end-of-line 1)
18582 (newline))
18583 (t (if indent (newline-and-indent) (newline)))))
18585 (defun org-return-indent ()
18586 "Goto next table row or insert a newline and indent.
18587 Calls `org-table-next-row' or `newline-and-indent', depending on
18588 context. See the individual commands for more information."
18589 (interactive)
18590 (org-return t))
18592 (defun org-ctrl-c-star ()
18593 "Compute table, or change heading status of lines.
18594 Calls `org-table-recalculate' or `org-toggle-heading',
18595 depending on context."
18596 (interactive)
18597 (cond
18598 ((org-at-table-p)
18599 (call-interactively 'org-table-recalculate))
18600 (t
18601 ;; Convert all lines in region to list items
18602 (call-interactively 'org-toggle-heading))))
18604 (defun org-ctrl-c-minus ()
18605 "Insert separator line in table or modify bullet status of line.
18606 Also turns a plain line or a region of lines into list items.
18607 Calls `org-table-insert-hline', `org-toggle-item', or
18608 `org-cycle-list-bullet', depending on context."
18609 (interactive)
18610 (cond
18611 ((org-at-table-p)
18612 (call-interactively 'org-table-insert-hline))
18613 ((org-region-active-p)
18614 (call-interactively 'org-toggle-item))
18615 ((org-in-item-p)
18616 (call-interactively 'org-cycle-list-bullet))
18617 (t
18618 (call-interactively 'org-toggle-item))))
18620 (defun org-toggle-item (arg)
18621 "Convert headings or normal lines to items, items to normal lines.
18622 If there is no active region, only the current line is considered.
18624 If the first non blank line in the region is an headline, convert
18625 all headlines to items, shifting text accordingly.
18627 If it is an item, convert all items to normal lines.
18629 If it is normal text, change region into an item. With a prefix
18630 argument ARG, change each line in region into an item."
18631 (interactive "P")
18632 (let ((shift-text
18633 (function
18634 ;; Shift text in current section to IND, from point to END.
18635 ;; The function leaves point to END line.
18636 (lambda (ind end)
18637 (let ((min-i 1000) (end (copy-marker end)))
18638 ;; First determine the minimum indentation (MIN-I) of
18639 ;; the text.
18640 (save-excursion
18641 (catch 'exit
18642 (while (< (point) end)
18643 (let ((i (org-get-indentation)))
18644 (cond
18645 ;; Skip blank lines and inline tasks.
18647 ((looking-at org-outline-regexp-bol))
18648 ;; We can't find less than 0 indentation.
18649 ((zerop i) (throw 'exit (setq min-i 0)))
18650 ((< i min-i) (setq min-i i))))
18651 (forward-line))))
18652 ;; Then indent each line so that a line indented to
18653 ;; MIN-I becomes indented to IND. Ignore blank lines
18654 ;; and inline tasks in the process.
18655 (let ((delta (- ind min-i)))
18656 (while (< (point) end)
18658 (looking-at org-outline-regexp-bol))
18659 (org-indent-line-to (+ (org-get-indentation) delta)))
18660 (forward-line)))))))
18661 (skip-blanks
18662 (function
18663 ;; Return beginning of first non-blank line, starting from
18664 ;; line at POS.
18665 (lambda (pos)
18666 (save-excursion
18667 (goto-char pos)
18669 (point-at-bol)))))
18670 beg end)
18671 ;; Determine boundaries of changes.
18672 (if (org-region-active-p)
18673 (setq beg (funcall skip-blanks (region-beginning))
18674 end (copy-marker (region-end)))
18675 (setq beg (funcall skip-blanks (point-at-bol))
18676 end (copy-marker (point-at-eol))))
18677 ;; Depending on the starting line, choose an action on the text
18678 ;; between BEG and END.
18679 (org-with-limited-levels
18680 (save-excursion
18681 (goto-char beg)
18682 (cond
18683 ;; Case 1. Start at an item: de-itemize. Note that it only
18684 ;; happens when a region is active: `org-ctrl-c-minus'
18685 ;; would call `org-cycle-list-bullet' otherwise.
18686 ((org-at-item-p)
18687 (while (< (point) end)
18688 (when (org-at-item-p)
18690 (delete-region (point) (match-end 0)))
18691 (forward-line)))
18692 ;; Case 2. Start at an heading: convert to items.
18693 ((org-at-heading-p)
18694 (let* ((bul (org-list-bullet-string "-"))
18695 (bul-len (length bul))
18696 ;; Indentation of the first heading. It should be
18697 ;; relative to the indentation of its parent, if any.
18698 (start-ind (save-excursion
18699 (cond
18700 ((not org-adapt-indentation) 0)
18701 ((not (outline-previous-heading)) 0)
18702 (t (length (match-string 0))))))
18703 ;; Level of first heading. Further headings will be
18704 ;; compared to it to determine hierarchy in the list.
18705 (ref-level (org-reduced-level (org-outline-level))))
18706 (while (< (point) end)
18707 (let* ((level (org-reduced-level (org-outline-level)))
18708 (delta (max 0 (- level ref-level))))
18709 ;; If current headline is less indented than the first
18710 ;; one, set it as reference, in order to preserve
18711 ;; subtrees.
18712 (when (< level ref-level) (setq ref-level level))
18713 (replace-match bul t t)
18714 (org-indent-line-to (+ start-ind (* delta bul-len)))
18715 ;; Ensure all text down to END (or SECTION-END) belongs
18716 ;; to the newly created item.
18717 (let ((section-end (save-excursion
18718 (or (outline-next-heading) (point)))))
18719 (forward-line)
18720 (funcall shift-text
18721 (+ start-ind (* (1+ delta) bul-len))
18722 (min end section-end)))))))
18723 ;; Case 3. Normal line with ARG: turn each non-item line into
18724 ;; an item.
18725 (arg
18726 (while (< (point) end)
18727 (unless (or (org-at-heading-p) (org-at-item-p))
18729 (replace-match
18731 (forward-line)))
18732 ;; Case 4. Normal line without ARG: make the first line of
18733 ;; region an item, and shift indentation of others
18734 ;; lines to set them as item's body.
18735 (t (let* ((bul (org-list-bullet-string "-"))
18736 (bul-len (length bul))
18737 (ref-ind (org-get-indentation)))
18739 (insert bul)
18740 (forward-line)
18741 (while (< (point) end)
18742 ;; Ensure that lines less indented than first one
18743 ;; still get included in item body.
18744 (funcall shift-text
18745 (+ ref-ind bul-len)
18746 (min end (save-excursion (or (outline-next-heading)
18747 (point)))))
18748 (forward-line)))))))))
18750 (defun org-toggle-heading (&optional nstars)
18751 "Convert headings to normal text, or items or text to headings.
18752 If there is no active region, only the current line is considered.
18754 If the first non blank line is an headline, remove the stars from
18755 all headlines in the region.
18757 If it is a plain list item, turn all plain list items into headings.
18759 If it is a normal line, turn each and every normal line (i.e. not
18760 an heading or an item) in the region into a heading.
18762 When converting a line into a heading, the number of stars is chosen
18763 such that the lines become children of the current entry. However,
18764 when a prefix argument is given, its value determines the number of
18765 stars to add."
18766 (interactive "P")
18767 (let ((skip-blanks
18768 (function
18769 ;; Return beginning of first non-blank line, starting from
18770 ;; line at POS.
18771 (lambda (pos)
18772 (save-excursion
18773 (goto-char pos)
18775 (point-at-bol)))))
18776 beg end)
18777 ;; Determine boundaries of changes. If region ends at a bol, do
18778 ;; not consider the last line to be in the region.
18779 (if (org-region-active-p)
18780 (setq beg (funcall skip-blanks (region-beginning))
18781 end (copy-marker (save-excursion
18782 (goto-char (region-end))
18783 (if (bolp) (point) (point-at-eol)))))
18784 (setq beg (funcall skip-blanks (point-at-bol))
18785 end (copy-marker (point-at-eol))))
18786 ;; Ensure inline tasks don't count as headings.
18787 (org-with-limited-levels
18788 (save-excursion
18789 (goto-char beg)
18790 (cond
18791 ;; Case 1. Started at an heading: de-star headings.
18792 ((org-at-heading-p)
18793 (while (< (point) end)
18794 (when (org-at-heading-p t)
18795 (looking-at org-outline-regexp) (replace-match ""))
18796 (forward-line)))
18797 ;; Case 2. Started at an item: change items into headlines.
18798 ;; One star will be added by `org-list-to-subtree'.
18799 ((org-at-item-p)
18800 (let* ((stars (make-string
18801 (if nstars
18802 ;; subtract the star that will be added again by
18803 ;; `org-list-to-subtree'
18804 (1- (prefix-numeric-value current-prefix-arg))
18805 (or (org-current-level) 0))
18806 ?*))
18807 (add-stars
18808 (cond (nstars "") ; stars from prefix only
18809 ((equal stars "") "") ; before first heading
18810 (org-odd-levels-only "*") ; inside heading, odd
18811 (t "")))) ; inside heading, oddeven
18812 (while (< (point) end)
18813 (when (org-at-item-p)
18814 ;; Pay attention to cases when region ends before list.
18815 (let* ((struct (org-list-struct))
18816 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18817 (save-restriction
18818 (narrow-to-region (point) list-end)
18819 (insert
18820 (org-list-to-subtree
18821 (org-list-parse-list t)
18822 '(:istart (concat stars add-stars (funcall get-stars depth))
18823 :icount (concat stars add-stars (funcall get-stars depth))))))))
18824 (forward-line))))
18825 ;; Case 3. Started at normal text: make every line an heading,
18826 ;; skipping headlines and items.
18827 (t (let* ((stars (make-string
18828 (if nstars
18829 (prefix-numeric-value current-prefix-arg)
18830 (or (org-current-level) 0))
18831 ?*))
18832 (add-stars
18833 (cond (nstars "") ; stars from prefix only
18834 ((equal stars "") "*") ; before first heading
18835 (org-odd-levels-only "**") ; inside heading, odd
18836 (t "*"))) ; inside heading, oddeven
18837 (rpl (concat stars add-stars " ")))
18838 (while (< (point) end)
18839 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18841 (replace-match (concat rpl (match-string 2))))
18842 (forward-line)))))))))
18844 (defun org-meta-return (&optional arg)
18845 "Insert a new heading or wrap a region in a table.
18846 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18847 See the individual commands for more information."
18848 (interactive "P")
18849 (cond
18850 ((run-hook-with-args-until-success 'org-metareturn-hook))
18851 ((org-at-table-p)
18852 (call-interactively 'org-table-wrap-region))
18853 (t (call-interactively 'org-insert-heading))))
18855 ;;; Menu entries
18857 ;; Define the Org-mode menus
18858 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18859 '("Tbl"
18860 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18861 ["Next Field" org-cycle (org-at-table-p)]
18862 ["Previous Field" org-shifttab (org-at-table-p)]
18863 ["Next Row" org-return (org-at-table-p)]
18864 "--"
18865 ["Blank Field" org-table-blank-field (org-at-table-p)]
18866 ["Edit Field" org-table-edit-field (org-at-table-p)]
18867 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18868 "--"
18869 ("Column"
18870 ["Move Column Left" org-metaleft (org-at-table-p)]
18871 ["Move Column Right" org-metaright (org-at-table-p)]
18872 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18873 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18874 ("Row"
18875 ["Move Row Up" org-metaup (org-at-table-p)]
18876 ["Move Row Down" org-metadown (org-at-table-p)]
18877 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18878 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18879 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18880 "--"
18881 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18882 ("Rectangle"
18883 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18884 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18885 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18886 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18887 "--"
18888 ("Calculate"
18889 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18890 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18891 ["Edit Formulas" org-edit-special (org-at-table-p)]
18892 "--"
18893 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18894 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18895 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18896 "--"
18897 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18898 "--"
18899 ["Sum Column/Rectangle" org-table-sum
18900 (or (org-at-table-p) (org-region-active-p))]
18901 ["Which Column?" org-table-current-column (org-at-table-p)])
18902 ["Debug Formulas"
18903 org-table-toggle-formula-debugger
18904 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18905 ["Show Col/Row Numbers"
18906 org-table-toggle-coordinate-overlays
18907 :style toggle
18908 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18909 "--"
18910 ["Create" org-table-create (and (not (org-at-table-p))
18911 org-enable-table-editor)]
18912 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18913 ["Import from File" org-table-import (not (org-at-table-p))]
18914 ["Export to File" org-table-export (org-at-table-p)]
18915 "--"
18916 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18918 (easy-menu-define org-org-menu org-mode-map "Org menu"
18919 '("Org"
18920 ("Show/Hide"
18921 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18922 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18923 ["Sparse Tree..." org-sparse-tree t]
18924 ["Reveal Context" org-reveal t]
18925 ["Show All" show-all t]
18926 "--"
18927 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18928 "--"
18929 ["New Heading" org-insert-heading t]
18930 ("Navigate Headings"
18931 ["Up" outline-up-heading t]
18932 ["Next" outline-next-visible-heading t]
18933 ["Previous" outline-previous-visible-heading t]
18934 ["Next Same Level" outline-forward-same-level t]
18935 ["Previous Same Level" outline-backward-same-level t]
18936 "--"
18937 ["Jump" org-goto t])
18938 ("Edit Structure"
18939 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18940 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18941 "--"
18942 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18943 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18944 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18945 "--"
18946 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18947 "--"
18948 ["Copy visible text" org-copy-visible t]
18949 "--"
18950 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18951 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18952 ["Demote Heading" org-metaright (not (org-at-table-p))]
18953 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18954 "--"
18955 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18956 "--"
18957 ["Convert to odd levels" org-convert-to-odd-levels t]
18958 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18959 ("Editing"
18960 ["Emphasis..." org-emphasize t]
18961 ["Edit Source Example" org-edit-special t]
18962 "--"
18963 ["Footnote new/jump" org-footnote-action t]
18964 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18965 ("Archive"
18966 ["Archive (default method)" org-archive-subtree-default t]
18967 "--"
18968 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18969 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18970 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18971 )
18972 "--"
18973 ("Hyperlinks"
18974 ["Store Link (Global)" org-store-link t]
18975 ["Find existing link to here" org-occur-link-in-agenda-files t]
18976 ["Insert Link" org-insert-link t]
18977 ["Follow Link" org-open-at-point t]
18978 "--"
18979 ["Next link" org-next-link t]
18980 ["Previous link" org-previous-link t]
18981 "--"
18982 ["Descriptive Links"
18983 org-toggle-link-display
18984 :style radio
18985 :selected org-descriptive-links
18986 ]
18987 ["Literal Links"
18988 org-toggle-link-display
18989 :style radio
18990 :selected (not org-descriptive-links)])
18991 "--"
18992 ("TODO Lists"
18993 ["TODO/DONE/-" org-todo t]
18994 ("Select keyword"
18995 ["Next keyword" org-shiftright (org-at-heading-p)]
18996 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18997 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18998 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18999 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19000 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19001 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19002 "--"
19003 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19004 :selected org-enforce-todo-dependencies :style toggle :active t]
19005 "Settings for tree at point"
19006 ["Do Children sequentially" org-toggle-ordered-property :style radio
19007 :selected (org-entry-get nil "ORDERED")
19008 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19009 ["Do Children parallel" org-toggle-ordered-property :style radio
19010 :selected (not (org-entry-get nil "ORDERED"))
19011 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19012 "--"
19013 ["Set Priority" org-priority t]
19014 ["Priority Up" org-shiftup t]
19015 ["Priority Down" org-shiftdown t]
19016 "--"
19017 ["Get news from all feeds" org-feed-update-all t]
19018 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19019 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19020 ("TAGS and Properties"
19021 ["Set Tags" org-set-tags-command t]
19022 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19023 "--"
19024 ["Set property" org-set-property t]
19025 ["Column view of properties" org-columns t]
19026 ["Insert Column View DBlock" org-insert-columns-dblock t])
19027 ("Dates and Scheduling"
19028 ["Timestamp" org-time-stamp t]
19029 ["Timestamp (inactive)" org-time-stamp-inactive t]
19030 ("Change Date"
19031 ["1 Day Later" org-shiftright t]
19032 ["1 Day Earlier" org-shiftleft t]
19033 ["1 ... Later" org-shiftup t]
19034 ["1 ... Earlier" org-shiftdown t])
19035 ["Compute Time Range" org-evaluate-time-range t]
19036 ["Schedule Item" org-schedule t]
19037 ["Deadline" org-deadline t]
19038 "--"
19039 ["Custom time format" org-toggle-time-stamp-overlays
19040 :style radio :selected org-display-custom-times]
19041 "--"
19042 ["Goto Calendar" org-goto-calendar t]
19043 ["Date from Calendar" org-date-from-calendar t]
19044 "--"
19045 ["Start/Restart Timer" org-timer-start t]
19046 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19047 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19048 ["Insert Timer String" org-timer t]
19049 ["Insert Timer Item" org-timer-item t])
19050 ("Logging work"
19051 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19052 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19053 ["Clock out" org-clock-out t]
19054 ["Clock cancel" org-clock-cancel t]
19055 "--"
19056 ["Mark as default task" org-clock-mark-default-task t]
19057 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19058 ["Goto running clock" org-clock-goto t]
19059 "--"
19060 ["Display times" org-clock-display t]
19061 ["Create clock table" org-clock-report t]
19062 "--"
19063 ["Record DONE time"
19064 (progn (setq org-log-done (not org-log-done))
19065 (message "Switching to %s will %s record a timestamp"
19066 (car org-done-keywords)
19067 (if org-log-done "automatically" "not")))
19068 :style toggle :selected org-log-done])
19069 "--"
19070 ["Agenda Command..." org-agenda t]
19071 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19072 ("File List for Agenda")
19073 ("Special views current file"
19074 ["TODO Tree" org-show-todo-tree t]
19075 ["Check Deadlines" org-check-deadlines t]
19076 ["Timeline" org-timeline t]
19077 ["Tags/Property tree" org-match-sparse-tree t])
19078 "--"
19079 ["Export/Publish..." org-export t]
19080 ("LaTeX"
19081 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19082 :selected org-cdlatex-mode]
19083 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19084 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19085 ["Modify math symbol" org-cdlatex-math-modify
19086 (org-inside-LaTeX-fragment-p)]
19087 ["Insert citation" org-reftex-citation t]
19088 "--"
19089 ["Template for BEAMER" (progn (require 'org-beamer)
19090 (org-insert-beamer-options-template)) t])
19091 "--"
19092 ("MobileOrg"
19093 ["Push Files and Views" org-mobile-push t]
19094 ["Get Captured and Flagged" org-mobile-pull t]
19095 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19096 "--"
19097 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19098 "--"
19099 ("Documentation"
19100 ["Show Version" org-version t]
19101 ["Info Documentation" org-info t])
19102 ("Customize"
19103 ["Browse Org Group" org-customize t]
19104 "--"
19105 ["Expand This Menu" org-create-customize-menu
19106 (fboundp 'customize-menu-create)])
19107 ["Send bug report" org-submit-bug-report t]
19108 "--"
19109 ("Refresh/Reload"
19110 ["Refresh setup current buffer" org-mode-restart t]
19111 ["Reload Org (after update)" org-reload t]
19112 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19113 ))
19115 (defun org-info (&optional node)
19116 "Read documentation for Org-mode in the info system.
19117 With optional NODE, go directly to that node."
19118 (interactive)
19119 (info (format "(org)%s" (or node ""))))
19121 ;;;###autoload
19122 (defun org-submit-bug-report ()
19123 "Submit a bug report on Org-mode via mail.
19125 Don't hesitate to report any problems or inaccurate documentation.
19127 If you don't have setup sending mail from (X)Emacs, please copy the
19128 output buffer into your mail program, as it gives us important
19129 information about your Org-mode version and configuration."
19130 (interactive)
19131 (require 'reporter)
19132 (org-load-modules-maybe)
19133 (org-require-autoloaded-modules)
19134 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19135 (reporter-submit-bug-report
19136 "emacs-orgmode@gnu.org"
19137 (org-version)
19138 (let (list)
19139 (save-window-excursion
19140 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19141 (delete-other-windows)
19142 (erase-buffer)
19143 (insert "You are about to submit a bug report to the Org-mode mailing list.
19145 We would like to add your full Org-mode and Outline configuration to the
19146 bug report. This greatly simplifies the work of the maintainer and
19147 other experts on the mailing list.
19149 HOWEVER, some variables you have customized may contain private
19150 information. The names of customers, colleagues, or friends, might
19151 appear in the form of file names, tags, todo states, or search strings.
19152 If you answer yes to the prompt, you might want to check and remove
19153 such private information before sending the email.")
19154 (add-text-properties (point-min) (point-max) '(face org-warning))
19155 (when (yes-or-no-p "Include your Org-mode configuration ")
19156 (mapatoms
19157 (lambda (v)
19158 (and (boundp v)
19160 (or (and (symbol-value v)
19162 (and
19163 (get v 'custom-type) (get v 'standard-value)
19164 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19165 (push v list)))))
19166 (kill-buffer (get-buffer "*Warn about privacy*"))
19167 list))
19168 nil nil
19169 "Remember to cover the basics, that is, what you expected to happen and
19170 what in fact did happen. You don't know how to make a good report? See
19172 http://orgmode.org/manual/Feedback.html#Feedback
19174 Your bug report will be posted to the Org-mode mailing list.
19175 ------------------------------------------------------------------------")
19176 (save-excursion
19181 (defun org-install-agenda-files-menu ()
19182 (let ((bl (buffer-list)))
19183 (save-excursion
19184 (while bl
19185 (set-buffer (pop bl))
19186 (if (eq major-mode 'org-mode) (setq bl nil)))
19187 (when (eq major-mode 'org-mode)
19188 (easy-menu-change
19189 '("Org") "File List for Agenda"
19190 (append
19191 (list
19192 ["Edit File List" (org-edit-agenda-file-list) t]
19193 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19194 ["Remove Current File from List" org-remove-file t]
19195 ["Cycle through agenda files" org-cycle-agenda-files t]
19196 ["Occur in all agenda files" org-occur-in-agenda-files t]
19197 "--")
19198 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19200 ;;;; Documentation
19202 ;;;###autoload
19203 (defun org-require-autoloaded-modules ()
19204 (interactive)
19205 (mapc 'require
19206 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19207 org-docbook org-exp org-html org-icalendar
19208 org-id org-latex
19209 org-publish org-remember org-table
19210 org-timer org-xoxo)))
19212 ;;;###autoload
19213 (defun org-reload (&optional uncompiled)
19214 "Reload all org lisp files.
19215 With prefix arg UNCOMPILED, load the uncompiled versions."
19216 (interactive "P")
19217 (require 'find-func)
19219 (dir-org (file-name-directory (org-find-library-name "org")))
19220 (dir-org-contrib (ignore-errors
19221 (file-name-directory
19222 (org-find-library-name "org-contribdir"))))
19223 (babel-files
19224 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19225 (append (list nil "comint" "eval" "exp" "keys"
19226 "lob" "ref" "table" "tangle")
19227 (delq nil
19228 (mapcar
19229 (lambda (lang)
19230 (when (cdr lang) (symbol-name (car lang))))
19231 org-babel-load-languages)))))
19232 (files
19233 (append (directory-files dir-org t file-re)
19234 babel-files
19235 (and dir-org-contrib
19236 (directory-files dir-org-contrib t file-re))))
19237 (remove-re (concat (if (featurep 'xemacs)
19238 "org-colview" "org-colview-xemacs")
19240 (setq files (mapcar 'file-name-sans-extension files))
19241 (setq files (mapcar
19242 (lambda (x) (if (string-match remove-re x) nil x))
19243 files))
19244 (setq files (delq nil files))
19245 (mapc
19246 (lambda (f)
19247 (when (featurep (intern (file-name-nondirectory f)))
19248 (if (and (not uncompiled)
19249 (file-exists-p (concat f ".elc")))
19250 (load (concat f ".elc") nil nil t)
19251 (load (concat f ".el") nil nil t))))
19252 files))
19253 (org-version))
19255 ;;;###autoload
19256 (defun org-customize ()
19257 "Call the customize function with org as argument."
19258 (interactive)
19259 (org-load-modules-maybe)
19260 (org-require-autoloaded-modules)
19261 (customize-browse 'org))
19263 (defun org-create-customize-menu ()
19264 "Create a full customization menu for Org-mode, insert it into the menu."
19265 (interactive)
19266 (org-load-modules-maybe)
19267 (org-require-autoloaded-modules)
19268 (if (fboundp 'customize-menu-create)
19269 (progn
19270 (easy-menu-change
19271 '("Org") "Customize"
19272 `(["Browse Org group" org-customize t]
19273 "--"
19274 ,(customize-menu-create 'org)
19275 ["Set" Custom-set t]
19276 ["Save" Custom-save t]
19277 ["Reset to Current" Custom-reset-current t]
19278 ["Reset to Saved" Custom-reset-saved t]
19279 ["Reset to Standard Settings" Custom-reset-standard t]))
19281 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19283 ;;;; Miscellaneous stuff
19285 ;;; Generally useful functions
19287 (defun org-get-at-bol (property)
19288 "Get text property PROPERTY at beginning of line."
19289 (get-text-property (point-at-bol) property))
19291 (defun org-find-text-property-in-string (prop s)
19292 "Return the first non-nil value of property PROP in string S."
19293 (or (get-text-property 0 prop s)
19294 (get-text-property (or (next-single-property-change 0 prop s) 0)
19295 prop s)))
19297 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19298 "Display the given MESSAGE as a warning."
19299 (if (fboundp 'display-warning)
19300 (display-warning 'org message
19301 (if (featurep 'xemacs) 'warning :warning))
19302 (let ((buf (get-buffer-create "*Org warnings*")))
19303 (with-current-buffer buf
19304 (goto-char (point-max))
19305 (insert "Warning (Org): " message)
19306 (unless (bolp)
19307 (newline)))
19308 (display-buffer buf)
19309 (sit-for 0))))
19311 (defun org-eval (form)
19312 "Eval FORM and return result."
19313 (condition-case error
19314 (eval form)
19315 (error (format "%%![Error: %s]" error))))
19317 (defun org-in-clocktable-p ()
19318 "Check if the cursor is in a clocktable."
19319 (let ((pos (point)) start)
19320 (save-excursion
19321 (end-of-line 1)
19323 (setq start (match-beginning 0))
19325 (>= (match-end 0) pos)
19326 start))))
19328 (defun org-in-commented-line ()
19329 "Is point in a line starting with `#'?"
19330 (equal (char-after (point-at-bol)) ?#))
19332 (defun org-in-indented-comment-line ()
19333 "Is point in a line starting with `#' after some white space?"
19334 (save-excursion
19335 (save-match-data
19336 (goto-char (point-at-bol))
19339 (defun org-in-verbatim-emphasis ()
19340 (save-match-data
19341 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19343 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19344 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19345 (if (and marker (marker-buffer marker)
19346 (buffer-live-p (marker-buffer marker)))
19347 (progn
19348 (org-pop-to-buffer-same-window (marker-buffer marker))
19349 (if (or (> marker (point-max)) (< marker (point-min)))
19350 (widen))
19351 (goto-char marker)
19352 (org-show-context 'org-goto))
19353 (if bookmark
19354 (bookmark-jump bookmark)
19355 (error "Cannot find location"))))
19357 (defun org-quote-csv-field (s)
19358 "Quote field for inclusion in CSV material."
19361 s))
19363 (defun org-force-self-insert (N)
19364 "Needed to enforce self-insert under remapping."
19365 (interactive "p")
19366 (self-insert-command N))
19368 (defun org-string-width (s)
19369 "Compute width of string, ignoring invisible characters.
19370 This ignores character with invisibility property `org-link', and also
19371 characters with property `org-cwidth', because these will become invisible
19372 upon the next fontification round."
19373 (let (b l)
19374 (when (or (eq t buffer-invisibility-spec)
19375 (assq 'org-link buffer-invisibility-spec))
19376 (while (setq b (text-property-any 0 (length s)
19377 'invisible 'org-link s))
19378 (setq s (concat (substring s 0 b)
19379 (substring s (or (next-single-property-change
19380 b 'invisible s) (length s)))))))
19381 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19382 (setq s (concat (substring s 0 b)
19383 (substring s (or (next-single-property-change
19384 b 'org-cwidth s) (length s))))))
19385 (setq l (string-width s) b -1)
19386 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19387 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19388 l))
19390 (defun org-shorten-string (s maxlength)
19391 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19392 If the string is shorter or has length MAXLENGTH, just return the
19393 original string. If it is longer, the functions finds a space in the
19394 string, breaks this string off at that locations and adds three dots
19395 as ellipsis. Including the ellipsis, the string will not be longer
19396 than MAXLENGTH. If finding a good breaking point in the string does
19397 not work, the string is just chopped off in the middle of a word
19398 if necessary."
19399 (if (<= (length s) maxlength)
19400 s
19401 (let* ((n (max (- maxlength 4) 1))
19403 (if (string-match re s)
19404 (concat (match-string 1 s) "...")
19405 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19407 (defun org-get-indentation (&optional line)
19408 "Get the indentation of the current line, interpreting tabs.
19409 When LINE is given, assume it represents a line and compute its indentation."
19410 (if line
19411 (if (string-match "^ *" (org-remove-tabs line))
19412 (match-end 0))
19413 (save-excursion
19414 (beginning-of-line 1)
19416 (current-column))))
19418 (defun org-get-string-indentation (s)
19419 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19420 (let ((n -1) (i 0) (w tab-width) c)
19421 (catch 'exit
19422 (while (< (setq n (1+ n)) (length s))
19423 (setq c (aref s n))
19424 (cond ((= c ?\ ) (setq i (1+ i)))
19426 (t (throw 'exit t)))))
19427 i))
19429 (defun org-remove-tabs (s &optional width)
19430 "Replace tabulators in S with spaces.
19431 Assumes that s is a single line, starting in column 0."
19432 (setq width (or width tab-width))
19434 (setq s (replace-match
19435 (make-string
19436 (- (* width (/ (+ (match-beginning 0) width) width))
19437 (match-beginning 0)) ?\ )
19438 t t s)))
19439 s)
19441 (defun org-fix-indentation (line ind)
19442 "Fix indentation in LINE.
19443 IND is a cons cell with target and minimum indentation.
19444 If the current indentation in LINE is smaller than the minimum,
19445 leave it alone. If it is larger than ind, set it to the target."
19446 (let* ((l (org-remove-tabs line))
19447 (i (org-get-indentation l))
19448 (i1 (car ind)) (i2 (cdr ind)))
19449 (if (>= i i2) (setq l (substring line i2)))
19450 (if (> i1 0)
19451 (concat (make-string i1 ?\ ) l)
19452 l)))
19454 (defun org-remove-indentation (code &optional n)
19455 "Remove the maximum common indentation from the lines in CODE.
19456 N may optionally be the number of spaces to remove."
19457 (with-temp-buffer
19458 (insert code)
19459 (org-do-remove-indentation n)
19460 (buffer-string)))
19462 (defun org-do-remove-indentation (&optional n)
19463 "Remove the maximum common indentation from the buffer."
19464 (untabify (point-min) (point-max))
19465 (let ((min 10000) re)
19466 (if n
19467 (setq min n)
19468 (goto-char (point-min))
19470 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19471 (unless (or (= min 0) (= min 10000))
19473 (goto-char (point-min))
19474 (while (re-search-forward re nil t)
19475 (replace-match "")
19476 (end-of-line 1))
19477 min)))
19479 (defun org-fill-template (template alist)
19480 "Find each %key of ALIST in TEMPLATE and replace it."
19481 (let ((case-fold-search nil)
19482 entry key value)
19483 (setq alist (sort (copy-sequence alist)
19484 (lambda (a b) (< (length (car a)) (length (car b))))))
19485 (while (setq entry (pop alist))
19486 (setq template
19487 (replace-regexp-in-string
19488 (concat "%" (regexp-quote (car entry)))
19489 (cdr entry) template t t)))
19490 template))
19492 (defun org-base-buffer (buffer)
19493 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19494 (if (not buffer)
19495 buffer
19496 (or (buffer-base-buffer buffer)
19497 buffer)))
19499 (defun org-trim (s)
19500 "Remove whitespace at beginning and end of string."
19503 s)
19505 (defun org-wrap (string &optional width lines)
19506 "Wrap string to either a number of lines, or a width in characters.
19507 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19508 that costs. If there is a word longer than WIDTH, the text is actually
19509 wrapped to the length of that word.
19510 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19511 many lines, whatever width that takes.
19512 The return value is a list of lines, without newlines at the end."
19514 (maxword (apply 'max (mapcar 'org-string-width words)))
19515 w ll)
19516 (cond (width
19517 (org-do-wrap words (max maxword width)))
19518 (lines
19519 (setq w maxword)
19520 (setq ll (org-do-wrap words maxword))
19521 (if (<= (length ll) lines)
19522 ll
19523 (setq ll words)
19524 (while (> (length ll) lines)
19525 (setq w (1+ w))
19526 (setq ll (org-do-wrap words w)))
19527 ll))
19528 (t (error "Cannot wrap this")))))
19530 (defun org-do-wrap (words width)
19531 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19532 (let (lines line)
19533 (while words
19534 (setq line (pop words))
19535 (while (and words (< (+ (length line) (length (car words))) width))
19536 (setq line (concat line " " (pop words))))
19537 (setq lines (push line lines)))
19538 (nreverse lines)))
19540 (defun org-split-string (string &optional separators)
19541 "Splits STRING into substrings at SEPARATORS.
19542 No empty strings are returned if there are matches at the beginning
19543 and end of string."
19545 (start 0)
19546 notfirst
19547 (list nil))
19548 (while (and (string-match rexp string
19549 (if (and notfirst
19550 (= start (match-beginning 0))
19551 (< start (length string)))
19552 (1+ start) start))
19553 (< (match-beginning 0) (length string)))
19554 (setq notfirst t)
19555 (or (eq (match-beginning 0) 0)
19556 (and (eq (match-beginning 0) (match-end 0))
19557 (eq (match-beginning 0) start))
19558 (setq list
19559 (cons (substring string start (match-beginning 0))
19560 list)))
19561 (setq start (match-end 0)))
19562 (or (eq start (length string))
19563 (setq list
19564 (cons (substring string start)
19565 list)))
19566 (nreverse list)))
19568 (defun org-quote-vert (s)
19570 (while (string-match "|" s)
19572 s)
19574 (defun org-uuidgen-p (s)
19575 "Is S an ID created by UUIDGEN?"
19576 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19578 (defun org-context ()
19579 "Return a list of contexts of the current cursor position.
19580 If several contexts apply, all are returned.
19581 Each context entry is a list with a symbol naming the context, and
19582 two positions indicating start and end of the context. Possible
19583 contexts are:
19585 :headline anywhere in a headline
19586 :headline-stars on the leading stars in a headline
19587 :todo-keyword on a TODO keyword (including DONE) in a headline
19588 :tags on the TAGS in a headline
19589 :priority on the priority cookie in a headline
19590 :item on the first line of a plain list item
19591 :item-bullet on the bullet/number of a plain list item
19592 :checkbox on the checkbox in a plain list item
19593 :table in an org-mode table
19594 :table-special on a special filed in a table
19595 :table-table in a table.el table
19596 :link on a hyperlink
19597 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19598 :target on a <<target>>
19599 :radio-target on a <<<radio-target>>>
19600 :latex-fragment on a LaTeX fragment
19601 :latex-preview on a LaTeX fragment with overlaid preview image
19603 This function expects the position to be visible because it uses font-lock
19604 faces as a help to recognize the following contexts: :table-special, :link,
19605 and :keyword."
19606 (let* ((f (get-text-property (point) 'face))
19607 (faces (if (listp f) f (list f)))
19608 (p (point)) clist o)
19609 ;; First the large context
19610 (cond
19611 ((org-at-heading-p t)
19612 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19613 (when (progn
19614 (beginning-of-line 1)
19615 (looking-at org-todo-line-tags-regexp))
19616 (push (org-point-in-group p 1 :headline-stars) clist)
19617 (push (org-point-in-group p 2 :todo-keyword) clist)
19618 (push (org-point-in-group p 4 :tags) clist))
19619 (goto-char p)
19622 (push (org-point-in-group p 0 :priority) clist)))
19624 ((org-at-item-p)
19625 (push (org-point-in-group p 2 :item-bullet) clist)
19626 (push (list :item (point-at-bol)
19627 (save-excursion (org-end-of-item) (point)))
19628 clist)
19629 (and (org-at-item-checkbox-p)
19630 (push (org-point-in-group p 0 :checkbox) clist)))
19632 ((org-at-table-p)
19633 (push (list :table (org-table-begin) (org-table-end)) clist)
19634 (if (memq 'org-formula faces)
19635 (push (list :table-special
19636 (previous-single-property-change p 'face)
19637 (next-single-property-change p 'face)) clist)))
19638 ((org-at-table-p 'any)
19639 (push (list :table-table) clist)))
19640 (goto-char p)
19642 ;; Now the small context
19643 (cond
19644 ((org-at-timestamp-p)
19645 (push (org-point-in-group p 0 :timestamp) clist))
19646 ((memq 'org-link faces)
19647 (push (list :link
19648 (previous-single-property-change p 'face)
19649 (next-single-property-change p 'face)) clist))
19650 ((memq 'org-special-keyword faces)
19651 (push (list :keyword
19652 (previous-single-property-change p 'face)
19653 (next-single-property-change p 'face)) clist))
19654 ((org-at-target-p)
19655 (push (org-point-in-group p 0 :target) clist)
19656 (goto-char (1- (match-beginning 0)))
19657 (if (looking-at org-radio-target-regexp)
19658 (push (org-point-in-group p 0 :radio-target) clist))
19659 (goto-char p))
19660 ((setq o (car (delq nil
19661 (mapcar
19662 (lambda (x)
19663 (if (memq x org-latex-fragment-image-overlays) x))
19664 (overlays-at (point))))))
19665 (push (list :latex-fragment
19666 (overlay-start o) (overlay-end o)) clist)
19667 (push (list :latex-preview
19668 (overlay-start o) (overlay-end o)) clist))
19669 ((org-inside-LaTeX-fragment-p)
19670 ;; FIXME: positions wrong.
19671 (push (list :latex-fragment (point) (point)) clist)))
19673 (setq clist (nreverse (delq nil clist)))
19674 clist))
19676 ;; FIXME: Compare with at-regexp-p Do we need both?
19677 (defun org-in-regexp (re &optional nlines visually)
19678 "Check if point is inside a match of regexp.
19679 Normally only the current line is checked, but you can include NLINES extra
19680 lines both before and after point into the search.
19681 If VISUALLY is set, require that the cursor is not after the match but
19682 really on, so that the block visually is on the match."
19683 (catch 'exit
19684 (let ((pos (point))
19685 (eol (point-at-eol (+ 1 (or nlines 0))))
19686 (inc (if visually 1 0)))
19687 (save-excursion
19688 (beginning-of-line (- 1 (or nlines 0)))
19689 (while (re-search-forward re eol t)
19690 (if (and (<= (match-beginning 0) pos)
19691 (>= (+ inc (match-end 0)) pos))
19692 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19694 (defun org-at-regexp-p (regexp)
19695 "Is point inside a match of REGEXP in the current line?"
19696 (catch 'exit
19697 (save-excursion
19698 (let ((pos (point)) (end (point-at-eol)))
19699 (beginning-of-line 1)
19700 (while (re-search-forward regexp end t)
19701 (if (and (<= (match-beginning 0) pos)
19702 (>= (match-end 0) pos))
19703 (throw 'exit t)))
19704 nil))))
19706 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19707 "Non-nil when point is between matches of START-RE and END-RE.
19709 Also return a non-nil value when point is on one of the matches.
19711 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19712 buffer positions. Default values are the positions of headlines
19713 surrounding the point.
19715 The functions returns a cons cell whose car (resp. cdr) is the
19716 position before START-RE (resp. after END-RE)."
19717 (save-match-data
19718 (let ((pos (point))
19719 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19720 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19721 beg end)
19722 (save-excursion
19723 ;; Point is on a block when on START-RE or if START-RE can be
19724 ;; found before it...
19725 (and (or (org-at-regexp-p start-re)
19726 (re-search-backward start-re limit-up t))
19727 (setq beg (match-beginning 0))
19728 ;; ... and END-RE after it...
19729 (goto-char (match-end 0))
19730 (re-search-forward end-re limit-down t)
19731 (> (setq end (match-end 0)) pos)
19732 ;; ... without another START-RE in-between.
19733 (goto-char (match-beginning 0))
19734 (not (re-search-backward start-re (1+ beg) t))
19735 ;; Return value.
19736 (cons beg end))))))
19738 (defun org-in-block-p (names)
19739 "Non-nil when point belongs to a block whose name belongs to NAMES.
19741 NAMES is a list of strings containing names of blocks.
19743 Return first block name matched, or nil. Beware that in case of
19744 nested blocks, the returned name may not belong to the closest
19745 block from point."
19746 (save-match-data
19747 (catch 'exit
19748 (let ((case-fold-search t)
19749 (lim-up (save-excursion (outline-previous-heading)))
19750 (lim-down (save-excursion (outline-next-heading))))
19751 (mapc (lambda (name)
19752 (let ((n (regexp-quote name)))
19753 (when (org-between-regexps-p
19756 lim-up lim-down)
19757 (throw 'exit n))))
19758 names))
19759 nil)))
19761 (defun org-occur-in-agenda-files (regexp &optional nlines)
19762 "Call `multi-occur' with buffers for all agenda files."
19764 (let* ((files (org-agenda-files))
19765 (tnames (mapcar 'file-truename files))
19766 (extra org-agenda-text-search-extra-files)
19767 f)
19768 (when (eq (car extra) 'agenda-archives)
19769 (setq extra (cdr extra))
19770 (setq files (org-add-archive-files files)))
19771 (while (setq f (pop extra))
19772 (unless (member (file-truename f) tnames)
19773 (add-to-list 'files f 'append)
19774 (add-to-list 'tnames (file-truename f) 'append)))
19775 (multi-occur
19776 (mapcar (lambda (x)
19777 (with-current-buffer
19778 (or (get-file-buffer x) (find-file-noselect x))
19779 (widen)
19780 (current-buffer)))
19781 files)
19782 regexp)))
19784 (if (boundp 'occur-mode-find-occurrence-hook)
19785 ;; Emacs 23
19786 (add-hook 'occur-mode-find-occurrence-hook
19787 (lambda ()
19788 (when (eq major-mode 'org-mode)
19789 (org-reveal))))
19790 ;; Emacs 22
19791 (defadvice occur-mode-goto-occurrence
19792 (after org-occur-reveal activate)
19793 (and (eq major-mode 'org-mode) (org-reveal)))
19794 (defadvice occur-mode-goto-occurrence-other-window
19795 (after org-occur-reveal activate)
19796 (and (eq major-mode 'org-mode) (org-reveal)))
19797 (defadvice occur-mode-display-occurrence
19798 (after org-occur-reveal activate)
19799 (when (eq major-mode 'org-mode)
19800 (let ((pos (occur-mode-find-occurrence)))
19801 (with-current-buffer (marker-buffer pos)
19802 (save-excursion
19803 (goto-char pos)
19804 (org-reveal)))))))
19806 (defun org-occur-link-in-agenda-files ()
19807 "Create a link and search for it in the agendas.
19808 The link is not stored in `org-stored-links', it is just created
19809 for the search purpose."
19810 (interactive)
19811 (let ((link (condition-case nil
19812 (org-store-link nil)
19813 (error "Unable to create a link to here"))))
19814 (org-occur-in-agenda-files (regexp-quote link))))
19816 (defun org-uniquify (list)
19817 "Remove duplicate elements from LIST."
19818 (let (res)
19819 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19820 res))
19822 (defun org-delete-all (elts list)
19823 "Remove all elements in ELTS from LIST."
19824 (while elts
19825 (setq list (delete (pop elts) list)))
19826 list)
19828 (defun org-count (cl-item cl-seq)
19829 "Count the number of occurrences of ITEM in SEQ.
19830 Taken from `count' in cl-seq.el with all keyword arguments removed."
19831 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19832 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19833 (while (< cl-start cl-end)
19834 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19835 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19836 (setq cl-start (1+ cl-start)))
19837 cl-count))
19839 (defun org-remove-if (predicate seq)
19840 "Remove everything from SEQ that fulfills PREDICATE."
19841 (let (res e)
19842 (while seq
19843 (setq e (pop seq))
19844 (if (not (funcall predicate e)) (push e res)))
19845 (nreverse res)))
19847 (defun org-remove-if-not (predicate seq)
19848 "Remove everything from SEQ that does not fulfill PREDICATE."
19849 (let (res e)
19850 (while seq
19851 (setq e (pop seq))
19852 (if (funcall predicate e) (push e res)))
19853 (nreverse res)))
19855 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19856 "Reduce two-argument FUNCTION across SEQ.
19857 Taken from `reduce' in cl-seq.el with all keyword arguments but
19859 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19860 (cadr (memq :initial-value cl-keys)))
19861 (cl-seq (pop cl-seq))
19862 (t (funcall cl-func)))))
19863 (while cl-seq
19864 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19865 cl-accum))
19867 (defun org-back-over-empty-lines ()
19868 "Move backwards over whitespace, to the beginning of the first empty line.
19869 Returns the number of empty lines passed."
19870 (let ((pos (point)))
19871 (if (cdr (assoc 'heading org-blank-before-new-entry))
19873 (unless (eobp)
19874 (forward-line -1)))
19875 (beginning-of-line 2)
19876 (goto-char (min (point) pos))
19877 (count-lines (point) pos)))
19879 (defun org-skip-whitespace ()
19882 (defun org-point-in-group (point group &optional context)
19883 "Check if POINT is in match-group GROUP.
19884 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19885 match. If the match group does not exist or point is not inside it,
19886 return nil."
19887 (and (match-beginning group)
19888 (>= point (match-beginning group))
19889 (<= point (match-end group))
19890 (if context
19891 (list context (match-beginning group) (match-end group))
19892 t)))
19894 (defun org-switch-to-buffer-other-window (&rest args)
19895 "Switch to buffer in a second window on the current frame.
19896 In particular, do not allow pop-up frames.
19897 Returns the newly created buffer."
19898 (let (pop-up-frames special-display-buffer-names special-display-regexps
19899 special-display-function)
19900 (apply 'switch-to-buffer-other-window args)))
19902 (defun org-combine-plists (&rest plists)
19903 "Create a single property list from all plists in PLISTS.
19904 The process starts by copying the first list, and then setting properties
19905 from the other lists. Settings in the last list are the most significant
19906 ones and overrule settings in the other lists."
19907 (let ((rtn (copy-sequence (pop plists)))
19908 p v ls)
19909 (while plists
19910 (setq ls (pop plists))
19911 (while ls
19912 (setq p (pop ls) v (pop ls))
19913 (setq rtn (plist-put rtn p v))))
19914 rtn))
19916 (defun org-move-line-down (arg)
19917 "Move the current line down. With prefix argument, move it past ARG lines."
19918 (interactive "p")
19919 (let ((col (current-column))
19920 beg end pos)
19921 (beginning-of-line 1) (setq beg (point))
19922 (beginning-of-line 2) (setq end (point))
19923 (beginning-of-line (+ 1 arg))
19924 (setq pos (move-marker (make-marker) (point)))
19925 (insert (delete-and-extract-region beg end))
19926 (goto-char pos)
19927 (org-move-to-column col)))
19929 (defun org-move-line-up (arg)
19930 "Move the current line up. With prefix argument, move it past ARG lines."
19931 (interactive "p")
19932 (let ((col (current-column))
19933 beg end pos)
19934 (beginning-of-line 1) (setq beg (point))
19935 (beginning-of-line 2) (setq end (point))
19936 (beginning-of-line (- arg))
19937 (setq pos (move-marker (make-marker) (point)))
19938 (insert (delete-and-extract-region beg end))
19939 (goto-char pos)
19940 (org-move-to-column col)))
19942 (defun org-replace-escapes (string table)
19943 "Replace %-escapes in STRING with values in TABLE.
19945 The sequences in STRING may contain normal field width and padding information,
19947 so values can contain further %-escapes if they are define later in TABLE."
19948 (let ((tbl (copy-alist table))
19949 (case-fold-search nil)
19950 (pchg 0)
19951 e re rpl)
19952 (while (setq e (pop tbl))
19953 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19954 (when (and (cdr e) (string-match re (cdr e)))
19955 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19956 (safe "SREF"))
19957 (add-text-properties 0 3 (list 'sref sref) safe)
19958 (setcdr e (replace-match safe t t (cdr e)))))
19959 (while (string-match re string)
19960 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19961 (cdr e)))
19962 (setq string (replace-match rpl t t string))))
19963 (while (setq pchg (next-property-change pchg string))
19964 (let ((sref (get-text-property pchg 'sref string)))
19965 (when (and sref (string-match "SREF" string pchg))
19966 (setq string (replace-match sref t t string)))))
19967 string))
19969 (defun org-sublist (list start end)
19970 "Return a section of LIST, from START to END.
19971 Counting starts at 1."
19972 (let (rtn (c start))
19973 (setq list (nthcdr (1- start) list))
19974 (while (and list (<= c end))
19975 (push (pop list) rtn)
19976 (setq c (1+ c)))
19977 (nreverse rtn)))
19979 (defun org-find-base-buffer-visiting (file)
19980 "Like `find-buffer-visiting' but always return the base buffer and
19981 not an indirect buffer."
19982 (let ((buf (or (get-file-buffer file)
19983 (find-buffer-visiting file))))
19984 (if buf
19985 (or (buffer-base-buffer buf) buf)
19986 nil)))
19988 (defun org-image-file-name-regexp (&optional extensions)
19989 "Return regexp matching the file names of images.
19990 If EXTENSIONS is given, only match these."
19991 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19992 (image-file-name-regexp)
19993 (let ((image-file-name-extensions
19994 (or extensions
19995 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19996 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19998 (regexp-opt (nconc (mapcar 'upcase
19999 image-file-name-extensions)
20000 image-file-name-extensions)
20001 t)
20004 (defun org-file-image-p (file &optional extensions)
20005 "Return non-nil if FILE is an image."
20006 (save-match-data
20007 (string-match (org-image-file-name-regexp extensions) file)))
20009 (defun org-get-cursor-date ()
20010 "Return the date at cursor in as a time.
20011 This works in the calendar and in the agenda, anywhere else it just
20012 returns the current time."
20013 (let (date day defd)
20014 (cond
20015 ((eq major-mode 'calendar-mode)
20016 (setq date (calendar-cursor-to-date)
20017 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20018 ((eq major-mode 'org-agenda-mode)
20019 (setq day (get-text-property (point) 'day))
20020 (if day
20021 (setq date (calendar-gregorian-from-absolute day)
20022 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20023 (nth 2 date))))))
20024 (or defd (current-time))))
20026 (defvar org-agenda-action-marker (make-marker)
20027 "Marker pointing to the entry for the next agenda action.")
20029 (defun org-mark-entry-for-agenda-action ()
20030 "Mark the current entry as target of an agenda action.
20031 Agenda actions are actions executed from the agenda with the key `k',
20032 which make use of the date at the cursor."
20033 (interactive)
20034 (move-marker org-agenda-action-marker
20035 (save-excursion (org-back-to-heading t) (point))
20036 (current-buffer))
20037 (message
20038 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20040 (defun org-mark-subtree ()
20041 "Mark the current subtree.
20042 This puts point at the start of the current subtree, and mark at the end.
20044 If point is in an inline task, mark that task instead."
20045 (interactive)
20046 (let ((inline-task-p
20047 (and (featurep 'org-inlinetask)
20048 (org-inlinetask-in-task-p)))
20049 (beg))
20050 ;; Get beginning of subtree
20051 (cond
20052 (inline-task-p (org-inlinetask-goto-beginning))
20053 ((org-at-heading-p) (beginning-of-line))
20054 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20055 (setq beg (point))
20056 ;; Get end of it
20057 (if inline-task-p
20058 (org-inlinetask-goto-end)
20059 (org-end-of-subtree))
20060 ;; Mark zone
20061 (push-mark (point) nil t)
20062 (goto-char beg)))
20064 ;;; Paragraph filling stuff.
20065 ;; We want this to be just right, so use the full arsenal.
20067 (defun org-indent-line-function ()
20068 "Indent line depending on context."
20069 (interactive)
20070 (let* ((pos (point))
20071 (itemp (org-at-item-p))
20072 (case-fold-search t)
20074 (inline-task-p (and (featurep 'org-inlinetask)
20075 (org-inlinetask-in-task-p)))
20076 (inline-re (and inline-task-p
20077 (org-inlinetask-outline-regexp)))
20078 column)
20079 (beginning-of-line 1)
20080 (cond
20081 ;; Comments
20082 ((looking-at "# ") (setq column 0))
20083 ;; Headings
20084 ((looking-at org-outline-regexp) (setq column 0))
20085 ;; Included files
20087 ;; Footnote definition
20088 ((looking-at org-footnote-definition-re) (setq column 0))
20089 ;; Literal examples
20091 (setq column (org-get-indentation))) ; do nothing
20092 ;; Lists
20093 ((ignore-errors (goto-char (org-in-item-p)))
20094 (setq column (if itemp
20095 (org-get-indentation)
20096 (org-list-item-body-column (point))))
20097 (goto-char pos))
20098 ;; Drawers
20100 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20101 (save-excursion
20102 (goto-char (1- (match-beginning 1)))
20103 (setq column (current-column))))
20104 ;; Special blocks
20106 (save-excursion
20107 (re-search-backward
20109 (setq column (org-get-indentation (match-string 0))))
20112 (save-excursion
20114 (setq column
20115 (cond ((equal (downcase (match-string 1)) "src")
20116 ;; src blocks: let `org-edit-src-exit' handle them
20117 (org-get-indentation))
20118 ((equal (downcase (match-string 1)) "example")
20119 (max (org-get-indentation)
20120 (org-get-indentation (match-string 0))))
20121 (t
20122 (org-get-indentation (match-string 0))))))
20123 ;; This line has nothing special, look at the previous relevant
20124 ;; line to compute indentation
20125 (t
20126 (beginning-of-line 0)
20127 (while (and (not (bobp))
20128 (not (looking-at org-drawer-regexp))
20129 ;; When point started in an inline task, do not move
20130 ;; above task starting line.
20131 (not (and inline-task-p (looking-at inline-re)))
20132 ;; Skip drawers, blocks, empty lines, verbatim,
20133 ;; comments, tables, footnotes definitions, lists,
20134 ;; inline tasks.
20136 (re-search-backward org-drawer-regexp nil t))
20140 (looking-at org-footnote-definition-re)
20141 (and (ignore-errors (goto-char (org-in-item-p)))
20142 (goto-char
20143 (org-list-get-top-point (org-list-struct))))
20144 (and (not inline-task-p)
20145 (featurep 'org-inlinetask)
20146 (org-inlinetask-in-task-p)
20147 (or (org-inlinetask-goto-beginning) t))))
20148 (beginning-of-line 0))
20149 (cond
20150 ;; There was an heading above.
20152 (if (not org-adapt-indentation)
20153 (setq column 0)
20154 (goto-char (match-end 0))
20155 (setq column (current-column))))
20156 ;; A drawer had started and is unfinished
20157 ((looking-at org-drawer-regexp)
20158 (goto-char (1- (match-beginning 1)))
20159 (setq column (current-column)))
20160 ;; Else, nothing noticeable found: get indentation and go on.
20161 (t (setq column (org-get-indentation))))))
20162 ;; Now apply indentation and move cursor accordingly
20163 (goto-char pos)
20164 (if (<= (current-column) (current-indentation))
20165 (org-indent-line-to column)
20166 (save-excursion (org-indent-line-to column)))
20167 ;; Special polishing for properties, see `org-property-format'
20168 (setq column (current-column))
20169 (beginning-of-line 1)
20170 (if (looking-at
20172 (replace-match (concat (match-string 1)
20173 (format org-property-format
20174 (match-string 2) (match-string 3)))
20175 t t))
20176 (org-move-to-column column)))
20178 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20179 "Variable to store copy of `adaptive-fill-regexp'.
20180 Since `adaptive-fill-regexp' is set to never match, we need to
20181 store a backup of its value before entering `org-mode' so that
20182 the functionality can be provided as a fall-back.")
20184 (defun org-set-autofill-regexps ()
20185 (interactive)
20186 ;; In the paragraph separator we include headlines, because filling
20187 ;; text in a line directly attached to a headline would otherwise
20188 ;; fill the headline as well.
20191 ;; The paragraph starter includes hand-formatted lists.
20192 (org-set-local
20193 'paragraph-start
20194 (concat
20203 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20204 ;; But only if the user has not turned off tables or fixed-width regions
20205 (org-set-local
20206 'auto-fill-inhibit-regexp
20207 (concat org-outline-regexp
20210 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20211 (concat
20213 (if org-enable-table-editor "|" "")
20214 (if org-enable-fixed-width-editor ":" "")
20215 "]"))))
20216 ;; We use our own fill-paragraph function, to make sure that tables
20217 ;; and fixed-width regions are not wrapped. That function will pass
20218 ;; through to `fill-paragraph' when appropriate.
20219 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20220 ;; Prevent auto-fill from inserting unwanted new items.
20221 (if (boundp 'fill-nobreak-predicate)
20222 (org-set-local 'fill-nobreak-predicate
20223 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20224 fill-nobreak-predicate
20225 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20226 ;; Adaptive filling: To get full control, first make sure that
20227 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20228 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20229 (org-set-local 'org-adaptive-fill-regexp-backup
20230 adaptive-fill-regexp))
20232 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20233 (org-set-local 'adaptive-fill-function
20234 'org-adaptive-fill-function)
20235 (org-set-local
20236 'align-mode-rules-list
20237 '((org-in-buffer-settings
20239 (modes . '(org-mode))))))
20241 (defun org-fill-item-nobreak-p ()
20242 "Non-nil when a line break at point would insert a new item."
20243 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20245 (defun org-fill-paragraph (&optional justify)
20246 "Re-align a table, pass through to fill-paragraph if no table."
20247 (let ((table-p (org-at-table-p))
20248 (table.el-p (org-at-table.el-p))
20249 (itemp (org-in-item-p)))
20250 (cond ((and (equal (char-after (point-at-bol)) ?*)
20251 (save-excursion (goto-char (point-at-bol))
20252 (looking-at org-outline-regexp)))
20253 t) ; skip headlines
20254 (table.el-p t) ; skip table.el tables
20255 (table-p (org-table-align) t) ; align Org tables
20256 (itemp ; align text in items
20257 (let* ((struct (save-excursion (goto-char itemp)
20258 (org-list-struct)))
20259 (parents (org-list-parents-alist struct))
20260 (children (org-list-get-children itemp struct parents))
20261 beg end prev next prefix)
20262 ;; Determine in which part of item point is: before
20263 ;; first child, after last child, between two
20264 ;; sub-lists, or simply in item if there's no child.
20265 (cond
20266 ((not children)
20267 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20268 beg itemp
20269 end (org-list-get-item-end itemp struct)))
20270 ((< (point) (setq next (car children)))
20271 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20272 beg itemp
20273 end next))
20274 ((> (point) (setq prev (car (last children))))
20275 (setq beg (org-list-get-item-end prev struct)
20276 end (org-list-get-item-end itemp struct)
20277 prefix (save-excursion
20278 (goto-char beg)
20280 (make-string (current-column) ?\ ))))
20281 (t (catch 'exit
20282 (while (setq next (pop children))
20283 (if (> (point) next)
20284 (setq prev next)
20285 (setq beg (org-list-get-item-end prev struct)
20286 end next
20287 prefix (save-excursion
20288 (goto-char beg)
20290 (make-string (current-column) ?\ )))
20291 (throw 'exit nil))))))
20292 ;; Use `fill-paragraph' with buffer narrowed to item
20293 ;; without any child, and with our computed PREFIX.
20294 (flet ((fill-context-prefix (from to &optional flr) prefix))
20295 (save-restriction
20296 (narrow-to-region beg end)
20297 (save-excursion (fill-paragraph justify)))) t))
20298 ;; Special case where point is not in a list but is on
20299 ;; a paragraph adjacent to a list: make sure this paragraph
20300 ;; doesn't get merged with the end of the list by narrowing
20301 ;; buffer first.
20302 ((save-excursion (forward-paragraph -1)
20303 (setq itemp (org-in-item-p)))
20304 (let ((struct (save-excursion (goto-char itemp)
20305 (org-list-struct))))
20306 (save-restriction
20307 (narrow-to-region (org-list-get-bottom-point struct)
20308 (save-excursion (forward-paragraph 1)
20309 (point)))
20310 (fill-paragraph justify) t)))
20311 ;; Else simply call `fill-paragraph'.
20312 (t nil))))
20314 ;; For reference, this is the default value of adaptive-fill-regexp
20317 (defun org-adaptive-fill-function ()
20318 "Return a fill prefix for org-mode files."
20319 (let (itemp)
20320 (save-excursion
20321 (cond
20322 ;; Comment line
20324 (match-string-no-properties 0))
20325 ;; Plain list item
20326 ((org-at-item-p)
20327 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20328 ;; Point is in a list after `backward-paragraph': original
20329 ;; point wasn't in the list, or filling would have been taken
20330 ;; care of by `org-auto-fill-function', but the list and the
20331 ;; real paragraph are not separated by a blank line. Thus, move
20332 ;; point after the list to go back to real paragraph and
20333 ;; determine fill-prefix.
20334 ((setq itemp (org-in-item-p))
20335 (goto-char itemp)
20336 (let* ((struct (org-list-struct))
20337 (bottom (org-list-get-bottom-point struct)))
20338 (goto-char bottom)
20339 (make-string (org-get-indentation) ?\ )))
20340 ;; Other text
20341 ((looking-at org-adaptive-fill-regexp-backup)
20342 (match-string-no-properties 0))))))
20344 (defun org-auto-fill-function ()
20345 "Auto-fill function."
20346 (let (itemp prefix)
20347 ;; When in a list, compute an appropriate fill-prefix and make
20348 ;; sure it will be used by `do-auto-fill'.
20349 (if (setq itemp (org-in-item-p))
20350 (progn
20351 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20352 (flet ((fill-context-prefix (from to &optional flr) prefix))
20353 (do-auto-fill)))
20354 ;; Else just use `do-auto-fill'.
20355 (do-auto-fill))))
20357 ;;; Other stuff.
20359 (defun org-toggle-fixed-width-section (arg)
20360 "Toggle the fixed-width export.
20361 If there is no active region, the QUOTE keyword at the current headline is
20362 inserted or removed. When present, it causes the text between this headline
20363 and the next to be exported as fixed-width text, and unmodified.
20364 If there is an active region, this command adds or removes a colon as the
20365 first character of this line. If the first character of a line is a colon,
20366 this line is also exported in fixed-width font."
20367 (interactive "P")
20368 (let* ((cc 0)
20369 (regionp (org-region-active-p))
20370 (beg (if regionp (region-beginning) (point)))
20371 (end (if regionp (region-end)))
20372 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20373 (case-fold-search nil)
20375 off)
20376 (if regionp
20377 (save-excursion
20378 (goto-char beg)
20379 (setq cc (current-column))
20380 (beginning-of-line 1)
20381 (setq off (looking-at re))
20382 (while (> nlines 0)
20383 (setq nlines (1- nlines))
20384 (beginning-of-line 1)
20385 (cond
20386 (arg
20387 (org-move-to-column cc t)
20389 (forward-line -1))
20390 ((and off (looking-at re))
20391 (replace-match "" t t nil 1))
20392 ((not off) (org-move-to-column cc t) (insert ": ")))
20393 (forward-line 1)))
20394 (save-excursion
20395 (org-back-to-heading)
20396 (cond
20397 ((looking-at (format org-heading-keyword-regexp-format
20398 org-quote-string))
20399 (goto-char (match-end 1))
20400 (looking-at (concat " +" org-quote-string))
20401 (replace-match "" t t)
20402 (when (eolp) (insert " ")))
20403 ((looking-at org-outline-regexp)
20404 (goto-char (match-end 0))
20405 (insert org-quote-string " ")))))))
20407 (defun org-reftex-citation ()
20408 "Use reftex-citation to insert a citation into the buffer.
20409 This looks for a line like
20411 #+BIBLIOGRAPHY: foo plain option:-d
20413 and derives from it that foo.bib is the bibliography file relevant
20414 for this document. It then installs the necessary environment for RefTeX
20415 to work in this buffer and calls `reftex-citation' to insert a citation
20416 into the buffer.
20418 Export of such citations to both LaTeX and HTML is handled by the contributed
20419 package org-exp-bibtex by Taru Karttunen."
20420 (interactive)
20421 (let ((reftex-docstruct-symbol 'rds)
20423 rds bib)
20424 (save-excursion
20425 (save-restriction
20426 (widen)
20427 (let ((case-fold-search t)
20429 (if (not (save-excursion
20430 (or (re-search-forward re nil t)
20431 (re-search-backward re nil t))))
20432 (error "No bibliography defined in file")
20433 (setq bib (concat (match-string 1) ".bib")
20434 rds (list (list 'bib bib)))))))
20435 (call-interactively 'reftex-citation)))
20437 ;;;; Functions extending outline functionality
20439 (defun org-beginning-of-line (&optional arg)
20440 "Go to the beginning of the current line. If that is invisible, continue
20441 to a visible line beginning. This makes the function of C-a more intuitive.
20442 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20443 first attempt, and only move to after the tags when the cursor is already
20444 beyond the end of the headline."
20445 (interactive "P")
20446 (let ((pos (point))
20447 (special (if (consp org-special-ctrl-a/e)
20448 (car org-special-ctrl-a/e)
20449 org-special-ctrl-a/e))
20450 refpos)
20451 (if (org-bound-and-true-p line-move-visual)
20452 (beginning-of-visual-line 1)
20453 (beginning-of-line 1))
20454 (if (and arg (fboundp 'move-beginning-of-line))
20455 (call-interactively 'move-beginning-of-line)
20456 (if (bobp)
20457 nil
20458 (backward-char 1)
20459 (if (org-truely-invisible-p)
20460 (while (and (not (bobp)) (org-truely-invisible-p))
20461 (backward-char 1)
20462 (beginning-of-line 1))
20463 (forward-char 1))))
20464 (when special
20465 (cond
20466 ((and (looking-at org-complex-heading-regexp)
20467 (= (char-after (match-end 1)) ?\ ))
20468 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20469 (point-at-eol)))
20470 (goto-char
20471 (if (eq special t)
20472 (cond ((> pos refpos) refpos)
20473 ((= pos (point)) refpos)
20474 (t (point)))
20475 (cond ((> pos (point)) (point))
20476 ((not (eq last-command this-command)) (point))
20477 (t refpos)))))
20478 ((org-at-item-p)
20479 ;; Being at an item and not looking at an the item means point
20480 ;; was previously moved to beginning of a visual line, which
20481 ;; doesn't contain the item. Therefore, do nothing special,
20482 ;; just stay here.
20483 (when (looking-at org-list-full-item-re)
20484 ;; Set special position at first white space character after
20485 ;; bullet, and check-box, if any.
20486 (let ((after-bullet
20487 (let ((box (match-end 3)))
20488 (if (not box) (match-end 1)
20489 (let ((after (char-after box)))
20490 (if (and after (= after ? )) (1+ box) box))))))
20491 ;; Special case: Move point to special position when
20492 ;; currently after it or at beginning of line.
20493 (if (eq special t)
20494 (when (or (> pos after-bullet) (= (point) pos))
20495 (goto-char after-bullet))
20496 ;; Reversed case: Move point to special position when
20497 ;; point was already at beginning of line and command is
20498 ;; repeated.
20499 (when (and (= (point) pos) (eq last-command this-command))
20500 (goto-char after-bullet))))))))
20501 (org-no-warnings
20502 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20504 (defun org-end-of-line (&optional arg)
20505 "Go to the end of the line.
20506 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20507 first attempt, and only move to after the tags when the cursor is already
20508 beyond the end of the headline."
20509 (interactive "P")
20510 (let ((special (if (consp org-special-ctrl-a/e)
20511 (cdr org-special-ctrl-a/e)
20512 org-special-ctrl-a/e)))
20513 (cond
20514 ((or (not special) arg
20515 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20516 (call-interactively
20517 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20518 ((fboundp 'move-end-of-line) 'move-end-of-line)
20519 (t 'end-of-line))))
20520 ((org-at-heading-p)
20521 (let ((pos (point)))
20522 (beginning-of-line 1)
20524 (if (eq special t)
20525 (if (or (< pos (match-beginning 1))
20526 (= pos (match-end 0)))
20527 (goto-char (match-beginning 1))
20528 (goto-char (match-end 0)))
20529 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20530 (goto-char (match-end 0))
20531 (goto-char (match-beginning 1))))
20532 (call-interactively (if (fboundp 'move-end-of-line)
20533 'move-end-of-line
20534 'end-of-line)))))
20535 ((org-at-drawer-p)
20536 (move-end-of-line 1)
20537 (when (overlays-at (1- (point))) (backward-char 1)))
20538 ;; At an item: Move before any hidden text.
20539 (t (call-interactively
20540 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20541 ((fboundp 'move-end-of-line) 'move-end-of-line)
20542 (t 'end-of-line)))))
20543 (org-no-warnings
20544 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20546 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20547 (define-key org-mode-map "\C-e" 'org-end-of-line)
20549 (defun org-backward-sentence (&optional arg)
20550 "Go to beginning of sentence, or beginning of table field.
20551 This will call `backward-sentence' or `org-table-beginning-of-field',
20552 depending on context."
20553 (interactive "P")
20554 (cond
20555 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20556 (t (call-interactively 'backward-sentence))))
20558 (defun org-forward-sentence (&optional arg)
20559 "Go to end of sentence, or end of table field.
20560 This will call `forward-sentence' or `org-table-end-of-field',
20561 depending on context."
20562 (interactive "P")
20563 (cond
20564 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20565 (t (call-interactively 'forward-sentence))))
20567 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20568 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20570 (defun org-kill-line (&optional arg)
20571 "Kill line, to tags or end of line."
20572 (interactive "P")
20573 (cond
20574 ((or (not org-special-ctrl-k)
20575 (bolp)
20576 (not (org-at-heading-p)))
20577 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20578 org-ctrl-k-protect-subtree)
20579 (if (or (eq org-ctrl-k-protect-subtree 'error)
20580 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20581 (error "C-k aborted - would kill hidden subtree")))
20582 (call-interactively 'kill-line))
20584 (kill-region (point) (match-beginning 1))
20585 (org-set-tags nil t))
20586 (t (kill-region (point) (point-at-eol)))))
20588 (define-key org-mode-map "\C-k" 'org-kill-line)
20590 (defun org-yank (&optional arg)
20591 "Yank. If the kill is a subtree, treat it specially.
20592 This command will look at the current kill and check if is a single
20593 subtree, or a series of subtrees[1]. If it passes the test, and if the
20594 cursor is at the beginning of a line or after the stars of a currently
20595 empty headline, then the yank is handled specially. How exactly depends
20596 on the value of the following variables, both set by default.
20598 org-yank-folded-subtrees
20599 When set, the subtree(s) will be folded after insertion, but only
20600 if doing so would now swallow text after the yanked text.
20602 org-yank-adjusted-subtrees
20603 When set, the subtree will be promoted or demoted in order to
20604 fit into the local outline tree structure, which means that the level
20605 will be adjusted so that it becomes the smaller one of the two
20606 *visible* surrounding headings.
20608 Any prefix to this command will cause `yank' to be called directly with
20610 will just
20611 plainly yank the text as it is.
20613 \[1] The test checks if the first non-white line is a heading
20614 and if there are no other headings with fewer stars."
20615 (interactive "P")
20616 (org-yank-generic 'yank arg))
20618 (defun org-yank-generic (command arg)
20619 "Perform some yank-like command.
20621 This function implements the behavior described in the `org-yank'
20622 documentation. However, it has been generalized to work for any
20623 interactive command with similar behavior."
20625 ;; pretend to be command COMMAND
20626 (setq this-command command)
20628 (if arg
20629 (call-interactively command)
20631 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20632 (and (org-kill-is-subtree-p)
20633 (or (bolp)
20635 (string-match
20637 (buffer-substring (point-at-bol) (point)))))))
20638 swallowp)
20639 (cond
20640 ((and subtreep org-yank-folded-subtrees)
20641 (let ((beg (point))
20642 end)
20643 (if (and subtreep org-yank-adjusted-subtrees)
20644 (org-paste-subtree nil nil 'for-yank)
20645 (call-interactively command))
20647 (setq end (point))
20648 (goto-char beg)
20649 (when (and (bolp) subtreep
20650 (not (setq swallowp
20651 (org-yank-folding-would-swallow-text beg end))))
20652 (org-with-limited-levels
20653 (or (looking-at org-outline-regexp)
20654 (re-search-forward org-outline-regexp-bol end t))
20655 (while (and (< (point) end) (looking-at org-outline-regexp))
20656 (hide-subtree)
20657 (org-cycle-show-empty-lines 'folded)
20658 (condition-case nil
20659 (outline-forward-same-level 1)
20660 (error (goto-char end))))))
20661 (when swallowp
20662 (message
20663 "Inserted text not folded because that would swallow text"))
20665 (goto-char end)
20667 (beginning-of-line 1)
20668 (push-mark beg 'nomsg)))
20669 ((and subtreep org-yank-adjusted-subtrees)
20670 (let ((beg (point-at-bol)))
20671 (org-paste-subtree nil nil 'for-yank)
20672 (push-mark beg 'nomsg)))
20673 (t
20674 (call-interactively command))))))
20676 (defun org-yank-folding-would-swallow-text (beg end)
20677 "Would hide-subtree at BEG swallow any text after END?"
20678 (let (level)
20679 (org-with-limited-levels
20680 (save-excursion
20681 (goto-char beg)
20682 (when (or (looking-at org-outline-regexp)
20683 (re-search-forward org-outline-regexp-bol end t))
20684 (setq level (org-outline-level)))
20685 (goto-char end)
20687 (if (or (eobp)
20688 (and (bolp) (looking-at org-outline-regexp)
20689 (<= (org-outline-level) level)))
20690 nil ; Nothing would be swallowed
20691 t))))) ; something would swallow
20693 (define-key org-mode-map "\C-y" 'org-yank)
20695 (defun org-truely-invisible-p ()
20696 "Check if point is at a character currently not visible.
20697 This version does not only check the character property, but also
20698 `visible-mode'."
20699 ;; Early versions of noutline don't have `outline-invisible-p'.
20700 (if (org-bound-and-true-p visible-mode)
20701 nil
20702 (outline-invisible-p)))
20704 (defun org-invisible-p2 ()
20705 "Check if point is at a character currently not visible."
20706 (save-excursion
20707 (if (and (eolp) (not (bobp))) (backward-char 1))
20708 ;; Early versions of noutline don't have `outline-invisible-p'.
20709 (outline-invisible-p)))
20711 (defun org-back-to-heading (&optional invisible-ok)
20712 "Call `outline-back-to-heading', but provide a better error message."
20713 (condition-case nil
20714 (outline-back-to-heading invisible-ok)
20715 (error (error "Before first headline at position %d in buffer %s"
20716 (point) (current-buffer)))))
20718 (defun org-beginning-of-defun ()
20719 "Go to the beginning of the subtree, i.e. back to the heading."
20720 (org-back-to-heading))
20721 (defun org-end-of-defun ()
20722 "Go to the end of the subtree."
20723 (org-end-of-subtree nil t))
20725 (defun org-before-first-heading-p ()
20726 "Before first heading?"
20727 (save-excursion
20728 (end-of-line)
20729 (null (re-search-backward org-outline-regexp-bol nil t))))
20731 (defun org-at-heading-p (&optional ignored)
20732 (outline-on-heading-p t))
20733 ;; Compatibility alias with Org versions < 7.8.03
20734 (defalias 'org-on-heading-p 'org-at-heading-p)
20736 (defun org-at-drawer-p nil
20737 "Whether point is at a drawer."
20738 (save-excursion
20739 (move-beginning-of-line 1)
20740 (looking-at org-drawer-regexp)))
20742 (defun org-point-at-end-of-empty-headline ()
20743 "If point is at the end of an empty headline, return t, else nil.
20744 If the heading only contains a TODO keyword, it is still still considered
20745 empty."
20747 (save-excursion
20748 (beginning-of-line 1)
20749 (let ((case-fold-search nil))
20750 (looking-at org-todo-line-regexp)))
20751 (string= (match-string 3) "")))
20753 (defun org-at-heading-or-item-p ()
20754 (or (org-at-heading-p) (org-at-item-p)))
20756 (defun org-at-target-p ()
20757 (or (org-in-regexp org-radio-target-regexp)
20758 (org-in-regexp org-target-regexp)))
20759 ;; Compatibility alias with Org versions < 7.8.03
20760 (defalias 'org-on-target-p 'org-at-target-p)
20762 (defun org-up-heading-all (arg)
20763 "Move to the heading line of which the present line is a subheading.
20764 This function considers both visible and invisible heading lines.
20765 With argument, move up ARG levels."
20766 (if (fboundp 'outline-up-heading-all)
20767 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20768 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20770 (defun org-up-heading-safe ()
20771 "Move to the heading line of which the present line is a subheading.
20772 This version will not throw an error. It will return the level of the
20773 headline found, or nil if no higher level is found.
20775 Also, this function will be a lot faster than `outline-up-heading',
20776 because it relies on stars being the outline starters. This can really
20777 make a significant difference in outlines with very many siblings."
20778 (let (start-level re)
20779 (org-back-to-heading t)
20780 (setq start-level (funcall outline-level))
20781 (if (equal start-level 1)
20782 nil
20784 (if (re-search-backward re nil t)
20785 (funcall outline-level)))))
20787 (defun org-first-sibling-p ()
20788 "Is this heading the first child of its parents?"
20789 (interactive)
20790 (let ((re org-outline-regexp-bol)
20791 level l)
20792 (unless (org-at-heading-p t)
20793 (error "Not at a heading"))
20794 (setq level (funcall outline-level))
20795 (save-excursion
20796 (if (not (re-search-backward re nil t))
20797 t
20798 (setq l (funcall outline-level))
20799 (< l level)))))
20801 (defun org-goto-sibling (&optional previous)
20802 "Goto the next sibling, even if it is invisible.
20803 When PREVIOUS is set, go to the previous sibling instead. Returns t
20804 when a sibling was found. When none is found, return nil and don't
20805 move point."
20806 (let ((fun (if previous 're-search-backward 're-search-forward))
20807 (pos (point))
20808 (re org-outline-regexp-bol)
20809 level l)
20810 (when (condition-case nil (org-back-to-heading t) (error nil))
20811 (setq level (funcall outline-level))
20812 (catch 'exit
20813 (or previous (forward-char 1))
20814 (while (funcall fun re nil t)
20815 (setq l (funcall outline-level))
20816 (when (< l level) (goto-char pos) (throw 'exit nil))
20817 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20818 (goto-char pos)
20819 nil))))
20821 (defun org-show-siblings ()
20822 "Show all siblings of the current headline."
20823 (save-excursion
20824 (while (org-goto-sibling) (org-flag-heading nil)))
20825 (save-excursion
20826 (while (org-goto-sibling 'previous)
20827 (org-flag-heading nil))))
20829 (defun org-goto-first-child ()
20830 "Goto the first child, even if it is invisible.
20831 Return t when a child was found. Otherwise don't move point and
20832 return nil."
20833 (let (level (pos (point)) (re org-outline-regexp-bol))
20834 (when (condition-case nil (org-back-to-heading t) (error nil))
20835 (setq level (outline-level))
20836 (forward-char 1)
20837 (if (and (re-search-forward re nil t) (> (outline-level) level))
20838 (progn (goto-char (match-beginning 0)) t)
20839 (goto-char pos) nil))))
20841 (defun org-show-hidden-entry ()
20842 "Show an entry where even the heading is hidden."
20843 (save-excursion
20844 (org-show-entry)))
20846 (defun org-flag-heading (flag &optional entry)
20847 "Flag the current heading. FLAG non-nil means make invisible.
20848 When ENTRY is non-nil, show the entire entry."
20849 (save-excursion
20850 (org-back-to-heading t)
20851 ;; Check if we should show the entire entry
20852 (if entry
20853 (progn
20854 (org-show-entry)
20855 (save-excursion
20856 (and (outline-next-heading)
20857 (org-flag-heading nil))))
20858 (outline-flag-region (max (point-min) (1- (point)))
20859 (save-excursion (outline-end-of-heading) (point))
20860 flag))))
20862 (defun org-get-next-sibling ()
20863 "Move to next heading of the same level, and return point.
20864 If there is no such heading, return nil.
20865 This is like outline-next-sibling, but invisible headings are ok."
20866 (let ((level (funcall outline-level)))
20867 (outline-next-heading)
20868 (while (and (not (eobp)) (> (funcall outline-level) level))
20869 (outline-next-heading))
20870 (if (or (eobp) (< (funcall outline-level) level))
20871 nil
20872 (point))))
20874 (defun org-get-last-sibling ()
20875 "Move to previous heading of the same level, and return point.
20876 If there is no such heading, return nil."
20877 (let ((opoint (point))
20878 (level (funcall outline-level)))
20879 (outline-previous-heading)
20880 (when (and (/= (point) opoint) (outline-on-heading-p t))
20881 (while (and (> (funcall outline-level) level)
20882 (not (bobp)))
20883 (outline-previous-heading))
20884 (if (< (funcall outline-level) level)
20885 nil
20886 (point)))))
20888 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20889 ;; This contains an exact copy of the original function, but it uses
20890 ;; `org-back-to-heading', to make it work also in invisible
20891 ;; trees. And is uses an invisible-OK argument.
20892 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20893 ;; Furthermore, when used inside Org, finding the end of a large subtree
20894 ;; with many children and grandchildren etc, this can be much faster
20895 ;; than the outline version.
20896 (org-back-to-heading invisible-OK)
20897 (let ((first t)
20898 (level (funcall outline-level)))
20899 (if (and (eq major-mode 'org-mode) (< level 1000))
20900 ;; A true heading (not a plain list item), in Org-mode
20901 ;; This means we can easily find the end by looking
20902 ;; only for the right number of stars. Using a regexp to do
20903 ;; this is so much faster than using a Lisp loop.
20905 (forward-char 1)
20906 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20907 ;; something else, do it the slow way
20908 (while (and (not (eobp))
20909 (or first (> (funcall outline-level) level)))
20910 (setq first nil)
20911 (outline-next-heading)))
20912 (unless to-heading
20914 (progn
20915 ;; Go to end of line before heading
20916 (forward-char -1)
20918 ;; leave blank line before heading
20919 (forward-char -1))))))
20920 (point))
20922 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20923 "Use Org version in org-mode, for dramatic speed-up."
20924 (if (eq major-mode 'org-mode)
20925 (progn
20926 (org-end-of-subtree nil t)
20927 (unless (eobp) (backward-char 1)))
20928 ad-do-it))
20930 (defun org-end-of-meta-data-and-drawers ()
20931 "Jump to the first text after meta data and drawers in the current entry.
20932 This will move over empty lines, lines with planning time stamps,
20933 clocking lines, and drawers."
20934 (org-back-to-heading t)
20935 (let ((end (save-excursion (outline-next-heading) (point)))
20938 (forward-line 1)
20939 (while (re-search-forward re end t)
20940 (if (not (match-end 1))
20941 ;; empty or planning line
20942 (forward-line 1)
20943 ;; a drawer, find the end
20945 (forward-line 1)))
20947 (point)))
20949 (defun org-forward-same-level (arg &optional invisible-ok)
20950 "Move forward to the arg'th subheading at same level as this one.
20951 Stop at the first and last subheadings of a superior heading.
20952 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20953 it wil also look at invisible ones."
20954 (interactive "p")
20955 (org-back-to-heading invisible-ok)
20956 (org-at-heading-p)
20957 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20959 l)
20960 (forward-char 1)
20961 (while (> arg 0)
20962 (while (and (re-search-forward re nil 'move)
20963 (setq l (- (match-end 0) (match-beginning 0) 1))
20964 (= l level)
20965 (not invisible-ok)
20966 (progn (backward-char 1) (outline-invisible-p)))
20967 (if (< l level) (setq arg 1)))
20968 (setq arg (1- arg)))
20969 (beginning-of-line 1)))
20971 (defun org-backward-same-level (arg &optional invisible-ok)
20972 "Move backward to the arg'th subheading at same level as this one.
20973 Stop at the first and last subheadings of a superior heading."
20974 (interactive "p")
20975 (org-back-to-heading)
20976 (org-at-heading-p)
20977 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20979 l)
20980 (while (> arg 0)
20981 (while (and (re-search-backward re nil 'move)
20982 (setq l (- (match-end 0) (match-beginning 0) 1))
20983 (= l level)
20984 (not invisible-ok)
20985 (outline-invisible-p))
20986 (if (< l level) (setq arg 1)))
20987 (setq arg (1- arg)))))
20989 (defun org-show-subtree ()
20990 "Show everything after this heading at deeper levels."
20991 (interactive)
20992 (outline-flag-region
20993 (point)
20994 (save-excursion
20995 (org-end-of-subtree t t))
20996 nil))
20998 (defun org-show-entry ()
20999 "Show the body directly following this heading.
21000 Show the heading too, if it is currently invisible."
21001 (interactive)
21002 (save-excursion
21003 (condition-case nil
21004 (progn
21005 (org-back-to-heading t)
21006 (outline-flag-region
21007 (max (point-min) (1- (point)))
21008 (save-excursion
21009 (if (re-search-forward
21011 (match-beginning 1)
21012 (point-max)))
21013 nil)
21014 (org-cycle-hide-drawers 'children))
21015 (error nil))))
21017 (defun org-make-options-regexp (kwds &optional extra)
21018 "Make a regular expression for keyword lines."
21019 (concat
21020 "^"
21027 ;; Make isearch reveal the necessary context
21028 (defun org-isearch-end ()
21029 "Reveal context after isearch exits."
21030 (when isearch-success ; only if search was successful
21031 (if (featurep 'xemacs)
21032 ;; Under XEmacs, the hook is run in the correct place,
21033 ;; we directly show the context.
21034 (org-show-context 'isearch)
21035 ;; In Emacs the hook runs *before* restoring the overlays.
21036 ;; So we have to use a one-time post-command-hook to do this.
21037 ;; (Emacs 22 has a special variable, see function `org-mode')
21038 (unless (and (boundp 'isearch-mode-end-hook-quit)
21039 isearch-mode-end-hook-quit)
21040 ;; Only when the isearch was not quitted.
21041 (org-add-hook 'post-command-hook 'org-isearch-post-command
21042 'append 'local)))))
21044 (defun org-isearch-post-command ()
21045 "Remove self from hook, and show context."
21046 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21047 (org-show-context 'isearch))
21050 ;;;; Integration with and fixes for other packages
21052 ;;; Imenu support
21054 (defvar org-imenu-markers nil
21055 "All markers currently used by Imenu.")
21056 (make-variable-buffer-local 'org-imenu-markers)
21058 (defun org-imenu-new-marker (&optional pos)
21059 "Return a new marker for use by Imenu, and remember the marker."
21060 (let ((m (make-marker)))
21061 (move-marker m (or pos (point)))
21062 (push m org-imenu-markers)
21063 m))
21065 (defun org-imenu-get-tree ()
21066 "Produce the index for Imenu."
21067 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21068 (setq org-imenu-markers nil)
21069 (let* ((n org-imenu-depth)
21070 (re (concat "^" (org-get-limited-outline-regexp)))
21071 (subs (make-vector (1+ n) nil))
21072 (last-level 0)
21073 m level head)
21074 (save-excursion
21075 (save-restriction
21076 (widen)
21077 (goto-char (point-max))
21078 (while (re-search-backward re nil t)
21079 (setq level (org-reduced-level (funcall outline-level)))
21080 (when (and (<= level n)
21081 (looking-at org-complex-heading-regexp))
21082 (setq head (org-link-display-format
21083 (org-match-string-no-properties 4))
21084 m (org-imenu-new-marker))
21085 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21086 (if (>= level last-level)
21087 (push (cons head m) (aref subs level))
21088 (push (cons head (aref subs (1+ level))) (aref subs level))
21089 (loop for i from (1+ level) to n do (aset subs i nil)))
21090 (setq last-level level)))))
21091 (aref subs 1)))
21093 (eval-after-load "imenu"
21094 '(progn
21095 (add-hook 'imenu-after-jump-hook
21096 (lambda ()
21097 (if (eq major-mode 'org-mode)
21098 (org-show-context 'org-goto))))))
21100 (defun org-link-display-format (link)
21101 "Replace a link with either the description, or the link target
21102 if no description is present"
21103 (save-match-data
21104 (if (string-match org-bracket-link-analytic-regexp link)
21105 (replace-match (if (match-end 5)
21106 (match-string 5 link)
21107 (concat (match-string 1 link)
21108 (match-string 3 link)))
21109 nil t link)
21110 link)))
21112 (defun org-toggle-link-display ()
21113 "Toggle the literal or descriptive display of links."
21114 (interactive)
21115 (if org-descriptive-links
21116 (progn (org-remove-from-invisibility-spec '(org-link))
21117 (org-restart-font-lock)
21118 (setq org-descriptive-links nil))
21119 (progn (add-to-invisibility-spec '(org-link))
21120 (org-restart-font-lock)
21121 (setq org-descriptive-links t))))
21123 ;; Speedbar support
21125 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21126 "Overlay marking the agenda restriction line in speedbar.")
21127 (overlay-put org-speedbar-restriction-lock-overlay
21128 'face 'org-agenda-restriction-lock)
21129 (overlay-put org-speedbar-restriction-lock-overlay
21130 'help-echo "Agendas are currently limited to this item.")
21131 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21133 (defun org-speedbar-set-agenda-restriction ()
21134 "Restrict future agenda commands to the location at point in speedbar.
21136 (interactive)
21137 (require 'org-agenda)
21138 (let (p m tp np dir txt)
21139 (cond
21140 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21141 'org-imenu t))
21142 (setq m (get-text-property p 'org-imenu-marker))
21143 (with-current-buffer (marker-buffer m)
21144 (goto-char m)
21145 (org-agenda-set-restriction-lock 'subtree)))
21146 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21147 'speedbar-function 'speedbar-find-file))
21148 (setq tp (previous-single-property-change
21149 (1+ p) 'speedbar-function)
21150 np (next-single-property-change
21151 tp 'speedbar-function)
21152 dir (speedbar-line-directory)
21153 txt (buffer-substring-no-properties (or tp (point-min))
21154 (or np (point-max))))
21155 (with-current-buffer (find-file-noselect
21156 (let ((default-directory dir))
21157 (expand-file-name txt)))
21158 (unless (eq major-mode 'org-mode)
21159 (error "Cannot restrict to non-Org-mode file"))
21160 (org-agenda-set-restriction-lock 'file)))
21161 (t (error "Don't know how to restrict Org-mode's agenda")))
21162 (move-overlay org-speedbar-restriction-lock-overlay
21163 (point-at-bol) (point-at-eol))
21164 (setq current-prefix-arg nil)
21165 (org-agenda-maybe-redo)))
21167 (eval-after-load "speedbar"
21168 '(progn
21169 (speedbar-add-supported-extension ".org")
21170 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21171 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21172 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21173 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21174 (add-hook 'speedbar-visiting-tag-hook
21175 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21177 ;;; Fixes and Hacks for problems with other packages
21179 ;; Make flyspell not check words in links, to not mess up our keymap
21180 (defun org-mode-flyspell-verify ()
21181 "Don't let flyspell put overlays at active buttons, or on
21182 {todo,all-time,additional-option-like}-keywords."
21183 (let ((pos (max (1- (point)) (point-min)))
21184 (word (thing-at-point 'word)))
21185 (and (not (get-text-property pos 'keymap))
21186 (not (get-text-property pos 'org-no-flyspell))
21187 (not (member word org-todo-keywords-1))
21188 (not (member word org-all-time-keywords))
21189 (not (member word org-additional-option-like-keywords)))))
21191 (defun org-remove-flyspell-overlays-in (beg end)
21192 "Remove flyspell overlays in region."
21193 (and (org-bound-and-true-p flyspell-mode)
21194 (fboundp 'flyspell-delete-region-overlays)
21195 (flyspell-delete-region-overlays beg end))
21196 (add-text-properties beg end '(org-no-flyspell t)))
21198 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21199 (eval-after-load "bookmark"
21200 '(if (boundp 'bookmark-after-jump-hook)
21201 ;; We can use the hook
21202 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21203 ;; Hook not available, use advice
21204 (defadvice bookmark-jump (after org-make-visible activate)
21205 "Make the position visible."
21206 (org-bookmark-jump-unhide))))
21208 ;; Make sure saveplace shows the location if it was hidden
21209 (eval-after-load "saveplace"
21210 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21211 "Make the position visible."
21212 (org-bookmark-jump-unhide)))
21214 ;; Make sure ecb shows the location if it was hidden
21215 (eval-after-load "ecb"
21216 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21217 "Make hierarchy visible when jumping into location from ECB tree buffer."
21218 (if (eq major-mode 'org-mode)
21219 (org-show-context))))
21221 (defun org-bookmark-jump-unhide ()
21222 "Unhide the current position, to show the bookmark location."
21223 (and (eq major-mode 'org-mode)
21224 (or (outline-invisible-p)
21225 (save-excursion (goto-char (max (point-min) (1- (point))))
21226 (outline-invisible-p)))
21227 (org-show-context 'bookmark-jump)))
21229 ;; Make session.el ignore our circular variable
21230 (eval-after-load "session"
21231 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21233 ;;;; Experimental code
21235 (defun org-closed-in-range ()
21236 "Sparse tree of items closed in a certain time range.
21237 Still experimental, may disappear in the future."
21238 (interactive)
21239 ;; Get the time interval from the user.
21240 (let* ((time1 (org-float-time
21241 (org-read-date nil 'to-time nil "Starting date: ")))
21242 (time2 (org-float-time
21243 (org-read-date nil 'to-time nil "End date:")))
21244 ;; callback function
21245 (callback (lambda ()
21246 (let ((time
21247 (org-float-time
21248 (apply 'encode-time
21249 (org-parse-time-string
21250 (match-string 1))))))
21251 ;; check if time in interval
21252 (and (>= time time1) (<= time time2))))))
21253 ;; make tree, check each match with the callback
21256 ;;;; Finish up
21258 (provide 'org)
21260 (run-hooks 'org-load-hook)
21262 ;;; org.el ends here